Skip to main content
Version: 4.1.0

SpectralProfileWidgetStore

Hierarchy

  • RegionWidgetStore
    • SpectralProfileWidgetStore

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new SpectralProfileWidgetStore(coordinate?: string): SpectralProfileWidgetStore
  • Parameters

    • coordinate: string = "z"

    Returns SpectralProfileWidgetStore

Properties

channel

channel: number

channelValueRange

channelValueRange: NumberRange

cursorX

cursorX: number

fileId

fileId: number

readonlyfittingStore

fittingStore: ProfileFittingStore

intensityUnit

intensityUnit: string

isHighlighted

isHighlighted: boolean

isMouseMoveIntoLinePlots

isMouseMoveIntoLinePlots: boolean

isStreamingData

isStreamingData: boolean

keep

keep: boolean

lineColorMap

lineColorMap: Map<LineKey, string>

linePlotInitXYBoundaries

linePlotInitXYBoundaries: { maxXVal: number; maxYVal: number; minXVal: number; minYVal: number }

Type declaration

  • maxXVal: number
  • maxYVal: number
  • minXVal: number
  • minYVal: number

linePlotPointSize

linePlotPointSize: number

lineWidth

lineWidth: number

markerTextVisible

markerTextVisible: boolean

maskRange

maskRange: NumberRange

maxX

maxX: number

maxY

maxY: number

meanRmsVisible

meanRmsVisible: boolean

minX

minX: number

minY

minY: number

momentMask

momentMask: MomentMask

momentRegionId

momentRegionId: number

plotType

plotType: PlotType

primaryLineColor

primaryLineColor: string

readonlyprofileSelectionStore

profileSelectionStore: SpectralProfileSelectionStore

regionIdMap

regionIdMap: Map<number, number>

secondaryAxisCursorInfoVisible

secondaryAxisCursorInfoVisible: boolean

selectedMoments

selectedMoments: Moment[]

selectingMode

selectingMode: MomentSelectingMode

settingsTabId

settingsTabId: SpectralProfilerSettingsTabs

readonlysmoothingStore

smoothingStore: ProfileSmoothingStore

type

type: RegionsType

publicstaticreadonlyPRIMARY_LINE_KEY

PRIMARY_LINE_KEY: Primary = "Primary"

Accessors

effectiveFrame

  • get effectiveFrame(): FrameStore
  • Returns FrameStore

effectiveRegion

  • get effectiveRegion(): RegionStore
  • Returns RegionStore

effectiveRegionId

  • get effectiveRegionId(): number
  • Returns number

effectiveRegionInfo

  • get effectiveRegionInfo(): string
  • Returns string

frameOptions

  • get frameOptions(): IOptionProps[]
  • Returns IOptionProps[]

intensityOptions

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

isAutoScaledX

  • get isAutoScaledX(): boolean
  • Returns boolean

isAutoScaledY

  • get isAutoScaledY(): boolean
  • Returns boolean

isEffectiveFrameEqualToActiveFrame

  • get isEffectiveFrameEqualToActiveFrame(): boolean
  • Returns boolean

isIntensityConvertible

  • get isIntensityConvertible(): boolean
  • Returns boolean

isMomentRegionValid

  • get isMomentRegionValid(): boolean
  • Returns boolean

isSelectingMomentChannelRange

  • get isSelectingMomentChannelRange(): boolean
  • Returns boolean

isSelectingMomentMaskRange

  • get isSelectingMomentMaskRange(): boolean
  • Returns boolean

matchesSelectedRegion

  • get matchesSelectedRegion(): boolean
  • Returns boolean

momentRegionInfo

  • get momentRegionInfo(): string
  • Returns string

momentRegionOptions

  • get momentRegionOptions(): IOptionProps[]
  • Returns IOptionProps[]

plotData

  • get plotData(): MultiPlotData
  • Returns MultiPlotData

profileNum

  • get profileNum(): number
  • Returns number

selectedRange

  • get selectedRange(): { center: number; isHorizontal: boolean; width: number }
  • Returns { center: number; isHorizontal: boolean; width: number }

    • center: number
    • isHorizontal: boolean
    • width: number

transformedSpectralLines

  • get transformedSpectralLines(): SpectralLine[]
  • Returns SpectralLine[]

yUnit

  • get yUnit(): string
  • Returns string

Methods

addSpectralLines

  • addSpectralLines(spectralLines: SpectralLine[]): void
  • Parameters

    • spectralLines: SpectralLine[]

    Returns void

clearFrameEntry

  • clearFrameEntry(fileId: number): void
  • Parameters

    • fileId: number

    Returns void

clearMomentRangeSelectingMode

  • clearMomentRangeSelectingMode(): void
  • Returns void

clearProfileColors

  • clearProfileColors(): void
  • Returns void

clearRegionMap

  • clearRegionMap(): void
  • Returns void

clearSelectedMoments

  • clearSelectedMoments(): void
  • Returns void

clearSpectralLines

  • clearSpectralLines(): void
  • Returns void

clearXBounds

  • clearXBounds(): void
  • Returns void

clearXYBounds

  • clearXYBounds(): void
  • Returns void

clearYBounds

  • clearYBounds(): void
  • Returns void

deselectMoment

  • deselectMoment(deselected: Moment): void
  • Parameters

    • deselected: Moment

    Returns void

getProfileColor

  • getProfileColor(lineKey: LineKey): string
  • Parameters

    • lineKey: LineKey

    Returns string

publicinit

  • init(widgetSettings: any): void
  • Parameters

    • widgetSettings: any

    Returns void

initXYBoundaries

  • initXYBoundaries(minXVal: number, maxXVal: number, minYVal: number, maxYVal: number): void
  • Parameters

    • minXVal: number
    • maxXVal: number
    • minYVal: number
    • maxYVal: number

    Returns void

isMomentSelected

  • isMomentSelected(momentType: Moment): boolean
  • Parameters

    • momentType: Moment

    Returns boolean

removeMomentByIndex

  • removeMomentByIndex(removeIndex: number): void
  • Parameters

    • removeIndex: number

    Returns void

removeProfileColor

  • removeProfileColor(lineKey: LineKey): void
  • Parameters

    • lineKey: LineKey

    Returns void

requestMoment

  • requestMoment(): void
  • Returns void

requestingMomentCancelled

  • requestingMomentCancelled(): void
  • Returns void

publicselectFrame

  • selectFrame(fileId: number): void
  • Parameters

    • fileId: number

    Returns void

selectMoment

  • selectMoment(selected: Moment): void
  • Parameters

    • selected: Moment

    Returns void

selectMomentRegion

  • selectMomentRegion(regionId: number): void
  • Parameters

    • regionId: number

    Returns void

setChannel

  • setChannel(channel: number): void
  • Parameters

    • channel: number

    Returns void

setCursor

  • setCursor(cursorVal: number): void
  • Parameters

    • cursorVal: number

    Returns void

setFileId

  • setFileId(fileId: number): void
  • Parameters

    • fileId: number

    Returns void

setHighlighted

  • setHighlighted(isHighlighted: boolean): void
  • Parameters

    • isHighlighted: boolean

    Returns void

setKeep

  • setKeep(bool: boolean): void
  • Parameters

    • bool: boolean

    Returns void

setLinePlotPointSize

  • setLinePlotPointSize(val: number): void
  • Parameters

    • val: number

    Returns void

setLineWidth

  • setLineWidth(val: number): void
  • Parameters

    • val: number

    Returns void

setMarkerTextVisible

  • setMarkerTextVisible(val: boolean): void
  • Parameters

    • val: boolean

    Returns void

setMeanRmsVisible

  • setMeanRmsVisible(val: boolean): void
  • Parameters

    • val: boolean

    Returns void

setMomentMask

  • setMomentMask(momentMask: MomentMask): void
  • Parameters

    • momentMask: MomentMask

    Returns void

setMomentRangeSelectingMode

  • setMomentRangeSelectingMode(mode: MomentSelectingMode): void
  • Parameters

    • mode: MomentSelectingMode

    Returns void

setMouseMoveIntoLinePlots

  • setMouseMoveIntoLinePlots(val: boolean): void
  • Parameters

    • val: boolean

    Returns void

