Skip to main content
Version: 4.1.0

WidgetsStore

Index

Properties

Accessors

Methods

Properties

publicreadonlyCARTAWidgets

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

animatorWidgets

animatorWidgets: Map<string, EmptyWidgetStore>

catalogPlotWidgets

catalogPlotWidgets: Map<string, CatalogPlotWidgetStore>

catalogWidgets

catalogWidgets: Map<string, CatalogWidgetStore>

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

isSpectralWidgetStreamingData

  • get isSpectralWidgetStreamingData(): boolean
  • Returns boolean

spectralProfilerList

  • get spectralProfilerList(): string[]
  • Returns string[]

staticInstance

  • get Instance(): WidgetsStore
  • Returns WidgetsStore

Methods

addAnimatorWidget

  • addAnimatorWidget(id?: string): string
  • Parameters

    • id: string = null

    Returns string

addCatalogPlotWidget

  • addCatalogPlotWidget(props: CatalogPlotWidgetStoreProps, id?: string): string
  • Parameters

    • props: CatalogPlotWidgetStoreProps
    • id: string = null

    Returns string

addCatalogWidget

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

    • catalogFileId: number
    • id: string = null
    • widgetSettings: object = null

    Returns string

addCursorInfoWidget

  • addCursorInfoWidget(id?: string): string
  • Parameters

    • id: string = null

    Returns string

addFloatingSettingsWidget

  • addFloatingSettingsWidget(id?: string, parentId: string, type: string): string
  • Parameters

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

    Returns string

addFloatingWidget

  • addFloatingWidget(widget: WidgetConfig): void
  • Parameters

    • widget: WidgetConfig

    Returns void

addHistogramWidget

  • addHistogramWidget(id?: string, widgetSettings?: object): string
  • Parameters

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

    Returns string

addLayerListWidget

  • addLayerListWidget(id?: string): string
  • Parameters

    • id: string = null

    Returns string

addLogWidget

  • addLogWidget(id?: string): string
  • Parameters

    • id: string = null

    Returns string

addPvGeneratorWidget

  • addPvGeneratorWidget(id?: string): string
  • Parameters

    • id: string = null

    Returns string

addRegionListWidget

  • addRegionListWidget(id?: string): string
  • Parameters

    • id: string = null

    Returns string

addRenderConfigWidget

  • addRenderConfigWidget(id?: string, widgetSettings?: object): string
  • Parameters

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

    Returns string

addSpatialProfileWidget

  • addSpatialProfileWidget(id?: string, widgetSettings?: object): string
  • Parameters

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

    Returns string

addSpectralLineQueryWidget

  • addSpectralLineQueryWidget(id?: string): string
  • Parameters

    • id: string = null

    Returns string

addSpectralProfileWidget

  • addSpectralProfileWidget(id?: string, widgetSettings?: object): string
  • Parameters

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

    Returns string

addStatsWidget

  • addStatsWidget(id?: string): string
  • Parameters

    • id: string = null

    Returns string

addStokesWidget

  • addStokesWidget(id?: string, widgetSettings?: object): string
  • Parameters

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

    Returns string

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 }
  • Parameters

    • props: CatalogPlotWidgetStoreProps

    Returns { widgetComponentId: string; widgetStoreId: string }

    • widgetComponentId: string
    • widgetStoreId: string

createFloatingCatalogWidget

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

    • catalogFileId: number

    Returns { widgetComponentId: string; widgetStoreId: string }

    • widgetComponentId: string
    • widgetStoreId: string

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

    • id: string

    Returns SpectralProfileWidgetStore

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

onCogPinedClick

  • onCogPinedClick(item: ContentItem): void
  • Parameters

    • item: ContentItem

    Returns void

onHelpPinedClick

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

    • ev: ClickEvent<HTMLElement, any, any, any>
    • 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): any
  • Parameters

    • widgetType: string
    • widgetID: string

    Returns any

unpinWidget

  • unpinWidget(item: ContentItem): void
  • Parameters

    • item: ContentItem

    Returns void

updateImagePanelPageButtons

  • updateImagePanelPageButtons(): void
  • Returns void

updateImageWidgetTitle

  • updateImageWidgetTitle(layout: GoldenLayout): void
  • Parameters

    • layout: GoldenLayout

    Returns void

updateSelectFloatingWidgetzIndex

  • updateSelectFloatingWidgetzIndex(id: string): void
  • Parameters

    • id: string

    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