RasterPresetRenderer | References | ArcGIS Maps SDK for JavaScript

import RasterPresetRenderer from "@arcgis/core/renderers/support/RasterPresetRenderer.js";

Inheritance:: RasterPresetRenderer→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.31

Defines a predefined raster renderer associated with an ImageryLayer.presetRenderers or ImageryTileLayer.presetRenderers. A raster layer may contain a data source of multidimensional data with multiple variables. These different variables often require different types of default symbology, which can be preconfigured individually and saved with the layer. This means you don't have to redefine the symbology each time you select a different variable. The predefined raster renderers can also be used as a general list of renderers available for clients, without a variable or raster function templates.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`RasterPresetRendererProperties`

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`bandIds`	`number[]`
`declaredClass` readonly inherited	`string`	Accessor
`method`	`"raster-function-template" \| "variable" \| "none"`
`name`	`string`
`renderer`	`RasterRendererUnion`
`value`	`string`

bandIds

Property

Type: number[]

The band ids associated with the raster renderer.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

method

Property

Type: "raster-function-template" | "variable" | "none"

Specifies how to match the renderer. The matching method can be based on a variable, a raster function template, or no specific method. Example workflow in a client app: When changing a multidimensional variable, the client can find the corresponding preset renderer with the method "variable" and the value as the variable name, then set it on the layer.

Default value: "none"

name

Property

Type: string

The name of the preset renderer.

renderer

autocast Property

Type: RasterRendererUnion

The raster renderer associated with the selected value and method.

value

Property

Type: string

The corresponding value of selected method. It can be a multidimensional variable name or a raster function template name.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone` inherited	`clone(): this`	ClonableMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. 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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns: this
A deep clone of the class instance that invoked this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.