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

new VoTableLayer(): VoTableLayer
Returns VoTableLayer

Inherited from Layer.constructor

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): null | string
Parameters
- filename: string
Returns null | string
Inherited from Layer.getFileStreamUrl
- Defined in engine/src/index.d.ts:1033

get_altColumn

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

get_altType

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

get_altUnit

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

get_astronomical

get_astronomical(): boolean
Returns boolean
Implementation of VoTableLayerSettingsInterface.get_astronomical

Inherited from Layer.get_astronomical
- Defined in engine/src/index.d.ts:1035

get_autoUpdate

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

get_beginRange

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

get_cartesianCustomScale

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

get_cartesianScale

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

get_color

get_color(): Color
Returns Color
Implementation of VoTableLayerSettingsInterface.get_color

Inherited from Layer.get_color
- Defined in engine/src/index.d.ts:1037

get_colorMapColumn

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

get_coordinatesType

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

get_dataSourceUrl

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

get_decay

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

get_dynamicData

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

get_enabled

get_enabled(): boolean
Returns boolean
Implementation of VoTableLayerSettingsInterface.get_enabled

Inherited from Layer.get_enabled
- Defined in engine/src/index.d.ts:1039

get_endDateColumn

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

get_endRange

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

get_endTime

get_endTime(): Date
Returns Date
Implementation of VoTableLayerSettingsInterface.get_endTime

Inherited from Layer.get_endTime
- Defined in engine/src/index.d.ts:1041

get_fadeSpan

get_fadeSpan(): number
Returns number
Implementation of VoTableLayerSettingsInterface.get_fadeSpan

Inherited from Layer.get_fadeSpan
- Defined in engine/src/index.d.ts:1043

get_fadeType

get_fadeType(): FadeType
Returns FadeType
Implementation of VoTableLayerSettingsInterface.get_fadeType

Inherited from Layer.get_fadeType
- Defined in engine/src/index.d.ts:1045

get_header

get_header(): string[]
Returns string[]
- Defined in engine/src/index.d.ts:2359

get_hyperlinkColumn

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

get_hyperlinkFormat

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

get_latColumn

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

get_lngColumn

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

get_markerColumn

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

get_markerIndex

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

get_markerScale

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

get_name

get_name(): string
Returns string
Implementation of VoTableLayerSettingsInterface.get_name

Inherited from Layer.get_name
- Defined in engine/src/index.d.ts:1047

get_nameColumn

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

get_opacity

get_opacity(): number
Returns number
Implementation of VoTableLayerSettingsInterface.get_opacity

Inherited from Layer.get_opacity
- Defined in engine/src/index.d.ts:1049

get_opened

get_opened(): boolean
Returns boolean
Implementation of VoTableLayerSettingsInterface.get_opened

Inherited from Layer.get_opened
- Defined in engine/src/index.d.ts:1051

get_plotType

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

get_pointScaleType

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

get_raUnits

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

get_referenceFrame

get_referenceFrame(): string
Returns string
Implementation of VoTableLayerSettingsInterface.get_referenceFrame

Inherited from Layer.get_referenceFrame
- Defined in engine/src/index.d.ts:1053

get_scaleFactor

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

get_showFarSide

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

get_sizeColumn

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

get_startDateColumn

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

get_startTime

get_startTime(): Date
Returns Date
Implementation of VoTableLayerSettingsInterface.get_startTime

Inherited from Layer.get_startTime
- Defined in engine/src/index.d.ts:1055

get_table

get_table(): VoTable
Returns VoTable
- Defined in engine/src/index.d.ts:2342

get_timeSeries

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

get_version

get_version(): number
Returns number
Implementation of VoTableLayerSettingsInterface.get_version

Inherited from Layer.get_version
- Defined in engine/src/index.d.ts:1057

get_xAxisColumn

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

get_xAxisReverse

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

get_yAxisColumn

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

get_yAxisReverse

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

get_zAxisColumn

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

get_zAxisReverse

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

set_altColumn

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

set_altType

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

set_altUnit

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

set_astronomical

set_astronomical(v): boolean
Parameters
- v: boolean
Returns boolean
Implementation of VoTableLayerSettingsInterface.set_astronomical

Inherited from Layer.set_astronomical
- Defined in engine/src/index.d.ts:1036

set_autoUpdate

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

set_beginRange

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

set_cartesianCustomScale

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

set_cartesianScale

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

set_color

set_color(v): Color
Parameters
- v: Color
Returns Color
Implementation of VoTableLayerSettingsInterface.set_color

Inherited from Layer.set_color
- Defined in engine/src/index.d.ts:1038

