Skip to main content

MVTWriter

caution

Experimental

Writer for the Mapbox Vector Tile format for representation of geometry.

LoaderCharacteristic
File Extension.mvt,
File TypeBinary
File FormatMapbox Vector Tile
Data FormatGeometry
Supported APIsencode, encodeSync

Installation​

npm install @loaders.gl/mvt
npm install @loaders.gl/core

Usage​

import {encode} from '@loaders.gl/core';
import {MVTWriter} from '@loaders.gl/mvt';

const arrayBuffer = await encode(geojson, MVTWriter, {
mvt: {
layerName: 'my-layer',
version: 2,
extent: 4096
}
});

Options​

OptionTypeDefaultDescription
mvt.layerNamestring'geojsonLayer'Name of the single layer that will be written into the tile
mvt.versionnumber1Vector tile specification version
mvt.extentnumber4096Extent of the vector tile grid
mvt.tileIndex{x: number, y: number, z: number}undefinedOptional tile index for projecting WGS84 coordinates into tile space