RasterPresetRenderer | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Defines a predefined raster renderer associated with an ImageryLayer or ImageryTileLayer. 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

RasterPresetRenderer Constructor new RasterPresetRenderer(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.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Number []	The band ids associated with the raster renderer.	RasterPresetRenderer
String	The name of the class.	Accessor
String	Specifies how to match the renderer.	RasterPresetRenderer
String	The name of the preset renderer.	RasterPresetRenderer
ClassBreaksRenderer\|UniqueValueRenderer\|RasterStretchRenderer\|RasterShadedReliefRenderer\|RasterColormapRenderer\|VectorFieldRenderer\|FlowRenderer	The raster renderer associated with the selected value and method.	RasterPresetRenderer
String	The corresponding value of selected method.	RasterPresetRenderer

Property Details

bandIds Property bandIds Number[]

The band ids associated with the raster renderer.

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

method Property method String

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.

Possible Values:"raster-function-template" |"variable" |"none"

name Property name String

The name of the preset renderer.

The raster renderer associated with the selected value and method.

value Property value String

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

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
this	Creates a deep clone of this object.	RasterPresetRenderer
*	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	RasterPresetRenderer
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	RasterPresetRenderer

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

clone Method clone(){this}

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

Type	Description
this	A deep clone of the class instance that invoked this method.

fromJSON Method fromJSON(json){*}static

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.

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

Type	Description
*	Returns a new instance of this class.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON Method 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.