WidgetsStore

Index

Properties

• animatorWidgets
• CARTAWidgets
• catalogPlotWidgets
• catalogWidgets
• channelMapControlWidgets
• cursorInfoWidgets
• floatingSettingsWidgets
• floatingWidgets
• histogramWidgets
• layerListWidgets
• logWidgets
• pvGeneratorWidgets
• regionListWidgets
• renderConfigWidgets
• spatialProfileWidgets
• spectralLineQueryWidgets
• spectralProfileWidgets
• statsWidgets
• stokesAnalysisWidgets

Accessors

• hasSpectralProfiler
• imageViewWidgetTitle
• isSpectralWidgetStreamingData
• spectralProfilerList
• Instance

Methods

• addAnimatorWidget
• addCatalogPlotWidget
• addCatalogWidget
• addChannelMapControlWidget
• addCursorInfoWidget
• addFloatingSettingsWidget
• addFloatingWidget
• addHistogramWidget
• addLayerListWidget
• addLogWidget
• addPvGeneratorWidget
• addRegionListWidget
• addRenderConfigWidget
• addSpatialProfileWidget
• addSpectralLineQueryWidget
• addSpectralProfileWidget
• addStatsWidget
• addStokesWidget
• changeWidgetId
• createFloatingAnimatorWidget
• createFloatingCatalogPlotWidget
• createFloatingCatalogWidget
• createFloatingChannelMapControlWidget
• createFloatingCursorInfoWidget
• createFloatingHistogramWidget
• createFloatingLayerListWidget
• createFloatingLogWidget
• createFloatingPvGeneratorWidget
• createFloatingRegionListWidget
• createFloatingRenderWidget
• createFloatingSettingsWidget
• createFloatingSpatialProfilerWidget
• createFloatingSpectralLineQueryWidget
• createFloatingSpectralProfilerWidget
• createFloatingStatsWidget
• createFloatingStokesWidget
• createFloatingWidget
• getSpectralWidgetStoreByID
• handleItemCreation
• handleItemRemoval
• handleStateUpdates
• initLayoutWithWidgets
• initWidgets
• onChannelMapButtonClick
• onCogPinedClick
• onHelpPinedClick
• onImagePanelButtonClick
• onNextPageClick
• onPreviousPageClick
• reloadFloatingCatalogWidget
• removeFloatingWidget
• removeFloatingWidgetComponent
• removeFloatingWidgets
• removeFrameFromRegionWidgets
• removeRegionFromRegionWidgets
• removeRegionsFromRegionWidgetsByFrame
• removeWidget
• selectFloatingWidget
• setImageMultiPanelEnabled
• setWidgetComponentTitle
• setWidgetTitle
• toWidgetSettingsConfig
• unpinWidget
• updateImagePanelPageButtons
• updateImageWidgetTitle
• updateRenderConfigSettingsVisibility
• ResetWidgetPlotXYBounds

Properties

animatorWidgets

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

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(): any

• 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 any

isSpectralWidgetStreamingData

• get isSpectralWidgetStreamingData(): boolean

• Returns boolean

spectralProfilerList

• get spectralProfilerList(): string[]

• Returns string[]

staticInstance

• get Instance(): WidgetsStore

• Returns WidgetsStore

Methods

addAnimatorWidget

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

• Parameters

  • id: string | null = null

  Returns string | null

addCatalogPlotWidget

• addCatalogPlotWidget(props: CatalogPlotWidgetStoreProps, id?: string | null): string | null

• Parameters

  • props: CatalogPlotWidgetStoreProps

  • id: string | null = null

  Returns string | null

addCatalogWidget

• addCatalogWidget(catalogFileId: number, id?: string | null, widgetSettings?: object | null): string | null

• Parameters

  • catalogFileId: number

  • id: string | null = null

  • widgetSettings: object | null = null

  Returns string | null

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

• addFloatingWidget(widget: WidgetConfig): void

• Parameters

  • widget: WidgetConfig

  Returns void

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

changeWidgetId

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

• Parameters

  • id: string

  • newId: string

  Returns void

createFloatingAnimatorWidget

• createFloatingAnimatorWidget(): void

• Returns void

createFloatingCatalogPlotWidget

• createFloatingCatalogPlotWidget(props: CatalogPlotWidgetStoreProps): { widgetComponentId: string; widgetStoreId: string | null }

• Parameters

  • props: CatalogPlotWidgetStoreProps

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

  • widgetComponentId: string

  • widgetStoreId: string | null

createFloatingCatalogWidget

• createFloatingCatalogWidget(catalogFileId: number): { widgetComponentId: string; widgetStoreId: string | null }

• Parameters

  • catalogFileId: number

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

  • widgetComponentId: string

  • widgetStoreId: string | null

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

publicgetSpectralWidgetStoreByID

