OpenLayers

Class: VectorTileLayer

ol/layer/VectorTile~VectorTileLayer 


import VectorTileLayer from 'ol/layer/VectorTile';

Layer for vector tile 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 VectorTileLayer(opt_options)

layer/VectorTile.js, line 99
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 tile extent used by the renderer when getting features from the vector tile for the rendering or hit-detection. Recommended value: Vector tiles are usually generated with a buffer, so this value should match the largest possible buffer of the used tiles. It should be at least the size of the largest point symbol or line width.
renderMode module:ol/layer/VectorTileRenderType | string 'hybrid'

Render mode for vector tiles:

  • 'image': Vector tiles are rendered as images. Great performance, but point symbols and texts are always rotated with the view and pixels are scaled during zoom animations.
  • 'hybrid': Polygon and line elements are rendered as images, so pixels are scaled during zoom animations. Point symbols and texts are accurately rendered as vectors and can stay upright on rotated views.
  • 'vector': Vector tiles are rendered as vectors. Most accurate rendering even during animations, but slower performance than the other options.

When declutter is set to true, 'hybrid' will be used instead of 'image'.
source module:ol/source/VectorTile~VectorTile

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. When set to true, a renderMode of 'image' will be overridden with 'hybrid'.
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, 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, feature batches will be recreated during interactions. See also updateWhileAnimating.
preload number 0

Preload. Load low-resolution tiles up to preload levels. 0 means no preloading.
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.
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.
useInterimTilesOnError boolean true

Use interim tiles on error.

Methods

getPreload(){number}

layer/VectorTile.js, line 142

Return the level as number to which we will preload tiles up to.

Returns:
The level to preload tiles up to.

getSource(){module:ol/source/VectorTile~VectorTile}

layer/VectorTile.js, line 184

Return the associated vectortilesource of the layer.

Returns:
Source.

getUseInterimTilesOnError(){boolean}

layer/VectorTile.js, line 152

Whether we use interim tiles on error.

Returns:
Use interim tiles on error.

setPreload(preload)

layer/VectorTile.js, line 162

Set the level as number to which we will preload tiles up to.

Name Type Description
preload number

The level to preload tiles up to.

setUseInterimTilesOnError(useInterimTilesOnError)

layer/VectorTile.js, line 172

Set whether we use interim tiles on error.

Name Type Description
useInterimTilesOnError boolean

Use interim tiles on error.