setMultiProfileIntensityUnit

  • setMultiProfileIntensityUnit(intensityUnitStr: string): void
  • Parameters

    • intensityUnitStr: string

    Returns void

setPlotType

  • setPlotType(val: PlotType): void
  • Parameters

    • val: PlotType

    Returns void

setProfileColor

  • setProfileColor(lineKey: LineKey, color: string): void
  • Parameters

    • lineKey: LineKey
    • color: string

    Returns void

setRegionId

  • setRegionId(fileId: number, regionId: number): void
  • Parameters

    • fileId: number
    • regionId: number

    Returns void

setSecondaryAxisCursorInfoVisible

  • setSecondaryAxisCursorInfoVisible(val: boolean): void
  • Parameters

    • val: boolean

    Returns void

setSelectedChannelRange

  • setSelectedChannelRange(min: number, max: number): void
  • Parameters

    • min: number
    • max: number

    Returns void

setSelectedMaskRange

  • setSelectedMaskRange(min: number, max: number): void
  • Parameters

    • min: number
    • max: number

    Returns void

setSettingsTabId

  • setSettingsTabId(tabId: SpectralProfilerSettingsTabs): void
  • Parameters

    • tabId: SpectralProfilerSettingsTabs

    Returns void

setSpectralCoordinate

  • setSpectralCoordinate(coordStr: string): void
  • Parameters

    • coordStr: string

    Returns void

setSpectralCoordinateSecondary

  • setSpectralCoordinateSecondary(coordStr: string): void
  • Parameters

    • coordStr: string

    Returns void

setSpectralSystem

  • setSpectralSystem(specsys: SpectralSystem): void
  • Parameters

    • specsys: SpectralSystem

    Returns void

setXBounds

  • setXBounds(minVal: number, maxVal: number): void
  • Parameters

    • minVal: number
    • maxVal: number

    Returns void

setXYBounds

  • setXYBounds(minX: number, maxX: number, minY: number, maxY: number): void
  • Parameters

    • minX: number
    • maxX: number
    • minY: number
    • maxY: number

    Returns void

setYBounds

  • setYBounds(minVal: number, maxVal: number): void
  • Parameters

    • minVal: number
    • maxVal: number

    Returns void

publictoConfig

  • toConfig(): { linePlotPointSize: number; lineWidth: number; maxXVal: number; maxYVal: number; meanRmsVisible: boolean; minXVal: number; minYVal: number; plotType: PlotType; primaryLineColor: string }
  • Returns { linePlotPointSize: number; lineWidth: number; maxXVal: number; maxYVal: number; meanRmsVisible: boolean; minXVal: number; minYVal: number; plotType: PlotType; primaryLineColor: string }

    • linePlotPointSize: number
    • lineWidth: number
    • maxXVal: number
    • maxYVal: number
    • meanRmsVisible: boolean
    • minXVal: number
    • minYVal: number
    • plotType: PlotType
    • primaryLineColor: string

updateStreamingDataStatus

  • updateStreamingDataStatus(val: boolean): void
  • Parameters

    • val: boolean

    Returns void

publicstaticCalculateRequirementsArray

  • CalculateRequirementsArray(widgetsMap: Map<string, RegionWidgetStore>): Map<number, number[]>
  • Parameters

    • widgetsMap: Map<string, RegionWidgetStore>

    Returns Map<number, number[]>

publicstaticCalculateRequirementsMap

  • CalculateRequirementsMap(widgetsMap: Map<string, SpectralProfileWidgetStore>): Map<number, Map<number, SetSpectralRequirements>>
  • Parameters

    • widgetsMap: Map<string, SpectralProfileWidgetStore>

    Returns Map<number, Map<number, SetSpectralRequirements>>

publicstaticDiffSpectralRequirements

  • DiffSpectralRequirements(originalRequirements: Map<number, Map<number, SetSpectralRequirements>>, updatedRequirements: Map<number, Map<number, SetSpectralRequirements>>): SetSpectralRequirements[]
  • Parameters

    • originalRequirements: Map<number, Map<number, SetSpectralRequirements>>
    • updatedRequirements: Map<number, Map<number, SetSpectralRequirements>>

    Returns SetSpectralRequirements[]