Class: Heatmap

Extends

• ol.layer.Vector

Observable Properties

Name	Type	Settable	ol.ObjectEvent type	Description
blur	number	yes	change:blur	Blur size in pixels.
extent	ol.Extent | undefined	yes	change:extent	The layer extent.
gradient	Array.<string>	yes	change:gradient	Colors.
maxResolution	number	yes	change:maxresolution	The maximum resolution of the layer.
minResolution	number	yes	change:minresolution	The minimum resolution of the layer.
opacity	number	yes	change:opacity	The opacity of the layer.
radius	number	yes	change:radius	Radius size in pixel.
source	ol.source.Source	yes	change:source	The layer source (or null if not yet set).
visible	boolean	yes	change:visible	The visibility of the layer.
zIndex	number	yes	change:zindex	The Z-index of the layer.

Methods

changed() inherited experimental

src/ol/observable.js, line 58

Increases the revision counter and dispatches a 'change' event.

dispatchEvent(event) inherited experimental

src/ol/observable.js, line 75

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name	Type	Description
event	Object | ol.events.Event | string	Event object.

get(key){*} inherited

src/ol/object.js, line 148

Gets a value.

Name	Type	Description
key	string	Key name.

Returns:

Value.

getBlur(){number} experimental

src/ol/layer/heatmap.js, line 188

Return the blur size in pixels.

Returns:

Blur size in pixels.

getExtent(){ol.Extent|undefined} inherited

src/ol/layer/base.js, line 112

Return the extent of the layer or undefined if it will be visible regardless of extent.

Returns:

The layer extent.

getGradient(){Array.<string>} experimental

src/ol/layer/heatmap.js, line 199

Return the gradient colors as array of strings.

Returns:

Colors.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 162

Get a list of object property names.

Returns:

List of property names.

getMaxResolution(){number} inherited

src/ol/layer/base.js, line 124

Return the maximum resolution of the layer.

Returns:

The maximum resolution of the layer.

getMinResolution(){number} inherited

src/ol/layer/base.js, line 136

Return the minimum resolution of the layer.

Returns:

The minimum resolution of the layer.

getOpacity(){number} inherited

src/ol/layer/base.js, line 148

Return the opacity of the layer (between 0 and 1).

Returns:

The opacity of the layer.

getProperties(){Object.<string, *>} inherited

src/ol/object.js, line 172

Get an object of all property names and values.

Returns:

Object.

getRadius(){number} experimental

src/ol/layer/heatmap.js, line 211

Return the size of the radius in pixels.

Returns:

Radius size in pixel.

getRevision(){number} inherited experimental

src/ol/observable.js, line 84

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:

Revision.

getSource(){ol.source.Vector} inherited

src/ol/layer/vector.js, line 113

Return the associated vectorsource of the layer.

Returns:

Source.

getStyle(){ol.style.Style|Array.<ol.style.Style>|ol.StyleFunction} inherited

src/ol/layer/vector.js, line 123

Get the style for features. This returns whatever was passed to the style option at construction or to the setStyle method.

Returns:

Layer style.

getStyleFunction(){ol.StyleFunction|undefined} inherited

src/ol/layer/vector.js, line 133

Get the style function.

Returns:

Layer style function.

getVisible(){boolean} inherited

src/ol/layer/base.js, line 166

Return the visibility of the layer (true or false).

Returns:

The visibility of the layer.

getZIndex(){number} inherited experimental

src/ol/layer/base.js, line 178

Return the Z-index of the layer, which is used to order layers before rendering. The default Z-index is 0.

Returns:

The Z-index of the layer.

on(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 99

Listen for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.
this	Object	The object to use as this in listener.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 124

Listen once for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.
this	Object	The object to use as this in listener.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

set(key, value, opt_silent) inherited

src/ol/object.js, line 197

Sets a value.

Name	Type	Description
key	string	Key name.
value	*	Value.
silent	boolean	Update without triggering an event.

setBlur(blur) experimental

src/ol/layer/heatmap.js, line 265

Set the blur size in pixels.

Name	Type	Description
blur	number	Blur size in pixels.

setExtent(extent) inherited

src/ol/layer/base.js, line 190

Set the extent at which the layer is visible. If undefined, the layer will be visible at all extents.

Name	Type	Description
extent	ol.Extent | undefined	The extent of the layer.

setGradient(colors) experimental

src/ol/layer/heatmap.js, line 276

Set the gradient colors as array of strings.

Name	Type	Description
colors	Array.<string>	Gradient.

setMap(map) inherited experimental

src/ol/layer/layer.js, line 166

Sets the layer to be rendered on top of other layers on a map. The map will not manage this layer in its layers collection, and the callback in ol.Map#forEachLayerAtPixel will receive null as layer. This is useful for temporary layers. To remove an unmanaged layer from the map, use #setMap(null).

To add the layer to a map and have it managed by the map, use ol.Map#addLayer instead.

Name	Type	Description
map	ol.Map	Map.

setMaxResolution(maxResolution) inherited

src/ol/layer/base.js, line 201

Set the maximum resolution at which the layer is visible.

Name	Type	Description
maxResolution	number	The maximum resolution of the layer.

setMinResolution(minResolution) inherited

src/ol/layer/base.js, line 212

Set the minimum resolution at which the layer is visible.

Name	Type	Description
minResolution	number	The minimum resolution of the layer.

setOpacity(opacity) inherited

src/ol/layer/base.js, line 223

Set the opacity of the layer, allowed values range from 0 to 1.

Name	Type	Description
opacity	number	The opacity of the layer.

setProperties(values, opt_silent) inherited

src/ol/object.js, line 217

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name	Type	Description
values	Object.<string, *>	Values.
silent	boolean	Update without triggering an event.

setRadius(radius) experimental

src/ol/layer/heatmap.js, line 287

Set the size of the radius in pixels.

Name	Type	Description
radius	number	Radius size in pixel.

setSource(source) inherited

src/ol/layer/layer.js, line 200

Set the layer source.

Name	Type	Description
source	ol.source.Source	The layer source.

setStyle(style) inherited

src/ol/layer/vector.js, line 180

Set the style for features. This can be a single style object, an array of styles, or a function that takes a feature and resolution and returns an array of styles. If it is undefined the default style is used. If it is null the layer has no style (a null style), so only features that have their own styles will be rendered in the layer. See ol.style for information on the default style.

Name	Type	Description
style	ol.style.Style | Array.<ol.style.Style> | ol.StyleFunction | null | undefined	Layer style.

setVisible(visible) inherited

src/ol/layer/base.js, line 234

Set the visibility of the layer (true or false).

Name	Type	Description
visible	boolean	The visibility of the layer.

setZIndex(zindex) inherited experimental

src/ol/layer/base.js, line 246

Set Z-index of the layer, which is used to order layers before rendering. The default Z-index is 0.

Name	Type	Description
zindex	number	The z-index of the layer.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 147

Unlisten for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.
this	Object	The object which was used as this by the listener.

unByKey(key) inherited

src/ol/observable.js, line 168

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name	Type	Description
key	ol.EventsKey | Array.<ol.EventsKey>	The key returned by on() or once() (or an array of keys).

unset(key, opt_silent) inherited

src/ol/object.js, line 231

Unsets a property.

Name	Type	Description
key	string	Key name.
silent	boolean	Unset without triggering an event.