Skip To ContentArcGIS for DevelopersSign In Dashboard

RasterColormapRenderer

require(["esri/renderers/RasterColormapRenderer"], function(RasterColormapRenderer) { /* code goes here */ });
Class: esri/renderers/RasterColormapRenderer
Inheritance: RasterColormapRenderer Accessor
Since: ArcGIS API for JavaScript 4.16

The RasterColormapRenderer defines the symbology to display raster data based on specific colors, aiding in visual analysis of the data. For example, a forestry commission may want to quickly visualize areas above and below the treeline occurring at a known elevation on a raster containing elevation values. They could overlay a transparent colormap set to color those areas below the treeline elevation green, and those above white.

The RasterColormapRenderer is only available if a color map is present in an ImageryLayer or ImageryTileLayer. Otherwise, you can use the UniqueValueRenderer to apply colors to your layer.

Constructors

new RasterColormapRenderer(properties)
Parameter:
properties Object
optional

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

Examples:
// create a new RasterColormapRenderer from provided the colormap array
const renderer = RasterColormapRenderer.createFromColormap(colors);
// create a new RasterColormapRenderer
const renderer = new RasterColormapRenderer({
 colormapInfos: colormapInfos
});

Property Overview

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

A colormap info array containing mappings for pixel and RGB color values.

more details
more detailsRasterColormapRenderer
String

The name of the class.

more details
more detailsAccessor
String

The type of Renderer.

more details
more detailsRasterColormapRenderer

Property Details

A colormap info array containing mappings for pixel and RGB color values. Colormaps contain a set of values that are associated with colors and pixel values, and are used to display a single-band raster consistently with the same colors.

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

type Stringreadonly

The type of Renderer.

For RasterColormapRenderer the type is always "raster-colormap".

Method Overview

NameReturn TypeSummaryClass
RasterColormapRenderer

Creates a deep clone of the renderer.

more details
more detailsRasterColormapRenderer
RasterColormapRenderer

Creates a new instance RasterColormapRenderer from an array of color maps where pixel values with its corresponding RGB color values specified.

more details
more detailsRasterColormapRenderer
*

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

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

more details
more detailsRasterColormapRenderer

Method Details

Creates a deep clone of the renderer.

Returns:
TypeDescription
RasterColormapRendererA deep clone of the object that invoked this method.
Example:
// Creates a deep clone of the first layer's renderer
var renderer = view.map.layers.getItemAt(0).renderer.clone();
createFromColormap(colormap){RasterColormapRenderer}static

Creates a new instance RasterColormapRenderer from an array of color maps where pixel values with its corresponding RGB color values specified.

Parameter:
colormap Number[][]

RGB color representation of pixel values. Each item in the colormap array has an array of the pixel value and red, green, and blue values.

Returns:
TypeDescription
RasterColormapRendererReturns a new instance RasterColormapRenderer based on provided colormap.
Example:
// create a color map where values 0-199 are pink and 200-250 are light blue.
var colors = [];
for (var i = 0; i <= 250; i++) {
  if (i < 200) {
    colors.push([i, 250, 0, 128]);
  } else {
    colors.push([i, 0, 128, 250]);
  }
}

// create a RasterColormapRenderer from the colors array
const renderer = RasterColormapRenderer.createFromColormap(colors);
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...