The HeatmapRenderer renders point data into a raster visualization that emphasizes areas of higher density or weighted values.

Referenced by: renderer

Properties

PropertyDetails
colorStops[]An array of colorStop objects describing the renderer’s color ramp with more specificity than just colors.
fieldThis is optional as this renderer can be created if no field is specified. Each feature gets the same value/importance/weight or with a field where each feature is weighted by the field’s value.
legendOptionsOptions for describing the heatmap in the legend.
See legendOptions properties table.
maxDensityThe density value assigned to the final color in the colorStops.
minDensityThe density value assigned to the first color in the colorStops.
radiusThe radius (in points) of the circle representing each point.
referenceScaleAn optional reference scale to make the heatmap visualization static (i.e. then the heatmap radius is defined as points at this certain view scale). A value of 0 means that the heatmap does not have a fixed reference scale.
typeSpecifies the type of renderer used.
Valid value of this property heatmap

legendOptions properties

PropertyDetails
maxLabelText in the legend that describes the hottest (most dense) part of the heatmap. Only applicable to Heatmap renderers. If not specified, then a localized label, for ‘High’ will display on the legend.
minLabelText in the legend that describes the coldest (least dense) part of the heatmap. Only applicable to Heatmap renderers. If not specified, then a localized label, for ‘Low’ will display on the legend.
titleThe title of the legend.

Example

Heatmap renderer calculated with kernel density.

{
"type": "heatmap",
"radius": 10,
"field": "mag",
"colorStops": [
{
"color": [
63,
40,
102,
0
],
"ratio": 0
},
{
"color": [
71,
43,
119,
77
],
"ratio": 0.083
},
{
"color": [
224,
207,
64,
77
],
"ratio": 0.913
},
{
"color": [
255,
255,
0,
77
],
"ratio": 1
}
],
"maxDensity": 1,
"minDensity": 0,
"referenceScale": 5500500
}