mapnik-reference is a spec of what Mapnik styling and datasource properties are supported for each version.
It is useful for building parsers, tests, compilers, and syntax highlighting/checking for languages.
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 structure of the file is as such:
version: the version of Mapnik targeted. Same as the containing directory.
style: properties of the
layer: properties of the
symbolizers/*: properties that apply to all symbolizers
symbolizers/symbolizer: properties that apply to each type of symbolizer
colors: named colors supported by Mapnik. see
status key may be used to define the stability of a property. When the key is not specified,
stable. Possible values are:
propertyis here to stay and its behavior is not anticipated to change
propertyis here to stay but its behavior/meaning of
propertyshould not be used and will be removed in upcoming major version of Mapnik
propertyshould not be used and may change, be re-named, or disappear at any time
npm install mapnik-reference
Install it as a dependency of your application. Then use that API to get a reference instance for a specific version of Mapnik:
var mapnik_reference = require('mapnik-reference'); var ref = mapnik_reference.load('3.0.0');
You can also get access to an array of all known versions:
var mapnik_reference = require('mapnik-reference'); mapnik_reference.versions; [ '2.0.0', '2.0.1', '2.0.2', '2.1.0', '2.1.1', '2.2.0', '2.3.0', '3.0.0' ]
Other implementations will want to simply copy the JSON file
from the desired implementation, like
The file can then be parsed with any of the many json parsers.
Tests require python and node.js: