Class VoTableLayer

A VoTable rendered as a layer.

This class is highly similar to SpreadSheetLayer, and the latter class is generally more featureful. It should be preferred when possible.

Hierarchy

Layer
- VoTableLayer

Implements

VoTableLayerSettingsInterface

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new VoTableLayer(): VoTableLayer

Inherited from Layer.constructor

Returns VoTableLayer

Properties

astronomical

astronomical: boolean

color

color: Color

enabled

enabled: boolean

id

id: Guid

loadedFromTour

loadedFromTour: boolean

opacity

opacity: number

The layer opacity, between 0 and 1.

opened

opened: boolean

tourDocument

tourDocument: null | TourDocument

version

version: number

Methods

getFileStreamUrl

getFileStreamUrl(filename: string): null | string

Inherited from Layer.getFileStreamUrl
- Defined in engine/src/index.d.ts:1027
Parameters
- filename: string
Returns null | string

get_altColumn

get_altColumn(): number

Implementation of VoTableLayerSettingsInterface.get_altColumn
- Defined in engine/src/index.d.ts:2224
Returns number

get_altType

get_altType(): AltTypes

Implementation of VoTableLayerSettingsInterface.get_altType
- Defined in engine/src/index.d.ts:2226
Returns AltTypes

get_altUnit

get_altUnit(): AltUnits

Implementation of VoTableLayerSettingsInterface.get_altUnit
- Defined in engine/src/index.d.ts:2228
Returns AltUnits

get_astronomical

get_astronomical(): boolean

Implementation of VoTableLayerSettingsInterface.get_astronomical

Inherited from Layer.get_astronomical
- Defined in engine/src/index.d.ts:1029
Returns boolean

get_autoUpdate

get_autoUpdate(): boolean

Implementation of VoTableLayerSettingsInterface.get_autoUpdate
- Defined in engine/src/index.d.ts:2230
Returns boolean

get_beginRange

get_beginRange(): Date

Implementation of VoTableLayerSettingsInterface.get_beginRange
- Defined in engine/src/index.d.ts:2232
Returns Date

get_cartesianCustomScale

get_cartesianCustomScale(): number

Implementation of VoTableLayerSettingsInterface.get_cartesianCustomScale
- Defined in engine/src/index.d.ts:2234
Returns number

get_cartesianScale

get_cartesianScale(): AltUnits

Implementation of VoTableLayerSettingsInterface.get_cartesianScale
- Defined in engine/src/index.d.ts:2236
Returns AltUnits

get_color

get_color(): Color

Implementation of VoTableLayerSettingsInterface.get_color

Inherited from Layer.get_color
- Defined in engine/src/index.d.ts:1031
Returns Color

get_colorMapColumn

get_colorMapColumn(): number

Implementation of VoTableLayerSettingsInterface.get_colorMapColumn
- Defined in engine/src/index.d.ts:2239
Returns number

get_coordinatesType

get_coordinatesType(): CoordinatesType

Implementation of VoTableLayerSettingsInterface.get_coordinatesType
- Defined in engine/src/index.d.ts:2241
Returns CoordinatesType

get_dataSourceUrl

get_dataSourceUrl(): string

Implementation of VoTableLayerSettingsInterface.get_dataSourceUrl
- Defined in engine/src/index.d.ts:2243
Returns string

get_decay

get_decay(): number

Implementation of VoTableLayerSettingsInterface.get_decay
- Defined in engine/src/index.d.ts:2245
Returns number

get_dynamicData

get_dynamicData(): boolean

Implementation of VoTableLayerSettingsInterface.get_dynamicData
- Defined in engine/src/index.d.ts:2247
Returns boolean

get_enabled

get_enabled(): boolean

Implementation of VoTableLayerSettingsInterface.get_enabled

Inherited from Layer.get_enabled
- Defined in engine/src/index.d.ts:1033
Returns boolean

get_endDateColumn

get_endDateColumn(): number

Implementation of VoTableLayerSettingsInterface.get_endDateColumn
- Defined in engine/src/index.d.ts:2249
Returns number

get_endRange

get_endRange(): Date

Implementation of VoTableLayerSettingsInterface.get_endRange
- Defined in engine/src/index.d.ts:2251
Returns Date

get_endTime

get_endTime(): Date

Implementation of VoTableLayerSettingsInterface.get_endTime

Inherited from Layer.get_endTime
- Defined in engine/src/index.d.ts:1035
Returns Date

