CatalogStore

Index

Properties

• catalogCounts
• catalogDisplayStores
• catalogPlots
• catalogProfileStores
• imageAssociatedCatalogId
• PENDING_CATALOG_FILE_ID

Accessors

• activeCatalogFiles
• catalogGLData
• visibleCatalogFiles
• Instance

Methods

• acceptsCatalogResponse
• addCatalog
• bindPendingCatalogPlots
• catalogAssociationForFileId
• catalogAssociationForRestore
• catalogAssociationFromInfo
• catalogMatchesAssociation
• clearCatalogPlotsByComponentId
• clearCatalogPlotsByFileId
• clearCatalogPlotsByWidgetId
• clearImageCoordsData
• closeAssociatedCatalog
• completeCatalogRequest
• convertToImageCoordinate
• getAssociatedIdByWidgetId
• getCatalogDisplayStore
• getCatalogFileNames
• getCatalogPlotSelection
• getDisplayedCatalogPlot
• getFrameIdByCatalogId
• getFrameMinMaxPoints
• getImageIdByCatalog
• getOrCreateCatalogDisplayStore
• isCatalogPlotWidgetIdReserved
• registerCatalogRequest
• removeCatalog
• removeCatalogDisplayStore
• resetActiveCatalogFile
• resolveCatalogAssociation
• setCatalogPlots
• setCatalogPlotSelection
• updateImageAssociatedCatalogId
• validateCatalogPlotColumns
• catalogAssociationFromConfig
• hasStableCatalogIdentity

Properties

catalogCounts

catalogCounts: Map<number, number> = ...

catalogDisplayStores

catalogDisplayStores: Map<number, CatalogDisplayStore> = ...

catalogPlots

catalogPlots: Map<string, ObservableMap<number, string>> = ...

catalogProfileStores

catalogProfileStores: Map<number, CatalogProfileStore | CatalogOnlineQueryProfileStore> = ...

imageAssociatedCatalogId

imageAssociatedCatalogId: Map<number, number[]> = ...

publicstaticreadonlyPENDING_CATALOG_FILE_ID

PENDING_CATALOG_FILE_ID: 0 = 0

Sentinel used while a restored plot is waiting for a catalog from the current session.

Accessors

activeCatalogFiles

• get activeCatalogFiles(): number[]

• Returns number[]

catalogGLData

• get catalogGLData(): Map<number, CatalogOverlayCoords>

• Returns Map<number, CatalogOverlayCoords>

visibleCatalogFiles

• get visibleCatalogFiles(): Map<FrameStore, number[]>

• Returns Map<FrameStore, number[]>

publicstaticInstance

• get Instance(): CatalogStore

• Returns CatalogStore

Methods

publicacceptsCatalogResponse

• acceptsCatalogResponse(catalogFileId: number, requestId?: number): boolean

• Return false for a response belonging to a superseded or completed request.

  ---

  Parameters

  • catalogFileId: number

  • optionalrequestId: number

  Returns boolean

addCatalog

• addCatalog(fileId: number, size: number): void

• Parameters

  • fileId: number

  • size: number

  Returns void

bindPendingCatalogPlots

• bindPendingCatalogPlots(fileId: number, info?: Pick<CatalogInfo, directory | fileInfo>): void

• Attach only restored plots whose stable association matches the newly loaded catalog.

  ---

  Parameters

  • fileId: number

  • optionalinfo: Pick<CatalogInfo, directory | fileInfo>

  Returns void

publiccatalogAssociationForFileId

• catalogAssociationForFileId(fileId: number): WorkspaceCatalogAssociation

• Create the persisted association for a loaded catalog.

  ---

  Parameters

  • fileId: number

  Returns WorkspaceCatalogAssociation

publiccatalogAssociationForRestore

• catalogAssociationForRestore(config: Partial<WorkspaceCatalogAssociation> | null | undefined): { association?: WorkspaceCatalogAssociation; catalogFileId: number }

