Module: ol/layer/Heatmap




Type Definitions


Name Type Argument Default Description
opacity number <optional>

Opacity (0, 1).

visible boolean <optional>


extent module:ol/extent~Extent <optional>

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

zIndex number <optional>

The z-index for layer rendering. At rendering time, the layers will be ordered, first by Z-index and then by position. When undefined, a zIndex of 0 is assumed for layers that are added to the map's layers collection, or Infinity when the layer's setMap() method was used.

minResolution number <optional>

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

maxResolution number <optional>

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

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

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

radius number <optional>

Radius size in pixels.

blur number <optional>

Blur size in pixels.

shadow number <optional>

Shadow size in pixels.

weight string | function <optional>

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 <optional>

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 <optional>