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
Colormore details

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

more detailsHeatmapColorStop
Stringmore details

The name of the class.

more detailsAccessor
Numbermore details

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

more detailsHeatmapColorStop

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
HeatmapColorStopmore details

Creates a deep clone of the color stop.

more detailsHeatmapColorStop
more details

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

more detailsAccessor

Method Details

clone(){HeatmapColorStop}

Creates a deep clone of the color stop.

Returns:
Type Description
HeatmapColorStop A deep clone of the object that invoked this method.
own(handleOrHandles)inherited
Since: ArcGIS API for JavaScript 4.24

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.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
});

handle.remove();

// Assign a handle using own()
this.own(reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
  }));
Parameter:
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

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