OpenLayers

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 89
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 0

The z-index for layer rendering. At rendering time, the layers will be ordered, first by Z-index and then by position.
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~Style | Array.<module:ol/style/Style~Style> | module:ol/style/Style~StyleFunction

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.

Methods

getSource(){module:ol/source/Vector~VectorSource}

layer/Vector.js, line 271

Return the associated vectorsource of the layer.

Returns:
Source.

getStyle(){module:ol/style/Style~Style|Array.<module:ol/style/Style~Style>|module:ol/style/Style~StyleFunction}

layer/Vector.js, line 201

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 210

Get the style function.

Returns:
Layer style function.

setStyle(style)

layer/Vector.js, line 249

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.