• Resolve persisted settings through the shared widget/plot restore policy.

  ---

  Parameters

  • config: Partial<WorkspaceCatalogAssociation> | null | undefined

  Returns { association?: WorkspaceCatalogAssociation; catalogFileId: number }

  • optionalassociation?: WorkspaceCatalogAssociation

  • catalogFileId: number

publiccatalogAssociationFromInfo

• catalogAssociationFromInfo(fileId: number, info?: Pick<CatalogInfo, directory | fileInfo>): WorkspaceCatalogAssociation

• Parameters

  • fileId: number

  • optionalinfo: Pick<CatalogInfo, directory | fileInfo>

  Returns WorkspaceCatalogAssociation

publiccatalogMatchesAssociation

• catalogMatchesAssociation(association: WorkspaceCatalogAssociation | undefined, fileId: number, info?: Pick<CatalogInfo, directory | fileInfo>): boolean

• Match a pending association against a newly loaded catalog.

  ---

  Parameters

  • association: WorkspaceCatalogAssociation | undefined

  • fileId: number

  • optionalinfo: Pick<CatalogInfo, directory | fileInfo>

  Returns boolean

clearCatalogPlotsByComponentId

• clearCatalogPlotsByComponentId(componentId: string): void

• Parameters

  • componentId: string

  Returns void

clearCatalogPlotsByFileId

• clearCatalogPlotsByFileId(fileId: number): void

• Parameters

  • fileId: number

  Returns void

clearCatalogPlotsByWidgetId

• clearCatalogPlotsByWidgetId(widgetId: string): void

• Parameters

  • widgetId: string

  Returns void

clearImageCoordsData

• clearImageCoordsData(fileId: number): void

• Parameters

  • fileId: number

  Returns void

closeAssociatedCatalog

• closeAssociatedCatalog(imageFileId: number): void

• Parameters

  • imageFileId: number

  Returns void

completeCatalogRequest

• completeCatalogRequest(catalogFileId: number, requestId?: number): void

• Mark the current request as finished so late responses cannot mutate the catalog.

  ---

  Parameters

  • catalogFileId: number

  • optionalrequestId: number

  Returns void

convertToImageCoordinate

• convertToImageCoordinate(fileId: number, xData: number[], yData: number[], wcsInfo: FrameSet, xUnit: string, yUnit: string, catalogCoordinateSystem: CatalogCoordinateSystem, subsetEndIndex: number, subsetDataSize: number): void

• Parameters

  • fileId: number

  • xData: number[]

  • yData: number[]

  • wcsInfo: FrameSet

  • xUnit: string

  • yUnit: string

  • catalogCoordinateSystem: CatalogCoordinateSystem

  • subsetEndIndex: number

  • subsetDataSize: number

  Returns void

getAssociatedIdByWidgetId

• getAssociatedIdByWidgetId(catalogPlotWidgetId: string): { catalogFileId: number | undefined; catalogPlotComponentId: string | undefined }

• Parameters

  • catalogPlotWidgetId: string

  Returns { catalogFileId: number | undefined; catalogPlotComponentId: string | undefined }

  • catalogFileId: number | undefined

  • catalogPlotComponentId: string | undefined

getCatalogDisplayStore

• getCatalogDisplayStore(fileId: number): CatalogDisplayStore | undefined

• The display store of a catalog, or undefined when the catalog has none.

  ---

  Parameters

  • fileId: number

  Returns CatalogDisplayStore | undefined

getCatalogFileNames

• getCatalogFileNames(fileIds: number[]): Map<number, string>

• Parameters

  • fileIds: number[]

  Returns Map<number, string>

publicgetCatalogPlotSelection

• getCatalogPlotSelection(componentId: string): number | undefined

• The catalog one catalog plot component is showing, once it has settled on one.

  ---

  Parameters

  • componentId: string

  Returns number | undefined

publicgetDisplayedCatalogPlot

• getDisplayedCatalogPlot(catalogPlotWidgetId: string): { catalogFileId: number | undefined; widgetId: string }

