new ol.layer.Heatmap(opt_options)
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Options.
|
||||||||||||||||||||||||||||||||||||||||
Fires:
-
change(ol.events.Event) - Generic change event. Triggered when the revision counter is increased. -
change:blur(ol.Object.Event) -
change:extent(ol.Object.Event) -
change:gradient(ol.Object.Event) -
change:maxResolution(ol.Object.Event) -
change:minResolution(ol.Object.Event) -
change:opacity(ol.Object.Event) -
change:radius(ol.Object.Event) -
change:source(ol.Object.Event) -
change:visible(ol.Object.Event) -
change:zIndex(ol.Object.Event) -
postcompose(ol.render.Event) -
precompose(ol.render.Event) -
propertychange(ol.Object.Event) - Triggered when a property is changed. -
render(ol.render.Event)
Extends
Observable Properties
| Name | Type | Settable | ol.Object.Event 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 |
visible |
boolean | yes | change:visible |
The visibility of the layer. |
zIndex |
number | yes | change:zindex |
The Z-index of the layer. |
Methods
-
Increases the revision counter and dispatches a 'change' event.
-
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
typeproperty.Name Type Description eventObject | ol.events.Event | string Event object.
-
Gets a value.
Name Type Description keystring Key name.
Returns:
Value.
-
getBlur(){number}
src/ol/layer/heatmap.js, line 180 -
Return the blur size in pixels.
Returns:
Blur size in pixels.
-
Return the
extentof the layer orundefinedif it will be visible regardless of extent.Returns:
The layer extent.
-
getGradient(){Array.<string>}
src/ol/layer/heatmap.js, line 191 -
Return the gradient colors as array of strings.
Returns:
Colors.
-
Get a list of object property names.
Returns:
List of property names.
-
Return the maximum resolution of the layer.
Returns:
The maximum resolution of the layer.
-
Return the minimum resolution of the layer.
Returns:
The minimum resolution of the layer.
-
Return the opacity of the layer (between 0 and 1).
Returns:
The opacity of the layer.
-
Get an object of all property names and values.
Returns:
Object.
-
getRadius(){number}
src/ol/layer/heatmap.js, line 203 -
Return the size of the radius in pixels.
Returns:
Radius size in pixel.
-
Get the version number for this object. Each time the object is modified, its version number will be incremented.
Returns:
Revision.
-
Return the associated
vectorsourceof the layer.Returns:
Source.
-
getStyle(){ol.style.Style|Array.<ol.style.Style>|ol.StyleFunction} inherited
src/ol/layer/vector.js, line 146 -
Get the style for features. This returns whatever was passed to the
styleoption at construction or to thesetStylemethod.Returns:
Layer style.
-
Get the style function.
Returns:
Layer style function.
-
Return the visibility of the layer (
trueorfalse).Returns:
The visibility of the layer.
-
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 typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object to use as
thisinlistener.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 typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object to use as
thisinlistener.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.
-
Sets a value.
Name Type Description keystring Key name.
value* Value.
silentboolean Update without triggering an event.
-
setBlur(blur)
src/ol/layer/heatmap.js, line 254 -
Set the blur size in pixels.
Name Type Description blurnumber Blur size in pixels.
-
Set the extent at which the layer is visible. If
undefined, the layer will be visible at all extents.Name Type Description extentol.Extent | undefined The extent of the layer.
-
setGradient(colors)
src/ol/layer/heatmap.js, line 265 -
Set the gradient colors as array of strings.
Name Type Description colorsArray.<string> Gradient.
-
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#forEachLayerAtPixelwill receivenullas 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#addLayerinstead.Name Type Description mapol.PluggableMap Map.
-
Set the maximum resolution at which the layer is visible.
Name Type Description maxResolutionnumber The maximum resolution of the layer.
-
Set the minimum resolution at which the layer is visible.
Name Type Description minResolutionnumber The minimum resolution of the layer.
-
Set the opacity of the layer, allowed values range from 0 to 1.
Name Type Description opacitynumber The opacity of the layer.
-
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 valuesObject.<string, *> Values.
silentboolean Update without triggering an event.
-
setRadius(radius)
src/ol/layer/heatmap.js, line 276 -
Set the size of the radius in pixels.
Name Type Description radiusnumber Radius size in pixel.
-
Set the layer source.
Name Type Description sourceol.source.Source The layer source.
-
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
undefinedthe default style is used. If it isnullthe layer has no style (anullstyle), so only features that have their own styles will be rendered in the layer. Seeol.stylefor information on the default style.Name Type Description styleol.style.Style | Array.<ol.style.Style> | ol.StyleFunction | null | undefined Layer style.
-
Set the visibility of the layer (
trueorfalse).Name Type Description visibleboolean The visibility of the layer.
-
Set Z-index of the layer, which is used to order layers before rendering. The default Z-index is 0.
Name Type Description zindexnumber The z-index of the layer.
-
Unlisten for a certain type of event.
Name Type Description typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object which was used as
thisby thelistener. -
Unsets a property.
Name Type Description keystring Key name.
silentboolean Unset without triggering an event.
OpenLayers