ScalarMapperFilledContours

class cee.ScalarMapperFilledContours()

Maps scalar values to texture coordinates/colors using a filled contours style color map with levels of uniform size.

Configured by specifying the colors and their values with the method setColorsAtValues.

To show a color legend in the view representing this mapper, use the Overlay.addCustomColorLegendForScalarMapper function.

Constructors

constructor

Accessors

aboveRangeColor
belowRangeColor
rangeMaximum
rangeMinimum
undefinedColor

Methods

createTexture
domainValue
mapToColor
mapToTextureCoordinate
normalizedValue
setColorsAtValues
tickValuesHint
version

Constructors

ScalarMapperFilledContours.constructor()

Return type:: ScalarMapperFilledContours

Accessors

cee.aboveRangeColor()

The color to assign values that are above the given range.

Default is undefined, which indicates that the last color in the color array will be used.

Return type:: Color4Like

cee.aboveRangeColor(color)

Arguments:

color (Color4Like) – None

Return type:

void

cee.belowRangeColor()

The color to assign values that are below the given range.

Default is undefined, which indicates that the first color in the color array will be used.

Return type:: Color4Like

cee.belowRangeColor(color)

Arguments:

color (Color4Like) – None

Return type:

void

cee.rangeMaximum()

The maximum range of the mapper

Return type:: number

cee.rangeMinimum()

The minimum range of the mapper

Return type:: number

cee.undefinedColor()

The color used for undefined values.

Default is undefined, which indicates that the last color in the color array will be used.

Return type:: Color4Like

cee.undefinedColor(color)

Arguments:

color (Color4Like) – None

Return type:

void

Methods

createTexture

ScalarMapperFilledContours.createTexture()

Creates and returns texture for this scalar mapper

Return type:: Texture

domainValue

ScalarMapperFilledContours.domainValue(normalizedPosition)

Arguments:

normalizedPosition (number) – None

Map normalized value (0 -> 1) into a domain value (range_min -> range_max)

Return type:: number

mapToColor

ScalarMapperFilledContours.mapToColor(scalarValue)

Arguments:

scalarValue (number) – None

Maps the given domain value to a color using the current range and color array.

Return type:: Color4Like

mapToTextureCoordinate

ScalarMapperFilledContours.mapToTextureCoordinate(scalarValue)

Arguments:

scalarValue (number) – None

Maps the given domain value to a color using the current range and color array.

Return type:: Vec2Like

normalizedValue

ScalarMapperFilledContours.normalizedValue(domainValue)

Arguments:

domainValue (number) – None

Map domain value (range_min -> range_max) into a normalized value (0 -> 1)

Return type:: number

setColorsAtValues

ScalarMapperFilledContours.setColorsAtValues(colorArr, valueArr)

Arguments:

colorArr (ArrayLike) – None
valueArr (ArrayLike) – None

Sets the scalar mapper level colors from an array of colors at the given values

Return type:: void

tickValuesHint

ScalarMapperFilledContours.tickValuesHint()

Returns the suggest tick values (the values of the color changes)

Return type:: ArrayLike <number>

version

ScalarMapperFilledContours.version()

Returns the version of the scalar mapper. Version is increased whenever the mapper is changed.

Return type:: number