Skip to main content
Version: 4.1.0

RenderConfigStore

Index

Constructors

constructor

  • new RenderConfigStore(preference: PreferenceStore, frame: FrameStore): RenderConfigStore
  • Parameters

    • preference: PreferenceStore
    • frame: FrameStore

    Returns RenderConfigStore

Properties

alpha

alpha: number

bias

bias: number

channelHistogram

channelHistogram: IHistogram

colorMapIndex

colorMapIndex: number

contrast

contrast: number

cubeHistogram

cubeHistogram: IHistogram

cubeHistogramProgress

cubeHistogramProgress: number

gamma

gamma: number

histChannel

histChannel: number

inverted

inverted: boolean

readonlypreference

preference: PreferenceStore

previewHistogramMax

previewHistogramMax: number

previewHistogramMin

previewHistogramMin: number

scaleMax

scaleMax: number[]

scaleMin

scaleMin: number[]

scaling

scaling: FrameScaling

selectedPercentile

selectedPercentile: number[]

stokesIndex

stokesIndex: number

useCubeHistogram

useCubeHistogram: boolean

useCubeHistogramContours

useCubeHistogramContours: boolean

visible

visible: boolean

staticreadonlyALPHA_MAX

ALPHA_MAX: 1000000 = 1000000

staticreadonlyALPHA_MIN

ALPHA_MIN: 0.1 = 0.1

staticreadonlyBIAS_MAX

BIAS_MAX: 1 = 1

staticreadonlyBIAS_MIN

BIAS_MIN: -1 = -1

staticreadonlyCOLOR_MAPS_ALL

COLOR_MAPS_ALL: string[] = ...

staticreadonlyCOLOR_MAPS_SELECTED

COLOR_MAPS_SELECTED: string[] = ...

staticreadonlyCONTRAST_MAX

CONTRAST_MAX: 2 = 2

staticreadonlyCONTRAST_MIN

CONTRAST_MIN: 0 = 0

staticreadonlyGAMMA_MAX

GAMMA_MAX: 2 = 2

staticreadonlyGAMMA_MIN

GAMMA_MIN: 0.1 = 0.1

staticreadonlyPERCENTILE_RANKS

PERCENTILE_RANKS: number[] = ...

staticreadonlySCALING_TYPES

SCALING_TYPES: Map<FrameScaling, string> = ...

Accessors

colorMap

  • get colorMap(): string
  • Returns string

colorscaleArray

  • get colorscaleArray(): any[]
  • Returns any[]

contourHistogram

  • get contourHistogram(): IHistogram
  • Returns IHistogram

histogram

  • get histogram(): IHistogram
  • Returns IHistogram

histogramMax

  • get histogramMax(): any
  • Returns any

histogramMin

  • get histogramMin(): number
  • Returns number

scaleMaxVal

  • get scaleMaxVal(): number
  • Returns number

scaleMinVal

  • get scaleMinVal(): number
  • Returns number

scalingName

  • get scalingName(): string
  • Returns string

selectedPercentileVal

  • get selectedPercentileVal(): number
  • Returns number

Methods

resetBias

  • resetBias(): void
  • Returns void

resetContrast

  • resetContrast(): void
  • Returns void

setAlpha

  • setAlpha(alpha: number): void
  • Parameters

    • alpha: number

    Returns void

setBias

  • setBias(bias: number): void
  • Parameters

    • bias: number

    Returns void

setColorMap

  • setColorMap(colormap: string): void
  • Parameters

    • colormap: string

    Returns void

setColorMapIndex

  • setColorMapIndex(index: number): void
  • Parameters

    • index: number

    Returns void

setContrast

  • setContrast(contrast: number): void
  • Parameters

    • contrast: number

    Returns void

setCustomScale

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

    • minVal: number
    • maxVal: number

    Returns void

setGamma

  • setGamma(gamma: number): void
  • Parameters

    • gamma: number

    Returns void

setHistChannel

  • setHistChannel(val: number): void
  • Parameters

    • val: number

    Returns void

setInverted

  • setInverted(inverted: boolean): void
  • Parameters

    • inverted: boolean

    Returns void

setPercentileRank

  • setPercentileRank(rank: number): boolean
  • Parameters

    • rank: number

    Returns boolean

setPreviewHistogramMax

  • setPreviewHistogramMax(histogramMax: number): void
  • Parameters

    • histogramMax: number

    Returns void

setPreviewHistogramMin

  • setPreviewHistogramMin(histogramMin: number): void
  • Parameters

    • histogramMin: number

    Returns void

setScaling

  • setScaling(newScaling: FrameScaling): void
  • Parameters

    • newScaling: FrameScaling

    Returns void

setStokesIndex

  • setStokesIndex(val: number): void
  • Parameters

    • val: number

    Returns void

setUseCubeHistogram

  • setUseCubeHistogram(val: boolean): void
  • Parameters

    • val: boolean

    Returns void

setUseCubeHistogramContours

  • setUseCubeHistogramContours(val: boolean): void
  • Parameters

    • val: boolean

    Returns void

setVisible

  • setVisible(visible: boolean): void
  • Parameters

    • visible: boolean

    Returns void

toggleVisibility

  • toggleVisibility(): void
  • Returns void

updateChannelHistogram

  • updateChannelHistogram(histogram: IHistogram): void
  • Parameters

    • histogram: IHistogram

    Returns void

updateCubeHistogram

  • updateCubeHistogram(histogram: IHistogram, progress: number): void
  • Parameters

    • histogram: IHistogram
    • progress: number

    Returns void

updateFrom

  • updateFrom(other: RenderConfigStore): void
  • Parameters

    • other: RenderConfigStore

    Returns void

updateFromWorkspace

  • updateFromWorkspace(config: WorkspaceRenderConfig): void
  • Parameters

    • config: WorkspaceRenderConfig

    Returns void

updateSiblings

  • updateSiblings(): void
  • Returns void

publicstaticIsColormapValid

  • IsColormapValid(colormap: string): boolean
  • Parameters

    • colormap: string

    Returns boolean

publicstaticIsGammaValid

  • IsGammaValid(gamma: number): boolean
  • Parameters

    • gamma: number

    Returns boolean

publicstaticIsPercentileValid

  • IsPercentileValid(percentile: number): boolean
  • Parameters

    • percentile: number

    Returns boolean

publicstaticIsScalingValid

  • IsScalingValid(scaling: FrameScaling): boolean
  • Parameters

    • scaling: FrameScaling

    Returns boolean