• The plot store one catalog plot component is showing. A component keeps one store per catalog it has been switched to, so the widget ID it was created with is not always the plot on screen. A component that has never been mounted has settled on nothing, and the widget's own binding stands in for it.

  ---

  Parameters

  • catalogPlotWidgetId: string

  Returns { catalogFileId: number | undefined; widgetId: string }

  • catalogFileId: number | undefined

  • widgetId: string

getFrameIdByCatalogId

• getFrameIdByCatalogId(catalogId: number): number

• Parameters

  • catalogId: number

  Returns number

getFrameMinMaxPoints

• getFrameMinMaxPoints(frameId: number): { maxX: number; maxY: number; minX: number; minY: number }

• Parameters

  • frameId: number

  Returns { maxX: number; maxY: number; minX: number; minY: number }

  • maxX: number

  • maxY: number

  • minX: number

  • minY: number

getImageIdByCatalog

• getImageIdByCatalog(catalogFileId: number): number | undefined

• Parameters

  • catalogFileId: number

  Returns number | undefined

getOrCreateCatalogDisplayStore

• getOrCreateCatalogDisplayStore(fileId: number): CatalogDisplayStore

• As getCatalogDisplayStore, but creates the display store when the catalog has none.

  ---

  Parameters

  • fileId: number

  Returns CatalogDisplayStore

publicisCatalogPlotWidgetIdReserved

• isCatalogPlotWidgetIdReserved(widgetId: string): boolean

• Whether a layout tab still retains this plot ID after its catalog store was removed.

  ---

  Parameters

  • widgetId: string

  Returns boolean

registerCatalogRequest

• registerCatalogRequest(catalogFileId: number, requestId: number): void

• Associate a catalog filter request with the catalog it updates.

  ---

  Parameters

  • catalogFileId: number

  • requestId: number

  Returns void

removeCatalog

• removeCatalog(fileId: number, catalogComponentId?: string): void

• Parameters

  • fileId: number

  • optionalcatalogComponentId: string

  Returns void

removeCatalogDisplayStore

• removeCatalogDisplayStore(fileId: number): void

• Releases the display store of a catalog that is being closed.

  ---

  Parameters

  • fileId: number

  Returns void

resetActiveCatalogFile

• resetActiveCatalogFile(imageFileId: number): void

• Parameters

  • imageFileId: number

  Returns void

publicresolveCatalogAssociation

• resolveCatalogAssociation(association: WorkspaceCatalogAssociation | undefined): number | undefined

• Resolve an association without trusting a stale session-local ID.

  ---

  Parameters

  • association: WorkspaceCatalogAssociation | undefined

  Returns number | undefined

setCatalogPlots

• setCatalogPlots(componentId: string, fileId: number, widgetId: string): void

• Parameters

  • componentId: string

  • fileId: number

  • widgetId: string

  Returns void

setCatalogPlotSelection

• setCatalogPlotSelection(componentId: string, catalogFileId: number): void

• Parameters

  • componentId: string

  • catalogFileId: number

  Returns void

updateImageAssociatedCatalogId

• updateImageAssociatedCatalogId(activeFrameIndex: number, associatedCatalogFiles: number[]): void

• Parameters

  • activeFrameIndex: number

  • associatedCatalogFiles: number[]

  Returns void

validateCatalogPlotColumns

• validateCatalogPlotColumns(fileId: number): void

• Drop restored plot columns the catalog turns out not to have, and say which. Columns are restored before the catalog is known, so they are checked once its data arrives, the way a restored display config is.

  ---

  Parameters

  • fileId: number

  Returns void

publicstaticcatalogAssociationFromConfig

• catalogAssociationFromConfig(config: Partial<WorkspaceCatalogAssociation> | null | undefined): WorkspaceCatalogAssociation | undefined

• Read and validate a catalog association from persisted widget settings.

  ---

  Parameters

  • config: Partial<WorkspaceCatalogAssociation> | null | undefined

  Returns WorkspaceCatalogAssociation | undefined

publicstatichasStableCatalogIdentity

• hasStableCatalogIdentity(association: WorkspaceCatalogAssociation | undefined): boolean

• Parameters

  • association: WorkspaceCatalogAssociation | undefined

  Returns boolean