Firefly

Global

Members

<constant> ActionScope

enum can be 'GROUP', 'SINGLE', 'LIST'

.

enum can be 'GROUP', 'SINGLE', 'LIST'

Source:

<constant> Band

A Band in an image plot must be enum 'RED', 'GREEN', 'BLUE', 'NO_BAND'

.

A Band in an image plot must be enum 'RED', 'GREEN', 'BLUE', 'NO_BAND'

Source:

<constant> parsePt

Parse a point

Source:

<constant> RequestType

web plot request type

can be 'SERVICE', 'FILE', 'URL', 'ALL_SKY', 'HiPS', 'BLANK', 'PROCESSOR', 'RAWDATASET_PROCESSOR', 'TRY_FILE_THEN_URL', 'WORKSPACE'

Source:

<constant> RotateType

The type of rotation can be 'NORTH', 'ANGLE', 'UNROTATE'

.

The type of rotation can be 'NORTH', 'ANGLE', 'UNROTATE'

Source:

<constant> ServiceType

service type

can be 'IRIS', 'ISSA', 'DSS', 'SDSS', 'TWOMASS', 'MSX', 'DSS_OR_IRIS', 'WISE', 'ATLAS','ZTF', 'PTF', 'NONE'

Source:

<constant> TitleOptions

title options

can be 'NONE', 'PLOT_DESC', 'FILE_NAME', 'HEADER_KEY', 'PLOT_DESC_PLUS', 'SERVICE_OBS_DATE'

Source:

<constant> UserZoomTypes

can be 'UP','DOWN', 'FIT', 'FILL', 'ONE', 'LEVEL', 'WCS_MATCH_PREV'

.

can be 'UP','DOWN', 'FIT', 'FILL', 'ONE', 'LEVEL', 'WCS_MATCH_PREV'

Source:

<constant> ZoomType

zoom type

can be 'STANDARD', 'LEVEL', 'FULL_SCREEN', 'TO_WIDTH_HEIGHT', 'TO_WIDTH', 'TO_HEIGHT', 'ARCSEC_PER_SCREEN_PIX'

Source:

Methods

getColumnType(tableModel, colName)

Returns the column data type with the given name

.

Returns the column data type with the given name

Parameters:
Name Type Description
tableModel TableModel
colName string
Source:
Returns:
Type
string

getDistanceCoords(plot, pt, x, y)

Return a Imge point the represents the passed Image point with a distance in World coordinates added to it.

Parameters:
Name Type Description
plot WebPlot

the plot
pt ImagePt

the x and y coordinate in image coordinates
x

the x distance away from the point in world coordinates
y

the y distance away from the point in world coordinates
Source:
Returns:

the new point

Type
ImagePt

makeDevicePt(x, y)

A point on the physical space of the image display area

Parameters:
Name Type Description
x number | string

the x, string is converted to number
y number | string

the y, string is converted to number
Source:
Returns:
Type
DevicePt

makeFitsImagePt(x, y)

A image point in a FITS file with FITS based offset Standard

Parameters:
Name Type Description
x number | string

the x, string is converted to number
y number | string

the y, string is converted to number
Source:
Returns:
Type
FitsImagePt

makeImagePt(x, y)

A point in the image file

Parameters:
Name Type Description
x number | string

the x, string is converted to number
y number | string

the y, string is converted to number
Source:
Returns:
Type
ImagePt

makeScreenPt(x, y)

A point of the display image

Parameters:
Name Type Description
x number | string

the x, string is converted to number
y number | string

the y, string is converted to number
Source:
Returns:
Type
ScreenPt

makeWorldPt(lon, lat [, coordSys] [, objName] [, resolver])

A point on the sky with a coordinate system

Parameters:
Name Type Argument Description
lon number | string

longitude in degrees, strings are converted to numbers
lat number | string

latitude in degrees, strings are converted to numbers
coordSys CoordinateSys <optional>

The coordinate system of this worldPt
objName String <optional>

object name used to create this worldPt
resolver <optional>

the resolver used to create this worldPt
Source:
Returns:
Type
WorldPt

makeZeroBasedImagePt(x, y)

A image point in a Zero based standard, can be offset with the LVT1 and LTV2 headers

Parameters:
Name Type Description
x number | string

the x, string is converted to number
y number | string

the y, string is converted to number
Source:
Returns:
Type
ImagePt

pointEquals(p1, p2)

Test if two points are equals. They must be the same coordinate system and have the same values to be equal. Two points that are null or undefined are also considered equal. If both points are WorldPt and are equal in values and coordinate system but have a different resolver and object names, * they are still considered equal.

Parameters:
Name Type Description
p1 Point

the first point
p2 Point

the second point
Source:
Returns:

true if equals

TableWatchFunc(tbl_id, action, cancelSelf, params)

Table watcher function

Like a normal watch with following exceptions:

  • one started per table
  • tbl_id is first parameter.
  • The params object with always include a options and a sharedData property. They may be undefined.
  • The options object should be thought of as read only. It should not be modified.
  • It is call the first time with the action undefined. This can be for initialization. The table will beloaded
Parameters:
Name Type Description
tbl_id String

the table id
action Action

the action
cancelSelf function

function to cancel, should be call when table is removed
params Object

