ScalarMapperFilledContoursUniform

class cee.ScalarMapperFilledContoursUniform()

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

Configured by specifying the number of level colors (colorArray) and the range (setRange).

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

Constructors

• constructor

Accessors

• aboveRangeColor

• belowRangeColor

• colorArray

• rangeMaximum

• rangeMinimum

• undefinedColor

Methods

• createTexture

• domainValue

• mapToColor

• mapToTextureCoordinate

• normalizedValue

• setRange

• setRangeLogarithmic

• tickValuesHint

• version

---

Constructors

ScalarMapperFilledContoursUniform.constructor()

Return type:

ScalarMapperFilledContoursUniform

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.colorArray()

The colors to use for the mapper.

Return type:

ArrayLike <Color4Like>

cee.colorArray(colors)

Arguments:

• colors (ArrayLike) – 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

ScalarMapperFilledContoursUniform.createTexture()

Creates and returns texture for this scalar mapper

Return type:

Texture

domainValue

ScalarMapperFilledContoursUniform.domainValue(normalizedPosition)

Arguments:

• normalizedPosition (number) – None

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

Return type:

number

mapToColor

ScalarMapperFilledContoursUniform.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

ScalarMapperFilledContoursUniform.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

ScalarMapperFilledContoursUniform.normalizedValue(domainValue)

Arguments:

• domainValue (number) – None

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

Return type:

number

setRange

ScalarMapperFilledContoursUniform.setRange(min, max)

Arguments:

• min (number) – None

• max (number) – None

Sets the range of the mapper. The mapper will map domain values to colors based on an even distribution between the given min and max values.

Return type:

void

setRangeLogarithmic

ScalarMapperFilledContoursUniform.setRangeLogarithmic(min, max)

Arguments:

• min (number) – None

• max (number) – None

Sets a logarithmic range of the mapper.

Return type:

void

tickValuesHint

ScalarMapperFilledContoursUniform.tickValuesHint()

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

Return type:

ArrayLike <number>

version

ScalarMapperFilledContoursUniform.version()

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

Return type:

number