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)
-
Parameterproperties 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 | 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
-
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 |
---|---|---|---|
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)inheritedSince: ArcGIS Maps SDK 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 } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
ReturnsType Description HeatmapColorStop A deep clone of the object that invoked this method.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");