params contents are created by the watcher with two exceptions, params will always contain:

  • options - The options object is the same as passed to dispatchAddTableTypeWatcherDef
  • sharedData - if the definition contains a shared data object it will be passed. sharedData provides a way for all the watcher with the same definition to share some state. This should only be used if absolutely necessary

Source:

TestWatchFunc(table, action, options)

Test to see if we should watch this table

.

Test to see if we should watch this table

Parameters:
Name Type Description
table TableModel
action Action
options Object
Source:
Returns:

true if we should watch

Type
boolean

Type Definitions

Action

Type:
  • Object
Properties:
Name Type Description
type String

the action constant, a unique string identifying this action
payload Object

object with anything, the data
Source:

ActivateParams

Type:
  • Object
Properties:
Name Type Description
imageViewerId string
chartViewerId string
tableGroupViewerId string
converterId string
Source:

AppDataStore

Information about the core of the application

Type:
  • Object
Properties:
Name Type Description
isReady boolean

: false,
connections Object.<String, Array>

channel:[] ... keyed by channel, contains an array of connId(s).
activeTarget WorldPt
rootUrlPath string
taskCounters Array
commandState Object
preferences, Object.<String, String>
appOptions Object

: {}
menu Object
alerts Object

ie. system notification messages
searches SearchInfo

define searches available to this application.
Source:

ApplicationState

Type:
  • Object
Properties:
Name Type Description
allPlots VisRoot

image plotting store (Controller: ImagePlotCntlr.js)
table_space TableSpace

table data store (Controller: TablesCntlr.js)
charts Object

information about 2D plots (Controller: ChartsCntlr.js)
fieldGroup FieldGroupStore

field group data for form and dialog input (Controller: FieldGroupCntlr.js)
readout Object

mouse readout information (Controller: ReadoutCntlr.js)
app_data AppDataStore

general application information (Controller: AppDataCntlr.js)
drawLayers Object

information about the drawing layers e.g. select tool, catalogs overlays, regions, etc
imageMultiView Viewer

data about the various image viewers (Controller: MultiViewCntlr.js)
externalAccess Object

controls communication events with eternal applications (Controller: ExternalAccessCntlr.js)
layout Object

information about application layout (Controller: LayoutCntlr.js)
tblstats Object

stats for histogram, etc (Controller: TableStatsCntlr.js)
dialogOrComponent Object

hold information about dialog visibility and other components (Controller: ComponentCntlr.js)
Source:

AppProps

A property object used for customizing the application

Type:
  • Object
Properties:
Name Type Argument Default Description
template String <optional>

UI template to display. API mode if not given
views string <optional>

some template may have multiple views. If not given, the default view of the template will be used.
div string <optional>
 app

ID of a div to place the viewer in.
appTitle string <optional>

title of this application.
showUserInfo boolean <optional>
 false

show user information. This is used when authentication is available
showViewsSwitch boolean <optional>

show/hide the swith views buttons
rightButtons Array.<function()> <optional>

function(s) returning a button to be displayed on the top-right of the result page.
menu Object

custom menu bar

Properties
Name Type Description
label string

button's label
action string

action to fire on button clicked
type string

use 'COMMAND' for actions that's not drop-down related.
Source:

BandState

Type:
  • Object
Properties:
Name Type Description
workingFitsFileStr
originalFitsFileStr
uploadFileNameStr
imageIdx
originalImageIdx
plotRequestSerialize
rangeValuesSerialize
directFileAccessData
multiImageFile
tileCompress
cubeCnt
cubePlaneNumber
Source:

ClientTile

Type:
  • Object
Properties:
Name Type Description
tileAttributes Object
dataUrl String
width number

width of this tile
height number

height of this tile
index number

index of this tile
url string

original file key to use in the service to retrieve this tile
x number

pixel offset of this tile
y number

pixel offset of this tile
Source:

ColsDescription

An object that describe a single column in a table

Type:
  • Object
Properties:
Name Type Description
colName string

name of the column
colIdx number

column index for the column
unit string

unit for the column
Source:

ConnectorInterface

Return value of useFieldGroupConnector. This object contains the view components properties (viewProps) and the fireValueChange. Simple pass the viewProps to the component and call fireValueChange when the view component has a value change call.

Type:
  • Object
Properties:
Name Type Description
fireValueChange- function

Call with the value of the view changes. The parameter is an object the should contains as least a value property plus anything else that is appropriate to pass
viewProps Object

all the properties passed to useFieldGroupConnector with the connection properties removed. This object should contain all the properties to pass on the the view component
fieldKey String

the passed fieldKey, you don't usually need to access this value
groupKey String

the passed groupKey, you don't usually need to access this value
Source:

CoordColsDescription

And object that describes a pairs of columns in a table that makes up a coordinate

Type:
  • Object
Properties:
Name Type Description
type string

content type of the columns, 'center'
lonCol string

name of the longitudinal column
latCol string

name of the latitudinal column
lonIdx number

column index for the longitudinal column
latIdx number

column index for the latitudinal column
csys CoordinateSys

the coordinate system to use
Source:

CoordinateSys

coordinate system

value is one of the following constants; EQ_J2000, EQ_B2000, EQ_B1950, GALACTIC, SUPERGALACTIC, ECL_J2000, ECL_B1950, PIXEL, SCREEN_PIXEL, UNDEFINED,

