ProtecteddisposedThe object has already been disposed.
ProtectedrenderedKey name.
Listener.
Type.
Listener.
ProtectedapplyProtected
Apply any properties from another object without triggering events.
The source object.
This will clear the renderer so that a new one can be created next time it is needed
ProtectedcreateProtected
Create a renderer for this layer.
A layer renderer.
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.
ProtecteddisposeProtected
Extension point for disposable objects.
Get the attributions of the source of this layer for the given view.
Optionalview: OlView | ViewStateLayerStateExtent
View or import("../Map.js").FrameState. Only required when the layer is not added to a map.
Attributions for this layer at the given view.
Get the background for this layer.
Layer background.
CSS class name.
Pixel.
Pixel data.
Declutter
Pixel.
Promise that resolves with an array of features.
AbstractgetThis 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.
Optionalmanaged: boolean
Layer is managed.
Layer state.
AbstractgetOptionalstates: State[]
Optional list of layer states (to be modified in place).
List of layer states.
Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.
Type.
Listeners.
Render buffer.
Get the renderer for this layer.
The layer renderer.
Render order.
The source being rendered.
AbstractgetSource state.
Whether the rendered layer should be updated while animating.
Whether the rendered layer should be updated while interacting.
Optionaltype: string
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.
The layer is visible on the map view, i.e. within its min/max resolution or zoom and
extent, not set to visible: false, and not inside a layer group that is set
to visible: false.
Optionalview: OlView | ViewStateLayerStateExtent
View or import("../Map.js").FrameState. Only required when the layer is not added to a map.
The layer is visible in the map view.
Key name.
Old value.
ProtectedonceProtectedonKey name.
Listener.
Type.
Listener.
In charge to manage the rendering of the layer. One layer type is bounded with one layer renderer.
Frame state.
Target which the renderer may (but need not) use for rendering its content.
The rendered element.
Frame state.
Layer state.
When the renderer follows a layout -> render approach, do the final rendering here.
Frame state
Sets the background color.
Optionalbackground: BackgroundColor
Background color.
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. 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~Map#addLayer instead.
Map.
Render order.
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 set to null, the layer has no style (a null style),
so only features that have their own styles will be rendered in the layer. Call
setStyle() without arguments to reset to the default style. See
[the ol/style/Style module]:ol/style/Style~Style for information on the default style.
If your layer has a static style, you can use [flat style]:ol/style/flat~FlatStyle object
literals instead of using the Style and symbolizer constructors (Fill, Stroke, etc.):
vectorLayer.setStyle({
"fill-color": "yellow",
"stroke-color": "black",
"stroke-width": 4
})
Optionalstyle: StyleLike | FlatStyleLike | null
Layer style.
ProtectedunProtected
Unlisten for a certain type of event.
Type.
Listener.
Called when a layer is not visible during a map render.
Classdesc
Vector data is rendered client-side, as vectors. This layer type provides most accurate rendering even during animations. Points and labels stay upright on rotated views. For very large amounts of vector data, performance may suffer during pan and zoom animations. In this case, try :ol/layer/VectorImage~VectorImageLayer.
Note that any property set in the options is set as a :ol/Object~BaseObject property on the layer object; for example, setting
title: 'My Title'in the options means thattitleis observable, and has get/set accessors.Api