OpenLayers

Class: VectorTile

ol.layer.VectorTile 


import VectorTile 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 ol.Object 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 ol.layer.VectorTile(opt_options)

src/ol/layer/vectortile.js, line 24
Name Type Description
options

Options.

Name Type Description
renderBuffer number | undefined

The buffer 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. Default is 100 pixels.
renderMode ol.layer.VectorTileRenderType | string | undefined

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'. The default is 'hybrid'.
renderOrder ol.RenderOrderFunction | undefined

Render order. Function to be used when sorting features before rendering. By default features are drawn in the order that they are created.
map ol.PluggableMap | 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 ol.Map#addLayer.
extent ol.Extent | undefined

The bounding extent for layer rendering. The layer will not be rendered outside of this extent.
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.
opacity number | undefined

Opacity. 0-1. Default is 1.
preload number | undefined

Preload. Load low-resolution tiles up to preload levels. By default preload is 0, which means no preloading.
source ol.source.VectorTile | undefined

Source.
declutter boolean | undefined

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'. Default is false.
style ol.style.Style | Array.<ol.style.Style> | ol.StyleFunction | undefined

Layer style. See ol.style for default style which will be used if this is not defined.
updateWhileAnimating boolean | undefined

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. Default is false.
updateWhileInteracting boolean | undefined

When set to true, feature batches will be recreated during interactions. See also updateWhileAnimating. Default is false.
visible boolean | undefined

Visibility. Default is true (visible).
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. The default Z-index is 0.
Fires:

Extends

Observable Properties

Name Type Settable ol.Object.Event type Description
extent ol.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.
preload number yes change:preload

The level to preload tiles up to.
source ol.source.Source yes change:source

The layer source (or null if not yet set).
useInterimTilesOnError boolean yes change:useinterimtilesonerror

Use interim tiles on error.
visible boolean yes change:visible

The visibility of the layer.
zIndex number yes change:zindex

The Z-index of the layer.

Methods

changed() inherited

src/ol/observable.js, line 58

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

dispatchEvent(event) inherited

src/ol/observable.js, line 75

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 Object | ol.events.Event | string

Event object.

get(key){*} inherited

src/ol/object.js, line 101

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getExtent(){ol.Extent|undefined} inherited

src/ol/layer/base.js, line 115

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

Returns:
The layer extent.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 115

Get a list of object property names.

Returns:
List of property names.

getMaxResolution(){number} inherited

src/ol/layer/base.js, line 127

Return the maximum resolution of the layer.

Returns:
The maximum resolution of the layer.

getMinResolution(){number} inherited

src/ol/layer/base.js, line 139

Return the minimum resolution of the layer.

Returns:
The minimum resolution of the layer.

getOpacity(){number} inherited

src/ol/layer/base.js, line 151

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

Returns:
The opacity of the layer.

getPreload(){number}

src/ol/layer/vectortile.js, line 65

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

Returns:
The level to preload tiles up to.

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

src/ol/object.js, line 125

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

src/ol/observable.js, line 84

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

Returns:
Revision.

getSource(){ol.source.VectorTile}

src/ol/layer/vectortile.js, line 111

Return the associated vectortilesource of the layer.

Returns:
Source.

getStyle(){ol.style.Style|Array.<ol.style.Style>|ol.StyleFunction} inherited

src/ol/layer/vector.js, line 146

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(){ol.StyleFunction|undefined} inherited

src/ol/layer/vector.js, line 156

Get the style function.

Returns:
Layer style function.

getUseInterimTilesOnError(){boolean}

src/ol/layer/vectortile.js, line 76

Whether we use interim tiles on error.

Returns:
Use interim tiles on error.

getVisible(){boolean} inherited

src/ol/layer/base.js, line 169

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

Returns:
The visibility of the layer.

getZIndex(){number} inherited

src/ol/layer/base.js, line 181

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, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 99

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.
this Object

The object to use as this in listener.
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, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited

src/ol/observable.js, line 124

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.
this Object

The object to use as this in listener.
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

src/ol/object.js, line 150

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean

Update without triggering an event.

setExtent(extent) inherited

src/ol/layer/base.js, line 193

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

Name Type Description
extent ol.Extent | undefined

The extent of the layer.

setMap(map) inherited

src/ol/layer/layer.js, line 167

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

Name Type Description
map ol.PluggableMap

Map.

setMaxResolution(maxResolution) inherited

src/ol/layer/base.js, line 204

Set the maximum resolution at which the layer is visible.

Name Type Description
maxResolution number

The maximum resolution of the layer.

setMinResolution(minResolution) inherited

src/ol/layer/base.js, line 215

Set the minimum resolution at which the layer is visible.

Name Type Description
minResolution number

The minimum resolution of the layer.

setOpacity(opacity) inherited

src/ol/layer/base.js, line 226

Set the opacity of the layer, allowed values range from 0 to 1.

Name Type Description
opacity number

The opacity of the layer.

setPreload(preload)

src/ol/layer/vectortile.js, line 88

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.

setProperties(values, opt_silent) inherited

src/ol/object.js, line 170

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

src/ol/layer/layer.js, line 201

Set the layer source.

Name Type Description
source ol.source.Source

The layer source.

setStyle(style) inherited

src/ol/layer/vector.js, line 199

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

Name Type Description
style ol.style.Style | Array.<ol.style.Style> | ol.StyleFunction | null | undefined

Layer style.

setUseInterimTilesOnError(useInterimTilesOnError)

src/ol/layer/vectortile.js, line 99

Set whether we use interim tiles on error.

Name Type Description
useInterimTilesOnError boolean

Use interim tiles on error.

setVisible(visible) inherited

src/ol/layer/base.js, line 237

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

Name Type Description
visible boolean

The visibility of the layer.

setZIndex(zindex) inherited

src/ol/layer/base.js, line 249

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, opt_this) inherited

src/ol/observable.js, line 147

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.
this Object

The object which was used as this by the listener.

unset(key, opt_silent) inherited

src/ol/object.js, line 184

Unsets a property.

Name Type Description
key string

Key name.
silent boolean

Unset without triggering an event.