Skip to main content
Version: Next

WidgetsStore

Index

Properties

Accessors

Methods

Properties

animatorWidgets

animatorWidgets: Map<string, AnimatorWidgetStore> = ...

publicreadonlyCARTAWidgets

CARTAWidgets: Map<WidgetType, { icon: string; isCustomIcon: boolean; onClick: () => void; widgetConfig: DefaultWidgetConfig }> = ...

catalogPlotWidgets

catalogPlotWidgets: Map<string, CatalogPlotWidgetStore> = ...

catalogWidgets

catalogWidgets: Map<string, CatalogWidgetStore> = ...

channelMapControlWidgets

channelMapControlWidgets: Map<string, EmptyWidgetStore> = ...

cursorInfoWidgets

cursorInfoWidgets: Map<string, EmptyWidgetStore> = ...

floatingSettingsWidgets

floatingSettingsWidgets: Map<string, string> = ...

floatingWidgets

floatingWidgets: WidgetConfig[] = []

histogramWidgets

histogramWidgets: Map<string, HistogramWidgetStore> = ...

layerListWidgets

layerListWidgets: Map<string, LayerListWidgetStore> = ...

logWidgets

logWidgets: Map<string, EmptyWidgetStore> = ...

pvGeneratorWidgets

pvGeneratorWidgets: Map<string, PvGeneratorWidgetStore> = ...

regionListWidgets

regionListWidgets: Map<string, EmptyWidgetStore> = ...

renderConfigWidgets

renderConfigWidgets: Map<string, RenderConfigWidgetStore> = ...

spatialProfileWidgets

spatialProfileWidgets: Map<string, SpatialProfileWidgetStore> = ...

spectralLineQueryWidgets

spectralLineQueryWidgets: Map<string, SpectralLineQueryWidgetStore> = ...

spectralProfileWidgets

spectralProfileWidgets: Map<string, SpectralProfileWidgetStore> = ...

statsWidgets

statsWidgets: Map<string, StatsWidgetStore> = ...

stokesAnalysisWidgets

stokesAnalysisWidgets: Map<string, StokesAnalysisWidgetStore> = ...

Accessors

hasSpectralProfiler

  • get hasSpectralProfiler(): boolean

  • Returns boolean

imageViewWidgetTitle

  • get imageViewWidgetTitle(): string

  • The title of the image view widget, which is the file name of the active image. If the active image is a PV preview, the title is the file name of the first image on the page.

    Returns string

isSpectralWidgetStreamingData

  • get isSpectralWidgetStreamingData(): boolean

  • Returns boolean

spectralProfilerList

  • get spectralProfilerList(): string[]

  • Returns string[]

publicstaticInstance

Methods

addAnimatorWidget

  • addAnimatorWidget(id?: string | null, widgetSettings?: object | null): string | null

  • Parameters

    • id: string | null = null
    • widgetSettings: object | null = null

    Returns string | null

addCatalogPlotWidget

addChannelMapControlWidget

  • addChannelMapControlWidget(id?: string | null): string | null

  • Parameters

    • id: string | null = null

    Returns string | null

addCursorInfoWidget

  • addCursorInfoWidget(id?: string | null): string | null

  • Parameters

    • id: string | null = null

    Returns string | null

addFloatingSettingsWidget

  • addFloatingSettingsWidget(id?: string | null, parentId: string, type: string): string | null

  • Parameters

    • id: string | null = null
    • parentId: string
    • type: string

    Returns string | null

addFloatingWidget

addHistogramWidget

  • addHistogramWidget(id?: string | null, widgetSettings?: object | null): string | null

  • Parameters

    • id: string | null = null
    • widgetSettings: object | null = null

    Returns string | null

addLayerListWidget

  • addLayerListWidget(id?: string | null): string | null

  • Parameters

    • id: string | null = null

    Returns string | null

addLogWidget

  • addLogWidget(id?: string | null): string | null

  • Parameters

    • id: string | null = null

    Returns string | null

addPvGeneratorWidget

  • addPvGeneratorWidget(id?: string | null): string | null

  • Parameters

    • id: string | null = null

    Returns string | null

addRegionListWidget

  • addRegionListWidget(id?: string | null): string | null

  • Parameters

    • id: string | null = null

    Returns string | null

addRenderConfigWidget

  • addRenderConfigWidget(id?: string | null, widgetSettings?: object | null): string | null

  • Parameters

    • id: string | null = null
    • widgetSettings: object | null = null

    Returns string | null

addSpatialProfileWidget

  • addSpatialProfileWidget(id?: string | null, widgetSettings?: object | null): string | null

  • Parameters

    • id: string | null = null
    • widgetSettings: object | null = null

    Returns string | null

