ColormapInfo
require(["esri/renderers/support/ColormapInfo"], function(ColormapInfo) { /* code goes here */ });esri/renderers/support/ColormapInfoThe ColormapInfo describes pixel value, RGB colors and labels to color the raster. It is used with RasterColormapRenderer to color pixels in ImageryLayer and ImageryTileLayer.
Constructors
- new ColormapInfo(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| Color | The color of a given pixel. more details | more details | ColormapInfo | |
| String | The name of the class. more details | more details | Accessor | |
| String | The label for a given pixel value and color mapping. more details | more details | ColormapInfo | |
| Number | The raster pixel value. more details | more details | ColormapInfo |
Property Details
The color of a given pixel. This can be autocast with an array of rgb(a) values, named string, hex string or an hsl(a) string, an object with
r,g,b, andaproperties, or a Color object.
The name of the class. The declared class name is formatted as
esri.folder.className.
- label String
The label for a given pixel value and color mapping.
- value Number
The raster pixel value.
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. more details | more details | ColormapInfo | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | ColormapInfo |
Method Details
- fromJSON(json){*}static
Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input
jsonparameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.Parameter:json ObjectA JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
Returns:Type Description * Returns a new instance of this class.
- toJSON(){Object}
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.