Type:
  • Object
Source:

CoverageOptions

options of coverage

Type:
  • Object
Properties:
Name Type Description
title string
tip string
coverageType string

one of 'GUESS', 'BOX', 'REGION', 'ALL', or 'X' default is 'ALL'
overlayPosition string

search position point to overlay, e.g '149.08;68.739;EQ_J2000'
symbol string | Object.<String, String>

symbol name one of 'X','SQUARE','CROSS','DIAMOND','DOT','CIRCLE','BOXCIRCLE', 'ARROW'
symbolSize string | Object.<String, Number>

a number of the symbol size or an object keyed by table id and value the symbol size
color string | Object.<String, String>

a color the symbol size or an object keyed by table id and color
fovMaxFitsSize number

how big this fits image can be (in degrees)
fovDegMinSize number

minimum field of view size in degrees
fovDegFallOver number

the field of view size to determine when to move between and HiPS and an image
multiCoverage boolean

overlay more than one table on the coverage
gridOn string

one of 'FALSE','TRUE','TRUE_LABELS_FALSE'
Source:

DataProductsConvertType

Type:
  • Object
Properties:
Name Type Description
tableMatches, function

function to test if the table fits the template form: tableMatches(TableModel): boolean
create function

create the converter based on this template. The converter is created by a function that is passed a table and the converter template. It then may return a new converter template that could be optionally customized to the table. form: create(TableModel,DataProductsConvertType): DataProductsConvertType
threeColor boolean

supports three color images
hasRelatedBands boolean

supports groups of related images
canGrid boolean

support grids of images
maxPlot number

total number of images that can be created at a time, i.e. page size
getSingleDataProduct function

pass table,rowNum,activate params return a activate function required
getGridDataProduct function

pass(table, array of plotrows, and activateParams) return activate function. Only required if canGrid is true
getRelatedDataProduct, function

pass (table, row, threeColorOps, highlightPlotId, activateParams) , return activate function. Only required if hasRelatedBands is true
threeColorBands Object

definition of the three color plot request
Source:

DataProductsDisplayType

Type:
  • Object
Properties:
Name Type Description
displayType string
activate function
menu Object
Source:

DevicePt

a rendered point on the device screen, including rotation, flipping, etc

Type:
  • Object
Properties:
Name Type Description
x Number
y Number
type String

constant must be 'DevicePt'
Source:

Dimension

Type:
  • Object
Properties:
Name Type Description
width number
height number
Source:

DownloadRequest

Download request.

Download request. Below is a list of predefined parameters available for a download request. All of the options are optional. These parameters let you control what data and how it will be returned.

Type:
  • object
Properties:
Name Type Description
FilePrefix number
BaseFileName number
Title string
TitlePrefix string
Email string
MaxBundleSize string
DataSource object
tableRequest TableRequest
selectionInfo string
Source:

DrawLayerRoot

The state of the Drawing layers store.

Type:
  • Object
Properties:
Name Type Description
drawLayerAry Array.<DrawLayer>

the array of all the drawing layers
allowedActions Array.<string>

the actions the go to the drawing layers by default
Source:

FieldGroup

Type:
  • Object
Properties:
Name Type Description
groupKey String
fields Array.<FieldGroupField>
reducerFunc function
keepState boolean
mounted boolean

field is mounted
wrapperGroupKey String
fieldGroupValid boolean
Source:

FieldGroupField

Type:
  • Object
Properties:
Name Type Description
fieldKey String

the field id, must be unique in the group
groupKey String

the group id, must be unique
value String | Promise | *

the value, can be anything including promise, typically a string
valid boolean

the group id, must be unique
validator function
mounted boolean

field is mounted
nullAllowed, boolean

default to true
Source:

FieldGroupStore

Type:
Source:

FireflyOptions

An object that is defined in the html that has configuration options for Firefly

Type:
  • Object
Properties:
Name Type Description
MenuItemKeys Object

an object the references MenuItemKeys.js that can turn on or off buttons on the image tool bar
imageTabs Array.<string>

specifies the order of the time in the image dialog e.g. - [ 'fileUpload', 'url', '2mass', 'wise', 'sdss', 'msx', 'dss', 'iras' ]
irsaCatalogFilter string | function

a function or a predefined key that specifies how the catalogs are filter in the UI
catalogSpacialOp string

two values undefined or 'polygonWhenPlotExist'. when catalogSpacialOp === 'polygonWhenPlotExist' then the catalog panel will show the polygon option as default when possible
imageMasterSources Array.<string>

default - ['ALL'], source to build image master data from
imageMasterSourcesOrder Array.<string>

for the image dialog sort order of the projects, anything not listed is put on bottom
Source:

FitsHeader

Type:
  • Array.<{}>
Properties:
Name Type Description
height number
Source:

FitsImagePt

a point in FITS standard image file coordinates

Type:
  • Object
Properties:
Name Type Description
x Number
y Number
type String

constant must be 'ImagePt'
Source:

footprintInfo

Footprint Info.

Footprint Info. The data object containing footprint info.

Type:
  • object
Properties:
Name Type Description
footprint string

name of footprint project, such as 'HST', 'WFIRST', etc. or footprint file at the server
instrument string

