Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SpreadSheetLayer

A tabular data layer.

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

astronomical

astronomical: boolean

color

color: Color

colorMapperName

colorMapperName: string

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

getTableDataInView

  • getTableDataInView(): string

  • Return the data in this table that are within the current camera view, as tab-separated values with Windows (\r\n) newlines. All columns defined in the table header are returned.

    This function is useful for HiPS catalog layers, which will responsively update their contents as the camera moves around. You can use this function to enable workflows where the user interactively zooms in on an area of interest, then wishes to "export" the selected data for further analysis.

    Returns string

    The data, as tab-separated values with Windows (\r\n) newlines.

get_altColumn

  • get_altColumn(): number

get_altType

  • get_altType(): AltTypes

get_altUnit

  • get_altUnit(): AltUnits

get_astronomical

  • get_astronomical(): boolean

get_barChartBitmask

  • get_barChartBitmask(): number

get_beginRange

  • get_beginRange(): Date

get_cartesianCustomScale

  • get_cartesianCustomScale(): number

get_cartesianScale

  • get_cartesianScale(): AltUnits

get_color

get_colorMapColumn

  • get_colorMapColumn(): number

get_colorMapper

get_colorMapperName

  • get_colorMapperName(): string

get_coordinatesType

  • get_coordinatesType(): CoordinatesType

get_decay

  • get_decay(): number

get_dynamicColor

  • get_dynamicColor(): boolean

get_dynamicData

  • get_dynamicData(): boolean

get_enabled

  • get_enabled(): boolean

get_endDateColumn

  • get_endDateColumn(): number

get_endRange

  • get_endRange(): Date

get_endTime

  • get_endTime(): Date

get_fadeSpan

  • get_fadeSpan(): number

get_fadeType

  • get_fadeType(): FadeType

get_geometryColumn

  • get_geometryColumn(): number

get_header

  • get_header(): string[]

get_hyperlinkColumn

  • get_hyperlinkColumn(): number

get_hyperlinkFormat

  • get_hyperlinkFormat(): string

get_latColumn

  • get_latColumn(): number

get_lngColumn

  • get_lngColumn(): number

get_markerColumn

  • get_markerColumn(): number

get_markerIndex

  • get_markerIndex(): number

get_markerScale

  • get_markerScale(): MarkerScales

get_name

  • get_name(): string

get_nameColumn

  • get_nameColumn(): number

get_normalizeColorMap

  • get_normalizeColorMap(): boolean

get_normalizeColorMapMax

  • get_normalizeColorMapMax(): number

get_normalizeColorMapMin

  • get_normalizeColorMapMin(): number

get_normalizeSize

  • get_normalizeSize(): boolean

get_normalizeSizeClip

  • get_normalizeSizeClip(): boolean

get_normalizeSizeMax

  • get_normalizeSizeMax(): number

get_normalizeSizeMin

  • get_normalizeSizeMin(): number

get_opacity

  • get_opacity(): number

get_opened

  • get_opened(): boolean

get_plotType

  • get_plotType(): PlotTypes

get_pointScaleType

  • get_pointScaleType(): PointScaleTypes

get_raUnits

  • get_raUnits(): RAUnits

get_referenceFrame

  • get_referenceFrame(): string

get_scaleFactor

  • get_scaleFactor(): number

get_showFarSide

  • get_showFarSide(): boolean

get_sizeColumn

  • get_sizeColumn(): number

get_startDateColumn

  • get_startDateColumn(): number

get_startTime

  • get_startTime(): Date

get_timeSeries

  • get_timeSeries(): boolean

get_version

  • get_version(): number

get_xAxisColumn

  • get_xAxisColumn(): number

get_xAxisReverse

  • get_xAxisReverse(): boolean

get_yAxisColumn

  • get_yAxisColumn(): number

get_yAxisReverse

  • get_yAxisReverse(): boolean

get_zAxisColumn

  • get_zAxisColumn(): number

get_zAxisReverse

  • get_zAxisReverse(): boolean

guessHeaderAssignmentsFromVoTable

  • guessHeaderAssignmentsFromVoTable(votable: VoTable): void

  • Guess header semantics using a VoTable with similarly named columns as a reference. This can exploit the typed "UCD" annotations associated with such tables.

    Parameters

    • votable: VoTable

      The table template to use.

    Returns void

