Skip to main content
Version: Next

ChannelMapStore

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

channelMapEnabled

channelMapEnabled: boolean = false

Indicates whether the channel map mode is enabled.

color

color: string = ChannelMapStore.DefaultLabelColor

The custom color used for rendering the channel map label.

customColor

customColor: boolean = false

Indicates whether to use a custom color for rendering the channel map label.

font

font: number = 0

Font index used for rendering the channel map label.

fontSize

fontSize: number = 12

Font size in pixels used for rendering the channel map label.

numColumns

numColumns: number = 2

The number of columns in the image view.

numRows

numRows: number = 2

The number of rows in the image view.

pixelHighlightValue

pixelHighlightValue: number = NaN

The threshold value below which pixels are displayed in grayscale.

showChannelString

showChannelString: boolean = false

Indicates whether to show the channel string.

showSpectralString

showSpectralString: boolean = false

Indicates whether to show the spectral string.

showSpectralStringUnit

showSpectralStringUnit: boolean = true

Indicates whether to show the unit of the spectral string.

showVelocityString

showVelocityString: boolean = false

Indicates whether to show the velocity string.

showVelocityStringUnit

showVelocityStringUnit: boolean = true

Indicates whether to show the unit of the velocity string.

startChannel

startChannel: number = 0

The first channel at the top-left corner.

staticreadonlyDefaultLabelColor

DefaultLabelColor: auto-light_gray = "auto-light_gray"

The default color used for rendering the channel map label.

Accessors

channelArray

  • get channelArray(): number[]

  • The displayed channels in the image view.

    Returns number[]

displayedFrame

  • The frame of the displayed image in the image view.

    Returns FrameStore

displayedImage

endChannel

  • get endChannel(): number

  • The last channel in the image view.

    Returns number

numChannels

  • get numChannels(): number

  • The number of panels in the image view.

    Returns number

totalChannelNum

  • get totalChannelNum(): number

  • The number of channels of the displayed image. Returns 1 if the information is unavailable.

    Returns number

staticInstance

Methods

handlePolarizationChanged

  • handlePolarizationChanged(frame: FrameStore): void

  • Clears the cache and requests new tiles when the polarization changes.

    Parameters

    Returns void

setChannelMapEnabled

  • setChannelMapEnabled(enabled: boolean): void

  • Enables or disables the channel map mode.

    Parameters

    • enabled: boolean

      Whether to enable the channel map mode.

    Returns void

setColor

  • setColor(color: string): void

  • Sets the color used for rendering the channel map label.

    Parameters

    • color: string

      The custom color.

    Returns void

setCustomColor

  • setCustomColor(customColor: boolean): void

  • Sets whether to use a custom color for rendering the channel map label.

    Parameters

    • customColor: boolean

      True to use a custom color, false to use the default color.

    Returns void

setFont

  • setFont(font: number): void

  • Sets the font index used for rendering the channel map label.

    Parameters

    • font: number

      Font index.

    Returns void

setFontSize

  • setFontSize(fontSize: number): void

  • Sets the font size in pixels used for rendering the channel map label.

    Parameters

    • fontSize: number

      Font size in pixels.

    Returns void

setNextChannel

  • setNextChannel(): void

  • Sets the first channel at the top-left corner to the next channel.

    Returns void

setNextPage

  • setNextPage(): void

  • Moves to the next page of channels.

    Returns void

setNumColumns

  • setNumColumns(numColumns: number): void

  • Sets the number of columns in the image view.

    Parameters

    • numColumns: number

      The number of columns in the image view.

    Returns void

setNumRows

  • setNumRows(numRows: number): void

  • Sets the number of rows in the image view.

    Parameters

    • numRows: number

      The number of rows in the image view.

    Returns void

setPixelHighlightValue

  • setPixelHighlightValue(val: number): void

  • Sets the threshold value below which pixels are displayed in grayscale.

    Parameters

    • val: number

      Threshold value.

    Returns void

setPrevChannel

  • setPrevChannel(): void

  • Sets the first channel at the top-left corner to the previous channel.

    Returns void

setPrevPage

  • setPrevPage(): void

  • Moves to the previous page of channels.

    Returns void

setShowChannelString

  • setShowChannelString(show: boolean): void

  • Show or hide the channel string.

    Parameters

    • show: boolean

      True to show, false to hide.

    Returns void

setShowSpectralString

  • setShowSpectralString(show: boolean): void

  • Show or hide the spectral string.

    Parameters

    • show: boolean

      True to show, false to hide.

    Returns void

setShowSpectralStringUnit

  • setShowSpectralStringUnit(show: boolean): void

  • Show or hide the unit of the spectral string.

    Parameters

    • show: boolean

      True to show, false to hide.

    Returns void

setShowVelocityString

  • setShowVelocityString(show: boolean): void

  • Show or hide the velocity string.

    Parameters

    • show: boolean

      True to show, false to hide.

    Returns void

setShowVelocityStringUnit

  • setShowVelocityStringUnit(show: boolean): void

  • Show or hide the unit of the velocity string.

    Parameters

    • show: boolean

      True to show, false to hide.

    Returns void

setStartChannel

  • setStartChannel(startChannel: number): void

  • Sets the first channel at the top-left corner. Skips when the channel is out of range.

    Parameters

    • startChannel: number

      The first channel at the top-left corner.

    Returns void