OpenLayers v10.3.1 API - Class: VectorLayer

new VectorLayer(options) layer/Vector.js, line 74

Name	Type	Description
`className`	string (defaults to 'ol-layer')	A CSS class name to set to the layer element.
`opacity`	number (defaults to 1)	Opacity (0, 1).
`visible`	boolean (defaults to true)	Visibility.
`extent`	Extent \| undefined	The bounding extent for layer rendering. The layer will not be rendered outside of this extent.
`zIndex`	number \| undefined	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 \| undefined	The minimum resolution (inclusive) at which this layer will be visible.
`maxResolution`	number \| undefined	The maximum resolution (exclusive) below which this layer will be visible.
`minZoom`	number \| undefined	The minimum view zoom level (exclusive) above which this layer will be visible.
`maxZoom`	number \| undefined	The maximum view zoom level (inclusive) at which this layer will be visible.
`renderOrder`	OrderFunction \| undefined	Render order. Function to be used when sorting features before rendering. By default features are drawn in the order that they are created. Use `null` to avoid the sort, but get an undefined draw order.
`renderBuffer`	number (defaults to 100)	The buffer in pixels around the viewport extent used by the renderer when getting features from the vector source for the rendering or hit-detection. Recommended value: the size of the largest symbol, line width or label.
`source`	VectorSourceType \| undefined	Source.
`map`	Map \| undefined	Sets the layer as overlay on a map. The map will not manage this layer in its layers collection, and the layer will be rendered on top. This is useful for temporary layers. The standard way to add a layer to a map and have it managed by the map is to use `map.addLayer()`.
`declutter`	boolean \| string \| number (defaults to false)	Declutter images and text. Any truthy value will enable decluttering. Within a layer, a feature rendered before another has higher priority. All layers with the same `declutter` value will be decluttered together. The priority is determined by the drawing order of the layers with the same `declutter` value. Higher in the layer stack means higher priority. To declutter distinct layers or groups of layers separately, use different truthy values for `declutter`.
`style`	StyleLike \| FlatStyleLike \| null \| undefined	Layer style. When set to `null`, only features that have their own style will be rendered. See `Style` for the default style which will be used if this is not set.
`background`	BackgroundColor \| undefined	Background color for the layer. If not specified, no background will be rendered.
`updateWhileAnimating`	boolean (defaults to false)	When set to `true`, feature batches will be recreated during animations. This means that no vectors will be shown clipped, but the setting will have a performance impact for large amounts of vector data. When set to `false`, batches will be recreated when no animation is active.
`updateWhileInteracting`	boolean (defaults to false)	When set to `true`, feature batches will be recreated during interactions. See also `updateWhileAnimating`.
`properties`	Object.<string, *> \| undefined	Arbitrary observable properties. Can be accessed with `#get()` and `#set()`.

Fires:

change (BaseEvent) - Generic change event. Triggered when the revision counter is increased.
change:extent (ObjectEvent)
change:maxResolution (ObjectEvent)
change:maxZoom (ObjectEvent)
change:minResolution (ObjectEvent)
change:minZoom (ObjectEvent)
change:opacity (ObjectEvent)
change:source (ObjectEvent)
change:visible (ObjectEvent)
change:zIndex (ObjectEvent)
error (BaseEvent) - Generic error event. Triggered when an error occurs.
postrender (RenderEvent) - Triggered after a layer is rendered.
prerender (RenderEvent) - Triggered before a layer is rendered.
propertychange (ObjectEvent) - Triggered when a property is changed.
sourceready (BaseEvent)

Subclasses

Graticule

Extends

BaseVectorLayer

Observable Properties

Name	Type	Settable	ObjectEvent type	Description
`extent`	Extent \| undefined	yes	`change:extent`	The layer extent.
`maxResolution`	number	yes	`change:maxresolution`	The maximum resolution of the layer.
`maxZoom`	number	yes	`change:maxzoom`	The maximum zoom level of the layer.
`minResolution`	number	yes	`change:minresolution`	The minimum resolution of the layer.
`minZoom`	number	yes	`change:minzoom`	The minimum zoom level of the layer.
`opacity`	number	yes	`change:opacity`	The opacity of the layer.
`source`	SourceType \| null	yes	`change:source`	The layer source (or `null` if not yet set).
`visible`	boolean	yes	`change:visible`	The value of the `visible` property of the layer.
`zIndex`	number \| undefined	yes	`change:zindex`	The Z-index of the layer.

Methods

changed() inherited Observable.js, line 68

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

