npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript.Learn more »

tilestrata-vtile-raster

0.5.0 • Public • Published

tilestrata-vtile-raster

NPM version Build Status Coverage Status

A TileStrata plugin for rendering mapnik vector tiles (pbf) into raster images. Use the tilestrata-vtile plugin for generating the vector tiles. 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 opts_vector = {
    xml: '/path/to/map.xml',
    tileSize: 256,
    metatile: 1,
    bufferSize: 128
};
 
var opts_raster = {
    xml: '/path/to/map-vt.xml',
    tileSize: 256,
    metatile: 1,
    bufferSize: 128
};
 
server.layer('myvectortiles', {maxZoom: 14})
    .route('t.pbf').use(vtile(opts_vector));
 
server.layer('mylayer')
    .route('t.png').use(vtileraster(opts_raster, {
        tilesource: ['myvectortiles', 't.pbf']
    }))
    .route('i.json').use(vtileraster(opts_raster, {
        tilesource: ['myvectortiles', 't.pbf'],
        interactivity: true
    }));

Overzooming

If the maxZoomproperty is set on the vector tile layer, the plugin will render higher zoom level tiles with the vector tiles from the max zoom level.

Mapnik XML Notes

tilestrata-vtile expects a typical mapnik xml file - the same as tilestrata-mapnik would expect. The XML for tilestrata-vtile-raster must have specialized for using vector-tiles however. It needs to differ from the typical xml file in the following ways:

  • The srs property must be removed or set to Web Mercator for each layer. Mapnik reprojects the source data before putting it into vector tiles
  • The Datasource for each layer must be removed. Mapnik will try to get the data from the datasource instead of the vector tile if Datasource is still set

Contributing

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

$ npm test

License

Copyright © 2015-2016 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.

install

npm i tilestrata-vtile-raster

Downloadsweekly downloads

24

version

0.5.0

license

Apache-2.0

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability