colormap

AMD: require(["esri/smartMapping/raster/renderers/colormap"], (rasterColormapCreator) => { /* code goes here */ });
ESM: import * as rasterColormapCreator from "@arcgis/core/smartMapping/raster/renderers/colormap";
Object: esri/smartMapping/raster/renderers/colormap
Since: ArcGIS API for JavaScript 4.20

This object contains helper methods for generating a RasterColormapRenderer for raster layers (i.e. ImageryLayer, ImageryTileLayer).

The createRenderer method in this module generates a renderer that may be applied directly to the input layer.

Method Overview

Name Return Type Summary Object
Promise<RasterColormapResult>more details

Generates a RasterColormapRenderer used to render imagery data.

more detailscolormap

Method Details

createRenderer(params){Promise<RasterColormapResult>}

Generates a RasterColormapRenderer used to render imagery data.

Parameters:
Specification:
params Object

Input parameters for generating a colormap visualization. See the table below for details of each parameter.

Specification:

The input layer for which the renderer is generated.

renderingRule RasterFunction
optional

Specifies the rule for how the requested image should be rendered. When renderingRule is applied, the server returns updated service information that reflects custom processing as defined by the rendering rule. If not provided, the output renderer is created using the layer's renderingRule.

signal AbortSignal
optional

Allows for cancelable requests. If canceled, the promise will be rejected with an error named AbortError. See also AbortController.

Returns:
Type Description
Promise<RasterColormapResult> Resolves to an object containing a RasterColormapRenderer that can be set on the input layer.

Type Definitions

RasterColormapResult

The result object of the createRenderer() method. See the table below for details of each property.

Property:

The colormap renderer to apply to the input layer.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.