• getSpectralWidgetStoreByID(id: string): SpectralProfileWidgetStore | undefined

• Parameters

  • id: string

  Returns SpectralProfileWidgetStore | undefined

handleItemCreation

• handleItemCreation(item: ContentItem): void

• Parameters

  • item: ContentItem

  Returns void

handleItemRemoval

• handleItemRemoval(item: ContentItem): void

• Parameters

  • item: ContentItem

  Returns void

handleStateUpdates

• handleStateUpdates(event: any): void

• Parameters

  • event: any

  Returns void

publicinitLayoutWithWidgets

• initLayoutWithWidgets(layout: GoldenLayout): void

• Parameters

  • layout: GoldenLayout

  Returns void

publicinitWidgets

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

• Parameters

  • componentConfigs: any[]

  • floating: any[]

  Returns void

onChannelMapButtonClick

• onChannelMapButtonClick(): void

• Returns void

onCogPinedClick

• onCogPinedClick(item: ContentItem): void

• Parameters

  • item: ContentItem

  Returns void

onHelpPinedClick

• onHelpPinedClick(ev: ClickEvent<HTMLElement>, item: ContentItem): void

• Parameters

  • ev: ClickEvent<HTMLElement>

  • item: ContentItem

  Returns void

onImagePanelButtonClick

• onImagePanelButtonClick(): void

• Returns void

onNextPageClick

• onNextPageClick(): void

• Returns void

onPreviousPageClick

• onPreviousPageClick(): void

• Returns void

reloadFloatingCatalogWidget

• reloadFloatingCatalogWidget(): void

• Returns void

removeFloatingWidget

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

• Parameters

  • id: string

  • preserveStore: 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

selectFloatingWidget

• selectFloatingWidget(id: string): void

• Parameters

  • id: string

  Returns void

setImageMultiPanelEnabled

• setImageMultiPanelEnabled(multiPanelEnabled: boolean): void

• Parameters

  • multiPanelEnabled: 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): { catalogColor: string; catalogFileId: number; catalogShape: CatalogOverlayShape; catalogSize: number; highlightColor: string; tableSeparatorPosition: string; thickness: number } | { linePlotPointSize: number; lineWidth: number; logScaleY: boolean; maxXVal: number; maxYVal: number; minXVal: number; minYVal: number; plotType: PlotType; primaryLineColor: string } | { linePlotPointSize: number; lineWidth: number; maxXVal: number | undefined; maxYVal: number | undefined; meanRmsVisible: boolean; minXVal: number | undefined; minYVal: number | undefined; plotType: PlotType; primaryLineColor: string } | { colorMap: string; equalAxes: boolean; linePlotPointSize: number; lineWidth: number; plotType: PlotType; pointTransparency: number; primaryLineColor: string; scatterPlotPointSize: number; secondaryLineColor: string } | null | undefined

• Parameters

  • widgetType: string

  • widgetID: string | undefined

  Returns { catalogColor: string; catalogFileId: number; catalogShape: CatalogOverlayShape; catalogSize: number; highlightColor: string; tableSeparatorPosition: string; thickness: number } | { linePlotPointSize: number; lineWidth: number; logScaleY: boolean; maxXVal: number; maxYVal: number; minXVal: number; minYVal: number; plotType: PlotType; primaryLineColor: string } | { linePlotPointSize: number; lineWidth: number; maxXVal: number | undefined; maxYVal: number | undefined; meanRmsVisible: boolean; minXVal: number | undefined; minYVal: number | undefined; plotType: PlotType; primaryLineColor: string } | { colorMap: string; equalAxes: boolean; linePlotPointSize: number; lineWidth: number; plotType: PlotType; pointTransparency: number; primaryLineColor: string; scatterPlotPointSize: number; secondaryLineColor: string } | null | undefined

unpinWidget

• unpinWidget(item: ContentItem): void

• Parameters

  • item: ContentItem

  Returns void

updateImagePanelPageButtons

• updateImagePanelPageButtons(): void

• Returns void

updateImageWidgetTitle

• updateImageWidgetTitle(): void

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

  ---

  Returns void

updateRenderConfigSettingsVisibility

• updateRenderConfigSettingsVisibility(): void

• Hides the settings buttons of docked render config widgets when color blending images are active.

  ---

  Returns void

publicstaticResetWidgetPlotXYBounds

• ResetWidgetPlotXYBounds(storeMap: Map<string, HistogramWidgetStore | SpatialProfileWidgetStore | SpectralProfileWidgetStore | StokesAnalysisWidgetStore>, fileId?: number): void

• Parameters

  • storeMap: Map<string, HistogramWidgetStore | SpatialProfileWidgetStore | SpectralProfileWidgetStore | StokesAnalysisWidgetStore>

  • fileId: number = ACTIVE_FILE_ID

  Returns void