Skip to main content
Version: Next

CatalogOnlineQueryProfileStore

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

catalogControlHeader

catalogControlHeader: Map<string, ControlHeader>

inheritedcatalogCoordinateSystem

catalogCoordinateSystem: CatalogCoordinateSystem = ...

inheritedcatalogFilterRequest

catalogFilterRequest: $Properties = {}

catalogHeader

catalogHeader: CatalogHeader[]

catalogInfo

catalogInfo: CatalogInfo

inheritedcatalogType

catalogType: CatalogType = CatalogType.SIMBAD

inheritedfilterDataSize

filterDataSize: number | undefined = undefined

inheritedfilterIndexMap

filterIndexMap: number[] = []

inheritedisLoadingData

isLoadingData: boolean = false

inheritedisUpdateColumnMode

isUpdateColumnMode: boolean = false

inheritedisUpdatingDataStream

isUpdatingDataStream: boolean = false

numVisibleRows

numVisibleRows: number

inheritedprogress

progress: number

inheritedselectedPointIndices

selectedPointIndices: number[] = []

inheritedshouldUpdateTableView

shouldUpdateTableView: boolean = false

inheritedsortedIndexMap

sortedIndexMap: number[] = []

inheritedsortingInfo

sortingInfo: { columnName: string | null; sortingType: any } = ...

Type declaration

  • columnName: string | null
  • sortingType: any

inheritedupdateMode

updateMode: CatalogUpdateMode = CatalogUpdateMode.TableUpdate

publicstaticreadonlyinheritedCOORDINATE_SYSTEM_NAME

COORDINATE_SYSTEM_NAME: Map<CatalogSystemType, string> = ...

Accessors

inheritedactivedSystem

inheritedautoScrollRowNumber

  • get autoScrollRowNumber(): Region

  • Returns Region

inheritedcatalogData

inheritedcatalogFileId

  • get catalogFileId(): number

  • Returns number

inheritedcatalogOriginalData

  • Returns Map<number, ProcessedColumnData>

inheriteddisplayedColumnHeaders

  • get displayedColumnHeaders(): CatalogHeader[]

  • Returns CatalogHeader[]

inheriteddisplayedNumericColumnNames

  • get displayedNumericColumnNames(): string[]

  • The displayed columns a scatter plot or histogram can read directly, in table order.

    Image overlays are not limited to these: a string column can be a coordinate too, which getCoordinateEligibility decides from its units or its values.

    Returns string[]

inheritedhasFilter

  • get hasFilter(): boolean

  • Returns boolean

initCatalogControlHeader

  • Returns Map<string, ControlHeader>

inheritedisFileBasedCatalog

  • get isFileBasedCatalog(): boolean

  • Returns boolean

isLoadingOntoImage

  • get isLoadingOntoImage(): boolean

  • Returns boolean

maxRows

  • get maxRows(): number

  • Returns number

inheritedregionSelected

  • get regionSelected(): number

  • Returns number

inheritedselectedData

  • Returns Map<number, ProcessedColumnData>

shouldUpdateData

  • get shouldUpdateData(): boolean

  • Returns boolean

inheritedsystemCoordinateMap

inheritedtableColumnWidths

  • get tableColumnWidths(): (number | null | undefined)[]

  • Returns (number | null | undefined)[]

updateRequestDataSize

  • get updateRequestDataSize(): $Properties

  • Returns $Properties

Methods

inheritedclearData

  • clearData(): void

  • Returns void

filterColumnData

  • filterColumnData(catalogColumn: [], filterConfig: FilterConfig): number[]

  • Parameters

    • catalogColumn: []
    • filterConfig: FilterConfig

    Returns number[]

publicinheritedget1DPlotData

  • get1DPlotData(column: string): { headerInfo: $Properties; wcsData?: TypedArray }

  • Parameters

    • column: string

    Returns { headerInfo: $Properties; wcsData?: TypedArray }

    • headerInfo: $Properties
    • optionalwcsData?: TypedArray

publicinheritedget2DCoordinateData

  • get2DCoordinateData(xColumnName: string, yColumnName: string, columnsData: Map<number, ProcessedColumnData>, rowCount?: number): { wcsX?: number[]; wcsY?: number[]; xHeaderInfo: $Properties; yHeaderInfo: $Properties }

  • Values for the image overlay, read as coordinates of the active system: string formats are parsed, and a latitude beyond a pole is dropped. Only here, where the columns are known to be feeding a sky transform, is that interpretation warranted.

    Parameters

    • xColumnName: string
    • yColumnName: string
    • columnsData: Map<number, ProcessedColumnData>
    • optionalrowCount: number

    Returns { wcsX?: number[]; wcsY?: number[]; xHeaderInfo: $Properties; yHeaderInfo: $Properties }

    • optionalwcsX?: number[]
    • optionalwcsY?: number[]
    • xHeaderInfo: $Properties
    • yHeaderInfo: $Properties

publicinheritedget2DPlotData

  • get2DPlotData(xColumnName: string, yColumnName: string, columnsData: Map<number, ProcessedColumnData>): { wcsX?: number[]; wcsY?: number[]; xHeaderInfo: $Properties; yHeaderInfo: $Properties }

  • Values for a scatter plot of any two columns. The axes carry no coordinate meaning here -- a flux against a velocity is as valid a pair as a longitude against a latitude -- so the values are read as plain numbers, with none of the parsing or range checks that get2DCoordinateData applies.

    Parameters

    Returns { wcsX?: number[]; wcsY?: number[]; xHeaderInfo: $Properties; yHeaderInfo: $Properties }

    • optionalwcsX?: number[]
    • optionalwcsY?: number[]
    • xHeaderInfo: $Properties
    • yHeaderInfo: $Properties

