mapnik-reference

Reference for Mapnik Styling Options

npm install mapnik-reference
85 downloads in the last day
332 downloads in the last week
892 downloads in the last month

mapnik-reference

mapnik-reference is a parse-able spec of what Mapnik can do - what main structures it supports (like layers, styles, and symbolizers) and the properties they can contain. It's useful for building parsers, tests, compilers, and syntax highlighting/checking for languages.

Versioning

The version of this repository indicates the schema of the reference.json file. Schema changes of any type are expected to change the implementation requirements of a parser, so they will increment the major version of this repository in semver style.

The directories in this repository directly correspond to released versions of Mapnik and the next targeted release of Mapnik. The latest reference, usually targeted toward a pre-release, is copied into /latest for convenience.

Meaning

The structure of the file is as such:

  • version: the version of Mapnik targeted. Same as the containing directory.
  • style: properties of the Style XML element
  • layer: properties of the Layer XML element
  • symbolizers/*: properties that apply to all symbolizers
  • symbolizers/symbolizer: properties that apply to each type of symbolizer
  • colors: named colors supported by Mapnik. see include/mapnik/css_color_grammar.hpp

Using

This is a valid npm module and therefore can easily be used with node.js.

npm install mapnik-reference

Once installing it as a dependency (like it's used in Carto), it can be included and used for a specific version of Mapnik:

var mapnik_reference = require('mapnik-reference');
var data = mapnik_reference.version['2.1.0'];

Other implementations will want to simply copy the JSON file from the desired implementation, like 2.0.1/reference.json. For python we could consider uploading to pypi if there is interest.

The file can then be parsed with any of the many json parsers.

Testing

Tests require python:

make test

Users

  • carto.js
  • Mapnik itself (the util/validate-mapnik-instance.py is used to check binding consistency like in #1427)
npm loves you