ScalarMapperContinuous

class cee.ScalarMapperContinuous()

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

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

Constructors


Constructors

constructor

cee.ScalarMapperContinuous.constructor()
Return type

cee.ScalarMapperContinuous

Accessors

cee.ScalarMapperContinuous.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.

cee.ScalarMapperContinuous.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.

cee.ScalarMapperContinuous.logarithmic

True if the mapper is setup to logarithmic mapping

cee.ScalarMapperContinuous.rangeMaximum

The maximum range of the mapper

cee.ScalarMapperContinuous.rangeMinimum

The minimum range of the mapper

cee.ScalarMapperContinuous.undefinedColor

The color used for undefined values.

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

Methods

createTexture

cee.ScalarMapperContinuous.createTexture()

Creates and returns texture for this scalar mapper

Return type

cee.Texture

domainValue

cee.ScalarMapperContinuous.domainValue(normalizedPosition)

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

Arguments
  • normalizedPosition (number) –

Return type

number

mapToColor

cee.ScalarMapperContinuous.mapToColor(scalarValue)

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

Arguments
  • scalarValue (number) –

Return type

cee.Color4Like

mapToTextureCoordinate

cee.ScalarMapperContinuous.mapToTextureCoordinate(scalarValue)

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

Arguments
  • scalarValue (number) –

Return type

cee.Vec2Like

normalizedValue

cee.ScalarMapperContinuous.normalizedValue(domainValue)

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

Arguments
  • domainValue (number) –

Return type

number

setColors

cee.ScalarMapperContinuous.setColors(colors)
Arguments
  • colors ([cee.Color4Like]) –

Return type

void

setColorsAtValues

cee.ScalarMapperContinuous.setColorsAtValues(colorArr, valueArr)
Arguments
  • colorArr (ArrayLike[cee.Color4Like]) –

  • valueArr (ArrayLike[number]) –

Return type

void

setColorsFromColorTable

cee.ScalarMapperContinuous.setColorsFromColorTable(colorTable)
Arguments
  • colorTable (cee.ColorTable) –

Return type

void

setRange

cee.ScalarMapperContinuous.setRange(min, max)

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.

Arguments
  • min (number) –

  • max (number) –

Return type

void

setRangeLogarithmic

cee.ScalarMapperContinuous.setRangeLogarithmic(min, max)

Sets a logarithmic range of the mapper.

Arguments
  • min (number) –

  • max (number) –

Return type

void

tickValuesHint

cee.ScalarMapperContinuous.tickValuesHint()
Return type

ArrayLike[number]

version

cee.ScalarMapperContinuous.version()
Return type

number