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 Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| Color | more details The color to shade a given pixel based on its calculated density ratio. | more details | HeatmapColorStop | |
| String | more details The name of the class. | more details | Accessor | |
| Number | more details The ratio of a pixel's density value to the maxDensity of the renderer. | more details | HeatmapColorStop |
Property Details
-
The color to shade a given pixel based on its calculated density ratio.
-
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
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| HeatmapColorStop | more details Creates a deep clone of the color stop. | more details | HeatmapColorStop | |
| more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor |
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)inheritedSince: 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.