publicinheritedgetColumnHeader

  • getColumnHeader(columnName: string): any

  • The header of one column, or undefined when this catalog does not have that column.

    Parameters

    • columnName: string

    Returns any

publicinheritedgetCoordinateEligibility

  • Whether a column can be read as a coordinate, and how. Settled once and then reused for the life of the store.

    A filter response carries only its own chunk of rows, so deciding this afresh on every call lets a chunk of blanks -- or one stray unparseable value -- declare the whole column unreadable. That is not just a chunk of missing sources: the overlay is written at absolute row offsets, so a skipped chunk leaves its slots at the image origin and counts every later chunk short. A column's format is a property of the column, not of the rows that happen to have arrived, so once it is known the rows that do not fit it are read as NaN and dropped individually.

    The evidence is the store's current data view rather than the rows passed in. For a file stream that is the accumulated prefix; for an online catalog it is the filtered view used by the overlay, so eligibility cannot disagree with the UI's sample.

    Parameters

    • columnName: string

    Returns CatalogAxisEligibilityResult

inheritedgetOriginIndices

  • getOriginIndices(selectedPointIndices: number[]): number[]

  • Parameters

    • selectedPointIndices: number[]

    Returns number[]

inheritedgetSortedIndices

  • getSortedIndices(selectedPointIndices: number[]): number[]

  • Parameters

    • selectedPointIndices: number[]

    Returns number[]

publicinheritedgetUserFilters

  • getUserFilters(): FilterConfig[]

  • Returns FilterConfig[]

initFilterIndexMap

  • initFilterIndexMap(): void

  • Returns void

initSortedIndexMap

  • initSortedIndexMap(): void

  • Returns void

publicinheritedisNumericColumn

  • isNumericColumn(columnName: string): boolean

  • Whether a column's declared type is already numeric, so plotting it needs no parsing.

    Parameters

    • columnName: string

      the column's name, as it appears in the catalog header

    Returns boolean

    true when the column's values can be read as numbers directly

resetCatalogFilterRequest

  • resetCatalogFilterRequest(): void

  • Returns void

resetFilterRequest

  • resetFilterRequest(filterConfigs?: FilterConfig[]): void

  • Parameters

    • optionalfilterConfigs: FilterConfig[]

    Returns void

inheritedresetUserFilters

  • resetUserFilters(): void

  • Returns void

inheritedsetCatalogCoordinateSystem

  • Parameters

    Returns void

inheritedsetColumnFilter

  • setColumnFilter(filter: string, columnName: string): void

  • Parameters

    • filter: string
    • columnName: string

    Returns void

inheritedsetHeaderDisplay

  • setHeaderDisplay(isVisible: boolean, columnName: string): void

  • Parameters

    • isVisible: boolean
    • columnName: string

    Returns void

inheritedsetIsUpdateColumn

  • setIsUpdateColumn(isUpdateColumn: boolean): void

  • Parameters

    • isUpdateColumn: boolean

    Returns void

inheritedsetLoadingDataStatus

  • setLoadingDataStatus(isLoading: boolean): void

  • Parameters

    • isLoading: boolean

    Returns void

setMaxRows

  • setMaxRows(maxRows: number): void

  • Parameters

    • maxRows: number

    Returns void

inheritedsetProgress

  • setProgress(val: number): void

  • Parameters

    • val: number

    Returns void

inheritedsetSelectedPointIndices

  • setSelectedPointIndices(pointIndices: number[], shouldAutoPanZoom: boolean): void

  • Parameters

    • pointIndices: number[]
    • shouldAutoPanZoom: boolean

    Returns void

setSortingInfo

  • setSortingInfo(columnName: string, sortingType: any): void

  • Parameters

    • columnName: string
    • sortingType: any

    Returns void

inheritedsetTableColumnWidth

  • setTableColumnWidth(width: number, columnName: string): void

  • Parameters

    • width: number
    • columnName: string

    Returns void

inheritedsetUpdateMode

  • Parameters

    Returns void

inheritedsetUpdatingDataStream

  • setUpdatingDataStream(isUpdating: boolean): void

  • Parameters

    • isUpdating: boolean

    Returns void

updateCatalogData

  • updateCatalogData(catalogFilter: CatalogFilterResponse, catalogData: Map<number, ProcessedColumnData>): void

  • Parameters

    Returns void

updateSortedIndexMap

  • updateSortedIndexMap(): void

  • Returns void

inheritedupdateTableStatus

  • updateTableStatus(isEnabled: boolean): void

  • Parameters

    • isEnabled: boolean

    Returns void

publicstaticinheritedgetCatalogCoordinateDefaults

  • getCatalogCoordinateDefaults(system: string | null | undefined): { epoch: string | null; equinox: string | null }

  • The equinox and epoch a coordinate system implies, used when the file declares neither.

    Takes the declared string rather than a CatalogSystemType, because ecl_FK4 implies B1950 and is indistinguishable from ecl_FK5 once both have been mapped to Ecliptic.

    Parameters

    • system: string | null | undefined

      the COOSYS/@system value as declared by the file

    Returns { epoch: string | null; equinox: string | null }

    the equinox and epoch in the Besselian/Julian year form AST accepts, or nulls for a system that has neither

    • epoch: string | null
    • equinox: string | null

publicstaticinheritedgetCatalogSystem

  • Maps a catalog's declared coordinate system onto the system CARTA transforms with.

    The VOTable enumeration is matched exactly before any looser spelling is tried, so the ecliptic values cannot fall through to the equatorial keywords they contain.

    Parameters

    • system: string | null | undefined

      the COOSYS/@system value as declared by the file

    Returns CatalogSystemType

    the matching system, or CatalogSystemType.ICRS when nothing matches

Page Options