addSpectralLineQueryWidget

  • addSpectralLineQueryWidget(id?: string | null): string | null

  • Parameters

    • id: string | null = null

    Returns string | null

addSpectralProfileWidget

  • addSpectralProfileWidget(id?: string | null, widgetSettings?: object | null): string | null

  • Parameters

    • id: string | null = null
    • widgetSettings: object | null = null

    Returns string | null

addStatsWidget

  • addStatsWidget(id?: string | null): string | null

  • Parameters

    • id: string | null = null

    Returns string | null

addStokesWidget

  • addStokesWidget(id?: string | null, widgetSettings?: object | null): string | null

  • Parameters

    • id: string | null = null
    • widgetSettings: object | null = null

    Returns string | null

bindPendingCatalogWidgets

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

  • Resolve restored overlay widgets independently as their catalogs arrive.

    Parameters

    • fileId: number
    • optionalinfo: Pick<CatalogInfo, directory | fileInfo>

    Returns void

changeWidgetId

  • changeWidgetId(id: string, newId: string): void

  • Parameters

    • id: string
    • newId: string

    Returns void

publicclearDockedWidgets

  • clearDockedWidgets(): void

  • Returns void

publicclearPopoutPositions

  • clearPopoutPositions(): void

  • Returns void

clearUnmatchedPendingCatalogRestores

  • clearUnmatchedPendingCatalogRestores(): void

  • Discard catalog widget restores that were not matched while the current workspace loaded.

    Returns void

createFloatingAnimatorWidget

  • createFloatingAnimatorWidget(): void

  • Returns void

createFloatingCatalogPlotWidget

  • Parameters

    Returns { widgetComponentId: string; widgetStoreId: string | null }

    • widgetComponentId: string
    • widgetStoreId: string | null

createFloatingCatalogWidget

  • createFloatingCatalogWidget(catalogFileId: number): string

  • Parameters

    • catalogFileId: number

    Returns string

createFloatingChannelMapControlWidget

  • createFloatingChannelMapControlWidget(): void

  • Returns void

createFloatingCursorInfoWidget

  • createFloatingCursorInfoWidget(): void

  • Returns void

createFloatingHistogramWidget

  • createFloatingHistogramWidget(): void

  • Returns void

createFloatingLayerListWidget

  • createFloatingLayerListWidget(): void

  • Returns void

createFloatingLogWidget

  • createFloatingLogWidget(): void

  • Returns void

createFloatingPvGeneratorWidget

  • createFloatingPvGeneratorWidget(): void

  • Returns void

createFloatingRegionListWidget

  • createFloatingRegionListWidget(): void

  • Returns void

createFloatingRenderWidget

  • createFloatingRenderWidget(): void

  • Returns void

createFloatingSettingsWidget

  • createFloatingSettingsWidget(title: string, parentId: string, parentType: string): void

  • Parameters

    • title: string
    • parentId: string
    • parentType: string

    Returns void

createFloatingSpatialProfilerWidget

  • createFloatingSpatialProfilerWidget(): void

  • Returns void

createFloatingSpectralLineQueryWidget

  • createFloatingSpectralLineQueryWidget(): void

  • Returns void

createFloatingSpectralProfilerWidget

  • createFloatingSpectralProfilerWidget(): void

  • Returns void

createFloatingStatsWidget

  • createFloatingStatsWidget(): void

  • Returns void

createFloatingStokesWidget

  • createFloatingStokesWidget(): void

  • Returns void

createFloatingWidget

  • createFloatingWidget(savedConfig: any): void

  • Parameters

    • savedConfig: any

    Returns void

getCatalogWidgetStore

  • getCatalogWidgetStore(componentId: string, selectedCatalogId?: number): CatalogWidgetStore

  • Get or create the widget-scoped state for one catalog overlay component.

    Parameters

    • componentId: string
    • selectedCatalogId: number = 1

    Returns CatalogWidgetStore

publicgetDisplayedCatalogPlotWidget

  • The catalog plot store a layout tab is showing. The tab is identified by the store it was created with, which its component may since have switched away from, and which is gone altogether once that catalog closes.

    Parameters

    • widgetID: string

    Returns CatalogPlotWidgetStore | undefined

publicgetSpectralWidgetStoreByID

handleToolbarWidgetDragStart

publicinitWidgets

  • initWidgets(componentConfigs: any[], floating: any[]): void

  • Parameters

    • componentConfigs: any[]
    • floating: any[]

    Returns void

onAction

  • onAction(action: any): any

  • Parameters

    • action: any

    Returns any

onChannelMapButtonClick

  • onChannelMapButtonClick(): void

  • Returns void

onCogPinedClick

  • onCogPinedClick(node: TabNode): void

  • Parameters

    • node: TabNode

    Returns void

onHelpPinedClick

  • onHelpPinedClick(ev: MouseEvent, node: TabNode): void

  • Parameters

    • ev: MouseEvent
    • node: TabNode

    Returns void