get_fadeSpan

get_fadeSpan(): number

Implementation of VoTableLayerSettingsInterface.get_fadeSpan

Inherited from Layer.get_fadeSpan
- Defined in engine/src/index.d.ts:1037
Returns number

get_fadeType

get_fadeType(): FadeType

Implementation of VoTableLayerSettingsInterface.get_fadeType

Inherited from Layer.get_fadeType
- Defined in engine/src/index.d.ts:1039
Returns FadeType

get_header

get_header(): string[]

- Defined in engine/src/index.d.ts:2301
Returns string[]

get_hyperlinkColumn

get_hyperlinkColumn(): number

Implementation of VoTableLayerSettingsInterface.get_hyperlinkColumn
- Defined in engine/src/index.d.ts:2253
Returns number

get_hyperlinkFormat

get_hyperlinkFormat(): string

Implementation of VoTableLayerSettingsInterface.get_hyperlinkFormat
- Defined in engine/src/index.d.ts:2255
Returns string

get_latColumn

get_latColumn(): number

Implementation of VoTableLayerSettingsInterface.get_latColumn
- Defined in engine/src/index.d.ts:2257
Returns number

get_lngColumn

get_lngColumn(): number

Implementation of VoTableLayerSettingsInterface.get_lngColumn
- Defined in engine/src/index.d.ts:2259
Returns number

get_markerColumn

get_markerColumn(): number

Implementation of VoTableLayerSettingsInterface.get_markerColumn
- Defined in engine/src/index.d.ts:2261
Returns number

get_markerIndex

get_markerIndex(): number

Implementation of VoTableLayerSettingsInterface.get_markerIndex
- Defined in engine/src/index.d.ts:2263
Returns number

get_markerScale

get_markerScale(): MarkerScales

Implementation of VoTableLayerSettingsInterface.get_markerScale
- Defined in engine/src/index.d.ts:2266
Returns MarkerScales

get_name

get_name(): string

Implementation of VoTableLayerSettingsInterface.get_name

Inherited from Layer.get_name
- Defined in engine/src/index.d.ts:1041
Returns string

get_nameColumn

get_nameColumn(): number

Implementation of VoTableLayerSettingsInterface.get_nameColumn
- Defined in engine/src/index.d.ts:2268
Returns number

get_opacity

get_opacity(): number

Implementation of VoTableLayerSettingsInterface.get_opacity

Inherited from Layer.get_opacity
- Defined in engine/src/index.d.ts:1043
Returns number

get_opened

get_opened(): boolean

Implementation of VoTableLayerSettingsInterface.get_opened

Inherited from Layer.get_opened
- Defined in engine/src/index.d.ts:1045
Returns boolean

get_plotType

get_plotType(): PlotTypes

Implementation of VoTableLayerSettingsInterface.get_plotType
- Defined in engine/src/index.d.ts:2270
Returns PlotTypes

get_pointScaleType

get_pointScaleType(): PointScaleTypes

Implementation of VoTableLayerSettingsInterface.get_pointScaleType
- Defined in engine/src/index.d.ts:2272
Returns PointScaleTypes

get_raUnits

get_raUnits(): RAUnits

Implementation of VoTableLayerSettingsInterface.get_raUnits
- Defined in engine/src/index.d.ts:2274
Returns RAUnits

get_referenceFrame

get_referenceFrame(): string

Implementation of VoTableLayerSettingsInterface.get_referenceFrame

Inherited from Layer.get_referenceFrame
- Defined in engine/src/index.d.ts:1047
Returns string

get_scaleFactor

get_scaleFactor(): number

Implementation of VoTableLayerSettingsInterface.get_scaleFactor
- Defined in engine/src/index.d.ts:2276
Returns number

get_showFarSide

get_showFarSide(): boolean

Implementation of VoTableLayerSettingsInterface.get_showFarSide
- Defined in engine/src/index.d.ts:2278
Returns boolean

get_sizeColumn

get_sizeColumn(): number

Implementation of VoTableLayerSettingsInterface.get_sizeColumn
- Defined in engine/src/index.d.ts:2280
Returns number

get_startDateColumn

get_startDateColumn(): number

Implementation of VoTableLayerSettingsInterface.get_startDateColumn
- Defined in engine/src/index.d.ts:2282
Returns number

get_startTime

get_startTime(): Date

Implementation of VoTableLayerSettingsInterface.get_startTime

Inherited from Layer.get_startTime
- Defined in engine/src/index.d.ts:1049
Returns Date

