Skip to main content
Version: Next

ColorBlendingStore

Configuration of a color blended image.

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

alpha

alpha: number[]

The alpha values of all the layers

contourVisible

contourVisible: boolean = true

The visibility of all the contours.

readonlyfilename

filename: string

The filename of the color blended image.

readonlyid

id: number

The unique identifier of the color blended image.

rasterVisible

rasterVisible: boolean = true

The visibility of the blended raster image.

selectedFrames

selectedFrames: FrameStore[]

The frames from the layers excluding the base layer.

titleCustomText

titleCustomText: string

The custom title shown in the image view overlay.

vectorOverlayVisible

vectorOverlayVisible: boolean = true

The visibility of all the vector overlays.

staticreadonlyColormapSets

ColormapSets: ReadonlyMap<string, ColormapSetConfig> = ...

Available colormap sets used for blending. The keys are the names of the sets, and the values are the configuration of the set.

staticreadonlyDefaultLayerLimit

DefaultLayerLimit: 10 = 10

The default limit for the number of layers during initialization.

Accessors

baseFrame

frames

  • The frames from all the layers.

    Returns FrameStore[]

Methods

addSelectedFrame

  • Adds a layer to the color blended image.

    Parameters

    Returns void

applyColormapSet

  • applyColormapSet(set: string): void

  • Applies the specified colormap set to the layers. Frames with raster scaling matching enabled are skipped.

    • If the colormap set is a single gradient colormap, it interpolates colors along the gradient for each frame.
    • If the colormap set is a collection of multiple colormaps, it interpolates between the indexes and selects a colormap from the collection to match the number of frames.

    Parameters

    • set: string

      The name of the colormap set to apply. Must be a key in the ColorBlendingStore.ColormapSets map.

    Returns void

deleteSelectedFrame

  • deleteSelectedFrame(index: number): void

  • Deletes a layer from the color blended image.

    Parameters

    • index: number

      The layer index excluding the base layer.

    Returns void

setAlpha

  • setAlpha(index: number, alpha: number): void

  • Sets the alpha value of the layer.

    Parameters

    • index: number

      The layer index.

    • alpha: number

      The alpha value.

    Returns void

setSelectedFrame

  • setSelectedFrame(index: number, frame: FrameStore): void

  • Sets the frame used for the layer.

    Parameters

    • index: number

      The layer index excluding the base layer.

    • frame: FrameStore

      The frame used for the layer.

    Returns void

setTitleCustomText

  • setTitleCustomText(text: string): void

  • Sets the custom title shown in the image view overlay.

    Parameters

    • text: string

      The custom text to set.

    Returns void

toggleContourVisible

  • toggleContourVisible(): void

  • Hides or shows all the contours.

    Returns void

toggleRasterVisible

  • toggleRasterVisible(): void

  • Hides or shows the blended raster image.

    Returns void

toggleVectorOverlayVisible

  • toggleVectorOverlayVisible(): void

  • Hides or shows all the vector overlays.

    Returns void