Class: MVT

ol/format/MVT~MVT 


import MVT from 'ol/format/MVT';

Feature format for reading data in the Mapbox MVT format.

new MVT(opt_options)

format/MVT.js, line 44
Name Type Description
options

Options.

Name Type Default Description
featureClass module:ol/Feature~FeatureClass

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

Geometry name to use when creating features.
layerName string 'layer'

Name of the feature attribute that holds the layer name.
layers Array.<string>

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

Extends

Methods

getLastExtent(){module:ol/extent~Extent}

format/MVT.js, line 231

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

Returns:
Tile extent.

readFeatures(source, opt_options){Array.<module:ol/Feature~FeatureLike>}

format/MVT.js, line 246

Read all features from a source.

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

Source.
options

Read options.

Name Type Description
dataProjection module:ol/proj~ProjectionLike

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

Tile extent of the tile being read. This is only used and required for module:ol/format/MVT.
featureProjection module:ol/proj~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){module:ol/proj/Projection~Projection}

format/MVT.js, line 273

Read the projection from a source.

Name Type Description
source Document | Node | Object | string

Source.
Returns:
Projection.

setLayers(layers)

format/MVT.js, line 282

Sets the layers that features will be read from.

Name Type Description
layers Array.<string>

Layers.