Skip to main content
Version: Next

abstractAbstractCatalogProfileStore

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

abstractcatalogControlHeader

catalogControlHeader: Map<string, ControlHeader>

catalogCoordinateSystem

catalogCoordinateSystem: CatalogCoordinateSystem = ...

catalogFilterRequest

catalogFilterRequest: $Properties = {}

abstractcatalogHeader

catalogHeader: CatalogHeader[]

abstractcatalogInfo

catalogInfo: CatalogInfo

catalogType

catalogType: CatalogType = CatalogType.SIMBAD

filterDataSize

filterDataSize: number | undefined = undefined

filterIndexMap

filterIndexMap: number[] = []

isLoadingData

isLoadingData: boolean = false

isUpdateColumnMode

isUpdateColumnMode: boolean = false

isUpdatingDataStream

isUpdatingDataStream: boolean = false

abstractnumVisibleRows

numVisibleRows: number

progress

progress: number

selectedPointIndices

selectedPointIndices: number[] = []

shouldUpdateTableView

shouldUpdateTableView: boolean = false

sortedIndexMap

sortedIndexMap: number[] = []

sortingInfo

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

Type declaration

  • columnName: string | null
  • sortingType: any

updateMode

updateMode: CatalogUpdateMode = CatalogUpdateMode.TableUpdate

publicstaticreadonlyCOORDINATE_SYSTEM_NAME

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

Accessors

activedSystem

autoScrollRowNumber

  • get autoScrollRowNumber(): Region

  • Returns Region

catalogData

catalogFileId

  • get catalogFileId(): number

  • Returns number

catalogOriginalData

displayedColumnHeaders

  • get displayedColumnHeaders(): CatalogHeader[]

  • Returns CatalogHeader[]

displayedNumericColumnNames

  • 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[]

hasFilter

  • get hasFilter(): boolean

  • Returns boolean

abstractinitCatalogControlHeader

isFileBasedCatalog

  • get isFileBasedCatalog(): boolean

  • Returns boolean

abstractisLoadingOntoImage

  • get isLoadingOntoImage(): boolean

  • Returns boolean

regionSelected

  • get regionSelected(): number

  • Returns number

selectedData

abstractshouldUpdateData

  • get shouldUpdateData(): boolean

  • Returns boolean

systemCoordinateMap

tableColumnWidths

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

  • Returns (number | null | undefined)[]

abstractupdateRequestDataSize

  • get updateRequestDataSize(): any

  • Returns any

Methods

clearData

  • clearData(): void

  • Returns void

publicget1DPlotData

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

  • Parameters

    • column: string

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

    • headerInfo: $Properties
    • optionalwcsData?: TypedArray

publicget2DCoordinateData

  • 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

publicget2DPlotData

  • 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

publicgetColumnHeader

  • getColumnHeader(columnName: string): any

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

    Parameters

    • columnName: string

    Returns any

publicgetCoordinateEligibility

  • 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

getOriginIndices

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

  • Parameters

    • selectedPointIndices: number[]

    Returns number[]

getSortedIndices

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

  • Parameters

    • selectedPointIndices: number[]

    Returns number[]

publicgetUserFilters

  • getUserFilters(): FilterConfig[]

  • Returns FilterConfig[]

publicisNumericColumn

  • 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

abstractresetCatalogFilterRequest

  • resetCatalogFilterRequest(): void

  • Returns void

abstractresetFilterRequest

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

  • Parameters

    • optionalfilterConfigs: FilterConfig[]

    Returns void

resetUserFilters

  • resetUserFilters(): void

  • Returns void

setCatalogCoordinateSystem

setColumnFilter

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

  • Parameters

    • filter: string
    • columnName: string

    Returns void

setHeaderDisplay

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

  • Parameters

    • isVisible: boolean
    • columnName: string

    Returns void

setIsUpdateColumn

  • setIsUpdateColumn(isUpdateColumn: boolean): void

  • Parameters

    • isUpdateColumn: boolean

    Returns void

setLoadingDataStatus

  • setLoadingDataStatus(isLoading: boolean): void

  • Parameters

    • isLoading: boolean

    Returns void

abstractsetMaxRows

  • setMaxRows(maxRows: number): void

  • Parameters

    • maxRows: number

    Returns void

setProgress

  • setProgress(val: number): void

  • Parameters

    • val: number

    Returns void

setSelectedPointIndices

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

  • Parameters

    • pointIndices: number[]
    • shouldAutoPanZoom: boolean

    Returns void

abstractsetSortingInfo

  • setSortingInfo(columnName: string, sortingType: SortingType, columnIndex?: number): void

  • Parameters

    • columnName: string
    • sortingType: SortingType
    • optionalcolumnIndex: number

    Returns void

setTableColumnWidth

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

  • Parameters

    • width: number
    • columnName: string

    Returns void

setUpdateMode

setUpdatingDataStream

  • setUpdatingDataStream(isUpdating: boolean): void

  • Parameters

    • isUpdating: boolean

    Returns void

updateTableStatus

  • updateTableStatus(isEnabled: boolean): void

  • Parameters

    • isEnabled: boolean

    Returns void

publicstaticgetCatalogCoordinateDefaults

  • 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

publicstaticgetCatalogSystem

  • 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