set_colorMapColumn

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

set_coordinatesType

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

set_dataSourceUrl

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

set_decay

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

set_dynamicData

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

set_enabled

set_enabled(v): boolean
Parameters
- v: boolean
Returns boolean
Implementation of VoTableLayerSettingsInterface.set_enabled

Inherited from Layer.set_enabled
- Defined in engine/src/index.d.ts:1040

set_endDateColumn

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

set_endRange

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

set_endTime

set_endTime(v): Date
Parameters
- v: Date
Returns Date
Implementation of VoTableLayerSettingsInterface.set_endTime

Inherited from Layer.set_endTime
- Defined in engine/src/index.d.ts:1042

set_fadeSpan

set_fadeSpan(v): number
Parameters
- v: number
Returns number
Implementation of VoTableLayerSettingsInterface.set_fadeSpan

Inherited from Layer.set_fadeSpan
- Defined in engine/src/index.d.ts:1044

set_fadeType

set_fadeType(v): FadeType
Parameters
- v: FadeType
Returns FadeType
Implementation of VoTableLayerSettingsInterface.set_fadeType

Inherited from Layer.set_fadeType
- Defined in engine/src/index.d.ts:1046

set_hyperlinkColumn

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

set_hyperlinkFormat

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

set_latColumn

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

set_lngColumn

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

set_markerColumn

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

set_markerIndex

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

set_markerScale

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

set_name

set_name(v): string
Parameters
- v: string
Returns string
Implementation of VoTableLayerSettingsInterface.set_name

Inherited from Layer.set_name
- Defined in engine/src/index.d.ts:1048

set_nameColumn

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

set_opacity

set_opacity(v): number
Parameters
- v: number
Returns number
Implementation of VoTableLayerSettingsInterface.set_opacity

Inherited from Layer.set_opacity
- Defined in engine/src/index.d.ts:1050

set_opened

set_opened(v): boolean
Parameters
- v: boolean
Returns boolean
Implementation of VoTableLayerSettingsInterface.set_opened

Inherited from Layer.set_opened
- Defined in engine/src/index.d.ts:1052

set_plotType

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

set_pointScaleType

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

set_raUnits

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

set_referenceFrame

set_referenceFrame(v): string
Parameters
- v: string
Returns string
Implementation of VoTableLayerSettingsInterface.set_referenceFrame

Inherited from Layer.set_referenceFrame
- Defined in engine/src/index.d.ts:1054

set_scaleFactor

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

set_showFarSide

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

set_sizeColumn

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

set_startDateColumn

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

set_startTime

set_startTime(v): Date
Parameters
- v: Date
Returns Date
Implementation of VoTableLayerSettingsInterface.set_startTime

Inherited from Layer.set_startTime
- Defined in engine/src/index.d.ts:1056

set_table

set_table(v): VoTable
Parameters
- v: VoTable
Returns VoTable
- Defined in engine/src/index.d.ts:2343

set_timeSeries

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

set_version

set_version(v): number
Parameters
- v: number
Returns number
Implementation of VoTableLayerSettingsInterface.set_version

Inherited from Layer.set_version
- Defined in engine/src/index.d.ts:1058

set_xAxisColumn

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

set_xAxisReverse

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

set_yAxisColumn

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

set_yAxisReverse

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

set_zAxisColumn

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

set_zAxisReverse

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

Class VoTableLayer

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns VoTableLayer

Properties

astronomical

color

enabled

id

loadedFromTour

opacity

opened

tourDocument

version

Methods

getFileStreamUrl

Parameters

filename: string

Returns null | string

get_altColumn

Returns number

get_altType

Returns AltTypes

get_altUnit

Returns AltUnits

get_astronomical

Returns boolean

get_autoUpdate

Returns boolean

get_beginRange

Returns Date

get_cartesianCustomScale

Returns number

get_cartesianScale

Returns AltUnits

get_color

Returns Color

get_colorMapColumn

Returns number

get_coordinatesType

Returns CoordinatesType

get_dataSourceUrl

Returns string

get_decay

Returns number

get_dynamicData

Returns boolean

get_enabled

Returns boolean

get_endDateColumn

Returns number

get_endRange

Returns Date

get_endTime

Returns Date

get_fadeSpan

Returns number

get_fadeType

Returns FadeType

get_header

Returns string[]

get_hyperlinkColumn

Returns number

get_hyperlinkFormat

Returns string

get_latColumn

Returns number

get_lngColumn

Returns number

get_markerColumn

Returns number

get_markerIndex

Returns number

get_markerScale