Namespace: ApiViewer

Methods

---

<static> setDefaultParams(params)

set the default params the will be add to image plot request

Parameters:

Name	Type	Description
params

Source:

• api/ApiViewer.js, line 246

---

<static> showChart(options, viewerId)

Show a chart

Parameters:

Name	Type	Description
options	Object
viewerId	string

Source:

• api/ApiViewer.js, line 346

---

<static> showHiPS(request, viewerId)

show a HiPS in the firefly viewer in another tab

Parameters:

Name	Type	Description
request	WebPlotParams | WebPlotRequest	The object contains parameters for web plot request on HiPS type
viewerId	String

Source:

• api/ApiViewer.js, line 274

---

<static> showHistogram(histogramOptions, viewerId)

Show Histogram

Parameters:

Name	Type	Description
histogramOptions	HistogramOptions
viewerId	string

Source:

• api/ApiViewer.js, line 374

---

<static> showImage(request, viewerId)

show a image in the firefly viewer in another tab

Parameters:

Name	Type	Description
request	WebPlotParams | WebPlotRequest	The object contains parameters for web plot request
viewerId	String

Source:

• api/ApiViewer.js, line 255

---

<static> showImageFileOrUrl(file, url)

show a image in the firefly viewer in another tab, the file first then the url

Parameters:

Name	Type	Description
file		a file on the server
url		a url to a fits file

Source:

• api/ApiViewer.js, line 288

---

<static> showTable(request, options)

Parameters:

Name	Type	Description
request	Object
options	TblOptions

Source:

• api/ApiViewer.js, line 322

---

<static> showXYPlot(xyPlotOptions, viewerId)

Show XY Plot

Parameters:

Name	Type	Description
xyPlotOptions	XYPlotOptions
viewerId	string

Source:

• api/ApiViewer.js, line 361