Skip to content
Bindings to mapnik for node.js
C++ JavaScript Shell Batchfile Python HTML Other
Failed to load latest commit information.
bench Remove parse in benchmark Jan 22, 2016
bin consistently import mapnik from relative path Mar 14, 2016
deps/clipper Updated the clipper to fix a rare bug May 4, 2016
docs Move and expand contributing.md Jun 14, 2015
documentation re-render docs with config file [skip ci] May 3, 2016
lib Removed lib protobuf updated vector tiles. Jan 27, 2016
scripts only define MAPNIK_GIT if it has not been defined already Apr 27, 2016
src use As<v8::Object> Apr 29, 2016
test Update tests after using incorrect MVT locally May 5, 2016
tools better c++ style as per mapnik conventions Apr 12, 2012
.gitattributes [skip ci] shapefile/geojson test, revert 183d8d9 Aug 2, 2015
.gitignore Merge branch 'master' into clipper_fix Mar 8, 2016
.npmignore npmignore nvm directory [skip ci] Mar 28, 2016
.travis.yml support node-v6 - refs #636 nodejs/nan@a90951e#commitcomment-17308472 Apr 29, 2016
CHANGELOG.md Bump to 3.5.13 [republish binary] Apr 19, 2016
CONTRIBUTING.md re-render documentation, update contributing with config file Mar 23, 2016
LICENSE.txt update licence year Apr 16, 2012
Makefile Added coveralls integration Mar 2, 2015
README.md [docs] refresh source build instructions - refs #613 Mar 14, 2016
appveyor.yml appveyor: build against latest node-cpp11 builds Mar 31, 2016
binding.gyp enable debug builds + binary publishing Mar 4, 2016
common.gypi Windows: Custom "ProgramDatabaseFile" to avoid naming conflict with '… Feb 15, 2015
gen_settings.py let gyp control if mapnik_settings.js needs rebuilt Mar 31, 2014
index.html fix relative URLs for docs [skip ci] Mar 1, 2016
package.json support node-v6 - refs #636 nodejs/nan@a90951e#commitcomment-17308472 Apr 29, 2016
vcbuild.bat use new mapnik-sdk Aug 25, 2014

README.md

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

  • Node v0.10.x or v0.12.x (v0.12.x support requires node-mapnik >= v3.1.6)
  • C++11 compatible C++ runtime library

Troubleshooting

If you hit an error like:

Error: /usr/lib/x86_64-linux-gnu/libstdc++.so.6: version `GLIBCXX_3.4.18' not found

This means your Linux distributions libstdc++ library is too old (for example you are running Ubuntu Precise rather than Trusty). To work around this upgrade libstdc++:

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

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

language: cpp

sudo: false

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

Installing

Just do:

npm install mapnik@3.x

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

Something went wrong with that request. Please try again.