name of instrument for the footprint
relocateBy string

name of instrument for the footprint from the server, method of relocation for the uploaded footprint
fromFile string

filename, not including the extension, of the uploaded file
fromRegionAry Array.<string>

array or string of region description
Source:

Group

Table group info

.

Table group info

Type:
  • object
Properties:
Name Type Description
ID string

ID used to reference this group.
name string

href of this group.
desc string

description
params Array.<PARAM>

params if any
paramRefs Array.<REF>

reference to params
columnRefs Array.<REF>

reference to columns
Source:

HiPSAllSkyCacheInfo

Type:
  • Object
Properties:
Name Type Description
url string
order3 Image

single image with the all order 3 allsky
order2Array Array.<Canvas>

array of order 2 image tiles, each index if the tile number
Source:

HiPSDeviceTileData

Type:
  • Object
Properties:
Name Type Description
tileNumber number

HiPS pixel number
nside number

healpix level
devPtCorners Array.<DevicePt>

the target corners of the tile in device coordinates
dx number

x offset into image
dy number

y offset into image
Source:

HipsImageConversionSettings

Parameters to do conversion between hips and images

Type:
  • Object
Properties:
Name Type Description
hipsRequestRoot WebPlotParams | WebPlotRequest

a request object that contains the base parameter to display a HiPS
imageRequestRoot WebPlotParams | WebPlotRequest

a request object that contains the base parameter to display an image. It must be a service type.
fovDegFallOver number

The field of view size to determine when to move between and HiPS and an image
fovMaxFitsSize number

how big this fits image can be
autoConvertOnZoom boolean

do auto convert on zoom
Source:

HiPSTile

a single hips image tile url computed by: NorderK/DirD/NpixN{.ext} where K= nOrder N= tileNumber D=(N/10000)*10000 (integer division)

Type:
  • Object
Properties:
Name Type Description
corners Array.<WorldPt>

(maybe) in worldPt
devPtCorners Array.<devpt>

(maybe) in screenPt (keep here?)
url string

