OpenLayers v5.3.0 API - Class: VectorLayer

Class: VectorLayer

ol/layer/Vector~VectorLayer

import VectorLayer from 'ol/layer/Vector';

Vector data that is rendered client-side. Note that any property set in the options is set as a module:ol/Object~BaseObject property on the layer object; for example, setting title: 'My Title' in the options means that title is observable, and has get/set accessors.

new VectorLayer(opt_options)

layer/Vector.js, line 75

Name Type Description

options

Options.

Name	Type	Default	Description
`opacity`	number	1	Opacity (0, 1).
`visible`	boolean	true	Visibility.
`extent`	module:ol/extent~Extent		The bounding extent for layer rendering. The layer will not be rendered outside of this extent.
`zIndex`	number		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		The minimum resolution (inclusive) at which this layer will be visible.
`maxResolution`	number		The maximum resolution (exclusive) below which this layer will be visible.
`renderOrder`	module:ol/render~OrderFunction		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	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.
`renderMode`	module:ol/layer/VectorRenderType \| string	'vector'	Render mode for vector layers: `'image'`: Vector layers are rendered as images. Great performance, but point symbols and texts are always rotated with the view and pixels are scaled during zoom animations. `'vector'`: Vector layers are rendered as vectors. Most accurate rendering even during animations, but slower performance.
`source`	module:ol/source/Vector~VectorSource		Source.
`map`	module:ol/PluggableMap~PluggableMap		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 `module:ol/Map#addLayer`.
`declutter`	boolean	false	Declutter images and text. Decluttering is applied to all image and text styles, and the priority is defined by the z-index of the style. Lower z-index means higher priority.
`style`	module:ol/style/Style~StyleLike		Layer style. See `module:ol/style` for default style which will be used if this is not defined.
`updateWhileAnimating`	boolean	false	When set to `true` and `renderMode` is `vector`, 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	false	When set to `true` and `renderMode` is `vector`, feature batches will be recreated during interactions. See also `updateWhileAnimating`.

Fires:

change (module:ol/events/Event~Event) - Generic change event. Triggered when the revision counter is increased.
change:extent (module:ol/Object.ObjectEvent)
change:maxResolution (module:ol/Object.ObjectEvent)
change:minResolution (module:ol/Object.ObjectEvent)
change:opacity (module:ol/Object.ObjectEvent)
change:source (module:ol/Object.ObjectEvent)
change:visible (module:ol/Object.ObjectEvent)
change:zIndex (module:ol/Object.ObjectEvent)
postcompose (module:ol/render/Event~RenderEvent)
precompose (module:ol/render/Event~RenderEvent)
propertychange (module:ol/Object.ObjectEvent) - Triggered when a property is changed.
render (module:ol/render/Event~RenderEvent)
rendercomplete (module:ol/render/Event~RenderEvent) - Triggered when rendering is complete, i.e. all sources and tiles have finished loading for the current viewport, and all tiles are faded in.

Subclasses

Extends

module:ol/layer/Layer~Layer

Observable Properties

Name	Type	Settable	ol/Object.ObjectEvent type	Description
`extent`	module:ol/extent~Extent \| undefined	yes	`change:extent`	The layer extent.
`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.
`source`	module:ol/source/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 Observable.js, line 36

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

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

Gets a value.

Name	Type	Description
`key`	string	Key name.

Returns:

Value.

getExtent(){module:ol/extent~Extent|undefined} inherited layer/Base.js, line 133

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

Returns:

The layer extent.

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

Get a list of object property names.

Returns:

List of property names.

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

Return the maximum resolution of the layer.

Returns:

The maximum resolution of the layer.

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

Return the minimum resolution of the layer.

Returns:

The minimum resolution of the layer.

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

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

Returns:

The opacity of the layer.

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

Get an object of all property names and values.

Returns:

Object.

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

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

Returns:

Revision.

getSource(){module:ol/source/Vector~VectorSource} layer/Vector.js, line 256

Return the associated vectorsource of the layer.

Returns:

Source.

getStyle(){module:ol/style/Style~StyleLike} layer/Vector.js, line 187

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(){module:ol/style/Style~StyleFunction|undefined} layer/Vector.js, line 196

Get the style function.

Returns:

Layer style function.

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

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

Returns:

The visibility of the layer.

getZIndex(){number} inherited layer/Base.js, line 194

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){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited Observable.js, line 60

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){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited Observable.js, line 82

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, opt_silent) inherited Object.js, line 164

Sets a value.

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

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

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

Name	Type	Description
`extent`	module:ol/extent~Extent \| undefined	The extent of the layer.

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

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 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 module:ol/Map#addLayer instead.

Name	Type	Description
`map`	module:ol/PluggableMap~PluggableMap	Map.

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

Set the maximum resolution at which the layer is visible.

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

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

Set the minimum resolution at which the layer is visible.

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

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

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 Object.js, line 183

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.

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

Set the layer source.

Name	Type	Description
`source`	module:ol/source/Source~Source	The layer source.

setStyle(style) layer/Vector.js, line 234

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 module:ol/style for information on the default style.

Name	Type	Description
`style`	module:ol/style/Style~Style \| Array.<module:ol/style/Style~Style> \| module:ol/style/Style~StyleFunction \| null \| undefined	Layer style.

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

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 256

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 101

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, opt_silent) inherited Object.js, line 195

Unsets a property.

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