Node.js utilities and tilelive integration for the MBTiles format.
npm install @mapbox/mbtiles
var MBTiles = require('@mapbox/mbtiles');All MBTiles instances need to be constructed before any of the methods become available. NOTE: All methods described below assume you've taken this step.
new MBTiles('./path/to/file.mbtiles?mode={ro, rw, rwc}', function(err, mbtiles) {
console.log(mbtiles) // mbtiles object with methods listed below
});The mode query parameter is a opening flag of mbtiles. It is optional, default as rwc. Available flags are:
ro: readonly mode, will throw error if the mbtiles does not exist.rw: read and write mode, will throw error if the mbtiles does not exist.rwc: read, write and create mode, will create a new mbtiles if the mbtiles does not exist.
getTile(z, x, y, callback)
Get an individual tile from the MBTiles table. This can be a raster or gzipped vector tile. Also returns headers that are important for serving over HTTP.
mbtiles.getTile(z, x, y, function(err, data, headers) {
// `data` is your gzipped buffer - use zlib to gunzip or inflate
});getInfo(callback)
Get info of an MBTiles file, which is stored in the metadata table. Includes information like zoom levels, bounds, vector_layers, that were created during generation. This performs fallback queries if certain keys like bounds, minzoom, or maxzoom have not been provided.
mbtiles.getInfo(function(err, info) {
console.log(info); // info
});getGrid(z, x, y, callback)
Get a UTFGrid tile from the MBTiles table.
mbtiles.getGrid(z, x, y, function(err, data) {
// continue onwards
});startWriting AND stopWriting
In order to write a new (or currently existing) MBTiles file you need to "start" and "stop" writing. First, construct the MBTiles object.
mbtiles.startWriting(function(err) {
// start writing with mbtiles methods (putTile, putInfo, etc)
mbtiles.stopWriting(function(err) {
// stop writing to your mbtiles object
});
});putTile(z, x, y, buffer, callback)
Add a new tile buffer to a specific ZXY. This can be a raster tile or a gzipped vector tile (we suggest using require('zlib') to gzip your tiles).
var zlib = require('zlib');
zlib.gzip(