root url (maybe, don't know if necessary)
Source:

HistogramOptions

shallow object with histogram parameters

Type:
  • Object
Properties:
Name Type Argument Default Description
source string <optional>

location of the ipac table, url or file path; ignored when histogram view is added to table
tbl_id string <optional>

table id of the table this plot is connected to
chartTitle string <optional>

title of the chart
col string

column or expression to use for histogram, can contain multiple column names ex. log(col) or (col1-col2)/col3
numBins number <optional>
 50

number of bins for fixed bins algorithm (default)
falsePositiveRate number <optional>

false positive rate for bayesian blocks algorithm
xOptions string <optional>

comma separated list of x axis options: flip,log
yOptions string <optional>

comma separated list of y axis options: flip,log
Source:

ImageContainer

Always contains key image and then anything else to specify the state

.

Always contains key image and then anything else to specify the state

Type:
  • Object
Properties:
Name Type Description
image Object
src Object
dataUrl String
tileAttributes Object
canCompress Object
Source:

ImageMasterData

need summary

Type:
  • Object
Properties:
Name Type Description
project string

name of project or mission
subProject string

subproject name or null
title string

description of the image
wavelength number

the actual wavelength value
wavelengthDesc string

description of the wavelength
helpUrl string

full url to help for this data
tooltip string

one line of helpful text
imageId string

a unique id for the list of image data
projectTypeKey string

as of key such as 'galactic', 'extra-galactic, solar-system'
projectTypeDesc string

description of the project type
minRangeDeg number

for radius search, smallest radius accepted
maxRangeDeg number

for radius search, largest radius accepted
plotRequestParams object

a plot request object for WebPlotParams or WebPlotRequest
Source:

ImagePt

a point in image file coordinates

Type:
  • Object
Properties:
Name Type Description
x Number
y Number
type String

constant must be 'ImagePt'
Source:

ImageTile

a single image tile

Type:
  • Object
Properties:
Name Type Description
width number

width of this tile
height number

height of this tile
index number

index of this tile
url string

file key to use in the service to retrieve this tile
x number

pixel offset of this tile
y number

pixel offset of this tile
Source:

ImageTileData

The information about all the image tiles

Type:
  • Object
Properties:
Name Type Description
images Array.<ImageTile>
screenWidth number

width of all the tiles
screenHeight number

height of all the tiles
templateName String

template name (not used)
zfact number

zoom factor
thumbnailImage ThumbnailImage

information about the thumbnail
Source:

Table link info

Type:
  • object
Properties:
Name Type Description
ID string

ID used to reference this LINK.
href string

href of this LINK.
value string

text of this LINK.
title string

title/label of this LINK.
role string

role, see VOTable content-role
type string

type, see VOTable content-type
action string

see VOTable LINK action
Source:

MouseReadoutType

Type:
  • Object
Properties:
Name Type Description
readoutKey: String

unique key represent this readout type
matches: function

function to test if this readout should be used form: tableMatches(WebPlot): boolean
createImmediateReadout: function

function to create a readout object
createAsyncReadout: function

function to create a readout by calling the server to get data, returns a promise with a readout
hasAsyncReadout: function

function to test readout should be used make async calls: hasAsyncReadout(WebPlot): boolean
Source:

MultiViewerRoot

Type:
Source:

PARAM

PARAM may have everything TableColumn has plus 'value'

.

PARAM may have everything TableColumn has plus 'value'

Type:
  • object
Properties:
Name Type Description
value string

value of this PARAM
Source:

PlotView

There is one PlotView object for each react ImageViewer.

There is one PlotView object for each react ImageViewer. A PlotView is uniquely identified by the plotId. The plot id will not change for the life time of the plotView. A plot view can be connected to a plot group. That is done by the plotGroupId. There will be several plotViews in a plot group.

PlotView is mostly about the viewing of the plot. The plot data is contained in a WebPlot. A plotView can have an array of WebPlots. The array length will only be one for normals fits files and n for multi image fits and cube fits files. plots[primeIdx] refers to the plot currently showing in the plot view.

Type:
  • Object
Properties:
Name Type Description
plotId, String

immutable
plotGroupId, String

immutable
drawingSubGroupId, String

immutable
plots Array.<WebPlot>

all the plots that this plotView can show, usually the image in the fits file
plottingStatus, String

end user description of the what is doing on
serverCall, String

one of 'success', 'working', 'fail'
primeIdx, number

which of the plots array is active
scrollX number

scroll position X
scrollY number

scroll position Y
viewDim Object

size of viewable area (div size: offsetWidth & offsetHeight)
menuItemKeys Object

which toolbar button are enables for this plotView
overlayPlotViews Object
options Object
rotation number

if > 0 then the plot is rotated by this many degrees
flipY boolean

if true, the the plot is flipped on the Y axis
plotViewCtx PlotViewContextData
Source:

PlotViewContextData

Various properties about this PlotView

.

Various properties about this PlotView

Type:
  • Object
Properties:
Name Type Description
userCanDeletePlots boolean

true if this plotView can be deleted by the user
zoomLockingEnabled boolean

the plot will automaticly adjust the zoom when resized
zoomLockingType UserZoomTypes

the type of zoom lockeing
lastCollapsedZoomLevel number

used for returning from expanded mode, keeps recode of the level before expanded
hipsImageConversion HipsImageConversionSettings

if defined, then plotview can convert between hips and image
plotCounter number

index of how many plots, used for making next ID
Source:

Point

a Point

Type:
  • Object
Properties:
Name Type Description
x Number
y Number
type String

one of 'RenderedPt', 'ScreenPt', 'ImagePt', 'ImageWorkSpacePt', 'WorldPt', 'ProjectionPt', 'OffsetPt'
Source:

ProcessedTiles

Type:
  • Object
Properties:
Name Type Description
plotId string
plotImageId string
imageOverlayId string
zoomFactor number
clientTileAry Array.<ClientTile>
Source:

PVCreateOptions

Object used for creating the PlotView

.

Object used for creating the PlotView

Type:
  • Object
Properties:
Name Type Description
hipsImageConversion HipsImageConversionSettings

If object is defined and populated correctly then the PlotView will convert between HiPS and Image
menuItemKeys Object

defines which menu items shows on the toolbar
userCanDeletePlots boolean

default to true, defines if a PlotView can be deleted by the user
Source:

PvNewPlotInfo

Main part of the payload of successful call to the server

Type:
  • Object
Properties:
Name Type Description
plotId, String
requestKey, String
plotAry Array.<WebPlot>
overlayPlotViews Array.<OverPlotView>
Source:

REF

reference to another object, i.e TableColumn, PARAM, LINK

.

reference to another object, i.e TableColumn, PARAM, LINK

Type:
  • object
Properties:
Name Type Description
ref string

ID if the referenced object
UCD string

UCD, see VOTable
utype string

utype, see VOTable
Source:

RegionColDescription

An object that describes the column which is ObsCore defined 's_region'

Type:
  • Object
Properties:
Name Type Description
type string

content type of the column, 'region'
regionCol string

name of the column
regionIdx number

column index for the column
unit string

unit of the measurement of the region
Source:

RegionSelectMode

shallow object with the rendering parameters for selected region

Type:
  • Object
Properties:
Name Type Argument Default Description
selectStyle string <optional>
 'UprightBox'

rendering style for the selected region including 'UprightBox', 'DottedOverlay', 'SolidOverlay', 'DottedReplace', and 'SolidReplace'
selectColor string <optional>
 '#DAA520'

rendering color for the selected region, CSS color values, such as '#DAA520' 'red'. are valid for rendering.
lineWidth int <optional>
 0

rendering line width for the selected region. 0 or less means the line width is the same as that of the selected region
Source:

RelatedData

overlay data that is associated with the image data

Type:
  • Object
Properties:
Name Type Description
relatedDataId string

a globally unique id made from the plotId and the dataKey - this is added by the client and does not come from the server
dataKey string

should be a unique string key an array of plot of RelatedData, that is all RelatedData array entries for a plot should have a unqiue dataKey
dataType string

one of 'IMAGE_OVERLAY', 'IMAGE_MASK', 'TABLE'
desc string

user description of the data
searchParams Object.<string, string>

map of search parameters to get the related data
availableMask Object.<string, string>

only used for masks- key is the bit number, value is the description
Source:

ScreenPt

a point on the image screen

Type:
  • Object
Properties:
Name Type Description
x Number
y Number
type String

constant must be 'ScreenPt'
Source:

TableColumn

Table column information.

Table column information.

Type:
  • object
Properties:
Name Type Description
name string

name of the column
label string

display name of the column
type string

data type
units string

data units
nullString string

string used to represent null value
desc string

description of the column
width number

max width needed to display data.
prefWidth number

preferred width, regardless of the data.
sortable boolean

true if undefined
filterable boolean

true if undefined
visibility string

show, hide, or hidden. hidden columns are not viewable by users.
sortByCols string

for multi-columns sorting. column names separated by comma(',').
enumVals string

contains only values in this list. values are seprated by comma(',')
ID string

ID used to reference this column.
precision string

applies only to floating point numbers. A string Tn where T is either F, E, or G If T is not present, it defaults to F. When T is F or E, n is the number of significant figures after the decimal point. When T is G, n is the number of significant digits
UCD string

UCD of this column.
utype string

UType of this column.
ref string

refer to this column for declarations.
value string

static value of this column for all of the rows in this table
maxValue string

maximum value.
minValue string

minimum value.
links Array.<LINK>

links if any.
Source:

TableGroup

Table group.

Table group. Define a group of tables used by the UI.

Type:
  • Object
Properties:
Name Type Description
name string

unique name of this group
active string

tbl_id of the active table in this group
tables Object.<string, TableGroupItem>

a map of TableGroupItem(s) keyed by tbl_id
Source:

TableGroupItem

Table group item.

Table group item. Contains enough key information to identify the table data as well as the UI data associate with this item.

Type:
  • Object
Properties:
Name Type Description
tbl_group string

table group name
tbl_id string

unique id of the table data
tbl_ui_id string

unique id of the table's UI data
title string

title or label of the table
removable boolean

true if this item can be removed from group.
options Object.<string, *>

table options, ie. selectable, expandable
Source:

TableKeywords

The full list of meta info for this table.

The full list of meta info for this table. It includes the original meta from source, comments, duplicates, and additional meta inserted

Type:
  • object
Properties:
Name Type Description
key string

meta key
value string

meta value
isKeyword boolean

true if this entry is from the original source.
Source:

TableMeta

Table meta information.

Table meta information. Below is only a small set of predefined meta used by table. The meta information in this object are used by many components for many reasons. ie catalog overlay.

Type:
  • object
Properties:
Name Type Description
Loading-Status string

COMPLETED or INPROGRESS
resultSetID string

ID for this table. If sorted or filtered, a new one will be generated.
source string

path of the original table source before any operations were performed. ie sort, filter, etc. this may not be fully supported.
relatedCols string

highlight related rows based on this column's value.
Source:

TableModel

Table model.

Table model. The top level table data object with meta info.

Type:
  • object
Properties:
Name Type Description
tbl_id string

unique ID of this table.
title string

title, used on label.
request TableRequest

the request used to create this table
keywords TableKeywords

a list of all meta from the original source, including comments and duplicates
tableMeta TableMeta

additional meta added and keywords as key/value pair. comments and duplicates are no longer here.
tableData TableData

table's meta information stored as key/value pair.
totalRows number

total number of rows.
highlightedRow number

the current highlighted row index. index is natural order starting from 0.
selectInfo object

selection information. use SelectInfo.newInstance take advantage of helper's functions.
isFetching boolean

true if data is being fetched and not ready for display.
error string

error message if the request fail to create a table.
groups Array.<Group>

groups is any.
links Array.<Link>

links is any.
params Array.<PARAM>

params is any.
Source:

TableRequest

Table request.

Table request. Below is a list of predefined parameters available for table request. All of the options are optional. These parameters let you control what data and how it will be returned.

Type:
  • object
Properties:
Name Type Description
startIdx number

the starting index to fetch. defaults to zero.
pageSize number

the number of rows per page. defaults to 100.
filters string

list of conditions separted by comma(,). Format: (col_name|index) operator value. operator is one of '> < = ! >= <= IN'. See DataGroupQueryStatement.java doc for more details.
sortInfo string

sort information. Format: (ASC|DESC),col_name[,col_name]*
inclCols string

list of columns to select. Column names separted by comma(,)
META_INFO object

meta information passed as key/value pair to server then returned as tableMeta.
use string

one of 'catalog_overlay', 'catalog_primary', 'data_primary'.
tbl_id string

unique id of the table. auto-create if not given.
Source:

TableSpace

Top level store for table related data.

Top level store for table related data. It's mounted as 'table_space' under the application state

Type:
  • object
Properties:
Name Type Description
data Object.<string, TableModel>

repository for table model; keyed by tbl_id
results Object.<string, TableGroup>

repository for table group information; keyed by tbl_group name
ui Object.<string, Object>

repository for table UI state; keyed by tbl_ui_id
Source:

TblOptions

Available options when a table is added.

Available options when a table is added.

Type:
  • object
Properties:
Name Type Argument Default Description
tbl_group string <optional>

the group this table belongs to. Defaults to 'main'.
backgroundable boolean <optional>
 false

true if this search can be sent to background. Defaults to false.
title string <optional>

title of this table.
setAsActive boolean <optional>
 true

make this the active table once it's added to the UI.
pageSize number <optional>

the starting page size. Will use the request's pageSize if not given.
selectable boolean <optional>
 true
expandable boolean <optional>
 true
removable boolean <optional>
 true

true if this table can be removed from view.
border boolean <optional>
 true
showToolbar boolean <optional>
 true

when false, showFilters, showTitle, showPaging, showSave, and showFilterButton will be false as well.
showFilters boolean <optional>
 false
showTitle boolean <optional>
 true
showPaging boolean <optional>
 true

enable/disable paging feature. When false, all data will be displayed.
showSave boolean <optional>
 true
showFilterButton boolean <optional>
 true
showInfoButton boolean <optional>
 false

when true, shows additional information about table, if available
showOptionButton boolean <optional>
 true
showUnits boolean <optional>
 true
allowUnits boolean <optional>
 true

enable/disable the use of units in a table.
leftButtons Array.<function()> <optional>

an array of functions that returns a button-like component laid out on the left side of this table header.
rightButtons Array.<function()> <optional>

an array of functions that returns a button-like component laid out on the right side of this table header.
Source:

TblOptions

Type:
  • object
Properties:
Name Type Description
tbl_group string

the group this table belongs to. Defaults to 'main'.
pageSize number

the starting page size. Will use the request's pageSize if not given.
removable boolean

true if this table can be removed from view. Defaults to true.
backgroundable boolean

true if this search can be sent to background. Defaults to false.
showUnits boolean

defaults to false
showTypes boolean

defaults to false
showFilters boolean

defaults to false
selectable boolean

defaults to true
expandable boolean

defaults to true
showToolbar boolean

defaults to true
showTitle boolean

defaults to true
showPaging boolean

defaults to true
showSave boolean

defaults to true
showOptionButton boolean

defaults to true
showFilterButton boolean

defaults to true
showInfoButton boolean

defaults to false
border boolean

defaults to true
help_id boolean

link to help if applicable
leftButtons Array.<function()>

an array of functions that returns a button-like component laid out on the left side of this table header. Function will be called with table's state.
rightButtons Array.<function()>

an array of functions that returns a button-like component laid out on the left side of this table header. Function will be called with table's state.
Source:

ThumbnailImage

the thumbnail information

Type:
  • Object
Properties:
Name Type Description
width number

width of thumbnail
height number

height of thumbnail
url string

file key to use in the service to retrieve this tile
Source:

Viewer

Type:
  • Object
Properties:
Name Type Description
viewerId:EXPANDED_MODE_RESERVED, string
itemIdAry Array.<string>
layout string

must be 'single' or 'grid'
canReceiveNewPlots boolean

NewPlotMode.create_replace.key,
reservedContainer boolean
containerType string

one of 'image', 'plot2d', 'wrapper'
mounted boolean

if the react component using the store is mounted
layoutDetail Object | String

may be any object, string, etc- Hint for the UI, can be any string but with 2 reserved GRID_RELATED, GRID_FULL
customData: object

{}
Source:

VisRoot

The state of the Image visualization. The state contains an array of PlotView each have a plotId and tie to an Image Viewer, one might be active (PlotView.js) A PlotView has an array of WebPlots, one is primary (WebPlot.js) An ImageViewer shows the primary plot of a plotView. (ImageView.js)

Type:
  • Object
Properties:
Name Type Description
activePlotId String

the id of the active plot
plotViewAry Array.<PlotView>

view array
plotGroupAry Array.<PlotGroup>

view array
plotRequestDefaults object

can have multiple values
expandedMode ExpandType

status of expand mode
previousExpandedMode ExpandType

the value last time it was expanded
singleAutoPlay boolean

true if auto play on in expanded mode
apiToolsView boolean

true if working in api mode
positionLock boolean

plots are locked together for scrolling and rotation.
Source:

WaveLengthData

Type:
  • Object
Properties:
Name Type Description
algorithm string
wlType string
N Number
r_j Array.<number>
pc_3j Array.<number>
s_3 Number
lambda_r Number
restWAV number
crpix number
cdelt number
crval number
Source:

WebPlot

This class contains plot information. Publicly this class operations in many coordinate system. Some include a Image coordinate system, a world coordinate system, and a screen coordinate system.

Type:
  • Object
Properties:
Name Type Description
plotId String

plot id, id of the plotView, immutable
plotImageId, String

plot image id, id of this WebPlot , immutable
serverImage, Object

immutable
title String

the title
cubeCtx Object
plotState PlotState

the plot state, immutable
dataWidth number

the width of the image data
dataHeight number

the height of the image data
zoomFactor number

the zoom factor
title string

title of the plot
webFitsData object

needs documentation
tileData ImageTileData

object contains the image tile information
imageCoordSys CoordinateSys

the image coordinate system
screenSize Dimension

width/height in screen pixels
projection Projection

projection routines for this projections
wlData Object

data object to wave length conversions, if defined then this conversion is available
affTrans Object

the affine transform
viewDim Object

size of viewable area (div size: offsetWidth & offsetHeight)
directFileAccessDataAry Array.<Object>

object of parameters to get flux from the FITS file
Source:
See:

WebPlotParams

object for web plot request

Below is a list of predefined parameters available for web plot request. Some parameters control how to get an image, a image can be retrieved from a service, a url, of a file on the server. Others control the zoom, stretch, and color, title, and default overlays. There are also parameters to pre-process an image, such as crop, rotate or flip.

Type:
  • object
Properties:
Name Type Description
Type string

the request type, see available types at RequestType.
File string

file name of a file on the server if Type=='File'
URL string

url reference to a fits file if Type=='URL'
Service string

the service type if Type=='SERVICE', see available services at ServiceType
plotId string

plot ID
plotGroupId string

plot group ID
ObjectName String

object name that can be looked up by NED or Simbad
Resolver string

the object name resolver to use, options are: NED, Simbad, NedThenSimbad, SimbadThenNed, PTF.
SizeInDeg string

the radius or side (in degrees) depending of the service type, used with Type=='SERVICE' or 'HiPS'
SurveyKey string

the survey, used with Type='SERVICE'
SurveyKeyBand string

the survey band, used with Type=='SERVICE' and Service='WISE', 'TWOMASS' or 'ATLAS'
WorldPt string

target for service request or HiPS request in serialized version
PlotId string

plot Id
PlotGroupId string

plot group id
Title string

plot title
TitleOptions string

title options, see available options at TitleOptions
PreTitle string

a String to append at the beginning of the title of the plot
PostTitle string

a String to append at the end of the title of the plot
hipsRootUrl string

HiPS root url or IVOID, e.g.: ivo://CDS/P/2MASS/J, used with Type='HiPS'
ZoomType string

zoom type, see ZoomType
ZoomToWidth string

the width of the viewable area to determine the zoom level, used with ZoomType.TO_WIDTH_HEIGHT, ZoomType.TO_WIDTH
ZoomToHeight string

the height of the viewable area to determine the zoom level, used with ZoomType.TO_WIDTH_HEIGHT, ZoomType.TO_HEIGHT
InitZoomLevel string

initialize zoom level, used with ZoomType.LEVEL
ZoomArcsecPerScreenPix string

the arcseconds per screen pixel that will be used to determine the zoom level, Used with ZoomType.ARCSEC_PER_SCREEN_PIX
RotateNorth boolean

plot should come up rotated north
RotateNorthType CoordinateSys

set to coordinate system for rotate north, eq EQ_J2000 is the default
Rotate boolean

set to rotate, if true, the angle should also be set
RotationAngle string

set the angle to rotate to
RotateFromNorth string

rotate angle from north
FlipY boolean

set if this image should be flipped on the Y axis
FlipX boolean

set if this image should be flipped on the X axis
PostCrop boolean

crop the image before returning it. If rotation is set then the crop will happen post rotation
PostCropAndCenter boolean

crop and center the image before returning it. Note: SizeInDeg and WorldPt are required
PostCropAndCenterType CoordinateSys

set to coordinate system for crop and center, eq EQ_J2000 is the default
CropPt1 string

one corner of the rectangle, in image coordinates, to crop out of the image.
CropPt2 string

second corner of the rectangle, in image coordinates, to crop out of the image.
CropWorldPt1 string

one corner of the rectangle, in world coordinates, to crop out of the image.
CropWorldPt2 string

second corner of the rectangle, in world coordinates, to crop out of the image.
OverlayPosition string

string of overlay position in world coordinates
ColorTable string

color table id, value 0 - 21 to represent different predefined color tables
RangeValues string

a complex string for specify the stretch of this plot. Use the method firefly.serializeRangeValues() to produce this string
MultiImageIdx string

number index of image
MultiImageExts string

image extension list. ex: '3,4,5' for extension 3, 4, 5
GridOn string

turn the coordinate grid on after the image is plotted, 'true' or 'false'
thumbnailSize number

thumbnail size
ContinueOnFail boolean

for 3 color, if this request fails then keep trying to make a plot with the other request
Source:

WorldPt

a point on the sky

Type:
  • Object
Properties:
Name Type Description
x Number
y Number
type String

constant must be 'WorldPt'
cSys CoordinateSys

the coordinate system constant
objName String

the object name the was used for name resolution, may not be defined
objName Resolver

the resolver used to create this worldPt, may not be defined
Source:

XYPlotOptions

shallow object with XYPlot parameters

.

shallow object with XYPlot parameters

Type:
  • Object
Properties:
Name Type Argument Description
source string <optional>

location of the ipac table, url or file path; ignored when XY plot view is added to table
tbl_id string <optional>

table id of the table this plot is connected to
chartTitle string <optional>

title of the chart
xCol string

column or expression to use for x values, can contain multiple column names ex. log(col) or (col1-col2)/col3
yCol string

column or expression to use for y values, can contain multiple column names ex. sin(col) or (col1-col2)/col3
plotStyle string <optional>

points, linepoints, line
xLabel string <optional>

label to use with x axis
yLabel string <optional>

label to use with y axis
xOptions string <optional>

comma separated list of x axis options: grid,flip,log
yOptions string <optional>

comma separated list of y axis options: grid,flip,log
xError string <optional>

column or expression for X error
yError string <optional>

column or expression for Y error
Source:

ZeroBasedImagePt

a point in Zero based image file coordinates, ca be offset by LTV1 and LTV2

Type:
  • Object
Properties:
Name Type Description
x Number
y Number
type String

constant must be 'ImagePt'
Source: