Module: ol/layer/MapboxVector




Type Definitions


Name Type Description
id string

The layer id.

source string

The source id.


Name Type Argument Default Description
styleUrl string

The URL of the Mapbox style object to use for this layer. For a style created with Mapbox Studio and hosted on Mapbox, this will look like 'mapbox://styles/you/your-style'.

accessToken string

The access token for your Mapbox style.

source string <optional>

If your style uses more than one source, you need to use either the source property or the layers property to limit rendering to a single vector source. The source property corresponds to the id of a vector source in your Mapbox style.

layers Array.<string> <optional>

Limit rendering to the list of included layers. All layers must share the same vector soource. If your style uses more than one source, you need to use either the source property or the layers property to limit rendering to a single vector source.

declutter boolean <optional>

Declutter images and text. Decluttering is applied to all image and text styles of all Vector and VectorTile layers that have set this to true. The priority is defined by the z-index of the layer, the zIndex of the style and the render order of features. Higher z-index means higher priority. Within the same z-index, a feature rendered before another has higher priority.

className string <optional>

A CSS class name to set to the layer element.

opacity number <optional>

Opacity (0, 1).

visible boolean <optional>


extent module:ol/extent~Extent <optional>

The bounding extent for layer rendering. The layer will not be rendered outside of this extent.

zIndex number <optional>

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 <optional>

The minimum resolution (inclusive) at which this layer will be visible.

maxResolution number <optional>

The maximum resolution (exclusive) below which this layer will be visible.

minZoom number <optional>

The minimum view zoom level (exclusive) above which this layer will be visible.

maxZoom number <optional>

The maximum view zoom level (inclusive) at which this layer will be visible.

renderOrder module:ol/render~OrderFunction <optional>

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 <optional>

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 <optional>

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. When declutter is set to true, the decluttering is done per tile resulting in labels and point symbols getting cut off at tile boundaries.
  • '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': Everything is rendered as vectors. Use this mode for improved performance on vector tile layers with only a few rendered features (e.g. for highlighting a subset of features of another layer with the same source).
map module:ol/PluggableMap~PluggableMap <optional>

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.

updateWhileAnimating boolean <optional>

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 <optional>

When set to true, feature batches will be recreated during interactions. See also updateWhileAnimating.

preload number <optional>

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

useInterimTilesOnError boolean <optional>

Use interim tiles on error.


Name Type Description
url string

The source URL.

type module:ol/layer/MapboxVector~SourceType

The source type.


Name Type Description
sources Object.<string, module:ol/layer/MapboxVector~SourceObject>

The style sources.

sprite string

The sprite URL.

glyphs string

The glyphs URL.

layers Array.<module:ol/layer/MapboxVector~LayerObject>

The style layers.