get_table

get_table(): VoTable

- Defined in engine/src/index.d.ts:2284
Returns VoTable

get_timeSeries

get_timeSeries(): boolean

Implementation of VoTableLayerSettingsInterface.get_timeSeries
- Defined in engine/src/index.d.ts:2286
Returns boolean

get_version

get_version(): number

Implementation of VoTableLayerSettingsInterface.get_version

Inherited from Layer.get_version
- Defined in engine/src/index.d.ts:1051
Returns number

get_xAxisColumn

get_xAxisColumn(): number

Implementation of VoTableLayerSettingsInterface.get_xAxisColumn
- Defined in engine/src/index.d.ts:2288
Returns number

get_xAxisReverse

get_xAxisReverse(): boolean

Implementation of VoTableLayerSettingsInterface.get_xAxisReverse
- Defined in engine/src/index.d.ts:2290
Returns boolean

get_yAxisColumn

get_yAxisColumn(): number

Implementation of VoTableLayerSettingsInterface.get_yAxisColumn
- Defined in engine/src/index.d.ts:2292
Returns number

get_yAxisReverse

get_yAxisReverse(): boolean

Implementation of VoTableLayerSettingsInterface.get_yAxisReverse
- Defined in engine/src/index.d.ts:2294
Returns boolean

get_zAxisColumn

get_zAxisColumn(): number

Implementation of VoTableLayerSettingsInterface.get_zAxisColumn
- Defined in engine/src/index.d.ts:2296
Returns number

get_zAxisReverse

get_zAxisReverse(): boolean

Implementation of VoTableLayerSettingsInterface.get_zAxisReverse
- Defined in engine/src/index.d.ts:2298
Returns boolean

set_altColumn

set_altColumn(v: number): number

Implementation of VoTableLayerSettingsInterface.set_altColumn
- Defined in engine/src/index.d.ts:2225
Parameters
- v: number
Returns number

set_altType

set_altType(v: AltTypes): AltTypes

Implementation of VoTableLayerSettingsInterface.set_altType
- Defined in engine/src/index.d.ts:2227
Parameters
- v: AltTypes
Returns AltTypes

set_altUnit

set_altUnit(v: AltUnits): AltUnits

Implementation of VoTableLayerSettingsInterface.set_altUnit
- Defined in engine/src/index.d.ts:2229
Parameters
- v: AltUnits
Returns AltUnits

set_astronomical

set_astronomical(v: boolean): boolean

Implementation of VoTableLayerSettingsInterface.set_astronomical

Inherited from Layer.set_astronomical
- Defined in engine/src/index.d.ts:1030
Parameters
- v: boolean
Returns boolean

set_autoUpdate

set_autoUpdate(v: boolean): boolean

Implementation of VoTableLayerSettingsInterface.set_autoUpdate
- Defined in engine/src/index.d.ts:2231
Parameters
- v: boolean
Returns boolean

set_beginRange

set_beginRange(v: Date): Date

Implementation of VoTableLayerSettingsInterface.set_beginRange
- Defined in engine/src/index.d.ts:2233
Parameters
- v: Date
Returns Date

set_cartesianCustomScale

set_cartesianCustomScale(v: number): number

Implementation of VoTableLayerSettingsInterface.set_cartesianCustomScale
- Defined in engine/src/index.d.ts:2235
Parameters
- v: number
Returns number

set_cartesianScale

set_cartesianScale(v: AltUnits): AltUnits

Implementation of VoTableLayerSettingsInterface.set_cartesianScale
- Defined in engine/src/index.d.ts:2237
Parameters
- v: AltUnits
Returns AltUnits

set_color

set_color(v: Color): Color

Implementation of VoTableLayerSettingsInterface.set_color

Inherited from Layer.set_color
- Defined in engine/src/index.d.ts:1032
Parameters
- v: Color
Returns Color

set_colorMapColumn

set_colorMapColumn(v: number): number

Implementation of VoTableLayerSettingsInterface.set_colorMapColumn
- Defined in engine/src/index.d.ts:2240
Parameters
- v: number
Returns number

set_coordinatesType

set_coordinatesType(v: CoordinatesType): CoordinatesType

Implementation of VoTableLayerSettingsInterface.set_coordinatesType
- Defined in engine/src/index.d.ts:2242
Parameters
- v: CoordinatesType
Returns CoordinatesType

set_dataSourceUrl

