Skip To ContentArcGIS for DevelopersSign In Dashboard
require(["esri/renderers/support/ColormapInfo"], function(ColormapInfo) { /* code goes here */ });
Class: esri/renderers/support/ColormapInfo
Inheritance: ColormapInfo Accessor
Since: ArcGIS API for JavaScript 4.16

The 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 Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
Color

The color of a given pixel.

more details
more detailsColormapInfo
String

The name of the class.

more details
more detailsAccessor
String

The label for a given pixel value and color mapping.

more details
more detailsColormapInfo
Number

The raster pixel value.

more details
more detailsColormapInfo

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, and a properties, or a Color object.

declaredClass Stringreadonly inherited

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

NameReturn TypeSummaryClass
*

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 detailsColormapInfo
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
more detailsColormapInfo

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 json parameter 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 Object

A 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:
TypeDescription
*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:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...