tilestrata-vtile

A TileStrata plugin for generating mapnik vector tiles (pbf). Vector tiles are useful for times when you want to render multiple variations of a tile (1x, 2x, interactivity, etc) without having to do expensive data fetching for each. Use the tilestrata-vtile-raster plugin to render them into normal images. To use this plugin, you must have node-mapnik in your dependency tree.

Sample Usage

var vtile = require('tilestrata-vtile');
var vtileraster = require('tilestrata-vtile-raster');

var common = {
    xml: '/path/to/map.xml',
    tileSize: 256,
    metatile: 1,
    bufferSize: 128
};

server.layer('mylayer')
    .route('t.pbf').use(vtile(common))
    .route('t.png').use(vtileraster(common, {
        tilesource: ['mylayer', 't.pbf']
    }))
    .route('i.json').use(rasterizer(common, {
        tilesource: ['mylayer', 't.pbf'],
        interactivity: true
    }));

If you need fine control over the Mapnik vector tile creation options, use the overrideRenderOptions option:

server.layer('mylayer')
    .route('t.pbf').use(vtile({
        xml: '/path/to/map.xml',
        tileSize: 256,
        metatile: 1,
        bufferSize: 128,
        overrideRenderOptions: function(opts, z, maxz) {
            opts.simplify_distance = z < maxz ? 8 : 1;
            return opts;
        }
    }))

Contributing

Before submitting pull requests, please update the tests and make sure they all pass.

$ npm test

License

Copyright © 2015 Natural Atlas, Inc. & Contributors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.