Skip to content
Fetching contributors…
Cannot retrieve contributors at this time
42 lines (30 sloc) 1.57 KB


Implements the tilelive API for generating mapnik vector tiles from traditional mapnik datasources.

Build Status Coverage Status Build status

new Bridge(options, callback)

  • xml: a Mapnik XML string that will be used to generate vector tiles.
  • base: Optional, basepath for Mapnik map. Defaults to __dirname.


npm install tilelive-bridge

Though tilelive is not a dependency of tilelive-bridge you will want to install it to actually make use of tilelive-bridge through a reasonable API.


var tilelive = require('tilelive');

tilelive.load('bridge:///path/to/file.xml', function(err, source) {
    if (err) throw err;

    // Interface is in XYZ/Google coordinates.
    // Use `y = (1 << z) - 1 - y` to flip TMS coordinates.
    source.getTile(0, 0, 0, function(err, tile, headers) {
        // `err` is an error object when generation failed, otherwise null.
        // `tile` contains the compressed image file as a Buffer
        // `headers` is a hash with HTTP headers for the image.

    // The `.getGrid` is implemented accordingly.
Something went wrong with that request. Please try again.