Class: Heatmap


import Heatmap from 'ol/layer/Heatmap';

Layer for rendering vector data as a heatmap. Note that any property set in the options is set as a module:ol/Object~BaseObject property on the layer object; for example, setting title: 'My Title' in the options means that title is observable, and has get/set accessors.

new Heatmap(opt_options)

layer/Heatmap.js, line 72
Name Type Description


Name Type Default Description
opacity number 1

Opacity (0, 1).

visible boolean true


extent module:ol/extent~Extent

The bounding extent for layer rendering. The layer will not be rendered outside of this extent.

zIndex number 0

The z-index for layer rendering. At rendering time, the layers will be ordered, first by Z-index and then by position.

minResolution number

The minimum resolution (inclusive) at which this layer will be visible.

maxResolution number

The maximum resolution (exclusive) below which this layer will be visible.

gradient Array.<string> ['#00f', '#0ff', '#0f0', '#ff0', '#f00']

The color gradient of the heatmap, specified as an array of CSS color strings.

radius number 8

Radius size in pixels.

blur number 15

Blur size in pixels.

shadow number 250

Shadow size in pixels.

weight string | function 'weight'

The feature attribute to use for the weight or a function that returns a weight from a feature. Weight values should range from 0 to 1 (and values outside will be clamped to that range).

renderMode module:ol/layer/VectorRenderType | string 'vector'

Render mode for vector layers:

  • 'image': Vector layers are rendered as images. Great performance, but point symbols and texts are always rotated with the view and pixels are scaled during zoom animations.
  • 'vector': Vector layers are rendered as vectors. Most accurate rendering even during animations, but slower performance.
source module:ol/source/Vector~VectorSource





layer/Heatmap.js, line 194

Return the blur size in pixels.

Blur size in pixels.


layer/Heatmap.js, line 204

Return the gradient colors as array of strings.



layer/Heatmap.js, line 214

Return the size of the radius in pixels.

Radius size in pixel.


layer/Heatmap.js, line 260

Set the blur size in pixels.

Name Type Description
blur number

Blur size in pixels.


layer/Heatmap.js, line 270

Set the gradient colors as array of strings.

Name Type Description
colors Array.<string>



layer/Heatmap.js, line 280

Set the size of the radius in pixels.

Name Type Description
radius number

Radius size in pixel.