dispatchEvent(event){boolean | undefined} inherited events/Target.js, line 85

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`	BaseEvent \| string	Event object.

Returns:

false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited Object.js, line 135

Gets a value.

Name	Type	Description
`key`	string	Key name.

Returns:

Value.

getAttributions(view){Array.<string>} inherited layer/Layer.js, line 344

Get the attributions of the source of this layer for the given view.

Name	Type	Description
`view`	View \| ViewStateLayerStateExtent \| undefined	View or `FrameState`. Only required when the layer is not added to a map.

Returns:

Attributions for this layer at the given view.

getExtent(){Extent | undefined} inherited layer/Base.js, line 207

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

Returns:

The layer extent.

getFeatures(pixel){Promise<Array<FeatureLike>>} inherited layer/BaseVector.js, line 178

Get the topmost feature that intersects the given pixel on the viewport. Returns a promise that resolves with an array of features. The array will either contain the topmost feature when a hit was detected, or it will be empty.

The hit detection algorithm used for this method is optimized for performance, but is less accurate than the one used in map.getFeaturesAtPixel(). Text is not considered, and icons are only represented by their bounding box instead of the exact image.

Name	Type	Description
`pixel`	Pixel	Pixel.

Returns:

Promise that resolves with an array of features.

getKeys(){Array.<string>} inherited Object.js, line 148

Get a list of object property names.

Returns:

List of property names.

getMaxResolution(){number} inherited layer/Base.js, line 220

Return the maximum resolution of the layer. Returns Infinity if the layer has no maximum resolution set.

Returns:

The maximum resolution of the layer.

getMaxZoom(){number} inherited layer/Base.js, line 253

Return the maximum zoom level of the layer. Returns Infinity if the layer has no maximum zoom set.

Returns:

The maximum zoom level of the layer.

getMinResolution(){number} inherited layer/Base.js, line 231

Return the minimum resolution of the layer. Returns 0 if the layer has no minimum resolution set.

Returns:

The minimum resolution of the layer.

getMinZoom(){number} inherited layer/Base.js, line 242

Return the minimum zoom level of the layer. Returns -Infinity if the layer has no minimum zoom set.

Returns:

The minimum zoom level of the layer.

getOpacity(){number} inherited layer/Base.js, line 263

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

Returns:

The opacity of the layer.

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

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited Observable.js, line 79

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

Returns:

Revision.

getSource(){SourceType | null} inherited layer/Layer.js, line 209

Get the layer source.

Returns:

The layer source (or null if not yet set).

getStyle(){StyleLike | FlatStyleLike | null | undefined} inherited layer/BaseVector.js, line 205

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(){StyleFunction | undefined} inherited layer/BaseVector.js, line 214

Get the style function.

Returns:

Layer style function.

getVisible(){boolean} inherited layer/Base.js, line 282

Return the value of this layer's visible property. To find out whether the layer is visible on a map, use isVisible() instead.

Returns:

The value of the visible property of the layer.

getZIndex(){number | undefined} inherited layer/Base.js, line 293

Return the Z-index of the layer, which is used to order layers before rendering. Returns undefined if the layer is unmanaged.

Returns:

The Z-index of the layer.

isVisible(view){boolean} inherited layer/Layer.js, line 300

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.

Name	Type	Description
`view`	View \| ViewStateLayerStateExtent \| undefined	View or `FrameState`. Only required when the layer is not added to a map.

Returns:

The layer is visible in the map view.

on(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 152

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.

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){EventsKey | Array<EventsKey>} inherited Observable.js, line 164

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.

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, silent) inherited Object.js, line 215

Sets a value.

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

setDeclutter(declutter) inherited layer/BaseVector.js, line 289

Name	Type	Description
`declutter`	boolean \| string \| number	Declutter images and text.

setExtent(extent) inherited layer/Base.js, line 313

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

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

setMap(map) inherited layer/Layer.js, line 439

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 addLayer instead.

Name	Type	Description
`map`	Map \| null	Map.

setMaxResolution(maxResolution) inherited layer/Base.js, line 323

Set the maximum resolution at which the layer is visible.

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

setMaxZoom(maxZoom) inherited layer/Base.js, line 345

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.

Name	Type	Description
`maxZoom`	number	The maximum zoom of the layer.

setMinResolution(minResolution) inherited layer/Base.js, line 333

Set the minimum resolution at which the layer is visible.

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

setMinZoom(minZoom) inherited layer/Base.js, line 357

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.

Name	Type	Description
`minZoom`	number	The minimum zoom of the layer.

setOpacity(opacity) inherited layer/Base.js, line 367

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, silent) inherited Object.js, line 235

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 \| undefined	Update without triggering an event.

setSource(source) inherited layer/Layer.js, line 487

Set the layer source.

Name	Type	Description
`source`	SourceType \| null	The layer source.

setStyle(style) inherited layer/BaseVector.js, line 277

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 for information on the default style.

If your layer has a static style, you can use flat style object literals instead of using the Style and symbolizer constructors (Fill, Stroke, etc.):

vectorLayer.setStyle({
  "fill-color": "yellow",
  "stroke-color": "black",
  "stroke-width": 4
})

Name	Type	Description
`style`	StyleLike \| FlatStyleLike \| null \| undefined	Layer style.

setVisible(visible) inherited layer/Base.js, line 378

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

Name	Type	Description
`visible`	boolean	The visibility of the layer.

setZIndex(zindex) inherited layer/Base.js, line 389

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) inherited Observable.js, line 173

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.

unset(key, silent) inherited Object.js, line 259

Unsets a property.

Name	Type	Description
`key`	string	Key name.
`silent`	boolean \| undefined	Unset without triggering an event.