node-mapnik 0,0 travis-ci npm

Bindings to mapnik for node.js

node-mapnik

Bindings to Mapnik for node.

NPM

Build Status Build status Coverage Status

Usage

Render a map from a stylesheet:

var mapnik = require('mapnik');
var fs = require('fs');

// register fonts and datasource plugins
mapnik.register_default_fonts();
mapnik.register_default_input_plugins();

var map = new mapnik.Map(256, 256);
map.load('./test/stylesheet.xml', function(err,map) {
    if (err) throw err;
    map.zoomAll();
    var im = new mapnik.Image(256, 256);
    map.render(im, function(err,im) {
      if (err) throw err;
      im.encode('png', function(err,buffer) {
          if (err) throw err;
          fs.writeFile('map.png',buffer, function(err) {
              if (err) throw err;
              console.log('saved map image to map.png');
          });
      });
    });
});

Convert a jpeg image to a png:

var mapnik = require('mapnik');
new mapnik.Image.open('input.jpg').save('output.png');

Convert a shapefile to GeoJSON:

var mapnik = require('mapnik');
mapnik.register_datasource(path.join(mapnik.settings.paths.input_plugins,'shape.input'));
var ds = new mapnik.Datasource({type:'shape',file:'test/data/world_merc.shp'});
var featureset = ds.featureset()
var geojson = {
  "type": "FeatureCollection",
  "features": [
  ]
}
var feat = featureset.next();
while (feat) {
    geojson.features.push(JSON.parse(feat.toJSON()));
    feat = featureset.next();
}
fs.writeFileSync("output.geojson",JSON.stringify(geojson,null,2));

For more sample code see the tests and sample code.

Depends

OS Node.js C++ minimum requirements OS versions
Mac v0.10.x, v4, v5, v6 C++11 Mac OS X > 10.10
Linux v0.10.x, v4, v5, v6 C++11 Ubuntu Linux > 16.04 or other Linux distributions with g++ >= 5 toolchain (>= GLIBCXX_3.4.20 from libstdc++)
Windows v0.10.x, v4, v5 C++11 See the Windows requirements section

An installation error like below indicates your system does not have a modern enough libstdc++/gcc-base toolchain:

Error: /usr/lib/x86_64-linux-gnu/libstdc++.so.6: version GLIBCXX_3.4.20 not found (required by /node_modules/osrm/lib/binding/osrm.node)

If you are running Ubuntu older than 16.04 you can easily upgrade your libstdc++ version like:

sudo add-apt-repository ppa:ubuntu-toolchain-r/test
sudo apt-get update -y
sudo apt-get install -y libstdc++-5-dev

To upgrade libstdc++ on travis (without sudo) you can do:

language: cpp

sudo: false

addons:
  apt:
    sources:
     - ubuntu-toolchain-r-test
    packages:
     - libstdc++-5-dev # upgrade libstdc++ on linux to support C++11

Installing

Just do:

npm install [email protected]

Note: This will install the latest node-mapnik 3.x series, which is recommended. There is also an 1.x series which maintains API compatibility with Mapnik 2.3.x and 2.2.x and a v0.7.x series which is not recommended unless you need to support Mapnik 2.1 or older.

By default, binaries are provided for:

On those platforms no external dependencies are needed.

Other platforms will fall back to a source compile: see Source Build for details.

Binaries started being provided at node-mapnik >= 1.4.2 for OSX and Linux and at 1.4.8 for Windows.

Windows specific

NOTE: Windows binaries for the 3.x series require the Visual C++ Redistributable Packages for Visual Studio 2015:

See https://github.com/mapnik/node-mapnik/wiki/WindowsBinaries for more details.

The 1.x series require the Visual C++ Redistributable Packages for Visual Studio 2013:

Source Build

To build from source you need:

  • Mapnik >= v3.0.10

Install Mapnik using the instructions at: https://github.com/mapnik/mapnik/wiki/Mapnik-Installation

Confirm that the mapnik-config program is available and on your ${PATH}.

Then run (within the cloned node-mapnik directory:

npm install --build-from-source

Windows specific

Windows builds are maintained in https://github.com/mapbox/windows-builds

Using node-mapnik from your node app

To require node-mapnik as a dependency of another package put in your package.json:

"dependencies"  : { "mapnik":"*" } // replace * with a given semver version string

Tests

To run the tests do:

npm test

License

BSD, see LICENSE.txt

Related Repositories

node-mapnik

node-mapnik

Bindings to mapnik for node.js ...

node-mapnik-sample-code

node-mapnik-sample-code

Sample code demonstrating usage of node-mapnik ...

elasticmaps

elasticmaps

Map tileserver based on node-mapnik and elasticsearch ...

node-mapnik

node-mapnik

Bindings to mapnik for node.js ...

alacarto

alacarto

Node.js CartoCSS implementation - Mapnik stylesheet compiler ...


Top Contributors

springmeyer flippmoke BergWerkGIS mapsam yhahn kkaefer artemp tmcw jakepruitt GretaCB bsudekum ingalls rclark taketime danpat mojodna tomhughes davidtheclark calvinmetcalf stefanklug booo sebastic mscdex kkoopa mikemorris Mithgol rcoup

Dependencies

package version
mapnik-vector-tile 1.4.0
protozero 1.5.1
nan ~2.5.0
node-pre-gyp ~0.6.30
dev node-gyp ^3.6.1
aws-sdk 2.0.12
jshint ^2.5.10
mocha 2.x
@mapbox/sphericalmercator ~1.0.2
bytes ~2.1.0

Releases

-   v3.5.14 zip tar
-   v3.5.13 zip tar
-   v3.5.12 zip tar
-   v3.4.19 zip tar
-   v3.4.18 zip tar
-   v1.1.3 zip tar
-   v1.1.2 zip tar
-   v0.5.5 zip tar
-   3.5.11 zip tar
-   3.5.10 zip tar
-   3.5.9 zip tar
-   3.5.8 zip tar
-   3.5.7 zip tar
-   3.5.6 zip tar
-   3.5.5 zip tar
-   3.5.4 zip tar
-   3.5.3 zip tar
-   3.5.2 zip tar
-   3.5.1 zip tar
-   3.5.0 zip tar
-   3.4.17 zip tar
-   3.4.16 zip tar
-   3.4.15 zip tar
-   3.4.14 zip tar
-   3.4.13 zip tar
-   3.4.12 zip tar
-   3.4.11 zip tar
-   3.4.10 zip tar
-   3.4.9 zip tar
-   3.4.8 zip tar