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.addCustomColorLegendForScalarMapperfunction.
Constructors
-
cee.ScalarMapperContinuous.constructor() - ScalarMapperContinuous():
ScalarMapperContinuousReturns:
ScalarMapperContinuous
Accessors
-
cee.ScalarMapperContinuous.aboveRangeColor() inherited
get aboveRangeColor():Color4LikeThe 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.
Returns:
Color4Likeset aboveRangeColor(color:Color4Like): voidParameters
color:Color4LikeReturns: void
-
cee.ScalarMapperContinuous.belowRangeColor() inherited
get belowRangeColor():Color4LikeThe color to assign values that are below the given range.
Default is null, which indicates that the first color in the color array will be used.
Returns:
Color4Likeset belowRangeColor(color:Color4Like): voidParameters
color:Color4LikeReturns: void
-
cee.ScalarMapperContinuous.logarithmic() - get logarithmic(): boolean
True if the mapper is setup to logarithmic mapping
Returns: boolean
-
cee.ScalarMapperContinuous.rangeMaximum() - get rangeMaximum(): number
The maximum range of the mapper
Returns: number
-
cee.ScalarMapperContinuous.rangeMinimum() - get rangeMinimum(): number
The minimum range of the mapper
Returns: number
-
cee.ScalarMapperContinuous.undefinedColor() inherited
get undefinedColor():Color4LikeThe color used for undefined values.
Returns:
Color4Likeset undefinedColor(color:Color4Like): voidParameters
color:Color4LikeReturns: void
Methods
-
cee.ScalarMapperContinuous.createTexture() - createTexture():
TextureCreates and returns texture for this scalar mapper
Returns:
Texture
-
cee.ScalarMapperContinuous.domainValue() - domainValue(normalizedPosition: number): number
Map normalized value (0 -> 1) into a domain value (range_min -> range_max)
Parameters
normalizedPosition: numberReturns: number
-
cee.ScalarMapperContinuous.mapToColor() - mapToColor(scalarValue: number):
Color4LikeMaps the given domain value to a color using the current range and color array.
Parameters
scalarValue: numberReturns:
Color4Like
-
cee.ScalarMapperContinuous.mapToTextureCoordinate() - mapToTextureCoordinate(scalarValue: number):
Vec2LikeMaps the given domain value to a color using the current range and color array.
Parameters
scalarValue: numberReturns:
Vec2Like
-
cee.ScalarMapperContinuous.normalizedValue() - normalizedValue(domainValue: number): number
Map domain value (range_min -> range_max) into a normalized value (0 -> 1)
Parameters
domainValue: numberReturns: number
-
cee.ScalarMapperContinuous.setColors() - setColors(colors:
Color4Like[]): voidParameters
colors:Color4Like[]Returns: void
-
cee.ScalarMapperContinuous.setColorsAtValues() - setColorsAtValues(colorArr: ArrayLike, valueArr: ArrayLike): void
Parameters
colorArr: ArrayLike
valueArr: ArrayLike
Returns: void
-
cee.ScalarMapperContinuous.setColorsFromColorTable() - setColorsFromColorTable(colorTable:
ColorTable): voidParameters
colorTable:ColorTableReturns: void
-
cee.ScalarMapperContinuous.setRange() - setRange(min: number, max: number): void
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.
Parameters
min: number
max: number
Returns: void
-
cee.ScalarMapperContinuous.setRangeLogarithmic() - setRangeLogarithmic(min: number, max: number): void
Sets a logarithmic range of the mapper.
Parameters
min: number
max: number
Returns: void
-
cee.ScalarMapperContinuous.tickValuesHint() - tickValuesHint(): ArrayLike
Returns: ArrayLike
-
cee.ScalarMapperContinuous.version() - version(): number
Returns: number