set_altColumn

  • set_altColumn(v: number): number

set_altType

  • set_altType(v: AltTypes): AltTypes

set_altUnit

  • set_altUnit(v: AltUnits): AltUnits

set_astronomical

  • set_astronomical(v: boolean): boolean

set_barChartBitmask

  • set_barChartBitmask(v: number): number

set_beginRange

  • set_beginRange(v: Date): Date

set_cartesianCustomScale

  • set_cartesianCustomScale(v: number): number

set_cartesianScale

  • set_cartesianScale(v: AltUnits): AltUnits

set_color

set_colorMapColumn

  • set_colorMapColumn(v: number): number

set_colorMapperName

  • set_colorMapperName(v: string): string

set_coordinatesType

  • set_coordinatesType(v: CoordinatesType): CoordinatesType

set_decay

  • set_decay(v: number): number

set_dynamicColor

  • set_dynamicColor(v: boolean): boolean

set_dynamicData

  • set_dynamicData(v: boolean): boolean

set_enabled

  • set_enabled(v: boolean): boolean

set_endDateColumn

  • set_endDateColumn(v: number): number

set_endRange

  • set_endRange(v: Date): Date

set_endTime

  • set_endTime(v: Date): Date

set_fadeSpan

  • set_fadeSpan(v: number): number

set_fadeType

  • set_fadeType(v: FadeType): FadeType

set_geometryColumn

  • set_geometryColumn(v: number): number

set_hyperlinkColumn

  • set_hyperlinkColumn(v: number): number

set_hyperlinkFormat

  • set_hyperlinkFormat(v: string): string

set_latColumn

  • set_latColumn(v: number): number

set_lngColumn

  • set_lngColumn(v: number): number

set_markerColumn

  • set_markerColumn(v: number): number

set_markerIndex

  • set_markerIndex(v: number): number

set_markerScale

  • set_markerScale(v: MarkerScales): MarkerScales

set_name

  • set_name(v: string): string

set_nameColumn

  • set_nameColumn(v: number): number

set_normalizeColorMap

  • set_normalizeColorMap(v: boolean): boolean

set_normalizeColorMapMax

  • set_normalizeColorMapMax(v: number): number

set_normalizeColorMapMin

  • set_normalizeColorMapMin(v: number): number

set_normalizeSize

  • set_normalizeSize(v: boolean): boolean

set_normalizeSizeClip

  • set_normalizeSizeClip(v: boolean): boolean

set_normalizeSizeMax

  • set_normalizeSizeMax(v: number): number

set_normalizeSizeMin

  • set_normalizeSizeMin(v: number): number

set_opacity

  • set_opacity(v: number): number

set_opened

  • set_opened(v: boolean): boolean

set_plotType

  • set_plotType(v: PlotTypes): PlotTypes

set_pointScaleType

  • set_pointScaleType(v: PointScaleTypes): PointScaleTypes

set_raUnits

  • set_raUnits(v: RAUnits): RAUnits

set_referenceFrame

  • set_referenceFrame(v: string): string

set_scaleFactor

  • set_scaleFactor(v: number): number

set_showFarSide

  • set_showFarSide(v: boolean): boolean

set_sizeColumn

  • set_sizeColumn(v: number): number

set_startDateColumn

  • set_startDateColumn(v: number): number

set_startTime

  • set_startTime(v: Date): Date

set_timeSeries

  • set_timeSeries(v: boolean): boolean

set_version

  • set_version(v: number): number

set_xAxisColumn

  • set_xAxisColumn(v: number): number

set_xAxisReverse

  • set_xAxisReverse(v: boolean): boolean

set_yAxisColumn

  • set_yAxisColumn(v: number): number

set_yAxisReverse

  • set_yAxisReverse(v: boolean): boolean

set_zAxisColumn

  • set_zAxisColumn(v: number): number

set_zAxisReverse

  • set_zAxisReverse(v: boolean): boolean

updateData

  • updateData(data: string, purgeOld: boolean, purgeAll: boolean, hasHeader: boolean): boolean

  • Parameters

    • data: string
    • purgeOld: boolean
    • purgeAll: boolean
    • hasHeader: boolean

    Returns boolean

Generated using TypeDoc