set_dataSourceUrl(v: string): string

Implementation of VoTableLayerSettingsInterface.set_dataSourceUrl
- Defined in engine/src/index.d.ts:2244
Parameters
- v: string
Returns string

set_decay

set_decay(v: number): number

Implementation of VoTableLayerSettingsInterface.set_decay
- Defined in engine/src/index.d.ts:2246
Parameters
- v: number
Returns number

set_dynamicData

set_dynamicData(v: boolean): boolean

Implementation of VoTableLayerSettingsInterface.set_dynamicData
- Defined in engine/src/index.d.ts:2248
Parameters
- v: boolean
Returns boolean

set_enabled

set_enabled(v: boolean): boolean

Implementation of VoTableLayerSettingsInterface.set_enabled

Inherited from Layer.set_enabled
- Defined in engine/src/index.d.ts:1034
Parameters
- v: boolean
Returns boolean

set_endDateColumn

set_endDateColumn(v: number): number

Implementation of VoTableLayerSettingsInterface.set_endDateColumn
- Defined in engine/src/index.d.ts:2250
Parameters
- v: number
Returns number

set_endRange

set_endRange(v: Date): Date

Implementation of VoTableLayerSettingsInterface.set_endRange
- Defined in engine/src/index.d.ts:2252
Parameters
- v: Date
Returns Date

set_endTime

set_endTime(v: Date): Date

Implementation of VoTableLayerSettingsInterface.set_endTime

Inherited from Layer.set_endTime
- Defined in engine/src/index.d.ts:1036
Parameters
- v: Date
Returns Date

set_fadeSpan

set_fadeSpan(v: number): number

Implementation of VoTableLayerSettingsInterface.set_fadeSpan

Inherited from Layer.set_fadeSpan
- Defined in engine/src/index.d.ts:1038
Parameters
- v: number
Returns number

set_fadeType

set_fadeType(v: FadeType): FadeType

Implementation of VoTableLayerSettingsInterface.set_fadeType

Inherited from Layer.set_fadeType
- Defined in engine/src/index.d.ts:1040
Parameters
- v: FadeType
Returns FadeType

set_hyperlinkColumn

set_hyperlinkColumn(v: number): number

Implementation of VoTableLayerSettingsInterface.set_hyperlinkColumn
- Defined in engine/src/index.d.ts:2254
Parameters
- v: number
Returns number

set_hyperlinkFormat

set_hyperlinkFormat(v: string): string

Implementation of VoTableLayerSettingsInterface.set_hyperlinkFormat
- Defined in engine/src/index.d.ts:2256
Parameters
- v: string
Returns string

set_latColumn

set_latColumn(v: number): number

Implementation of VoTableLayerSettingsInterface.set_latColumn
- Defined in engine/src/index.d.ts:2258
Parameters
- v: number
Returns number

set_lngColumn

set_lngColumn(v: number): number

Implementation of VoTableLayerSettingsInterface.set_lngColumn
- Defined in engine/src/index.d.ts:2260
Parameters
- v: number
Returns number

set_markerColumn

set_markerColumn(v: number): number

Implementation of VoTableLayerSettingsInterface.set_markerColumn
- Defined in engine/src/index.d.ts:2262
Parameters
- v: number
Returns number

set_markerIndex

set_markerIndex(v: number): number

Implementation of VoTableLayerSettingsInterface.set_markerIndex
- Defined in engine/src/index.d.ts:2264
Parameters
- v: number
Returns number

set_markerScale

set_markerScale(v: MarkerScales): MarkerScales

Implementation of VoTableLayerSettingsInterface.set_markerScale
- Defined in engine/src/index.d.ts:2267
Parameters
- v: MarkerScales
Returns MarkerScales

set_name

set_name(v: string): string

Implementation of VoTableLayerSettingsInterface.set_name

Inherited from Layer.set_name
- Defined in engine/src/index.d.ts:1042
Parameters
- v: string
Returns string

set_nameColumn

set_nameColumn(v: number): number

Implementation of VoTableLayerSettingsInterface.set_nameColumn
- Defined in engine/src/index.d.ts:2269
Parameters
- v: number
Returns number

set_opacity

set_opacity(v: number): number

Implementation of VoTableLayerSettingsInterface.set_opacity

Inherited from Layer.set_opacity
- Defined in engine/src/index.d.ts:1044
Parameters
- v: number
Returns number

set_opened

set_opened(v: boolean): boolean