onImagePanelButtonClick

  • onImagePanelButtonClick(): void

  • Returns void

onNextPageClick

  • onNextPageClick(): void

  • Returns void

onPreviousPageClick

  • onPreviousPageClick(): void

  • Returns void

onRenderTab

  • onRenderTab(node: TabNode, renderValues: ITabRenderValues): void

  • Parameters

    • node: TabNode
    • renderValues: ITabRenderValues

    Returns void

onRenderTabSet

  • onRenderTabSet(tabSetNode: any, renderValues: ITabSetRenderValues): void

  • Parameters

    • tabSetNode: any
    • renderValues: ITabSetRenderValues

    Returns void

popoutFloatingWidget

reloadFloatingCatalogWidget

  • reloadFloatingCatalogWidget(): void

  • Returns void

removeFloatingWidget

  • removeFloatingWidget(id: string, shouldPreserveStore?: boolean): void

  • Parameters

    • id: string
    • shouldPreserveStore: boolean = false

    Returns void

removeFloatingWidgetComponent

  • removeFloatingWidgetComponent(componentId: string): void

  • Parameters

    • componentId: string

    Returns void

publicremoveFloatingWidgets

  • removeFloatingWidgets(): void

  • Returns void

publicremoveFrameFromRegionWidgets

  • removeFrameFromRegionWidgets(fileId?: number): void

  • Parameters

    • fileId: number = ACTIVE_FILE_ID

    Returns void

publicremoveRegionFromRegionWidgets

  • removeRegionFromRegionWidgets(fileId: number, regionId: number): void

  • Parameters

    • fileId: number
    • regionId: number

    Returns void

publicremoveRegionsFromRegionWidgetsByFrame

  • removeRegionsFromRegionWidgetsByFrame(fileId: number): void

  • Parameters

    • fileId: number

    Returns void

publicremoveWidget

  • removeWidget(widgetId: string, widgetType: string): void

  • Parameters

    • widgetId: string
    • widgetType: string

    Returns void

renderWidgetFactory

  • renderWidgetFactory(node: TabNode): ReactNode

  • Parameters

    • node: TabNode

    Returns ReactNode

replaceCatalogWidgetSelection

  • replaceCatalogWidgetSelection(catalogFileId: number, replacementCatalogFileId: number): void

  • Replace a catalog only in widgets that were showing it.

    Parameters

    • catalogFileId: number
    • replacementCatalogFileId: number

    Returns void

resetCatalogWidgetSelections

  • resetCatalogWidgetSelections(activeCatalogFileIds: number[]): void

  • Keep widget selections valid when the active image changes.

    Parameters

    • activeCatalogFileIds: number[]

    Returns void

selectDockedWidgetTab

  • selectDockedWidgetTab(componentType: string): boolean

  • Selects an existing docked widget tab, preferring the canonical component id when multiple instances exist.

    Parameters

    • componentType: string

    Returns boolean

selectFloatingWidget

  • selectFloatingWidget(id: string): void

  • Parameters

    • id: string

    Returns void

setCatalogWidgetSelection

  • setCatalogWidgetSelection(componentId: string, catalogFileId: number): boolean

  • Select a loaded catalog in one widget by its component ID.

    Parameters

    • componentId: string
    • catalogFileId: number

    Returns boolean

setImageMultiPanelEnabled

  • setImageMultiPanelEnabled(isMultiPanelEnabled: boolean): void

  • Parameters

    • isMultiPanelEnabled: boolean

    Returns void

setWidgetComponentTitle

  • setWidgetComponentTitle(componentId: string, title: string): void

  • Parameters

    • componentId: string
    • title: string

    Returns void

setWidgetTitle

  • setWidgetTitle(id: string, title: string): void

  • Parameters

    • id: string
    • title: string

    Returns void

