Module: ol/layer/VectorTile

ol/layer/VectorTile


Classes

VectorTileLayer

Type Definitions

Options{Object}

Properties:
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 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 VectorTileRenderType
(defaults to 'hybrid')

Render mode for vector tiles:

  • '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, but get lifted above all polygon and line elements.
  • 'vector': Everything is rendered as vectors and the original render order is maintained. Use this mode for improved performance and visual epxerience on vector tile layers with not too many rendered features (e.g. for highlighting a subset of features of another layer with the same source).
source VectorTileSourceType | 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 | 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.

preload number
(defaults to 0)

Preload. Load low-resolution tiles up to preload levels. 0 means no preloading.

useInterimTilesOnError boolean
(defaults to true)

Deprecated. Use interim tiles on error.

properties Object.<string, *> | undefined

Arbitrary observable properties. Can be accessed with #get() and #set().

cacheSize number
(defaults to 0)

The internal tile cache size. If too small, this will auto-grow to hold two zoom levels worth of tiles.

VectorTileRenderType{'hybrid'} {'vector'}