Type.
Listener.
Increases the revision counter and dispatches a 'change' event.
a half length of a square's side.
an extent.
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.
Event object.
false if anyone called preventDefault on the
event object or if any of the listeners returned false.
Clean up.
Gets a value.
Key name.
Value.
CSS class name.
Return the {@link module:ol/extent~Extent extent} of the layer or undefined if it
will be visible regardless of extent.
The layer extent.
Pixel.
Promise that resolves with an array of features.
Get a list of object property names.
List of property names.
This method is not meant to be called by layers or layer renderers because the state is incorrect if the layer is included in a layer group.
Layer is managed.
Layer state.
Opacity, the value is rounded to two digits to appear after the decimal point.
Optional list of layer states (to be modified in place).
List of layer states.
Array of layers (to be modified in place).
Array of layers.
Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.
Type.
Listeners.
Return the maximum resolution of the layer.
The maximum resolution of the layer.
Return the maximum zoom level of the layer.
The maximum zoom level of the layer.
Return the minimum resolution of the layer.
The minimum resolution of the layer.
Return the minimum zoom level of the layer.
The minimum zoom level of the layer.
Return the opacity of the layer (between 0 and 1).
The opacity of the layer.
Get an object of all property names and values.
Object.
Get the renderer for this layer.
The layer renderer.
Get the version number for this object. Each time the object is modified, its version number will be incremented.
Revision.
Get the layer source.
The layer source (or null if not yet set).
Source state.
Return the visibility of the layer (true or false).
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.
The Z-index of the layer.
Type. If not provided,
true will be returned if this event target has any listeners.
Has listeners.
The object has properties.
The layer has a renderer.
Key name.
Old value.
Listen for a certain type of event.
The event type or array of event types.
The listener function.
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.
Listen once for a certain type of event.
The event type or array of event types.
The listener function.
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.
Type.
Listener.
Sets a value.
Key name.
Value.
Update without triggering an event.
Set the extent at which the layer is visible. If undefined, the layer
will be visible at all extents.
The extent of the layer.
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
{@link module: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 {@link module:ol/Map#addLayer} instead.
Map.
Set the maximum resolution at which the layer is visible.
The maximum resolution of the layer.
Set the maximum zoom (exclusive) at which the layer is visible. Note that the zoom levels for layer visibility are based on the view zoom level, which may be different from a tile source zoom level.
The maximum zoom of the layer.
Set the minimum resolution at which the layer is visible.
The minimum resolution of the layer.
Set the minimum zoom (inclusive) at which the layer is visible. Note that the zoom levels for layer visibility are based on the view zoom level, which may be different from a tile source zoom level.
The minimum zoom of the layer.
Set the opacity of the layer, allowed values range from 0 to 1.
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).
Values.
Update without triggering an event.
Set the layer source.
The layer source.
Set the visibility of the layer (true or false).
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.
The z-index of the layer.
Unlisten for a certain type of event.
The event type or array of event types.
The listener function.
Unsets a property.
Key name.
Unset without triggering an event.
Generated using TypeDoc