Implementation of VoTableLayerSettingsInterface.set_opened

Inherited from Layer.set_opened
- Defined in engine/src/index.d.ts:1046
Parameters
- v: boolean
Returns boolean

set_plotType

set_plotType(v: PlotTypes): PlotTypes

Implementation of VoTableLayerSettingsInterface.set_plotType
- Defined in engine/src/index.d.ts:2271
Parameters
- v: PlotTypes
Returns PlotTypes

set_pointScaleType

set_pointScaleType(v: PointScaleTypes): PointScaleTypes

Implementation of VoTableLayerSettingsInterface.set_pointScaleType
- Defined in engine/src/index.d.ts:2273
Parameters
- v: PointScaleTypes
Returns PointScaleTypes

set_raUnits

set_raUnits(v: RAUnits): RAUnits

Implementation of VoTableLayerSettingsInterface.set_raUnits
- Defined in engine/src/index.d.ts:2275
Parameters
- v: RAUnits
Returns RAUnits

set_referenceFrame

set_referenceFrame(v: string): string

Implementation of VoTableLayerSettingsInterface.set_referenceFrame

Inherited from Layer.set_referenceFrame
- Defined in engine/src/index.d.ts:1048
Parameters
- v: string
Returns string

set_scaleFactor

set_scaleFactor(v: number): number

Implementation of VoTableLayerSettingsInterface.set_scaleFactor
- Defined in engine/src/index.d.ts:2277
Parameters
- v: number
Returns number

set_showFarSide

set_showFarSide(v: boolean): boolean

Implementation of VoTableLayerSettingsInterface.set_showFarSide
- Defined in engine/src/index.d.ts:2279
Parameters
- v: boolean
Returns boolean

set_sizeColumn

set_sizeColumn(v: number): number

Implementation of VoTableLayerSettingsInterface.set_sizeColumn
- Defined in engine/src/index.d.ts:2281
Parameters
- v: number
Returns number

set_startDateColumn

set_startDateColumn(v: number): number

Implementation of VoTableLayerSettingsInterface.set_startDateColumn
- Defined in engine/src/index.d.ts:2283
Parameters
- v: number
Returns number

set_startTime

set_startTime(v: Date): Date

Implementation of VoTableLayerSettingsInterface.set_startTime

Inherited from Layer.set_startTime
- Defined in engine/src/index.d.ts:1050
Parameters
- v: Date
Returns Date

set_table

set_table(v: VoTable): VoTable

- Defined in engine/src/index.d.ts:2285
Parameters
- v: VoTable
Returns VoTable

set_timeSeries

set_timeSeries(v: boolean): boolean

Implementation of VoTableLayerSettingsInterface.set_timeSeries
- Defined in engine/src/index.d.ts:2287
Parameters
- v: boolean
Returns boolean

set_version

set_version(v: number): number

Implementation of VoTableLayerSettingsInterface.set_version

Inherited from Layer.set_version
- Defined in engine/src/index.d.ts:1052
Parameters
- v: number
Returns number

set_xAxisColumn

set_xAxisColumn(v: number): number

Implementation of VoTableLayerSettingsInterface.set_xAxisColumn
- Defined in engine/src/index.d.ts:2289
Parameters
- v: number
Returns number

set_xAxisReverse

set_xAxisReverse(v: boolean): boolean

Implementation of VoTableLayerSettingsInterface.set_xAxisReverse
- Defined in engine/src/index.d.ts:2291
Parameters
- v: boolean
Returns boolean

set_yAxisColumn

set_yAxisColumn(v: number): number

Implementation of VoTableLayerSettingsInterface.set_yAxisColumn
- Defined in engine/src/index.d.ts:2293
Parameters
- v: number
Returns number

set_yAxisReverse

set_yAxisReverse(v: boolean): boolean

Implementation of VoTableLayerSettingsInterface.set_yAxisReverse
- Defined in engine/src/index.d.ts:2295
Parameters
- v: boolean
Returns boolean

set_zAxisColumn

set_zAxisColumn(v: number): number

Implementation of VoTableLayerSettingsInterface.set_zAxisColumn
- Defined in engine/src/index.d.ts:2297
Parameters
- v: number
Returns number

set_zAxisReverse

set_zAxisReverse(v: boolean): boolean

Implementation of VoTableLayerSettingsInterface.set_zAxisReverse
- Defined in engine/src/index.d.ts:2299
Parameters
- v: boolean
Returns boolean

Generated using TypeDoc