HeatmapColorStop

require(["esri/renderers/support/HeatmapColorStop"], function(HeatmapColorStop) { /* code goes here */ });
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 intensity 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.
NameTypeSummaryClass
Color

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

more details
more detailsHeatmapColorStop
String

The name of the class.

more details
more detailsAccessor
Number

The ratio of a pixel's intensity value to the minPixelIntensity of the renderer.

more details
more detailsHeatmapColorStop

Property Details

Autocasts from Object|Number[]|String

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

declaredClassStringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

ratioNumber

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

Method Overview

NameReturn TypeSummaryClass
HeatmapColorStop

Creates a deep clone of the color stop.

more details
more detailsHeatmapColorStop

Method Details

Creates a deep clone of the color stop.

Returns:
TypeDescription
HeatmapColorStopA deep clone of the object that invoked this method.

API Reference search results

NameTypeModule
Loading...