HeatmapColorStop

AMD: require(["esri/renderers/support/HeatmapColorStop"], (HeatmapColorStop) => { /* code goes here */ });
ESM: import HeatmapColorStop from "@arcgis/core/renderers/support/HeatmapColorStop.js";
Class: esri/renderers/support/HeatmapColorStop
Inheritance: HeatmapColorStop Accessor
Since: ArcGIS Maps SDK for JavaScript 4.8

This class is used to define an array of objects describing the HeatmapRenderer's color ramp and associated density value ratios. See HeatmapRenderer for examples of how this is used.

See also

Constructors

HeatmapColorStop

Constructor
new HeatmapColorStop(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
Name Type Summary Class

The color to shade a given pixel based on its calculated density ratio.

HeatmapColorStop

The name of the class.

Accessor

The ratio of a pixel's density value to the maxDensity of the renderer.

HeatmapColorStop

Property Details

color

Property
color Colorautocast
Autocasts from Object|number[]|string

The color to shade a given pixel based on its calculated density ratio.

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

ratio

Property
ratio Number

The ratio of a pixel's density value to the maxDensity of the renderer. The ratio of each pixel is matched to the corresponding color.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor

Creates a deep clone of the color stop.

HeatmapColorStop

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

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(){HeatmapColorStop}

Creates a deep clone of the color stop.

Returns
Type Description
HeatmapColorStop A deep clone of the object that invoked this method.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

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
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

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");

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