OpenLayers

Class: MVT

ol.format.MVT 


import MVT from 'ol/format/mvt';

Feature format for reading data in the Mapbox MVT format.

new ol.format.MVT(opt_options)

src/ol/format/mvt.js, line 33
Name Type Description
options

Options.

Name Type Description
featureClass undefined | function | function

Class for features returned by ol.format.MVT#readFeatures. Set to ol.Feature to get full editing and geometry support at the cost of decreased rendering performance. The default is ol.render.Feature, which is optimized for rendering and hit detection.
geometryName string | undefined

Geometry name to use when creating features. Default is 'geometry'.
layerName string | undefined

Name of the feature attribute that holds the layer name. Default is 'layer'.
layers Array.<string> | undefined

Layers to read features from. If not provided, features will be read from all layers.

Extends

Methods

getLastExtent(){ol.Extent}

src/ol/format/mvt.js, line 338

Get the extent from the source of the last readFeatures call.

Returns:
Tile extent.

readFeatures(source, opt_options){Array.<ol.Feature>}

src/ol/format/mvt.js, line 355

Read all features from a source.

Name Type Description
source Document | Node | ArrayBuffer | Object | string

Source.
options

Read options.

Name Type Description
dataProjection ol.ProjectionLike

Projection of the data we are reading. If not provided, the projection will be derived from the data (where possible) or the defaultDataProjection of the format is assigned (where set). If the projection can not be derived from the data and if no defaultDataProjection is set for a format, the features will not be reprojected.
extent ol.Extent

Tile extent of the tile being read. This is only used and required for ol.format.MVT. Required.
featureProjection ol.ProjectionLike

Projection of the feature geometries created by the format reader. If not provided, features will be returned in the dataProjection.
Returns:
Features.

readProjection(source){ol.proj.Projection}

src/ol/format/mvt.js, line 385

Read the projection from a source.

Name Type Description
source Document | Node | Object | string

Source.
Returns:
Projection.

setLayers(layers)

src/ol/format/mvt.js, line 395

Sets the layers that features will be read from.

Name Type Description
layers Array.<string>

Layers.