HeatmapColorStop

AMD: require(["esri/renderers/support/HeatmapColorStop"], (HeatmapColorStop) => { /* code goes here */ });
ESM: import HeatmapColorStop from "@arcgis/core/renderers/support/HeatmapColorStop";
Class: esri/renderers/support/HeatmapColorStop
Inheritance: HeatmapColorStop Accessor
Since: ArcGIS API 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

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
Color

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

more details
HeatmapColorStop
String

The name of the class.

more details
Accessor
Number

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

more details
HeatmapColorStop

Property Details

Autocasts from Object|number[]|string

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

declaredClass Stringreadonly inherited

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

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.

more details
Accessor
HeatmapColorStop

Creates a deep clone of the color stop.

more details
HeatmapColorStop
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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(){HeatmapColorStop}

Creates a deep clone of the color stop.

Returns
Type Description
HeatmapColorStop A deep clone of the object that invoked this method.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 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(groupKey)inherited
Since: ArcGIS API for JavaScript 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.