publictoWidgetSettingsConfig

  • toWidgetSettingsConfig(widgetType: string, widgetID: string | undefined): AnimatorWidgetConfig | { linePlotPointSize: number; lineWidth: number; logScaleY: boolean; maxXVal: number; maxYVal: number; minXVal: number; minYVal: number; plotType: PlotType; primaryLineColor: string } | { coordinate: string; linePlotPointSize: number; lineWidth: number; maxXVal: number; maxYVal: number; meanRmsVisible: boolean; minXVal: number; minYVal: number; plotType: PlotType; primaryLineColor: string; wcsAxisVisible: boolean } | { linePlotPointSize: number; lineWidth: number; maxXVal: number | undefined; maxYVal: number | undefined; meanRmsVisible: boolean; minXVal: number | undefined; minYVal: number | undefined; plotType: PlotType; primaryLineColor: string; restFrameRedshift: number; restFrameShiftMode: RestFrameShiftMode; restFrameVelocityConvention: VelocityConvention; xAxisRestFrameEnabled: boolean; yAxisRestFrameEnabled: boolean } | { colorMap: string; equalAxes: boolean; linePlotPointSize: number; lineWidth: number; plotType: PlotType; pointTransparency: number; primaryLineColor: string; scatterPlotPointSize: number; secondaryLineColor: string } | { canvasSizeUnit?: CatalogSizeUnits; catalogDirectory?: string; catalogFileId?: number; catalogFilename?: string; color?: string; colorAxis?: WorkspaceCatalogColorAxisConfig; displayMode?: CatalogDisplayMode; highlightColor?: string; orientationAxis?: WorkspaceCatalogOrientationAxisConfig; plotType?: CatalogPlotType; settingsTabId?: CatalogSettingsTabs; shape?: CatalogOverlayShape; size?: number; sizeAxis?: WorkspaceCatalogSizeAxisConfig; sizeMinorAxis?: WorkspaceCatalogSizeAxisConfig; sourceRadiusType?: CatalogSourceRadiusMode; tableSeparatorPosition?: string; thickness?: number; worldSizeUnit?: AngularSizeUnit; xAxis?: string; yAxis?: string } | { catalogDirectory?: string; catalogFileId?: number; catalogFilename?: string; dragMode?: DragMode; histogramBorder?: XBorder; isLogScaleY?: boolean; nBinX?: number; plotType: CatalogPlotType; scatterBorder?: Border; statisticColumnName?: string; xColumnName: string; yColumnName?: string } | null | undefined

  • Parameters

    • widgetType: string
    • widgetID: string | undefined

    Returns AnimatorWidgetConfig | { linePlotPointSize: number; lineWidth: number; logScaleY: boolean; maxXVal: number; maxYVal: number; minXVal: number; minYVal: number; plotType: PlotType; primaryLineColor: string } | { coordinate: string; linePlotPointSize: number; lineWidth: number; maxXVal: number; maxYVal: number; meanRmsVisible: boolean; minXVal: number; minYVal: number; plotType: PlotType; primaryLineColor: string; wcsAxisVisible: boolean } | { linePlotPointSize: number; lineWidth: number; maxXVal: number | undefined; maxYVal: number | undefined; meanRmsVisible: boolean; minXVal: number | undefined; minYVal: number | undefined; plotType: PlotType; primaryLineColor: string; restFrameRedshift: number; restFrameShiftMode: RestFrameShiftMode; restFrameVelocityConvention: VelocityConvention; xAxisRestFrameEnabled: boolean; yAxisRestFrameEnabled: boolean } | { colorMap: string; equalAxes: boolean; linePlotPointSize: number; lineWidth: number; plotType: PlotType; pointTransparency: number; primaryLineColor: string; scatterPlotPointSize: number; secondaryLineColor: string } | { canvasSizeUnit?: CatalogSizeUnits; catalogDirectory?: string; catalogFileId?: number; catalogFilename?: string; color?: string; colorAxis?: WorkspaceCatalogColorAxisConfig; displayMode?: CatalogDisplayMode; highlightColor?: string; orientationAxis?: WorkspaceCatalogOrientationAxisConfig; plotType?: CatalogPlotType; settingsTabId?: CatalogSettingsTabs; shape?: CatalogOverlayShape; size?: number; sizeAxis?: WorkspaceCatalogSizeAxisConfig; sizeMinorAxis?: WorkspaceCatalogSizeAxisConfig; sourceRadiusType?: CatalogSourceRadiusMode; tableSeparatorPosition?: string; thickness?: number; worldSizeUnit?: AngularSizeUnit; xAxis?: string; yAxis?: string } | { catalogDirectory?: string; catalogFileId?: number; catalogFilename?: string; dragMode?: DragMode; histogramBorder?: XBorder; isLogScaleY?: boolean; nBinX?: number; plotType: CatalogPlotType; scatterBorder?: Border; statisticColumnName?: string; xColumnName: string; yColumnName?: string } | null | undefined

unpinWidget

  • unpinWidget(node: TabNode): void

  • Parameters

    • node: TabNode

    Returns void

updateCatalogWidgetSelection

  • updateCatalogWidgetSelection(catalogFileId: number): string | undefined

  • Select a catalog in the first widget that can show it, and return that widget's ID. A widget still waiting for the catalog a restored workspace named is not one that can: it is left waiting, and undefined is returned so that the caller gives this catalog a widget of its own.

    Parameters

    • catalogFileId: number

    Returns string | undefined

updateImageWidgetTitle

  • updateImageWidgetTitle(): void

  • Updates the title of the image view widget using imageViewWidgetTitle.

    Returns void

publicstaticresetWidgetPlotXYBounds

Page Options