diff options
| author | Johannes Schauer Marin Rodrigues <josch@mister-muffin.de> | 2021-11-07 20:04:19 +0100 |
|---|---|---|
| committer | Johannes Schauer Marin Rodrigues <josch@mister-muffin.de> | 2021-11-07 20:04:19 +0100 |
| commit | a1e66c74691e391c55e94a20932ac2d21ed1e4bc (patch) | |
| tree | e175aad6f3dc7fc4330767f90e275ea3bb4165d9 | |
| parent | 0de5417925439f165903b8dfcd41a722b1a5ae50 (diff) | |
New upstream version 1.2.0
324 files changed, 39126 insertions, 32605 deletions
diff --git a/.eslintrc.yml b/.eslintrc.yml index cd269dc..6079c82 100644 --- a/.eslintrc.yml +++ b/.eslintrc.yml @@ -68,6 +68,9 @@ rules: no-array-constructor: 2 no-bitwise: 0 no-caller: 2 + no-cond-assign: + - 2 + - except-parens no-confusing-arrow: 2 no-console: 0 no-continue: 0 @@ -189,3 +192,4 @@ rules: wrap-regex: 0 yield-star-spacing: 2 yoda: 0 + no-useless-escape: 0 diff --git a/.gitignore b/.gitignore deleted file mode 100644 index d62ccf5..0000000 --- a/.gitignore +++ /dev/null @@ -1,5 +0,0 @@ -**/node_modules -.DS_Store -test/rendering/layers/ -test/rendering/cache/ -test/rendering-mss/npm-debug.log diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 11e2c4b..0000000 --- a/.travis.yml +++ /dev/null @@ -1,13 +0,0 @@ -language: node_js - -sudo: true - -node_js: - - "5" - - "4" - - "0.12" - - "0.10.44" - -script: - - npm test - - if [[ ${TRAVIS_NODE_VERSION} == "0.10.44" ]]; then npm run coverage; fi; diff --git a/CHANGELOG.md b/CHANGELOG.md index ab3e8fc..fc9ba3a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,109 @@ -## Changelog +# Changelog + +## 1.2.0 + +* Update dependencies +* Update mapnik-reference to support new Mapnik API version ([#498](https://github.com/mapbox/carto/issues/498)) + +## 1.1.0 + +* Update dependencies +* Update mapnik-reference to support new Mapnik API version ([#494](https://github.com/mapbox/carto/issues/494)) + +## 1.0.1 + +* Fix a error in the serialization process. ([#473](https://github.com/mapbox/carto/issues/488)) + +## 1.0.0 + +* Documentation is now available on https://cartocss.readthedocs.io. ([#473](https://github.com/mapbox/carto/issues/473)) +* Warnings are emitted if properties are used that are `deprecated`, `unstable` or `experimental`. +There is a new command line / API switch (`-q / --quiet` / `quiet`) to suppress those warnings. ([#474](https://github.com/mapbox/carto/issues/474)) +* Warnings are emitted if a layer has no associated styles or styles do not match a corresponding layer selector. ([#29](https://github.com/mapbox/carto/issues/29)) +* New command line switch `-f / --file` to specify a file for output instead of `stdout`. +* carto now honors variable redefinition and uses the last defined value instead of the first one ([#338](https://github.com/mapbox/carto/issues/338)). +* All parameters of XML tags are now ouput in alphabetical order. This makes output more predictable. +* carto is now able to output a JSON variant of Mapnik XML. There is a new command line / API switch +(`-o / --output` / `outputFormat`) to choose the output format. Possible values are `mapnik` (default) +for Mapnik XML and `json` for the JSON variant (part of [#413](https://github.com/mapbox/carto/issues/413)). +For Mapnik XML all character data as tag content is now prefixed with CDATA. +* Expressions are allowed in filters e.g. `[height] % 50 = 0` or `[height] + 10 = 0`, fields have to be properly written within brackets +([#377](https://github.com/mapbox/carto/issues/377)) +* carto now accepts custom references for validating rules (part of [#413](https://github.com/mapbox/carto/issues/413)) +* The JavaScript API has been documented ([#479](https://github.com/mapbox/carto/issues/479)) +* New symbolizer rules (work on the whole symbolizer) enable control of symbolizer serialization. Write e.g. `line: none` to suppress output +of the line symbolizer for this definition. Write e.g. `marker: auto` to output a markers symbolizer with default values. Symbolizer rules +are considered an advanced features and are never inherited to other definitions ([#477](https://github.com/mapbox/carto/pull/477)). +* Remove `millstone` from optional dependencies again ([#482](https://github.com/mapbox/carto/issues/482)). + +### Breaking changes + +#### Stylesheets + +* The deprecated `name` attribute for layers is no longer supported. Use `id` instead. +* The deprecated color functions `husl` and `husla` are no longer supported. Use `hsluv` and `hsluva` instead. +* If you define a variable with the same name twice the latest defined value is now used in contrast to the first defined one as before. +* All parameters of XML tags are now ouput in alphabetical order. If you somehow depend on the order +of parameters (e.g. for tests) expect them to change. + +#### API + +* `carto.Renderer.render` and `carto.Renderer.renderMSS` now return an object `{ msg: Array, data: String }` instead of just a +string. `data` contains the output as before and `msg` now contains an array of error or warning objects. +In case of errors `data` is `null`. +* carto now only throws errors in case of program failures. All other style processing +related errors can be found in the `msg` property (see above). +* The constructor of `carto.Renderer` now only takes one options object +instead of a `env` and `options` parameter. +* The option `mapnik_version` and `validation_data` of `carto.Renderer` have +been renamed to `version` and `validationData` respectively. +* `carto.Renderer` now checks each option before forwarding them to the rendering +chain. Supported options are defined in the documentation. If you use a option that is +missing please open a issue. + +## 0.18.2 + +* Remove `millstone` from optional dependencies again + +## 0.18.1 + +* Updated `mapnik-reference` to fix an install problem for some Node.js versions +* Backported documentation updates + +## 0.18.0 + +* Compile time performance improvement by leaving out rules that do not apply to layer minzoom and maxzoom restrictions if specified ([#469](https://github.com/mapbox/carto/issues/469)) +* Confirmed that [#348](https://github.com/mapbox/carto/issues/348) does not occur (anymore) +* Updated dependencies + +## 0.17.3 + +* Fix regression with number parsing after fixing of [#411](https://github.com/mapbox/carto/issues/411) ([#471](https://github.com/mapbox/carto/issues/471)) + +## 0.17.2 + +* Remove unintended scoping of package. It is now again `carto`. The NPM requirement is dropped. +* Variables in font definitions are now processed correctly ([#333](https://github.com/mapbox/carto/issues/333)) +* Display a better error for missing fonts on font name validation ([#242](https://github.com/mapbox/carto/issues/242)) +* Some properties can now be reset to their default value by using `none` ([#214](https://github.com/mapbox/carto/issues/214)) + +## 0.17.1 + +* Revert fix for [#315](https://github.com/mapbox/carto/issues/315) due to performance problems ([#466](https://github.com/mapbox/carto/issues/466)) + +## 0.17.0 + +* Carto is now a scoped package named `@mapbox/carto`. Scoped packages require NPM >= 1.5. ([#457](https://github.com/mapbox/carto/pull/457)) +* Carto now runs in the browser too (part of [#413](https://github.com/mapbox/carto/issues/413)) +* Carto can now load MML itself and supports absolute file paths in MML stylesheet references ([#439](https://github.com/mapbox/carto/pull/439)) +* The target API default of Mapnik moved from 2.3.0 to being always the latest version (3.0.x). Take that into account if you run a Mapnik 2.x instance (see also the `-a/--api` command line option). +([#454](https://github.com/mapbox/carto/issues/454)) +* `husl()` was renamed to `hsluv()`. The HuSL variant is deprecated and will be removed in 1.0.0. ([#456](https://github.com/mapbox/carto/issues/456)) +* The `name` attribute for layers in the MML is deprecated and will be removed in 1.0.0. Use `id` instead. ([#165](https://github.com/mapbox/carto/issues/165)) +* The `_properties` object in the MML of vector tiles projects is now supported ([#450](https://github.com/mapbox/carto/issues/450)) +* Updated `mapnik-reference` to 8.6.1, which enables Browser support and support for the `transform` property of PolygonPatternSymbolizer ([#445](https://github.com/mapbox/carto/issues/445)) +* Bugfixes ([#296](https://github.com/mapbox/carto/issues/296), [#121](https://github.com/mapbox/carto/issues/121), [#315](https://github.com/mapbox/carto/issues/315), [#411](https://github.com/mapbox/carto/issues/411), [#426](https://github.com/mapbox/carto/issues/426), [#273](https://github.com/mapbox/carto/issues/273)) +* Documentation updates ([#269](https://github.com/mapbox/carto/issues/269), [#452](https://github.com/mapbox/carto/issues/452)) ## 0.16.3 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index afb531a..20c0afb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,26 +22,14 @@ Running the head binary: - `npm publish` - Regenerate documentation (see below) -If there's a high chance of regression, please bump to 1.0.0 so that code using a semver ^ or ~ doesn't auto-upgrade anyone. +If there's a high chance of regression, please bump to a new major version number +so that code using a semver ^ or ~ doesn't auto-upgrade anyone. For examples of previous releases see: https://github.com/mapbox/carto/issues/440 ## Documentation This repository contains auto-generated documentation of the content of Carto -that's published on Mapbox.com. - - git fetch origin gh-pages:gh-pages - -Edit `_docs/package.json` to point to the head version of [mapnik-reference](https://github.com/mapnik/mapnik-reference). - - cd _docs - npm install - node generate.js - -Then run up a directory and run the testing server: - - cd ../ - jekyll serve -p 4000 - -Test the new site at `localhost:4000/carto` and if things look good then git add your changes and push. +that's published on readthedocs.io. You find the relevant files in the `docs` +directory. Those files with the extension `rst` are the ones where you find +the documentation sources in reStructuredText. @@ -1,17 +1,16 @@ # CartoCSS -[](http://travis-ci.org/mapbox/carto) [](https://ci.appveyor.com/project/Mapbox/carto) [](https://coveralls.io/github/mapbox/carto?branch=master) [](https://www.npmjs.com/package/carto) +[](http://travis-ci.org/mapbox/carto) [](https://ci.appveyor.com/project/Mapbox/carto) [](https://coveralls.io/github/mapbox/carto?branch=master) [](https://www.npmjs.com/package/carto) [](https://david-dm.org/mapbox/carto) [](http://cartocss.readthedocs.io/en/latest/?badge=latest) -Is the language for map design used by [Mapbox Studio Classic](http://mapbox.com/mapbox-studio-classic/). It is similar in syntax to CSS, but builds upon it with specific abilities to filter map data and by providing things like variables. +CartoCSS (short: Carto) is a language for map design. It is similar in syntax to CSS, but builds upon it with specific abilities to filter map data and by providing things like variables. +It targets the [Mapnik renderer](http://mapnik.org) and is able to generate Mapnik XML and a JSON variant of Mapnik XML. +It can run from the command line or in the browser. -Carto, aka CartoCSS, targets the [Mapnik renderer](http://mapnik.org) and is able to generate Mapnik XML. - -Carto is an evolution of the [Cascadenik](https://github.com/mapnik/Cascadenik) idea and language, -with an emphasis on speed and flexibility. If you are a previous user of Cascadenik, see the [key differences wiki](https://github.com/mapbox/carto/wiki/Differences-With-Cascadenik). +Carto is an evolution of the [Cascadenik](https://github.com/mapnik/Cascadenik) idea and language, with an emphasis on speed and flexibility. ## Documentation -For users looking to learn how to use Mapbox Studio Classic the best places to start are to 1) Download [Mapbox Studio Classic](https://www.mapbox.com/mapbox-studio-classic/) and review the [Carto reference documentation](https://github.com/mapbox/carto/blob/master/docs/latest.md). +The best place to start is to review the [CartoCSS documentation](https://cartocss.readthedocs.io). Tutorials like the [Mapbox Getting started with CartoCSS guide](https://www.mapbox.com/guides/getting-started-cartocss/) are a great place to start to learn the basics of CartoCSS. @@ -24,166 +23,16 @@ For more advanced topics see the [Studio style quickstart guide](https://www.map - [How to style polygons](https://www.mapbox.com/tilemill/docs/guides/styling-polygons/) - See also the [Styling Concepts](#styling-concepts) for explanations of advanced features. -## Developers - -For details about how to install Carto from source and use on the command line see the [Installation section](#installation). - -## Styling Concepts - -### Attachments and Instances - -In CSS, a certain object can only have one instance of a property. A `<div>` has a specific border width and color, rules that match better than others (#id instead of .class) override previous definitions. `CartoCSS` acts the same way normally for the sake of familiarity and organization, but Mapnik itself is more powerful. - -Layers in Mapnik can have multiple [borders](http://trac.mapnik.org/wiki/LineSymbolizer) and multiple copies of other attributes. This ability is useful in drawing line outlines, like in the case of road borders or 'glow' effects around coasts. `CartoCSS` makes this accessible by allowing attachments to styles: - -```css -#world { - line-color: #fff; - line-width: 3; -} - -#world::outline { - line-color: #000; - line-width: 6; -} -``` - -Attachments are optional. - -While attachments allow creating implicit "layers" with the same data, using **instances** allows you to create multiple symbolizers in the same style/layer: - -```css -#roads { - casing/line-width: 6; - casing/line-color: #333; - line-width: 4; - line-color: #666; -} -``` - -This makes Mapnik first draw the line of color #333 with a width of 6, and then immediately afterwards, it draws the same line again with width 4 and color #666. Contrast that to attachments: Mapnik would first draw all casings before proceeding to the actual lines. - -## Variables & Expressions - -CartoCSS inherits from its basis in [less.js](http://lesscss.org/) some new features in CSS. One can define variables in stylesheets, and use expressions to modify them. - -```css -@mybackground: #2B4D2D; - -Map { - background-color: @mybackground -} - -#world { - polygon-fill: @mybackground + #222; - line-color: darken(@mybackground, 10%); -} -``` - -## Nested Styles - -CartoCSS also inherits nesting of rules from less.js. - -```css -/* Applies to all layers with .land class */ -.land { - line-color: #ccc; - line-width: 0.5; - polygon-fill: #eee; - /* Applies to #lakes.land */ - #lakes { - polygon-fill: #000; - } -} -``` - -This can be a convenient way to group style changes by zoom level: - -```css -[zoom > 1] { - /* Applies to all layers at zoom > 1 */ - polygon-gamma: 0.3; - #world { - polygon-fill: #323; - } - #lakes { - polygon-fill: #144; - } -} -``` - -## FontSets - -By defining multiple fonts in a `text-face-name` definition, you create [FontSets](http://trac.mapnik.org/wiki/FontSet) in `CartoCSS`. These are useful for supporting multiple character sets and fallback fonts for distributed styles. - -<table> - <tr> - <th>carto</th><th>XML</th> - </tr> - <tr> - <td valign='top'> - - <pre>#world { - text-name: "[NAME]"; - text-size: 11; - text-face-name: "Georgia Regular", "Arial Italic"; -}</pre> - -</td> -<td valign='top'> -<pre><FontSet name="fontset-0"> - <Font face-name="Georgia Regular"/> - <Font face-name="Arial Italic"/> -</FontSet> -<Style name="world-text"> - <Rule> - <TextSymbolizer fontset-name="fontset-0" - size="11" - name="[NAME]"/> - </Rule> -</Style></pre> -</td> -<tr> -</table> - -## Filters - -CartoCSS supports a variety of filter styles: - -Numeric comparisons: - -``` -#world[population > 100] -#world[population < 100] -#world[population >= 100] -#world[population <= 100] -``` +## Installation -General comparisons: +If you are using a map design application like Kosmtik, Mapbox Studio Classic or Tilemill you already have CartoCSS installed +and might be more interested in the language reference. -``` -#world[population = 100] -#world[population != 100] -``` - - -String comparisons: - -``` -/* a regular expression over name */ -#world[name =~ "A.*"] -``` - -#### Installation - -If you're using [Mapbox Studio Classic](http://mapbox.com/mapbox-studio/), you're already -using CartoCSS and don't need to do a thing. - -If you're a developer-type and want to use the `carto` binary with -`node.js` (and you have [npm](http://npmjs.org/) installed), +Else you can install the `carto` binary with NPM by running: npm install -g carto +You should consider using a Node.js version manager like [NVM](https://github.com/creationix/nvm). Optionally you may also want to install millstone which is required for resolving data in the same way as Mapbox Studio Classic does: npm install -g millstone @@ -191,44 +40,70 @@ Optionally you may also want to install millstone which is required for resolvin Having `millstone` installed specifically enable support for localizing external resources (URLs and local files) referenced in your mml file, and detecting projections (using [node-srs](https://github.com/mapbox/node-srs)) -Now that Carto is installed you should have a `carto` command line tool available that can be run on a Mapbox Studio Classic project: +## Usage + +Now that Carto is installed you should have a `carto` command line tool available that can be run on a CartoCSS project: carto project.mml > mapnik.xml Available parameters: -* -h / --help - Display help message -* -v / --version - Display version information +* -a / --api VERSION - Specify Mapnik API version (e.g. --api 3.0.10) (default: latest Mapnik API version) * -b / --benchmark - Outputs total compile time +* -f / --file - Outputs to the specified file instead of stdout +* -h / --help - Display help message * -l / --localize - Use millstone to localize resources when loading an MML (default: off) * -n / --nosymlink - Use absolute paths instead of symlinking files -* -a / --api VERSION - Specify Mapnik API version (e.g. --api 3.0.10) (default: 2.3.0) +* -o / --output - Specify output format, possible values are `mapnik` and `json` (default: `mapnik`) * -ppi RESOLUTION - Pixels per inch used to convert m, mm, cm, in, pt, pc to pixels (default: 90.714) +* -q / --quiet - Do not output any warnings (default: off) +* -v / --version - Display version information -#### From code - -Currently CartoCSS is designed to be invoked from [node.js](http://nodejs.org/). +Alternatively, Carto can be used from JavaScript. The `Renderer` interface is the main API for developers, and it takes an MML file as a string as input. - // defined variables: - // - input (the name or identifier of the file being parsed) - // - data (a string containing the MML or an object of MML) - var carto = require('carto'); - - try { - var output = new carto.Renderer({ - filename: input, - local_data_dir: path.dirname(input), - }).render(data); - } catch(err) { - if (Array.isArray(err)) { - err.forEach(function(e) { - carto.writeError(e, options); +```javascript +// defined variables: +// - input (the name or identifier of the file being parsed) +var carto = require('carto'); + +try { + var data = fs.readFileSync(input, 'utf-8'); + var mml = new carto.MML({}); + mml.load(path.dirname(input), data, function (err, data) { + var output = {}; + + if (!err) { + output = new carto.Renderer({ + filename: input + }).render(data); + } + + if (output.msg) { + output.msg.forEach(function (v) { + if (v.type === 'error') { + console.error(carto.Util.getMessageToPrint(v)); + } + else if (v.type === 'warning') { + console.warn(carto.Util.getMessageToPrint(v)); + } }); - } else { throw err; } - } - console.log(output); + } + + // output content (if no errors) + if (output.data) { + console.log(output.data); + } + }); +} catch (err) { + // program failures + ... +} +``` -### Vim +If you want to use CartoCSS within the browser you should not use MML loading via `carto.MML.load`. +Instead you should supply the JSON of the MML including the Stylesheet strings directly to `carto.Renderer.render`. + +## Vim To install, download or clone this repository, then copy the `vim-carto` directory located at `build/vim-carto` to your `~/.vim` directory. @@ -241,9 +116,14 @@ CartoCSS is based on [less.js](https://github.com/cloudhead/less.js), a CSS comp See also a [list of dependencies](https://david-dm.org/mapbox/carto#info=dependencies&view=list). +## Similar projects + +* [Magnacarto](https://github.com/omniscale/magnacarto) (Go implementation of CartoCSS for Mapnik and Mapserver) + ## Authors * Tom MacWright (tmcw) * Konstantin Käfer (kkaefer) * AJ Ashton (ajashton) * Dane Springmeyer (springmeyer) +* Michael Glanznig (nebulon42) diff --git a/appveyor.yml b/appveyor.yml index 09804c9..21383f8 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -1,10 +1,9 @@ # Test against this versions of Node.js environment: matrix: - - nodejs_version: 5 - - nodejs_version: 4 - - nodejs_version: 0.12 - - nodejs_version: 0.10 + - nodejs_version: 10 + - nodejs_version: 8 + - nodejs_version: 6 # Install scripts. (runs after repo cloning) install: @@ -3,10 +3,9 @@ var path = require('path'), fs = require('fs'), carto = require('../lib/carto'), - semver = require('semver'), url = require('url'), _ = require('lodash'), - yaml = require('js-yaml'); + util = require('../lib/carto/util'); var existsSync = require('fs').existsSync || require('path').existsSync @@ -17,7 +16,10 @@ var yargs = require('yargs') .options('b', {alias:'benchmark', boolean:true, describe:'Outputs total compile time'}) .options('l', {alias:'localize', boolean:true, default:false, describe:'Use millstone to localize resources when loading an MML'}) .options('n', {alias:'nosymlink', boolean:true, describe:'Use absolute paths instead of symlinking files'}) - .options('a', {alias:'api', describe:'Specify Mapnik API version', default:'2.3.0'}) + .options('a', {alias:'api', describe:'Specify Mapnik API version'}) + .options('f', {alias:'file', describe:'Outputs to the given file instead of stdout.'}) + .options('o', {alias:'output', describe:'Specify output format (mapnik, json)', default:'mapnik'}) + .options('q', {alias:'quiet', boolean:true, default:false, describe:'Do not output any warnings'}) .options('ppi', {describe:'Pixels per inch used to convert m, mm, cm, in, pt, pc to pixels', default:90.714}); var options = yargs.argv; @@ -42,13 +44,6 @@ if (!input) { process.exit(1); } -if (options.api) { - if (!semver.valid(options.api)) { - console.error("carto: invalid Mapnik API version. A valid version is e.g. 3.0.10"); - process.exit(1); - } -} - if (options.benchmark) { var start = +new Date; } @@ -65,26 +60,62 @@ if (!existsSync(input)) { process.exit(1); } -function compileMML(err, data) { - // force drain the millstone download pool now - // to ensure we can exit without waiting - if (options.localize && millstone.drainPool) { - millstone.drainPool(function() {}); - } +try { + var data = fs.readFileSync(input, 'utf-8'); +} catch(err) { + console.error("carto: " + err.message.replace(/^[A-Z]+, /, '')); + process.exit(1); +} + +if (ext === '.mml') { + var mml = new carto.MML(options); + mml.load(path.dirname(input), data, compile); +} else if (ext === '.mss') { + compile(null, data); +} else { + console.error("carto: please pass either a .mml file or .mss file"); +} + + +function compile(err, data) { if (err) { console.error(err); process.exit(1); } + var renderer = new carto.Renderer({ filename: input, benchmark: options.benchmark, - ppi: options.ppi - }, - { - mapnik_version: options.api + ppi: options.ppi, + quiet: options.quiet, + outputFormat: options.output, + version: options.api }); try { - var output = renderer.render(data); + var output; + if (ext === '.mml') { + output = renderer.render(data); + } else if (ext === '.mss') { + output = renderer.renderMSS(data); + } + + if (_.has(output, 'msg') && _.isArray(output.msg) && + output.msg.length > 0) { + var hasError = false; + _.forEach(output.msg, function (v) { + if (v.type === 'error') { + console.error(util.getMessageToPrint(v)); + hasError = true; + } + else if (v.type === 'warning') { + console.warn(util.getMessageToPrint(v)); + } + }); + + if (hasError) { + process.exit(1); + } + } } catch (e) { if (e.stack) { console.error(e.stack); @@ -97,88 +128,23 @@ function compileMML(err, data) { process.exit(1); } if (!options.benchmark) { - console.log(output); - } else { - var duration = (+new Date) - start; - console.log('TOTAL: ' + (duration) + 'ms'); - } -}; - -function compileMSS(err, data) { - if (err) { - console.error(err); - process.exit(1); - } - var renderer = new carto.Renderer({ - filename: path.basename(input), - benchmark: options.benchmark, - ppi: options.ppi - }, - { - mapnik_version: options.api - }); - try { - var output = renderer.renderMSS(data); - } catch (e) { - if (e.stack) { - console.error(e.stack); - } else { - console.error(e); + if (!_.isNil(output.data)) { + if (options.file) { + try { + fs.writeFileSync(options.file, output.data); + } + catch (e) { + console.error(e); + console.error('Writing to given file ' + options.file + ' failed. Falling back to stdout output.'); + console.log(output.data); + } + } + else { + console.log(output.data); + } } - process.exit(1); - } - if (!options.benchmark) { - console.log(output); } else { var duration = (+new Date) - start; console.log('TOTAL: ' + (duration) + 'ms'); } }; - -try { - var data = fs.readFileSync(input, 'utf-8'); -} catch(err) { - console.error("carto: " + err.message.replace(/^[A-Z]+, /, '')); - process.exit(1); -} - -if (ext == '.mml') { - try { - data = yaml.safeLoad(data); - } catch(err) { - console.error("carto: " + err.message.replace(/^[A-Z]+, /, '')); - process.exit(1); - } - - if (options.localize) { - var millstone = undefined; - try { - require.resolve('millstone'); - millstone = require('millstone'); - } catch (err) { - console.error('carto: Millstone not found, required if localizing stylesheet resources. ' + err.message.replace(/^[A-Z]+, /, '')); - process.exit(1); - } - millstone.resolve({ - mml: data, - base: path.dirname(input), - cache: path.join(path.dirname(input), 'cache'), - nosymlink: options.nosymlink - }, compileMML); - } else { - if (_.has(data, 'Stylesheet') && !_.isNil(data.Stylesheet)) { - data.Stylesheet = _.castArray(data.Stylesheet); - data.Stylesheet = data.Stylesheet.map(function(x) { - if (typeof x !== 'string') { - return { id: x, data: x.data } - } - return { id: x, data: fs.readFileSync(path.join(path.dirname(input), x), 'utf8') } - }); - } - compileMML(null,data); - } -} else if (ext == '.mss') { - compileMSS(null,data); -} else { - console.error("carto: please pass either a .mml file or .mss file"); -} diff --git a/docs-generator/README.md b/docs-generator/README.md deleted file mode 100644 index 3cd22d6..0000000 --- a/docs-generator/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# Generating CartoCSS docs - -From the `docs-generator/` directory: - -``` -$ npm install -``` - -Then: - -``` -$ node generate.js -``` - -Will save docs to `docs/`.
\ No newline at end of file diff --git a/docs-generator/generate.js b/docs-generator/generate.js deleted file mode 100644 index 399437e..0000000 --- a/docs-generator/generate.js +++ /dev/null @@ -1,22 +0,0 @@ -var fs = require('fs'), - path = require('path'), - refs = require('mapnik-reference'), - _ = require('lodash'); - -function tmpl(x) { - return _.template(fs.readFileSync(path.join(__dirname, x), 'utf-8')); -} - -var index = tmpl('index._'); -var table = tmpl('symbolizers._'); - - refs.versions.forEach(function (v) { - var ref = refs.load(v); - fs.writeFileSync(path.join(__dirname, '../docs/' + v + '.md'), index({ - symbolizers: ref.symbolizers, - table: table, - version: v, - versions: refs.versions, - _: _ - })); -}); diff --git a/docs-generator/index._ b/docs-generator/index._ deleted file mode 100644 index 8f8bd56..0000000 --- a/docs-generator/index._ +++ /dev/null @@ -1,153 +0,0 @@ -# Carto documentation - -The following is a list of properties provided in CartoCSS that you can apply to map elements. -<%= table({symbolizers:symbolizers}) %> - -### Values - -Below is a list of values and an explanation of any expression that can be applied to properties in CartCSS. - -### Color - -CartoCSS accepts a variety of syntaxes for colors - HTML-style hex values, rgb, rgba, hsl, hsla, husl, and husla. It also supports the predefined HTML colors names, like `yellow` and `blue`. - -``` css -#line { -line-color: #ff0; -line-color: #ffff00; -line-color: rgb(255, 255, 0); -line-color: rgba(255, 255, 0, 1); -line-color: hsl(100, 50%, 50%); -line-color: hsla(100, 50%, 50%, 1); -line-color: husl(100, 50%, 50%); // same values yield different color than HSL -line-color: husla(100, 50%, 50%, 1); -line-color: yellow; -} -``` - -Especially of note is the support for hsl and husl, which can be [easier to reason about than rgb()](http://mothereffinghsl.com/). Carto also includes several color operation functions [borrowed from less](http://lesscss.org/functions/#color-operations): - -``` css -// lighten and darken colors -lighten(#ace, 10%); -darken(#ace, 10%); - -// saturate and desaturate -saturate(#550000, 10%); -desaturate(#00ff00, 10%); - -// increase or decrease the opacity of a color -fadein(#fafafa, 10%); -fadeout(#fefefe, 14%); - -// spin rotates a color around the color wheel by degrees -spin(#ff00ff, 10); - -// mix generates a color in between two other colors. -mix(#fff, #000, 50%); - -// get color components -hue(#ff00ff); -saturation(#ff00ff); -lightness(#ff00ff); -alpha(hsla(100, 50%, 50%, 0.5)); -``` - -These functions all take arguments which can be color variables, literal colors, or the results of other functions operating on colors. All the above mentioned functions also come in -a `functionp`-variant (e.g. `lightenp`), which force a given color into perceptual color space. - -### Float - -Float is a fancy way of saying 'number'. In CartoCSS, you specify _just a number_ - unlike CSS, there are no units, but everything is specified in pixels. - -``` css -#line { -line-width: 2; -} -``` - -It's also possible to do simple math with number values: - -``` css -#line { -line-width: 4 / 2; // division -line-width: 4 + 2; // addition -line-width: 4 - 2; // subtraction -line-width: 4 * 2; // multiplication -line-width: 4 % 2; // modulus -} -``` - -### URI - -URI is a fancy way of saying URL. When an argument is a URI, you use the same kind of `url('place.png')` notation that you would with HTML. Quotes around the URL aren't required, but are highly recommended. URIs can be paths to places on your computer, or on the internet. - -```css -#markers { -marker-file: url('marker.png'); -} -``` - -### String - -A string is basically just text. In the case of CartoCSS, you're going to put it in quotes. Strings can be anything, though pay attention to the cases of `text-name` and `shield-name` - they actually will refer to features, which you refer to by putting them in brackets, as seen in the example below. - -```css -#labels { -text-name: "[MY_FIELD]"; -} -``` - -### Boolean - -Boolean means yes or no, so it accepts the values `true` or `false`. - -```css -#markers { -marker-allow-overlap:true; -} -``` - -### Expressions - -Expressions are statements that can include fields, numbers, and other types in a really flexible way. You have run into expressions before, in the realm of 'fields', where you'd specify `"[FIELD]"`, but expressions allow you to drop the quotes and also do quick addition, division, multiplication, and concatenation from within Carto syntax. - -```css -#buildings { -building-height: [HEIGHT_FIELD] * 10; -} -``` - -### Numbers -Numbers are comma-separated lists of one or more number in a specific order. They're used in line dash arrays, in which the numbers specify intervals of line, break, and line again. - -```css -#disputedboundary { -line-dasharray: 1, 4, 2; -} -``` - -### Percentages -In Carto, the percentage symbol, `%` universally means `value/100`. It's meant to be used with ratio-related properties, like opacity rules. - -_You should not use percentages as widths, heights, or other properties - unlike CSS, percentages are not relative to cascaded classes or page size, they're, as stated, simply the value divided by one hundred._ - -```css -#world { -// this syntax -polygon-opacity: 50%; - -// is equivalent to -polygon-opacity: 0.5; -} -``` - -### Functions - -Functions are comma-separated lists of one or more functions. For instance, transforms use the `functions` type to allow for transforms within Carto, which are optionally chainable. - -```css -#point { -point-transform: scale(2, 2); -} -``` diff --git a/docs-generator/package.json b/docs-generator/package.json deleted file mode 100644 index 3277622..0000000 --- a/docs-generator/package.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "name": "carto-site", - "private": true, - "version": "0.0.0", - "description": "Mapnik Stylesheet Compiler", - "url": "https://github.com/mapbox/carto", - "repositories": [{ - "type": "git", - "url": "http://github.com/mapbox/carto.git" - }], - "author": { - "name": "MapBox", - "url": "http://mapbox.com/", - "email": "info@mapbox.com" - }, - "dependencies": { - "lodash": "~4.5.1", - "mapnik-reference": "~8.5.3" - } -} diff --git a/docs-generator/symbolizers._ b/docs-generator/symbolizers._ deleted file mode 100644 index 0cf507b..0000000 --- a/docs-generator/symbolizers._ +++ /dev/null @@ -1,14 +0,0 @@ -<% _(symbolizers).each(function(symbolizer, name) { %> -<% if (name == '*') { %>## All elements<% } else { %>## <%= name %><% } %> -<% _(symbolizer).filter(function(p) { return p.css; }).each(function(p) { %> -##### <%= p.css.replace(/\s/g, '') %> <% if (_.isArray(p.type)) { %>`keyword`<% } else { %>`<%= p.type %>`<% } %> -<% if (_.isArray(p.type)) { %><% _(p.type).each(function(type) { %>`<%= type %>`<% }); %><% } %> -<% if (p.type === 'functions' && _.isArray(p.functions)) { %><% _(p.functions).each(function(type) { %>`<%= type[0] %>`<% }); %><% } %> - -<% if (typeof p['default-value'] !== '') { %>Default Value: <%= p['default-value'] %><% } %> -<% if (p['default-meaning']) { %>_(<%- p['default-meaning'] %>)_<% } %> -<% if (typeof p['range'] !== 'undefined') { %>Range: <%= '' + p['range'] %><% } %> -<% if (p.doc) { %><%= p.doc%><% } %> -* * * -<% }); %> -<% }); %> diff --git a/docs/2.0.0.md b/docs/2.0.0.md deleted file mode 100644 index e81d79d..0000000 --- a/docs/2.0.0.md +++ /dev/null @@ -1,1277 +0,0 @@ -# Carto documentation - -The following is a list of properties provided in CartoCSS that you can apply to map elements. - -## map - -##### background-color `color` - - - -Default Value: none -_(transparent)_ - -Map Background color -* * * - -##### background-image `uri` - - - -Default Value: -_(transparent)_ - -An image that is repeated below all features on a map as a background. -* * * - -##### srs `string` - - - -Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs -_(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space)_ - -Map spatial reference (proj4 string) -* * * - -##### buffer-size `float` - - - -Default Value: 0 -_(No buffer will be used)_ - -Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". -* * * - -##### base `string` - - - -Default Value: -_(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)_ - -Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. -* * * - -##### font-directory `uri` - - - -Default Value: none -_(No map-specific fonts will be registered)_ - -Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). -* * * - - -## polygon - -##### polygon-fill `color` - - - -Default Value: rgba(128,128,128,1) -_(gray and fully opaque (alpha = 1), same as rgb(128,128,128))_ - -Fill color to assign to a polygon -* * * - -##### polygon-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of polygon edges -* * * - -##### polygon-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of the polygon -* * * - -##### polygon-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Amount of smoothing applied -* * * - - -## line - -##### line-color `color` - - - -Default Value: rgba(0,0,0,1) -_(black and fully opaque (alpha = 1), same as rgb(0,0,0))_ - -The color of a drawn line -* * * - -##### line-width `float` - - - -Default Value: 1 - - -The width of a line in pixels -* * * - -##### line-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of a line -* * * - -##### line-join `keyword` -`miter``round``bevel` - - -Default Value: miter - - -The behavior of lines when joining -* * * - -##### line-cap `keyword` -`butt``round``square` - - -Default Value: butt - - -The display of line endings -* * * - -##### line-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of stroke line -* * * - -##### line-dasharray `numbers` - - - -Default Value: none -_(solid line)_ - -A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. -* * * - -##### line-dash-offset `numbers` - - - -Default Value: none -_(solid line)_ - -valid parameter but not currently used in renderers -* * * - -##### line-rasterizer `keyword` -`full``fast` - - -Default Value: full - - -Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. -* * * - - -## markers - -##### marker-file `uri` - - - -Default Value: -_(An ellipse or circle, if width equals height)_ - -An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse. -* * * - -##### marker-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The overall opacity of the marker -* * * - -##### marker-line-color `color` - - - -Default Value: black - - -The color of the stroke around a marker shape. -* * * - -##### marker-line-width `float` - - - -Default Value: 0.5 - - -The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. -* * * - -##### marker-line-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of a line -* * * - -##### marker-placement `keyword` -`point``line` - - -Default Value: line - - -Attempt to place markers on a point once or on a line repeatedly -* * * - -##### marker-type `keyword` -`arrow``ellipse` - - -Default Value: ellipse - - -The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width) -* * * - -##### marker-width `float` - - - -Default Value: 10 - - -The width of the marker, if using one of the default types. -* * * - -##### marker-height `float` - - - -Default Value: 10 - - -The height of the marker, if using one of the default types. -* * * - -##### marker-fill `color` - - - -Default Value: blue - - -The color of the area of the marker. -* * * - -##### marker-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow makers to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping markers are shown or hidden. -* * * - -##### marker-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache)_ - -value to control whether the placement of the feature will prevent the placement of other features -* * * - -##### marker-spacing `float` - - - -Default Value: 100 - - -Space between repeated labels -* * * - -##### marker-max-error `float` - - - -Default Value: 0.2 - - -The maximum difference between actual marker placement and the marker-spacing parameter. Setting a high value can allow the renderer to try to resolve placement conflicts with other symbolizers. -* * * - -##### marker-transform `string` - - - -Default Value: -_(no transformation)_ - -An SVG transformation definition -* * * - - -## shield - -##### shield-name `string` - - - -Default Value: - - -Value to use for a shield"s text label. Data columns are specified using brackets like [column_name] -* * * - -##### shield-face-name `string` - - - -Default Value: - - -Font name and style to use for the shield text -* * * - -##### shield-unlock-image `boolean` - - - -Default Value: false -_(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)_ - -This parameter should be set to true if you are trying to position text beside rather than on top of the shield image -* * * - -##### shield-size `float` - - - -Default Value: 10 - - -The size of the shield text in pixels -* * * - -##### shield-fill `color` - - - -Default Value: black - - -The color of the shield text -* * * - -##### shield-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point - - -How this shield should be placed. Point placement attempts to place it on top of points, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of polygons. -* * * - -##### shield-avoid-edges `boolean` - - - -Default Value: false - - -Tell positioning algorithm to avoid labeling near intersection edges. -* * * - -##### shield-min-distance `float` - - - -Default Value: 0 - - -Minimum distance to the next shield symbol, not necessarily the same shield. -* * * - -##### shield-spacing `float` - - - -Default Value: 0 - - -The spacing between repeated occurrences of the same shield on a line -* * * - -##### shield-min-padding `float` - - - -Default Value: 0 - - -Determines the minimum amount of padding that a shield gets relative to other shields -* * * - -##### shield-wrap-width `float` - - - -Default Value: 0 - - -Length before wrapping long names. -* * * - -##### shield-wrap-character `string` - - - -Default Value: - - -Use this character instead of a space to wrap long names. -* * * - -##### shield-halo-fill `color` - - - -Default Value: #FFFFFF -_(white)_ - -Specifies the color of the halo around the text. -* * * - -##### shield-halo-radius `float` - - - -Default Value: 0 -_(no halo)_ - -Specify the radius of the halo in pixels -* * * - -##### shield-character-spacing `float` - - - -Default Value: 0 - - -Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. -* * * - -##### shield-line-spacing `float` - - - -Default Value: 0 - - -Vertical spacing between lines of multiline labels (in pixels) -* * * - -##### shield-file `uri` - - - -Default Value: none - - -Image file to render behind the shield text -* * * - -##### shield-text-dx `float` - - - -Default Value: 0 - - -Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right -* * * - -##### shield-text-dy `float` - - - -Default Value: 0 - - -Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down -* * * - -##### shield-dx `float` - - - -Default Value: 0 - - -Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right -* * * - -##### shield-dy `float` - - - -Default Value: 0 - - -Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down -* * * - -##### shield-opacity `float` - - - -Default Value: 1 - - -(Default 1.0) - opacity of the image used for the shield -* * * - -##### shield-text-opacity `float` - - - -Default Value: 1 - - -(Default 1.0) - opacity of the text placed on top of the shield -* * * - -##### shield-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: middle - - -The shield's horizontal alignment from its centerpoint -* * * - -##### shield-text-transform `keyword` -`none``uppercase``lowercase``capitalize` - - -Default Value: none - - -Transform the case of the characters -* * * - -##### shield-no-text `boolean` - - - -Default Value: false - - -Whether the shield should make room for a text label. -* * * - -##### shield-justify-alignment `string` - - - -Default Value: middle - - -Define how text in a shield's label is justified -* * * - - -## line-pattern - -##### line-pattern-file `uri` - - - -Default Value: none - - -An image file to be repeated and warped along a line -* * * - - -## polygon-pattern - -##### polygon-pattern-file `uri` - - - -Default Value: none - - -Image to use as a repeated pattern fill within a polygon -* * * - -##### polygon-pattern-alignment `keyword` -`local``global` - - -Default Value: local - - -Specify whether to align pattern fills to the layer or to the map. -* * * - -##### polygon-pattern-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of polygon pattern edges -* * * - - -## raster - -##### raster-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of the raster symbolizer on top of other symbolizers. -* * * - -##### raster-mode `keyword` -`normal``grain_merge``grain_merge2``multiply``multiply2``divide``divide2``screen``hard_light` - - -Default Value: normal - - -The blending technique used to overlay this raster image on the layer below. Normal simply covers the layer. Grain merge adds the two layers together and subtracts 128 from the value, making the resulting area sometimes high-contrast. Screen often gives a lighter, washed-out appearance. Multiply multiplies the pixels, giving a high-contrast result. Divide divides the upper layer by the lower layer, making a lighter version. -* * * - -##### raster-filter-factor `float` - - - -Default Value: -1 -_(Allow the datasource to choose appropriate downscaling.)_ - -This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. -* * * - -##### raster-scaling `keyword` -`fast``bilinear``bilinear8``bicubic``spline16``gaussian``lanczos` - - -Default Value: fast - - -The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. -* * * - -##### raster-mesh-size `integer` - - - -Default Value: 16 -_(Reprojection mesh will be 1/16 of the resolution of the source image)_ - -A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. -* * * - - -## point - -##### point-file `uri` - - - -Default Value: none - - -Image file to represent a point -* * * - -##### point-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow points to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping points are shown or hidden. -* * * - -##### point-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache)_ - -value to control whether the placement of the feature will prevent the placement of other features -* * * - -##### point-opacity `float` - - - -Default Value: 1 -_(Fully opaque)_ - -A value from 0 to 1 to control the opacity of the point -* * * - -##### point-placement `keyword` -`centroid``interior` - - -Default Value: centroid - - -How this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. -* * * - -##### point-transform `string` - - - -Default Value: -_(No transformation)_ - -SVG transformation definition -* * * - - -## text - -##### text-name `string` - - - -Default Value: - - -Value to use for a text label. Data columns are specified using brackets like [column_name] -* * * - -##### text-face-name `string` - - - -Default Value: - - -Font name and style to render a label in -* * * - -##### text-size `float` - - - -Default Value: 10 - - -Text size in pixels -* * * - -##### text-ratio `float` - - - -Default Value: 0 - - -Define the amount of text (of the total) present on successive lines when wrapping occurs -* * * - -##### text-wrap-width `float` - - - -Default Value: 0 - - -Length of a chunk of text in characters before wrapping text -* * * - -##### text-wrap-character `string` - - - -Default Value: - - -Use this character instead of a space to wrap long text. -* * * - -##### text-spacing `float` - - - -Default Value: 0 - - -Distance between repeated text labels on a line -* * * - -##### text-character-spacing `float` - - - -Default Value: 0 - - -Horizontal spacing adjustment between characters in pixels -* * * - -##### text-line-spacing `float` - - - -Default Value: 0 - - -Vertical spacing adjustment between lines in pixels -* * * - -##### text-label-position-tolerance `float` - - - -Default Value: 0 - - -Allows the label to be displaced from its ideal position by a number of pixels -* * * - -##### text-max-char-angle-delta `float` - - - -Default Value: none - - -If present, the maximum angle change, in degrees, allowed between adjacent characters in a label. This will stop label placement around sharp corners. -* * * - -##### text-fill `color` - - - -Default Value: #000000 - - -Specifies the color for the text -* * * - -##### text-opacity `float` - - - -Default Value: 1 -_(Fully opaque)_ - -A number from 0 to 1 specifying the opacity for the text -* * * - -##### text-halo-fill `color` - - - -Default Value: #FFFFFF -_(white)_ - -Specifies the color of the halo around the text. -* * * - -##### text-halo-radius `float` - - - -Default Value: 0 -_(no halo)_ - -Specify the radius of the halo in pixels -* * * - -##### text-dx `float` - - - -Default Value: 0 - - -Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right -* * * - -##### text-dy `float` - - - -Default Value: 0 - - -Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down -* * * - -##### text-vertical-alignment `keyword` -`top``middle``bottom` - - -Default Value: middle -_(Default affected by value of dy; "bottom" for dy>0, "top" for dy<0.)_ - -Position of label relative to point position. -* * * - -##### text-avoid-edges `boolean` - - - -Default Value: false - - -Tell positioning algorithm to avoid labeling near intersection edges. -* * * - -##### text-min-distance `float` - - - -Default Value: 0 - - -Minimum permitted distance to the next text symbolizer. -* * * - -##### text-min-padding `float` - - - -Default Value: 0 - - -Determines the minimum amount of padding that a text symbolizer gets relative to other text -* * * - -##### text-min-path-length `float` - - - -Default Value: 0 -_(place labels on all paths)_ - -Place labels only on paths longer than this value. -* * * - -##### text-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow text to overlap with other text - overlapping markers will not be shown.)_ - -Control whether overlapping text is shown or hidden. -* * * - -##### text-orientation `float` - - - -Default Value: 0 - - -Rotate the text. -* * * - -##### text-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point - - -Control the style of placement of a point versus the geometry it is attached to. -* * * - -##### text-placement-type `keyword` -`dummy``simple` - - -Default Value: dummy - - -Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. -* * * - -##### text-placements `string` - - - -Default Value: - - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. See TextSymbolizer docs for format. -* * * - -##### text-transform `keyword` -`none``uppercase``lowercase``capitalize` - - -Default Value: none - - -Transform the case of the characters -* * * - -##### text-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: middle - - -The text's horizontal alignment from its centerpoint -* * * - -##### text-align `keyword` -`left``right``center` - - -Default Value: center - - -Set the text alignment. -* * * - - -## building - -##### building-fill `color` - - - -Default Value: #FFFFFF - - -The color of the buildings walls. -* * * - -##### building-fill-opacity `float` - - - -Default Value: 1 - - -The opacity of the building as a whole, including all walls. -* * * - -##### building-height `float` - - - -Default Value: 0 - - -The height of the building in pixels. -* * * - - - - -### Values - -Below is a list of values and an explanation of any expression that can be applied to properties in CartCSS. - -### Color - -CartoCSS accepts a variety of syntaxes for colors - HTML-style hex values, rgb, rgba, hsl, hsla, husl, and husla. It also supports the predefined HTML colors names, like `yellow` and `blue`. - -``` css -#line { -line-color: #ff0; -line-color: #ffff00; -line-color: rgb(255, 255, 0); -line-color: rgba(255, 255, 0, 1); -line-color: hsl(100, 50%, 50%); -line-color: hsla(100, 50%, 50%, 1); -line-color: husl(100, 50%, 50%); // same values yield different color than HSL -line-color: husla(100, 50%, 50%, 1); -line-color: yellow; -} -``` - -Especially of note is the support for hsl and husl, which can be [easier to reason about than rgb()](http://mothereffinghsl.com/). Carto also includes several color operation functions [borrowed from less](http://lesscss.org/functions/#color-operations): - -``` css -// lighten and darken colors -lighten(#ace, 10%); -darken(#ace, 10%); - -// saturate and desaturate -saturate(#550000, 10%); -desaturate(#00ff00, 10%); - -// increase or decrease the opacity of a color -fadein(#fafafa, 10%); -fadeout(#fefefe, 14%); - -// spin rotates a color around the color wheel by degrees -spin(#ff00ff, 10); - -// mix generates a color in between two other colors. -mix(#fff, #000, 50%); - -// get color components -hue(#ff00ff); -saturation(#ff00ff); -lightness(#ff00ff); -alpha(hsla(100, 50%, 50%, 0.5)); -``` - -These functions all take arguments which can be color variables, literal colors, or the results of other functions operating on colors. All the above mentioned functions also come in -a `functionp`-variant (e.g. `lightenp`), which force a given color into perceptual color space. - -### Float - -Float is a fancy way of saying 'number'. In CartoCSS, you specify _just a number_ - unlike CSS, there are no units, but everything is specified in pixels. - -``` css -#line { -line-width: 2; -} -``` - -It's also possible to do simple math with number values: - -``` css -#line { -line-width: 4 / 2; // division -line-width: 4 + 2; // addition -line-width: 4 - 2; // subtraction -line-width: 4 * 2; // multiplication -line-width: 4 % 2; // modulus -} -``` - -### URI - -URI is a fancy way of saying URL. When an argument is a URI, you use the same kind of `url('place.png')` notation that you would with HTML. Quotes around the URL aren't required, but are highly recommended. URIs can be paths to places on your computer, or on the internet. - -```css -#markers { -marker-file: url('marker.png'); -} -``` - -### String - -A string is basically just text. In the case of CartoCSS, you're going to put it in quotes. Strings can be anything, though pay attention to the cases of `text-name` and `shield-name` - they actually will refer to features, which you refer to by putting them in brackets, as seen in the example below. - -```css -#labels { -text-name: "[MY_FIELD]"; -} -``` - -### Boolean - -Boolean means yes or no, so it accepts the values `true` or `false`. - -```css -#markers { -marker-allow-overlap:true; -} -``` - -### Expressions - -Expressions are statements that can include fields, numbers, and other types in a really flexible way. You have run into expressions before, in the realm of 'fields', where you'd specify `"[FIELD]"`, but expressions allow you to drop the quotes and also do quick addition, division, multiplication, and concatenation from within Carto syntax. - -```css -#buildings { -building-height: [HEIGHT_FIELD] * 10; -} -``` - -### Numbers -Numbers are comma-separated lists of one or more number in a specific order. They're used in line dash arrays, in which the numbers specify intervals of line, break, and line again. - -```css -#disputedboundary { -line-dasharray: 1, 4, 2; -} -``` - -### Percentages -In Carto, the percentage symbol, `%` universally means `value/100`. It's meant to be used with ratio-related properties, like opacity rules. - -_You should not use percentages as widths, heights, or other properties - unlike CSS, percentages are not relative to cascaded classes or page size, they're, as stated, simply the value divided by one hundred._ - -```css -#world { -// this syntax -polygon-opacity: 50%; - -// is equivalent to -polygon-opacity: 0.5; -} -``` - -### Functions - -Functions are comma-separated lists of one or more functions. For instance, transforms use the `functions` type to allow for transforms within Carto, which are optionally chainable. - -```css -#point { -point-transform: scale(2, 2); -} -``` diff --git a/docs/2.0.1.md b/docs/2.0.1.md deleted file mode 100644 index e81d79d..0000000 --- a/docs/2.0.1.md +++ /dev/null @@ -1,1277 +0,0 @@ -# Carto documentation - -The following is a list of properties provided in CartoCSS that you can apply to map elements. - -## map - -##### background-color `color` - - - -Default Value: none -_(transparent)_ - -Map Background color -* * * - -##### background-image `uri` - - - -Default Value: -_(transparent)_ - -An image that is repeated below all features on a map as a background. -* * * - -##### srs `string` - - - -Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs -_(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space)_ - -Map spatial reference (proj4 string) -* * * - -##### buffer-size `float` - - - -Default Value: 0 -_(No buffer will be used)_ - -Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". -* * * - -##### base `string` - - - -Default Value: -_(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)_ - -Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. -* * * - -##### font-directory `uri` - - - -Default Value: none -_(No map-specific fonts will be registered)_ - -Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). -* * * - - -## polygon - -##### polygon-fill `color` - - - -Default Value: rgba(128,128,128,1) -_(gray and fully opaque (alpha = 1), same as rgb(128,128,128))_ - -Fill color to assign to a polygon -* * * - -##### polygon-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of polygon edges -* * * - -##### polygon-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of the polygon -* * * - -##### polygon-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Amount of smoothing applied -* * * - - -## line - -##### line-color `color` - - - -Default Value: rgba(0,0,0,1) -_(black and fully opaque (alpha = 1), same as rgb(0,0,0))_ - -The color of a drawn line -* * * - -##### line-width `float` - - - -Default Value: 1 - - -The width of a line in pixels -* * * - -##### line-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of a line -* * * - -##### line-join `keyword` -`miter``round``bevel` - - -Default Value: miter - - -The behavior of lines when joining -* * * - -##### line-cap `keyword` -`butt``round``square` - - -Default Value: butt - - -The display of line endings -* * * - -##### line-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of stroke line -* * * - -##### line-dasharray `numbers` - - - -Default Value: none -_(solid line)_ - -A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. -* * * - -##### line-dash-offset `numbers` - - - -Default Value: none -_(solid line)_ - -valid parameter but not currently used in renderers -* * * - -##### line-rasterizer `keyword` -`full``fast` - - -Default Value: full - - -Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. -* * * - - -## markers - -##### marker-file `uri` - - - -Default Value: -_(An ellipse or circle, if width equals height)_ - -An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse. -* * * - -##### marker-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The overall opacity of the marker -* * * - -##### marker-line-color `color` - - - -Default Value: black - - -The color of the stroke around a marker shape. -* * * - -##### marker-line-width `float` - - - -Default Value: 0.5 - - -The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. -* * * - -##### marker-line-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of a line -* * * - -##### marker-placement `keyword` -`point``line` - - -Default Value: line - - -Attempt to place markers on a point once or on a line repeatedly -* * * - -##### marker-type `keyword` -`arrow``ellipse` - - -Default Value: ellipse - - -The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width) -* * * - -##### marker-width `float` - - - -Default Value: 10 - - -The width of the marker, if using one of the default types. -* * * - -##### marker-height `float` - - - -Default Value: 10 - - -The height of the marker, if using one of the default types. -* * * - -##### marker-fill `color` - - - -Default Value: blue - - -The color of the area of the marker. -* * * - -##### marker-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow makers to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping markers are shown or hidden. -* * * - -##### marker-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache)_ - -value to control whether the placement of the feature will prevent the placement of other features -* * * - -##### marker-spacing `float` - - - -Default Value: 100 - - -Space between repeated labels -* * * - -##### marker-max-error `float` - - - -Default Value: 0.2 - - -The maximum difference between actual marker placement and the marker-spacing parameter. Setting a high value can allow the renderer to try to resolve placement conflicts with other symbolizers. -* * * - -##### marker-transform `string` - - - -Default Value: -_(no transformation)_ - -An SVG transformation definition -* * * - - -## shield - -##### shield-name `string` - - - -Default Value: - - -Value to use for a shield"s text label. Data columns are specified using brackets like [column_name] -* * * - -##### shield-face-name `string` - - - -Default Value: - - -Font name and style to use for the shield text -* * * - -##### shield-unlock-image `boolean` - - - -Default Value: false -_(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)_ - -This parameter should be set to true if you are trying to position text beside rather than on top of the shield image -* * * - -##### shield-size `float` - - - -Default Value: 10 - - -The size of the shield text in pixels -* * * - -##### shield-fill `color` - - - -Default Value: black - - -The color of the shield text -* * * - -##### shield-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point - - -How this shield should be placed. Point placement attempts to place it on top of points, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of polygons. -* * * - -##### shield-avoid-edges `boolean` - - - -Default Value: false - - -Tell positioning algorithm to avoid labeling near intersection edges. -* * * - -##### shield-min-distance `float` - - - -Default Value: 0 - - -Minimum distance to the next shield symbol, not necessarily the same shield. -* * * - -##### shield-spacing `float` - - - -Default Value: 0 - - -The spacing between repeated occurrences of the same shield on a line -* * * - -##### shield-min-padding `float` - - - -Default Value: 0 - - -Determines the minimum amount of padding that a shield gets relative to other shields -* * * - -##### shield-wrap-width `float` - - - -Default Value: 0 - - -Length before wrapping long names. -* * * - -##### shield-wrap-character `string` - - - -Default Value: - - -Use this character instead of a space to wrap long names. -* * * - -##### shield-halo-fill `color` - - - -Default Value: #FFFFFF -_(white)_ - -Specifies the color of the halo around the text. -* * * - -##### shield-halo-radius `float` - - - -Default Value: 0 -_(no halo)_ - -Specify the radius of the halo in pixels -* * * - -##### shield-character-spacing `float` - - - -Default Value: 0 - - -Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. -* * * - -##### shield-line-spacing `float` - - - -Default Value: 0 - - -Vertical spacing between lines of multiline labels (in pixels) -* * * - -##### shield-file `uri` - - - -Default Value: none - - -Image file to render behind the shield text -* * * - -##### shield-text-dx `float` - - - -Default Value: 0 - - -Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right -* * * - -##### shield-text-dy `float` - - - -Default Value: 0 - - -Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down -* * * - -##### shield-dx `float` - - - -Default Value: 0 - - -Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right -* * * - -##### shield-dy `float` - - - -Default Value: 0 - - -Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down -* * * - -##### shield-opacity `float` - - - -Default Value: 1 - - -(Default 1.0) - opacity of the image used for the shield -* * * - -##### shield-text-opacity `float` - - - -Default Value: 1 - - -(Default 1.0) - opacity of the text placed on top of the shield -* * * - -##### shield-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: middle - - -The shield's horizontal alignment from its centerpoint -* * * - -##### shield-text-transform `keyword` -`none``uppercase``lowercase``capitalize` - - -Default Value: none - - -Transform the case of the characters -* * * - -##### shield-no-text `boolean` - - - -Default Value: false - - -Whether the shield should make room for a text label. -* * * - -##### shield-justify-alignment `string` - - - -Default Value: middle - - -Define how text in a shield's label is justified -* * * - - -## line-pattern - -##### line-pattern-file `uri` - - - -Default Value: none - - -An image file to be repeated and warped along a line -* * * - - -## polygon-pattern - -##### polygon-pattern-file `uri` - - - -Default Value: none - - -Image to use as a repeated pattern fill within a polygon -* * * - -##### polygon-pattern-alignment `keyword` -`local``global` - - -Default Value: local - - -Specify whether to align pattern fills to the layer or to the map. -* * * - -##### polygon-pattern-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of polygon pattern edges -* * * - - -## raster - -##### raster-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of the raster symbolizer on top of other symbolizers. -* * * - -##### raster-mode `keyword` -`normal``grain_merge``grain_merge2``multiply``multiply2``divide``divide2``screen``hard_light` - - -Default Value: normal - - -The blending technique used to overlay this raster image on the layer below. Normal simply covers the layer. Grain merge adds the two layers together and subtracts 128 from the value, making the resulting area sometimes high-contrast. Screen often gives a lighter, washed-out appearance. Multiply multiplies the pixels, giving a high-contrast result. Divide divides the upper layer by the lower layer, making a lighter version. -* * * - -##### raster-filter-factor `float` - - - -Default Value: -1 -_(Allow the datasource to choose appropriate downscaling.)_ - -This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. -* * * - -##### raster-scaling `keyword` -`fast``bilinear``bilinear8``bicubic``spline16``gaussian``lanczos` - - -Default Value: fast - - -The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. -* * * - -##### raster-mesh-size `integer` - - - -Default Value: 16 -_(Reprojection mesh will be 1/16 of the resolution of the source image)_ - -A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. -* * * - - -## point - -##### point-file `uri` - - - -Default Value: none - - -Image file to represent a point -* * * - -##### point-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow points to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping points are shown or hidden. -* * * - -##### point-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache)_ - -value to control whether the placement of the feature will prevent the placement of other features -* * * - -##### point-opacity `float` - - - -Default Value: 1 -_(Fully opaque)_ - -A value from 0 to 1 to control the opacity of the point -* * * - -##### point-placement `keyword` -`centroid``interior` - - -Default Value: centroid - - -How this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. -* * * - -##### point-transform `string` - - - -Default Value: -_(No transformation)_ - -SVG transformation definition -* * * - - -## text - -##### text-name `string` - - - -Default Value: - - -Value to use for a text label. Data columns are specified using brackets like [column_name] -* * * - -##### text-face-name `string` - - - -Default Value: - - -Font name and style to render a label in -* * * - -##### text-size `float` - - - -Default Value: 10 - - -Text size in pixels -* * * - -##### text-ratio `float` - - - -Default Value: 0 - - -Define the amount of text (of the total) present on successive lines when wrapping occurs -* * * - -##### text-wrap-width `float` - - - -Default Value: 0 - - -Length of a chunk of text in characters before wrapping text -* * * - -##### text-wrap-character `string` - - - -Default Value: - - -Use this character instead of a space to wrap long text. -* * * - -##### text-spacing `float` - - - -Default Value: 0 - - -Distance between repeated text labels on a line -* * * - -##### text-character-spacing `float` - - - -Default Value: 0 - - -Horizontal spacing adjustment between characters in pixels -* * * - -##### text-line-spacing `float` - - - -Default Value: 0 - - -Vertical spacing adjustment between lines in pixels -* * * - -##### text-label-position-tolerance `float` - - - -Default Value: 0 - - -Allows the label to be displaced from its ideal position by a number of pixels -* * * - -##### text-max-char-angle-delta `float` - - - -Default Value: none - - -If present, the maximum angle change, in degrees, allowed between adjacent characters in a label. This will stop label placement around sharp corners. -* * * - -##### text-fill `color` - - - -Default Value: #000000 - - -Specifies the color for the text -* * * - -##### text-opacity `float` - - - -Default Value: 1 -_(Fully opaque)_ - -A number from 0 to 1 specifying the opacity for the text -* * * - -##### text-halo-fill `color` - - - -Default Value: #FFFFFF -_(white)_ - -Specifies the color of the halo around the text. -* * * - -##### text-halo-radius `float` - - - -Default Value: 0 -_(no halo)_ - -Specify the radius of the halo in pixels -* * * - -##### text-dx `float` - - - -Default Value: 0 - - -Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right -* * * - -##### text-dy `float` - - - -Default Value: 0 - - -Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down -* * * - -##### text-vertical-alignment `keyword` -`top``middle``bottom` - - -Default Value: middle -_(Default affected by value of dy; "bottom" for dy>0, "top" for dy<0.)_ - -Position of label relative to point position. -* * * - -##### text-avoid-edges `boolean` - - - -Default Value: false - - -Tell positioning algorithm to avoid labeling near intersection edges. -* * * - -##### text-min-distance `float` - - - -Default Value: 0 - - -Minimum permitted distance to the next text symbolizer. -* * * - -##### text-min-padding `float` - - - -Default Value: 0 - - -Determines the minimum amount of padding that a text symbolizer gets relative to other text -* * * - -##### text-min-path-length `float` - - - -Default Value: 0 -_(place labels on all paths)_ - -Place labels only on paths longer than this value. -* * * - -##### text-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow text to overlap with other text - overlapping markers will not be shown.)_ - -Control whether overlapping text is shown or hidden. -* * * - -##### text-orientation `float` - - - -Default Value: 0 - - -Rotate the text. -* * * - -##### text-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point - - -Control the style of placement of a point versus the geometry it is attached to. -* * * - -##### text-placement-type `keyword` -`dummy``simple` - - -Default Value: dummy - - -Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. -* * * - -##### text-placements `string` - - - -Default Value: - - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. See TextSymbolizer docs for format. -* * * - -##### text-transform `keyword` -`none``uppercase``lowercase``capitalize` - - -Default Value: none - - -Transform the case of the characters -* * * - -##### text-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: middle - - -The text's horizontal alignment from its centerpoint -* * * - -##### text-align `keyword` -`left``right``center` - - -Default Value: center - - -Set the text alignment. -* * * - - -## building - -##### building-fill `color` - - - -Default Value: #FFFFFF - - -The color of the buildings walls. -* * * - -##### building-fill-opacity `float` - - - -Default Value: 1 - - -The opacity of the building as a whole, including all walls. -* * * - -##### building-height `float` - - - -Default Value: 0 - - -The height of the building in pixels. -* * * - - - - -### Values - -Below is a list of values and an explanation of any expression that can be applied to properties in CartCSS. - -### Color - -CartoCSS accepts a variety of syntaxes for colors - HTML-style hex values, rgb, rgba, hsl, hsla, husl, and husla. It also supports the predefined HTML colors names, like `yellow` and `blue`. - -``` css -#line { -line-color: #ff0; -line-color: #ffff00; -line-color: rgb(255, 255, 0); -line-color: rgba(255, 255, 0, 1); -line-color: hsl(100, 50%, 50%); -line-color: hsla(100, 50%, 50%, 1); -line-color: husl(100, 50%, 50%); // same values yield different color than HSL -line-color: husla(100, 50%, 50%, 1); -line-color: yellow; -} -``` - -Especially of note is the support for hsl and husl, which can be [easier to reason about than rgb()](http://mothereffinghsl.com/). Carto also includes several color operation functions [borrowed from less](http://lesscss.org/functions/#color-operations): - -``` css -// lighten and darken colors -lighten(#ace, 10%); -darken(#ace, 10%); - -// saturate and desaturate -saturate(#550000, 10%); -desaturate(#00ff00, 10%); - -// increase or decrease the opacity of a color -fadein(#fafafa, 10%); -fadeout(#fefefe, 14%); - -// spin rotates a color around the color wheel by degrees -spin(#ff00ff, 10); - -// mix generates a color in between two other colors. -mix(#fff, #000, 50%); - -// get color components -hue(#ff00ff); -saturation(#ff00ff); -lightness(#ff00ff); -alpha(hsla(100, 50%, 50%, 0.5)); -``` - -These functions all take arguments which can be color variables, literal colors, or the results of other functions operating on colors. All the above mentioned functions also come in -a `functionp`-variant (e.g. `lightenp`), which force a given color into perceptual color space. - -### Float - -Float is a fancy way of saying 'number'. In CartoCSS, you specify _just a number_ - unlike CSS, there are no units, but everything is specified in pixels. - -``` css -#line { -line-width: 2; -} -``` - -It's also possible to do simple math with number values: - -``` css -#line { -line-width: 4 / 2; // division -line-width: 4 + 2; // addition -line-width: 4 - 2; // subtraction -line-width: 4 * 2; // multiplication -line-width: 4 % 2; // modulus -} -``` - -### URI - -URI is a fancy way of saying URL. When an argument is a URI, you use the same kind of `url('place.png')` notation that you would with HTML. Quotes around the URL aren't required, but are highly recommended. URIs can be paths to places on your computer, or on the internet. - -```css -#markers { -marker-file: url('marker.png'); -} -``` - -### String - -A string is basically just text. In the case of CartoCSS, you're going to put it in quotes. Strings can be anything, though pay attention to the cases of `text-name` and `shield-name` - they actually will refer to features, which you refer to by putting them in brackets, as seen in the example below. - -```css -#labels { -text-name: "[MY_FIELD]"; -} -``` - -### Boolean - -Boolean means yes or no, so it accepts the values `true` or `false`. - -```css -#markers { -marker-allow-overlap:true; -} -``` - -### Expressions - -Expressions are statements that can include fields, numbers, and other types in a really flexible way. You have run into expressions before, in the realm of 'fields', where you'd specify `"[FIELD]"`, but expressions allow you to drop the quotes and also do quick addition, division, multiplication, and concatenation from within Carto syntax. - -```css -#buildings { -building-height: [HEIGHT_FIELD] * 10; -} -``` - -### Numbers -Numbers are comma-separated lists of one or more number in a specific order. They're used in line dash arrays, in which the numbers specify intervals of line, break, and line again. - -```css -#disputedboundary { -line-dasharray: 1, 4, 2; -} -``` - -### Percentages -In Carto, the percentage symbol, `%` universally means `value/100`. It's meant to be used with ratio-related properties, like opacity rules. - -_You should not use percentages as widths, heights, or other properties - unlike CSS, percentages are not relative to cascaded classes or page size, they're, as stated, simply the value divided by one hundred._ - -```css -#world { -// this syntax -polygon-opacity: 50%; - -// is equivalent to -polygon-opacity: 0.5; -} -``` - -### Functions - -Functions are comma-separated lists of one or more functions. For instance, transforms use the `functions` type to allow for transforms within Carto, which are optionally chainable. - -```css -#point { -point-transform: scale(2, 2); -} -``` diff --git a/docs/2.0.2.md b/docs/2.0.2.md deleted file mode 100644 index e81d79d..0000000 --- a/docs/2.0.2.md +++ /dev/null @@ -1,1277 +0,0 @@ -# Carto documentation - -The following is a list of properties provided in CartoCSS that you can apply to map elements. - -## map - -##### background-color `color` - - - -Default Value: none -_(transparent)_ - -Map Background color -* * * - -##### background-image `uri` - - - -Default Value: -_(transparent)_ - -An image that is repeated below all features on a map as a background. -* * * - -##### srs `string` - - - -Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs -_(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space)_ - -Map spatial reference (proj4 string) -* * * - -##### buffer-size `float` - - - -Default Value: 0 -_(No buffer will be used)_ - -Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". -* * * - -##### base `string` - - - -Default Value: -_(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)_ - -Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. -* * * - -##### font-directory `uri` - - - -Default Value: none -_(No map-specific fonts will be registered)_ - -Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). -* * * - - -## polygon - -##### polygon-fill `color` - - - -Default Value: rgba(128,128,128,1) -_(gray and fully opaque (alpha = 1), same as rgb(128,128,128))_ - -Fill color to assign to a polygon -* * * - -##### polygon-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of polygon edges -* * * - -##### polygon-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of the polygon -* * * - -##### polygon-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Amount of smoothing applied -* * * - - -## line - -##### line-color `color` - - - -Default Value: rgba(0,0,0,1) -_(black and fully opaque (alpha = 1), same as rgb(0,0,0))_ - -The color of a drawn line -* * * - -##### line-width `float` - - - -Default Value: 1 - - -The width of a line in pixels -* * * - -##### line-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of a line -* * * - -##### line-join `keyword` -`miter``round``bevel` - - -Default Value: miter - - -The behavior of lines when joining -* * * - -##### line-cap `keyword` -`butt``round``square` - - -Default Value: butt - - -The display of line endings -* * * - -##### line-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of stroke line -* * * - -##### line-dasharray `numbers` - - - -Default Value: none -_(solid line)_ - -A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. -* * * - -##### line-dash-offset `numbers` - - - -Default Value: none -_(solid line)_ - -valid parameter but not currently used in renderers -* * * - -##### line-rasterizer `keyword` -`full``fast` - - -Default Value: full - - -Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. -* * * - - -## markers - -##### marker-file `uri` - - - -Default Value: -_(An ellipse or circle, if width equals height)_ - -An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse. -* * * - -##### marker-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The overall opacity of the marker -* * * - -##### marker-line-color `color` - - - -Default Value: black - - -The color of the stroke around a marker shape. -* * * - -##### marker-line-width `float` - - - -Default Value: 0.5 - - -The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. -* * * - -##### marker-line-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of a line -* * * - -##### marker-placement `keyword` -`point``line` - - -Default Value: line - - -Attempt to place markers on a point once or on a line repeatedly -* * * - -##### marker-type `keyword` -`arrow``ellipse` - - -Default Value: ellipse - - -The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width) -* * * - -##### marker-width `float` - - - -Default Value: 10 - - -The width of the marker, if using one of the default types. -* * * - -##### marker-height `float` - - - -Default Value: 10 - - -The height of the marker, if using one of the default types. -* * * - -##### marker-fill `color` - - - -Default Value: blue - - -The color of the area of the marker. -* * * - -##### marker-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow makers to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping markers are shown or hidden. -* * * - -##### marker-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache)_ - -value to control whether the placement of the feature will prevent the placement of other features -* * * - -##### marker-spacing `float` - - - -Default Value: 100 - - -Space between repeated labels -* * * - -##### marker-max-error `float` - - - -Default Value: 0.2 - - -The maximum difference between actual marker placement and the marker-spacing parameter. Setting a high value can allow the renderer to try to resolve placement conflicts with other symbolizers. -* * * - -##### marker-transform `string` - - - -Default Value: -_(no transformation)_ - -An SVG transformation definition -* * * - - -## shield - -##### shield-name `string` - - - -Default Value: - - -Value to use for a shield"s text label. Data columns are specified using brackets like [column_name] -* * * - -##### shield-face-name `string` - - - -Default Value: - - -Font name and style to use for the shield text -* * * - -##### shield-unlock-image `boolean` - - - -Default Value: false -_(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)_ - -This parameter should be set to true if you are trying to position text beside rather than on top of the shield image -* * * - -##### shield-size `float` - - - -Default Value: 10 - - -The size of the shield text in pixels -* * * - -##### shield-fill `color` - - - -Default Value: black - - -The color of the shield text -* * * - -##### shield-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point - - -How this shield should be placed. Point placement attempts to place it on top of points, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of polygons. -* * * - -##### shield-avoid-edges `boolean` - - - -Default Value: false - - -Tell positioning algorithm to avoid labeling near intersection edges. -* * * - -##### shield-min-distance `float` - - - -Default Value: 0 - - -Minimum distance to the next shield symbol, not necessarily the same shield. -* * * - -##### shield-spacing `float` - - - -Default Value: 0 - - -The spacing between repeated occurrences of the same shield on a line -* * * - -##### shield-min-padding `float` - - - -Default Value: 0 - - -Determines the minimum amount of padding that a shield gets relative to other shields -* * * - -##### shield-wrap-width `float` - - - -Default Value: 0 - - -Length before wrapping long names. -* * * - -##### shield-wrap-character `string` - - - -Default Value: - - -Use this character instead of a space to wrap long names. -* * * - -##### shield-halo-fill `color` - - - -Default Value: #FFFFFF -_(white)_ - -Specifies the color of the halo around the text. -* * * - -##### shield-halo-radius `float` - - - -Default Value: 0 -_(no halo)_ - -Specify the radius of the halo in pixels -* * * - -##### shield-character-spacing `float` - - - -Default Value: 0 - - -Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. -* * * - -##### shield-line-spacing `float` - - - -Default Value: 0 - - -Vertical spacing between lines of multiline labels (in pixels) -* * * - -##### shield-file `uri` - - - -Default Value: none - - -Image file to render behind the shield text -* * * - -##### shield-text-dx `float` - - - -Default Value: 0 - - -Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right -* * * - -##### shield-text-dy `float` - - - -Default Value: 0 - - -Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down -* * * - -##### shield-dx `float` - - - -Default Value: 0 - - -Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right -* * * - -##### shield-dy `float` - - - -Default Value: 0 - - -Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down -* * * - -##### shield-opacity `float` - - - -Default Value: 1 - - -(Default 1.0) - opacity of the image used for the shield -* * * - -##### shield-text-opacity `float` - - - -Default Value: 1 - - -(Default 1.0) - opacity of the text placed on top of the shield -* * * - -##### shield-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: middle - - -The shield's horizontal alignment from its centerpoint -* * * - -##### shield-text-transform `keyword` -`none``uppercase``lowercase``capitalize` - - -Default Value: none - - -Transform the case of the characters -* * * - -##### shield-no-text `boolean` - - - -Default Value: false - - -Whether the shield should make room for a text label. -* * * - -##### shield-justify-alignment `string` - - - -Default Value: middle - - -Define how text in a shield's label is justified -* * * - - -## line-pattern - -##### line-pattern-file `uri` - - - -Default Value: none - - -An image file to be repeated and warped along a line -* * * - - -## polygon-pattern - -##### polygon-pattern-file `uri` - - - -Default Value: none - - -Image to use as a repeated pattern fill within a polygon -* * * - -##### polygon-pattern-alignment `keyword` -`local``global` - - -Default Value: local - - -Specify whether to align pattern fills to the layer or to the map. -* * * - -##### polygon-pattern-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of polygon pattern edges -* * * - - -## raster - -##### raster-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of the raster symbolizer on top of other symbolizers. -* * * - -##### raster-mode `keyword` -`normal``grain_merge``grain_merge2``multiply``multiply2``divide``divide2``screen``hard_light` - - -Default Value: normal - - -The blending technique used to overlay this raster image on the layer below. Normal simply covers the layer. Grain merge adds the two layers together and subtracts 128 from the value, making the resulting area sometimes high-contrast. Screen often gives a lighter, washed-out appearance. Multiply multiplies the pixels, giving a high-contrast result. Divide divides the upper layer by the lower layer, making a lighter version. -* * * - -##### raster-filter-factor `float` - - - -Default Value: -1 -_(Allow the datasource to choose appropriate downscaling.)_ - -This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. -* * * - -##### raster-scaling `keyword` -`fast``bilinear``bilinear8``bicubic``spline16``gaussian``lanczos` - - -Default Value: fast - - -The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. -* * * - -##### raster-mesh-size `integer` - - - -Default Value: 16 -_(Reprojection mesh will be 1/16 of the resolution of the source image)_ - -A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. -* * * - - -## point - -##### point-file `uri` - - - -Default Value: none - - -Image file to represent a point -* * * - -##### point-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow points to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping points are shown or hidden. -* * * - -##### point-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache)_ - -value to control whether the placement of the feature will prevent the placement of other features -* * * - -##### point-opacity `float` - - - -Default Value: 1 -_(Fully opaque)_ - -A value from 0 to 1 to control the opacity of the point -* * * - -##### point-placement `keyword` -`centroid``interior` - - -Default Value: centroid - - -How this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. -* * * - -##### point-transform `string` - - - -Default Value: -_(No transformation)_ - -SVG transformation definition -* * * - - -## text - -##### text-name `string` - - - -Default Value: - - -Value to use for a text label. Data columns are specified using brackets like [column_name] -* * * - -##### text-face-name `string` - - - -Default Value: - - -Font name and style to render a label in -* * * - -##### text-size `float` - - - -Default Value: 10 - - -Text size in pixels -* * * - -##### text-ratio `float` - - - -Default Value: 0 - - -Define the amount of text (of the total) present on successive lines when wrapping occurs -* * * - -##### text-wrap-width `float` - - - -Default Value: 0 - - -Length of a chunk of text in characters before wrapping text -* * * - -##### text-wrap-character `string` - - - -Default Value: - - -Use this character instead of a space to wrap long text. -* * * - -##### text-spacing `float` - - - -Default Value: 0 - - -Distance between repeated text labels on a line -* * * - -##### text-character-spacing `float` - - - -Default Value: 0 - - -Horizontal spacing adjustment between characters in pixels -* * * - -##### text-line-spacing `float` - - - -Default Value: 0 - - -Vertical spacing adjustment between lines in pixels -* * * - -##### text-label-position-tolerance `float` - - - -Default Value: 0 - - -Allows the label to be displaced from its ideal position by a number of pixels -* * * - -##### text-max-char-angle-delta `float` - - - -Default Value: none - - -If present, the maximum angle change, in degrees, allowed between adjacent characters in a label. This will stop label placement around sharp corners. -* * * - -##### text-fill `color` - - - -Default Value: #000000 - - -Specifies the color for the text -* * * - -##### text-opacity `float` - - - -Default Value: 1 -_(Fully opaque)_ - -A number from 0 to 1 specifying the opacity for the text -* * * - -##### text-halo-fill `color` - - - -Default Value: #FFFFFF -_(white)_ - -Specifies the color of the halo around the text. -* * * - -##### text-halo-radius `float` - - - -Default Value: 0 -_(no halo)_ - -Specify the radius of the halo in pixels -* * * - -##### text-dx `float` - - - -Default Value: 0 - - -Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right -* * * - -##### text-dy `float` - - - -Default Value: 0 - - -Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down -* * * - -##### text-vertical-alignment `keyword` -`top``middle``bottom` - - -Default Value: middle -_(Default affected by value of dy; "bottom" for dy>0, "top" for dy<0.)_ - -Position of label relative to point position. -* * * - -##### text-avoid-edges `boolean` - - - -Default Value: false - - -Tell positioning algorithm to avoid labeling near intersection edges. -* * * - -##### text-min-distance `float` - - - -Default Value: 0 - - -Minimum permitted distance to the next text symbolizer. -* * * - -##### text-min-padding `float` - - - -Default Value: 0 - - -Determines the minimum amount of padding that a text symbolizer gets relative to other text -* * * - -##### text-min-path-length `float` - - - -Default Value: 0 -_(place labels on all paths)_ - -Place labels only on paths longer than this value. -* * * - -##### text-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow text to overlap with other text - overlapping markers will not be shown.)_ - -Control whether overlapping text is shown or hidden. -* * * - -##### text-orientation `float` - - - -Default Value: 0 - - -Rotate the text. -* * * - -##### text-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point - - -Control the style of placement of a point versus the geometry it is attached to. -* * * - -##### text-placement-type `keyword` -`dummy``simple` - - -Default Value: dummy - - -Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. -* * * - -##### text-placements `string` - - - -Default Value: - - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. See TextSymbolizer docs for format. -* * * - -##### text-transform `keyword` -`none``uppercase``lowercase``capitalize` - - -Default Value: none - - -Transform the case of the characters -* * * - -##### text-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: middle - - -The text's horizontal alignment from its centerpoint -* * * - -##### text-align `keyword` -`left``right``center` - - -Default Value: center - - -Set the text alignment. -* * * - - -## building - -##### building-fill `color` - - - -Default Value: #FFFFFF - - -The color of the buildings walls. -* * * - -##### building-fill-opacity `float` - - - -Default Value: 1 - - -The opacity of the building as a whole, including all walls. -* * * - -##### building-height `float` - - - -Default Value: 0 - - -The height of the building in pixels. -* * * - - - - -### Values - -Below is a list of values and an explanation of any expression that can be applied to properties in CartCSS. - -### Color - -CartoCSS accepts a variety of syntaxes for colors - HTML-style hex values, rgb, rgba, hsl, hsla, husl, and husla. It also supports the predefined HTML colors names, like `yellow` and `blue`. - -``` css -#line { -line-color: #ff0; -line-color: #ffff00; -line-color: rgb(255, 255, 0); -line-color: rgba(255, 255, 0, 1); -line-color: hsl(100, 50%, 50%); -line-color: hsla(100, 50%, 50%, 1); -line-color: husl(100, 50%, 50%); // same values yield different color than HSL -line-color: husla(100, 50%, 50%, 1); -line-color: yellow; -} -``` - -Especially of note is the support for hsl and husl, which can be [easier to reason about than rgb()](http://mothereffinghsl.com/). Carto also includes several color operation functions [borrowed from less](http://lesscss.org/functions/#color-operations): - -``` css -// lighten and darken colors -lighten(#ace, 10%); -darken(#ace, 10%); - -// saturate and desaturate -saturate(#550000, 10%); -desaturate(#00ff00, 10%); - -// increase or decrease the opacity of a color -fadein(#fafafa, 10%); -fadeout(#fefefe, 14%); - -// spin rotates a color around the color wheel by degrees -spin(#ff00ff, 10); - -// mix generates a color in between two other colors. -mix(#fff, #000, 50%); - -// get color components -hue(#ff00ff); -saturation(#ff00ff); -lightness(#ff00ff); -alpha(hsla(100, 50%, 50%, 0.5)); -``` - -These functions all take arguments which can be color variables, literal colors, or the results of other functions operating on colors. All the above mentioned functions also come in -a `functionp`-variant (e.g. `lightenp`), which force a given color into perceptual color space. - -### Float - -Float is a fancy way of saying 'number'. In CartoCSS, you specify _just a number_ - unlike CSS, there are no units, but everything is specified in pixels. - -``` css -#line { -line-width: 2; -} -``` - -It's also possible to do simple math with number values: - -``` css -#line { -line-width: 4 / 2; // division -line-width: 4 + 2; // addition -line-width: 4 - 2; // subtraction -line-width: 4 * 2; // multiplication -line-width: 4 % 2; // modulus -} -``` - -### URI - -URI is a fancy way of saying URL. When an argument is a URI, you use the same kind of `url('place.png')` notation that you would with HTML. Quotes around the URL aren't required, but are highly recommended. URIs can be paths to places on your computer, or on the internet. - -```css -#markers { -marker-file: url('marker.png'); -} -``` - -### String - -A string is basically just text. In the case of CartoCSS, you're going to put it in quotes. Strings can be anything, though pay attention to the cases of `text-name` and `shield-name` - they actually will refer to features, which you refer to by putting them in brackets, as seen in the example below. - -```css -#labels { -text-name: "[MY_FIELD]"; -} -``` - -### Boolean - -Boolean means yes or no, so it accepts the values `true` or `false`. - -```css -#markers { -marker-allow-overlap:true; -} -``` - -### Expressions - -Expressions are statements that can include fields, numbers, and other types in a really flexible way. You have run into expressions before, in the realm of 'fields', where you'd specify `"[FIELD]"`, but expressions allow you to drop the quotes and also do quick addition, division, multiplication, and concatenation from within Carto syntax. - -```css -#buildings { -building-height: [HEIGHT_FIELD] * 10; -} -``` - -### Numbers -Numbers are comma-separated lists of one or more number in a specific order. They're used in line dash arrays, in which the numbers specify intervals of line, break, and line again. - -```css -#disputedboundary { -line-dasharray: 1, 4, 2; -} -``` - -### Percentages -In Carto, the percentage symbol, `%` universally means `value/100`. It's meant to be used with ratio-related properties, like opacity rules. - -_You should not use percentages as widths, heights, or other properties - unlike CSS, percentages are not relative to cascaded classes or page size, they're, as stated, simply the value divided by one hundred._ - -```css -#world { -// this syntax -polygon-opacity: 50%; - -// is equivalent to -polygon-opacity: 0.5; -} -``` - -### Functions - -Functions are comma-separated lists of one or more functions. For instance, transforms use the `functions` type to allow for transforms within Carto, which are optionally chainable. - -```css -#point { -point-transform: scale(2, 2); -} -``` diff --git a/docs/2.1.0.md b/docs/2.1.0.md deleted file mode 100644 index 3a72323..0000000 --- a/docs/2.1.0.md +++ /dev/null @@ -1,1640 +0,0 @@ -# Carto documentation - -The following is a list of properties provided in CartoCSS that you can apply to map elements. - -## All elements - -##### image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen` - -Default Value: none -_(no filters)_ - -A list of image filters. -* * * - -##### comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current layer on top of other layers)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - -##### opacity `float` - - - -Default Value: 1 -_(no separate buffer will be used and no alpha will be applied to the style after rendering)_ - -An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer) -* * * - - -## map - -##### background-color `color` - - - -Default Value: none -_(transparent)_ - -Map Background color -* * * - -##### background-image `uri` - - - -Default Value: -_(transparent)_ - -An image that is repeated below all features on a map as a background. -* * * - -##### srs `string` - - - -Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs -_(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space)_ - -Map spatial reference (proj4 string) -* * * - -##### buffer-size `float` - - - -Default Value: 0 -_(No buffer will be used)_ - -Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". -* * * - -##### base `string` - - - -Default Value: -_(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)_ - -Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. -* * * - -##### font-directory `uri` - - - -Default Value: none -_(No map-specific fonts will be registered)_ - -Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). -* * * - - -## polygon - -##### polygon-fill `color` - - - -Default Value: rgba(128,128,128,1) -_(gray and fully opaque (alpha = 1), same as rgb(128,128,128))_ - -Fill color to assign to a polygon -* * * - -##### polygon-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of the polygon -* * * - -##### polygon-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of polygon edges -* * * - -##### polygon-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions.h -* * * - -##### polygon-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### polygon-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(geometry will not be transformed)_ - -Allows transformation functions to be applied to the geometry. -* * * - -##### polygon-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line - -##### line-color `color` - - - -Default Value: rgba(0,0,0,1) -_(black and fully opaque (alpha = 1), same as rgb(0,0,0))_ - -The color of a drawn line -* * * - -##### line-width `float` - - - -Default Value: 1 - - -The width of a line in pixels -* * * - -##### line-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of a line -* * * - -##### line-join `keyword` -`miter``round``bevel` - - -Default Value: miter - - -The behavior of lines when joining -* * * - -##### line-cap `keyword` -`butt``round``square` - - -Default Value: butt - - -The display of line endings -* * * - -##### line-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of stroke line -* * * - -##### line-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions.h -* * * - -##### line-dasharray `numbers` - - - -Default Value: none -_(solid line)_ - -A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. -* * * - -##### line-dash-offset `numbers` - - - -Default Value: none -_(solid line)_ - -valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled) -* * * - -##### line-miterlimit `float` - - - -Default Value: 4 -_(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )')_ - -The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. -* * * - -##### line-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### line-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-offset `float` - - - -Default Value: 0 -_(no offset)_ - -Offsets a line a number of pixels parallel to its actual path. Postive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-rasterizer `keyword` -`full``fast` - - -Default Value: full - - -Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. -* * * - -##### line-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(geometry will not be transformed)_ - -Allows transformation functions to be applied to the geometry. -* * * - -##### line-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## markers - -##### marker-file `uri` - - - -Default Value: -_(An ellipse or circle, if width equals height)_ - -An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse. -* * * - -##### marker-opacity `float` - - - -Default Value: 1 -_(The stroke-opacity and fill-opacity will be used)_ - -The overall opacity of the marker, if set, overrides both the opacity of both the fill and stroke -* * * - -##### marker-fill-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The fill opacity of the marker -* * * - -##### marker-line-color `color` - - - -Default Value: black - - -The color of the stroke around a marker shape. -* * * - -##### marker-line-width `float` - - - -Default Value: 0.5 - - -The width of the stroke around a marker shape, in pixels. This is positioned on the boundary, so high values can cover the area itself. -* * * - -##### marker-line-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of a line -* * * - -##### marker-placement `keyword` -`point``line``interior` - - -Default Value: point -_(Place markers at the center point (centroid) of the geometry)_ - -Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior -* * * - -##### marker-type `keyword` -`arrow``ellipse` - - -Default Value: ellipse - - -The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width) -* * * - -##### marker-width `float` - - - -Default Value: 10 - - -The width of the marker, if using one of the default types. -* * * - -##### marker-height `float` - - - -Default Value: 10 - - -The height of the marker, if using one of the default types. -* * * - -##### marker-fill `color` - - - -Default Value: blue - - -The color of the area of the marker. -* * * - -##### marker-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow makers to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping markers are shown or hidden. -* * * - -##### marker-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache)_ - -value to control whether the placement of the feature will prevent the placement of other features -* * * - -##### marker-spacing `float` - - - -Default Value: 100 - - -Space between repeated labels -* * * - -##### marker-max-error `float` - - - -Default Value: 0.2 - - -The maximum difference between actual marker placement and the marker-spacing parameter. Setting a high value can allow the renderer to try to resolve placement conflicts with other symbolizers. -* * * - -##### marker-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation)_ - -SVG transformation definition -* * * - -##### marker-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### marker-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### marker-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(geometry will not be transformed)_ - -Allows transformation functions to be applied to the geometry. -* * * - -##### marker-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## shield - -##### shield-name `string` - - - -Default Value: - - -Value to use for a shield"s text label. Data columns are specified using brackets like [column_name] -* * * - -##### shield-file `uri` - - - -Default Value: none - - -Image file to render behind the shield text -* * * - -##### shield-face-name `string` - - - -Default Value: - - -Font name and style to use for the shield text -* * * - -##### shield-unlock-image `boolean` - - - -Default Value: false -_(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)_ - -This parameter should be set to true if you are trying to position text beside rather than on top of the shield image -* * * - -##### shield-size `float` - - - -Default Value: 10 - - -The size of the shield text in pixels -* * * - -##### shield-fill `color` - - - -Default Value: black - - -The color of the shield text -* * * - -##### shield-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point - - -How this shield should be placed. Point placement attempts to place it on top of points, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of polygons. -* * * - -##### shield-avoid-edges `boolean` - - - -Default Value: false - - -Tell positioning algorithm to avoid labeling near intersection edges. -* * * - -##### shield-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow shields to overlap with other map elements already placed.)_ - -Control whether overlapping shields are shown or hidden. -* * * - -##### shield-min-distance `float` - - - -Default Value: 0 - - -Minimum distance to the next shield symbol, not necessarily the same shield. -* * * - -##### shield-spacing `float` - - - -Default Value: 0 - - -The spacing between repeated occurrences of the same shield on a line -* * * - -##### shield-min-padding `float` - - - -Default Value: 0 - - -Determines the minimum amount of padding that a shield gets relative to other shields -* * * - -##### shield-wrap-width `unsigned` - - - -Default Value: 0 - - -Length of a chunk of text in characters before wrapping text -* * * - -##### shield-wrap-before `boolean` - - - -Default Value: false - - -Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width. -* * * - -##### shield-wrap-character `string` - - - -Default Value: - - -Use this character instead of a space to wrap long names. -* * * - -##### shield-halo-fill `color` - - - -Default Value: #FFFFFF -_(white)_ - -Specifies the color of the halo around the text. -* * * - -##### shield-halo-radius `float` - - - -Default Value: 0 -_(no halo)_ - -Specify the radius of the halo in pixels -* * * - -##### shield-character-spacing `unsigned` - - - -Default Value: 0 - - -Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. -* * * - -##### shield-line-spacing `unsigned` - - - -Default Value: 0 - - -Vertical spacing between lines of multiline labels (in pixels) -* * * - -##### shield-text-dx `float` - - - -Default Value: 0 - - -Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right -* * * - -##### shield-text-dy `float` - - - -Default Value: 0 - - -Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down -* * * - -##### shield-dx `float` - - - -Default Value: 0 - - -Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right -* * * - -##### shield-dy `float` - - - -Default Value: 0 - - -Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down -* * * - -##### shield-opacity `float` - - - -Default Value: 1 - - -(Default 1.0) - opacity of the image used for the shield -* * * - -##### shield-text-opacity `float` - - - -Default Value: 1 - - -(Default 1.0) - opacity of the text placed on top of the shield -* * * - -##### shield-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: auto - - -The shield's horizontal alignment from its centerpoint -* * * - -##### shield-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: middle - - -The shield's vertical alignment from its centerpoint -* * * - -##### shield-text-transform `keyword` -`none``uppercase``lowercase``capitalize` - - -Default Value: none - - -Transform the case of the characters -* * * - -##### shield-justify-alignment `keyword` -`left``center``right``auto` - - -Default Value: auto - - -Define how text in a shield's label is justified -* * * - -##### shield-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### shield-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line-pattern - -##### line-pattern-file `uri` - - - -Default Value: none - - -An image file to be repeated and warped along a line -* * * - -##### line-pattern-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### line-pattern-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(geometry will not be transformed)_ - -Allows transformation functions to be applied to the geometry. -* * * - -##### line-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## polygon-pattern - -##### polygon-pattern-file `uri` - - - -Default Value: none - - -Image to use as a repeated pattern fill within a polygon -* * * - -##### polygon-pattern-alignment `keyword` -`local``global` - - -Default Value: local - - -Specify whether to align pattern fills to the layer or to the map. -* * * - -##### polygon-pattern-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of polygon pattern edges -* * * - -##### polygon-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications)_ - -(Default 1.0) - Apply an opacity level to the image used for the pattern -* * * - -##### polygon-pattern-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### polygon-pattern-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(geometry will not be transformed)_ - -Allows transformation functions to be applied to the geometry. -* * * - -##### polygon-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## raster - -##### raster-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of the raster symbolizer on top of other symbolizers. -* * * - -##### raster-filter-factor `float` - - - -Default Value: -1 -_(Allow the datasource to choose appropriate downscaling.)_ - -This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. -* * * - -##### raster-scaling `keyword` -`near``fast``bilinear``bilinear8``bicubic``spline16``spline36``hanning``hamming``hermite``kaiser``quadric``catrom``gaussian``bessel``mitchell``sinc``lanczos``blackman` - - -Default Value: near - - -The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. -* * * - -##### raster-mesh-size `unsigned` - - - -Default Value: 16 -_(Reprojection mesh will be 1/16 of the resolution of the source image)_ - -A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. -* * * - -##### raster-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## point - -##### point-file `uri` - - - -Default Value: none - - -Image file to represent a point -* * * - -##### point-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow points to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping points are shown or hidden. -* * * - -##### point-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache)_ - -value to control whether the placement of the feature will prevent the placement of other features -* * * - -##### point-opacity `float` - - - -Default Value: 1 -_(Fully opaque)_ - -A value from 0 to 1 to control the opacity of the point -* * * - -##### point-placement `keyword` -`centroid``interior` - - -Default Value: centroid - - -How this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. -* * * - -##### point-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation)_ - -SVG transformation definition -* * * - -##### point-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## text - -##### text-name `string` - - - -Default Value: - - -Value to use for a text label. Data columns are specified using brackets like [column_name] -* * * - -##### text-face-name `string` - - - -Default Value: - - -Font name and style to render a label in -* * * - -##### text-size `float` - - - -Default Value: 10 - - -Text size in pixels -* * * - -##### text-ratio `unsigned` - - - -Default Value: 0 - - -Define the amount of text (of the total) present on successive lines when wrapping occurs -* * * - -##### text-wrap-width `unsigned` - - - -Default Value: 0 - - -Length of a chunk of text in characters before wrapping text -* * * - -##### text-wrap-before `boolean` - - - -Default Value: false - - -Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width. -* * * - -##### text-wrap-character `string` - - - -Default Value: - - -Use this character instead of a space to wrap long text. -* * * - -##### text-spacing `unsigned` - - - -Default Value: 0 - - -Distance between repeated text labels on a line (aka. label-spacing) -* * * - -##### text-character-spacing `float` - - - -Default Value: 0 - - -Horizontal spacing adjustment between characters in pixels -* * * - -##### text-line-spacing `unsigned` - - - -Default Value: 0 - - -Vertical spacing adjustment between lines in pixels -* * * - -##### text-label-position-tolerance `unsigned` - - - -Default Value: 0 - - -Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line) -* * * - -##### text-max-char-angle-delta `float` - - - -Default Value: 22.5 - - -The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. -* * * - -##### text-fill `color` - - - -Default Value: #000000 - - -Specifies the color for the text -* * * - -##### text-opacity `float` - - - -Default Value: 1 -_(Fully opaque)_ - -A number from 0 to 1 specifying the opacity for the text -* * * - -##### text-halo-fill `color` - - - -Default Value: #FFFFFF -_(white)_ - -Specifies the color of the halo around the text. -* * * - -##### text-halo-radius `float` - - - -Default Value: 0 -_(no halo)_ - -Specify the radius of the halo in pixels -* * * - -##### text-dx `float` - - - -Default Value: 0 - - -Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right -* * * - -##### text-dy `float` - - - -Default Value: 0 - - -Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down -* * * - -##### text-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: auto -_(Default affected by value of dy; "bottom" for dy>0, "top" for dy<0.)_ - -Position of label relative to point position. -* * * - -##### text-avoid-edges `boolean` - - - -Default Value: false - - -Tell positioning algorithm to avoid labeling near intersection edges. -* * * - -##### text-min-distance `float` - - - -Default Value: 0 - - -Minimum permitted distance to the next text symbolizer. -* * * - -##### text-min-padding `float` - - - -Default Value: 0 - - -Determines the minimum amount of padding that a text symbolizer gets relative to other text -* * * - -##### text-min-path-length `float` - - - -Default Value: 0 -_(place labels on all paths)_ - -Place labels only on paths longer than this value. -* * * - -##### text-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow text to overlap with other text - overlapping markers will not be shown.)_ - -Control whether overlapping text is shown or hidden. -* * * - -##### text-orientation `float` - - - -Default Value: 0 - - -Rotate the text. -* * * - -##### text-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point - - -Control the style of placement of a point versus the geometry it is attached to. -* * * - -##### text-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy - - -Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. -* * * - -##### text-placements `string` - - - -Default Value: - - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `text-placements: "E,NE,SE,W,NW,SW";` -* * * - -##### text-transform `keyword` -`none``uppercase``lowercase``capitalize` - - -Default Value: none - - -Transform the case of the characters -* * * - -##### text-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: auto - - -The text's horizontal alignment from its centerpoint -* * * - -##### text-align `keyword` -`left``right``center``auto` - - -Default Value: auto -_(Auto alignment means that text will be centered by default except when using the `placement-type` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the `text-placements` directives)_ - -Define how text is justified -* * * - -##### text-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### text-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## building - -##### building-fill `color` - - - -Default Value: #FFFFFF - - -The color of the buildings walls. -* * * - -##### building-fill-opacity `float` - - - -Default Value: 1 - - -The opacity of the building as a whole, including all walls. -* * * - -##### building-height `float` - - - -Default Value: 0 - - -The height of the building in pixels. -* * * - - - - -### Values - -Below is a list of values and an explanation of any expression that can be applied to properties in CartCSS. - -### Color - -CartoCSS accepts a variety of syntaxes for colors - HTML-style hex values, rgb, rgba, hsl, hsla, husl, and husla. It also supports the predefined HTML colors names, like `yellow` and `blue`. - -``` css -#line { -line-color: #ff0; -line-color: #ffff00; -line-color: rgb(255, 255, 0); -line-color: rgba(255, 255, 0, 1); -line-color: hsl(100, 50%, 50%); -line-color: hsla(100, 50%, 50%, 1); -line-color: husl(100, 50%, 50%); // same values yield different color than HSL -line-color: husla(100, 50%, 50%, 1); -line-color: yellow; -} -``` - -Especially of note is the support for hsl and husl, which can be [easier to reason about than rgb()](http://mothereffinghsl.com/). Carto also includes several color operation functions [borrowed from less](http://lesscss.org/functions/#color-operations): - -``` css -// lighten and darken colors -lighten(#ace, 10%); -darken(#ace, 10%); - -// saturate and desaturate -saturate(#550000, 10%); -desaturate(#00ff00, 10%); - -// increase or decrease the opacity of a color -fadein(#fafafa, 10%); -fadeout(#fefefe, 14%); - -// spin rotates a color around the color wheel by degrees -spin(#ff00ff, 10); - -// mix generates a color in between two other colors. -mix(#fff, #000, 50%); - -// get color components -hue(#ff00ff); -saturation(#ff00ff); -lightness(#ff00ff); -alpha(hsla(100, 50%, 50%, 0.5)); -``` - -These functions all take arguments which can be color variables, literal colors, or the results of other functions operating on colors. All the above mentioned functions also come in -a `functionp`-variant (e.g. `lightenp`), which force a given color into perceptual color space. - -### Float - -Float is a fancy way of saying 'number'. In CartoCSS, you specify _just a number_ - unlike CSS, there are no units, but everything is specified in pixels. - -``` css -#line { -line-width: 2; -} -``` - -It's also possible to do simple math with number values: - -``` css -#line { -line-width: 4 / 2; // division -line-width: 4 + 2; // addition -line-width: 4 - 2; // subtraction -line-width: 4 * 2; // multiplication -line-width: 4 % 2; // modulus -} -``` - -### URI - -URI is a fancy way of saying URL. When an argument is a URI, you use the same kind of `url('place.png')` notation that you would with HTML. Quotes around the URL aren't required, but are highly recommended. URIs can be paths to places on your computer, or on the internet. - -```css -#markers { -marker-file: url('marker.png'); -} -``` - -### String - -A string is basically just text. In the case of CartoCSS, you're going to put it in quotes. Strings can be anything, though pay attention to the cases of `text-name` and `shield-name` - they actually will refer to features, which you refer to by putting them in brackets, as seen in the example below. - -```css -#labels { -text-name: "[MY_FIELD]"; -} -``` - -### Boolean - -Boolean means yes or no, so it accepts the values `true` or `false`. - -```css -#markers { -marker-allow-overlap:true; -} -``` - -### Expressions - -Expressions are statements that can include fields, numbers, and other types in a really flexible way. You have run into expressions before, in the realm of 'fields', where you'd specify `"[FIELD]"`, but expressions allow you to drop the quotes and also do quick addition, division, multiplication, and concatenation from within Carto syntax. - -```css -#buildings { -building-height: [HEIGHT_FIELD] * 10; -} -``` - -### Numbers -Numbers are comma-separated lists of one or more number in a specific order. They're used in line dash arrays, in which the numbers specify intervals of line, break, and line again. - -```css -#disputedboundary { -line-dasharray: 1, 4, 2; -} -``` - -### Percentages -In Carto, the percentage symbol, `%` universally means `value/100`. It's meant to be used with ratio-related properties, like opacity rules. - -_You should not use percentages as widths, heights, or other properties - unlike CSS, percentages are not relative to cascaded classes or page size, they're, as stated, simply the value divided by one hundred._ - -```css -#world { -// this syntax -polygon-opacity: 50%; - -// is equivalent to -polygon-opacity: 0.5; -} -``` - -### Functions - -Functions are comma-separated lists of one or more functions. For instance, transforms use the `functions` type to allow for transforms within Carto, which are optionally chainable. - -```css -#point { -point-transform: scale(2, 2); -} -``` diff --git a/docs/2.1.1.md b/docs/2.1.1.md deleted file mode 100644 index 821e216..0000000 --- a/docs/2.1.1.md +++ /dev/null @@ -1,1650 +0,0 @@ -# Carto documentation - -The following is a list of properties provided in CartoCSS that you can apply to map elements. - -## All elements - -##### image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen` - -Default Value: none -_(no filters)_ - -A list of image filters. -* * * - -##### comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current layer on top of other layers)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - -##### opacity `float` - - - -Default Value: 1 -_(no separate buffer will be used and no alpha will be applied to the style after rendering)_ - -An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer) -* * * - - -## map - -##### background-color `color` - - - -Default Value: none -_(transparent)_ - -Map Background color -* * * - -##### background-image `uri` - - - -Default Value: -_(transparent)_ - -An image that is repeated below all features on a map as a background. -* * * - -##### srs `string` - - - -Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs -_(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space)_ - -Map spatial reference (proj4 string) -* * * - -##### buffer-size `float` - - - -Default Value: 0 -_(No buffer will be used)_ - -Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". -* * * - -##### base `string` - - - -Default Value: -_(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)_ - -Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. -* * * - -##### font-directory `uri` - - - -Default Value: none -_(No map-specific fonts will be registered)_ - -Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). -* * * - - -## polygon - -##### polygon-fill `color` - - - -Default Value: rgba(128,128,128,1) -_(gray and fully opaque (alpha = 1), same as rgb(128,128,128))_ - -Fill color to assign to a polygon -* * * - -##### polygon-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of the polygon -* * * - -##### polygon-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of polygon edges -* * * - -##### polygon-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions.h -* * * - -##### polygon-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### polygon-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(geometry will not be transformed)_ - -Allows transformation functions to be applied to the geometry. -* * * - -##### polygon-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line - -##### line-color `color` - - - -Default Value: rgba(0,0,0,1) -_(black and fully opaque (alpha = 1), same as rgb(0,0,0))_ - -The color of a drawn line -* * * - -##### line-width `float` - - - -Default Value: 1 - - -The width of a line in pixels -* * * - -##### line-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of a line -* * * - -##### line-join `keyword` -`miter``round``bevel` - - -Default Value: miter - - -The behavior of lines when joining -* * * - -##### line-cap `keyword` -`butt``round``square` - - -Default Value: butt - - -The display of line endings -* * * - -##### line-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of stroke line -* * * - -##### line-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions.h -* * * - -##### line-dasharray `numbers` - - - -Default Value: none -_(solid line)_ - -A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. -* * * - -##### line-dash-offset `numbers` - - - -Default Value: none -_(solid line)_ - -valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled) -* * * - -##### line-miterlimit `float` - - - -Default Value: 4 -_(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )')_ - -The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. -* * * - -##### line-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### line-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-offset `float` - - - -Default Value: 0 -_(no offset)_ - -Offsets a line a number of pixels parallel to its actual path. Postive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-rasterizer `keyword` -`full``fast` - - -Default Value: full - - -Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. -* * * - -##### line-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(geometry will not be transformed)_ - -Allows transformation functions to be applied to the geometry. -* * * - -##### line-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## markers - -##### marker-file `uri` - - - -Default Value: -_(An ellipse or circle, if width equals height)_ - -An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse. -* * * - -##### marker-opacity `float` - - - -Default Value: 1 -_(The stroke-opacity and fill-opacity will be used)_ - -The overall opacity of the marker, if set, overrides both the opacity of both the fill and stroke -* * * - -##### marker-fill-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The fill opacity of the marker -* * * - -##### marker-line-color `color` - - - -Default Value: black - - -The color of the stroke around a marker shape. -* * * - -##### marker-line-width `float` - - - -Default Value: 0.5 - - -The width of the stroke around a marker shape, in pixels. This is positioned on the boundary, so high values can cover the area itself. -* * * - -##### marker-line-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of a line -* * * - -##### marker-placement `keyword` -`point``line``interior` - - -Default Value: point -_(Place markers at the center point (centroid) of the geometry)_ - -Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior -* * * - -##### marker-multi-policy `keyword` -`each``whole``largest` - - -Default Value: each -_(If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each)_ - -A special setting to allow the user to control rendering behavior for 'multi-geometries' (when a feature contains multiple geometries). This setting does not apply to markers placed along lines. The 'each' policy is default and means all geometries will get a marker. The 'whole' policy means that the aggregate centroid between all geometries will be used. The 'largest' policy means that only the largest (by bounding box areas) feature will get a rendered marker (this is how text labeling behaves by default). -* * * - -##### marker-type `keyword` -`arrow``ellipse` - - -Default Value: ellipse - - -The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width) -* * * - -##### marker-width `expression` - - - -Default Value: 10 - - -The width of the marker, if using one of the default types. -* * * - -##### marker-height `expression` - - - -Default Value: 10 - - -The height of the marker, if using one of the default types. -* * * - -##### marker-fill `color` - - - -Default Value: blue - - -The color of the area of the marker. -* * * - -##### marker-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow makers to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping markers are shown or hidden. -* * * - -##### marker-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache)_ - -value to control whether the placement of the feature will prevent the placement of other features -* * * - -##### marker-spacing `float` - - - -Default Value: 100 - - -Space between repeated labels -* * * - -##### marker-max-error `float` - - - -Default Value: 0.2 - - -The maximum difference between actual marker placement and the marker-spacing parameter. Setting a high value can allow the renderer to try to resolve placement conflicts with other symbolizers. -* * * - -##### marker-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation)_ - -SVG transformation definition -* * * - -##### marker-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### marker-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### marker-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(geometry will not be transformed)_ - -Allows transformation functions to be applied to the geometry. -* * * - -##### marker-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## shield - -##### shield-name `expression` - - - -Default Value: - - -Value to use for a shield"s text label. Data columns are specified using brackets like [column_name] -* * * - -##### shield-file `uri` - - - -Default Value: none - - -Image file to render behind the shield text -* * * - -##### shield-face-name `string` - - - -Default Value: - - -Font name and style to use for the shield text -* * * - -##### shield-unlock-image `boolean` - - - -Default Value: false -_(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)_ - -This parameter should be set to true if you are trying to position text beside rather than on top of the shield image -* * * - -##### shield-size `float` - - - -Default Value: 10 - - -The size of the shield text in pixels -* * * - -##### shield-fill `color` - - - -Default Value: black - - -The color of the shield text -* * * - -##### shield-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point - - -How this shield should be placed. Point placement attempts to place it on top of points, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of polygons. -* * * - -##### shield-avoid-edges `boolean` - - - -Default Value: false - - -Tell positioning algorithm to avoid labeling near intersection edges. -* * * - -##### shield-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow shields to overlap with other map elements already placed.)_ - -Control whether overlapping shields are shown or hidden. -* * * - -##### shield-min-distance `float` - - - -Default Value: 0 - - -Minimum distance to the next shield symbol, not necessarily the same shield. -* * * - -##### shield-spacing `float` - - - -Default Value: 0 - - -The spacing between repeated occurrences of the same shield on a line -* * * - -##### shield-min-padding `float` - - - -Default Value: 0 - - -Determines the minimum amount of padding that a shield gets relative to other shields -* * * - -##### shield-wrap-width `unsigned` - - - -Default Value: 0 - - -Length of a chunk of text in characters before wrapping text -* * * - -##### shield-wrap-before `boolean` - - - -Default Value: false - - -Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width. -* * * - -##### shield-wrap-character `string` - - - -Default Value: - - -Use this character instead of a space to wrap long names. -* * * - -##### shield-halo-fill `color` - - - -Default Value: #FFFFFF -_(white)_ - -Specifies the color of the halo around the text. -* * * - -##### shield-halo-radius `float` - - - -Default Value: 0 -_(no halo)_ - -Specify the radius of the halo in pixels -* * * - -##### shield-character-spacing `unsigned` - - - -Default Value: 0 - - -Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. -* * * - -##### shield-line-spacing `unsigned` - - - -Default Value: 0 - - -Vertical spacing between lines of multiline labels (in pixels) -* * * - -##### shield-text-dx `float` - - - -Default Value: 0 - - -Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right -* * * - -##### shield-text-dy `float` - - - -Default Value: 0 - - -Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down -* * * - -##### shield-dx `float` - - - -Default Value: 0 - - -Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right -* * * - -##### shield-dy `float` - - - -Default Value: 0 - - -Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down -* * * - -##### shield-opacity `float` - - - -Default Value: 1 - - -(Default 1.0) - opacity of the image used for the shield -* * * - -##### shield-text-opacity `float` - - - -Default Value: 1 - - -(Default 1.0) - opacity of the text placed on top of the shield -* * * - -##### shield-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: auto - - -The shield's horizontal alignment from its centerpoint -* * * - -##### shield-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: middle - - -The shield's vertical alignment from its centerpoint -* * * - -##### shield-text-transform `keyword` -`none``uppercase``lowercase``capitalize` - - -Default Value: none - - -Transform the case of the characters -* * * - -##### shield-justify-alignment `keyword` -`left``center``right``auto` - - -Default Value: auto - - -Define how text in a shield's label is justified -* * * - -##### shield-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### shield-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line-pattern - -##### line-pattern-file `uri` - - - -Default Value: none - - -An image file to be repeated and warped along a line -* * * - -##### line-pattern-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### line-pattern-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(geometry will not be transformed)_ - -Allows transformation functions to be applied to the geometry. -* * * - -##### line-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## polygon-pattern - -##### polygon-pattern-file `uri` - - - -Default Value: none - - -Image to use as a repeated pattern fill within a polygon -* * * - -##### polygon-pattern-alignment `keyword` -`local``global` - - -Default Value: local - - -Specify whether to align pattern fills to the layer or to the map. -* * * - -##### polygon-pattern-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of polygon pattern edges -* * * - -##### polygon-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications)_ - -(Default 1.0) - Apply an opacity level to the image used for the pattern -* * * - -##### polygon-pattern-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### polygon-pattern-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(geometry will not be transformed)_ - -Allows transformation functions to be applied to the geometry. -* * * - -##### polygon-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## raster - -##### raster-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of the raster symbolizer on top of other symbolizers. -* * * - -##### raster-filter-factor `float` - - - -Default Value: -1 -_(Allow the datasource to choose appropriate downscaling.)_ - -This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. -* * * - -##### raster-scaling `keyword` -`near``fast``bilinear``bilinear8``bicubic``spline16``spline36``hanning``hamming``hermite``kaiser``quadric``catrom``gaussian``bessel``mitchell``sinc``lanczos``blackman` - - -Default Value: near - - -The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. -* * * - -##### raster-mesh-size `unsigned` - - - -Default Value: 16 -_(Reprojection mesh will be 1/16 of the resolution of the source image)_ - -A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. -* * * - -##### raster-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## point - -##### point-file `uri` - - - -Default Value: none - - -Image file to represent a point -* * * - -##### point-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow points to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping points are shown or hidden. -* * * - -##### point-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache)_ - -value to control whether the placement of the feature will prevent the placement of other features -* * * - -##### point-opacity `float` - - - -Default Value: 1 -_(Fully opaque)_ - -A value from 0 to 1 to control the opacity of the point -* * * - -##### point-placement `keyword` -`centroid``interior` - - -Default Value: centroid - - -How this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. -* * * - -##### point-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation)_ - -SVG transformation definition -* * * - -##### point-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## text - -##### text-name `expression` - - - -Default Value: - - -Value to use for a text label. Data columns are specified using brackets like [column_name] -* * * - -##### text-face-name `string` - - - -Default Value: - - -Font name and style to render a label in -* * * - -##### text-size `float` - - - -Default Value: 10 - - -Text size in pixels -* * * - -##### text-ratio `unsigned` - - - -Default Value: 0 - - -Define the amount of text (of the total) present on successive lines when wrapping occurs -* * * - -##### text-wrap-width `unsigned` - - - -Default Value: 0 - - -Length of a chunk of text in characters before wrapping text -* * * - -##### text-wrap-before `boolean` - - - -Default Value: false - - -Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width. -* * * - -##### text-wrap-character `string` - - - -Default Value: - - -Use this character instead of a space to wrap long text. -* * * - -##### text-spacing `unsigned` - - - -Default Value: 0 - - -Distance between repeated text labels on a line (aka. label-spacing) -* * * - -##### text-character-spacing `float` - - - -Default Value: 0 - - -Horizontal spacing adjustment between characters in pixels -* * * - -##### text-line-spacing `unsigned` - - - -Default Value: 0 - - -Vertical spacing adjustment between lines in pixels -* * * - -##### text-label-position-tolerance `unsigned` - - - -Default Value: 0 - - -Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line) -* * * - -##### text-max-char-angle-delta `float` - - - -Default Value: 22.5 - - -The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. -* * * - -##### text-fill `color` - - - -Default Value: #000000 - - -Specifies the color for the text -* * * - -##### text-opacity `float` - - - -Default Value: 1 -_(Fully opaque)_ - -A number from 0 to 1 specifying the opacity for the text -* * * - -##### text-halo-fill `color` - - - -Default Value: #FFFFFF -_(white)_ - -Specifies the color of the halo around the text. -* * * - -##### text-halo-radius `float` - - - -Default Value: 0 -_(no halo)_ - -Specify the radius of the halo in pixels -* * * - -##### text-dx `float` - - - -Default Value: 0 - - -Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right -* * * - -##### text-dy `float` - - - -Default Value: 0 - - -Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down -* * * - -##### text-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: auto -_(Default affected by value of dy; "bottom" for dy>0, "top" for dy<0.)_ - -Position of label relative to point position. -* * * - -##### text-avoid-edges `boolean` - - - -Default Value: false - - -Tell positioning algorithm to avoid labeling near intersection edges. -* * * - -##### text-min-distance `float` - - - -Default Value: 0 - - -Minimum permitted distance to the next text symbolizer. -* * * - -##### text-min-padding `float` - - - -Default Value: 0 - - -Determines the minimum amount of padding that a text symbolizer gets relative to other text -* * * - -##### text-min-path-length `float` - - - -Default Value: 0 -_(place labels on all paths)_ - -Place labels only on paths longer than this value. -* * * - -##### text-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow text to overlap with other text - overlapping markers will not be shown.)_ - -Control whether overlapping text is shown or hidden. -* * * - -##### text-orientation `expression` - - - -Default Value: 0 - - -Rotate the text. -* * * - -##### text-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point - - -Control the style of placement of a point versus the geometry it is attached to. -* * * - -##### text-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy - - -Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. -* * * - -##### text-placements `string` - - - -Default Value: - - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `text-placements: "E,NE,SE,W,NW,SW";` -* * * - -##### text-transform `keyword` -`none``uppercase``lowercase``capitalize` - - -Default Value: none - - -Transform the case of the characters -* * * - -##### text-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: auto - - -The text's horizontal alignment from its centerpoint -* * * - -##### text-align `keyword` -`left``right``center``auto` - - -Default Value: auto -_(Auto alignment means that text will be centered by default except when using the `placement-type` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the `text-placements` directives)_ - -Define how text is justified -* * * - -##### text-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### text-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## building - -##### building-fill `color` - - - -Default Value: #FFFFFF - - -The color of the buildings walls. -* * * - -##### building-fill-opacity `float` - - - -Default Value: 1 - - -The opacity of the building as a whole, including all walls. -* * * - -##### building-height `expression` - - - -Default Value: 0 - - -The height of the building in pixels. -* * * - - - - -### Values - -Below is a list of values and an explanation of any expression that can be applied to properties in CartCSS. - -### Color - -CartoCSS accepts a variety of syntaxes for colors - HTML-style hex values, rgb, rgba, hsl, hsla, husl, and husla. It also supports the predefined HTML colors names, like `yellow` and `blue`. - -``` css -#line { -line-color: #ff0; -line-color: #ffff00; -line-color: rgb(255, 255, 0); -line-color: rgba(255, 255, 0, 1); -line-color: hsl(100, 50%, 50%); -line-color: hsla(100, 50%, 50%, 1); -line-color: husl(100, 50%, 50%); // same values yield different color than HSL -line-color: husla(100, 50%, 50%, 1); -line-color: yellow; -} -``` - -Especially of note is the support for hsl and husl, which can be [easier to reason about than rgb()](http://mothereffinghsl.com/). Carto also includes several color operation functions [borrowed from less](http://lesscss.org/functions/#color-operations): - -``` css -// lighten and darken colors -lighten(#ace, 10%); -darken(#ace, 10%); - -// saturate and desaturate -saturate(#550000, 10%); -desaturate(#00ff00, 10%); - -// increase or decrease the opacity of a color -fadein(#fafafa, 10%); -fadeout(#fefefe, 14%); - -// spin rotates a color around the color wheel by degrees -spin(#ff00ff, 10); - -// mix generates a color in between two other colors. -mix(#fff, #000, 50%); - -// get color components -hue(#ff00ff); -saturation(#ff00ff); -lightness(#ff00ff); -alpha(hsla(100, 50%, 50%, 0.5)); -``` - -These functions all take arguments which can be color variables, literal colors, or the results of other functions operating on colors. All the above mentioned functions also come in -a `functionp`-variant (e.g. `lightenp`), which force a given color into perceptual color space. - -### Float - -Float is a fancy way of saying 'number'. In CartoCSS, you specify _just a number_ - unlike CSS, there are no units, but everything is specified in pixels. - -``` css -#line { -line-width: 2; -} -``` - -It's also possible to do simple math with number values: - -``` css -#line { -line-width: 4 / 2; // division -line-width: 4 + 2; // addition -line-width: 4 - 2; // subtraction -line-width: 4 * 2; // multiplication -line-width: 4 % 2; // modulus -} -``` - -### URI - -URI is a fancy way of saying URL. When an argument is a URI, you use the same kind of `url('place.png')` notation that you would with HTML. Quotes around the URL aren't required, but are highly recommended. URIs can be paths to places on your computer, or on the internet. - -```css -#markers { -marker-file: url('marker.png'); -} -``` - -### String - -A string is basically just text. In the case of CartoCSS, you're going to put it in quotes. Strings can be anything, though pay attention to the cases of `text-name` and `shield-name` - they actually will refer to features, which you refer to by putting them in brackets, as seen in the example below. - -```css -#labels { -text-name: "[MY_FIELD]"; -} -``` - -### Boolean - -Boolean means yes or no, so it accepts the values `true` or `false`. - -```css -#markers { -marker-allow-overlap:true; -} -``` - -### Expressions - -Expressions are statements that can include fields, numbers, and other types in a really flexible way. You have run into expressions before, in the realm of 'fields', where you'd specify `"[FIELD]"`, but expressions allow you to drop the quotes and also do quick addition, division, multiplication, and concatenation from within Carto syntax. - -```css -#buildings { -building-height: [HEIGHT_FIELD] * 10; -} -``` - -### Numbers -Numbers are comma-separated lists of one or more number in a specific order. They're used in line dash arrays, in which the numbers specify intervals of line, break, and line again. - -```css -#disputedboundary { -line-dasharray: 1, 4, 2; -} -``` - -### Percentages -In Carto, the percentage symbol, `%` universally means `value/100`. It's meant to be used with ratio-related properties, like opacity rules. - -_You should not use percentages as widths, heights, or other properties - unlike CSS, percentages are not relative to cascaded classes or page size, they're, as stated, simply the value divided by one hundred._ - -```css -#world { -// this syntax -polygon-opacity: 50%; - -// is equivalent to -polygon-opacity: 0.5; -} -``` - -### Functions - -Functions are comma-separated lists of one or more functions. For instance, transforms use the `functions` type to allow for transforms within Carto, which are optionally chainable. - -```css -#point { -point-transform: scale(2, 2); -} -``` diff --git a/docs/2.2.0.md b/docs/2.2.0.md deleted file mode 100644 index 6182cf8..0000000 --- a/docs/2.2.0.md +++ /dev/null @@ -1,1833 +0,0 @@ -# Carto documentation - -The following is a list of properties provided in CartoCSS that you can apply to map elements. - -## All elements - -##### image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``colorize-alpha` - -Default Value: none -_(no filters)_ - -A list of image filters that will be applied to the active rendering canvas for a given style. The presence of one more more `image-filters` will trigger a new canvas to be created before starting to render a style and then this canvas will be composited back into the main canvas after rendering all features and after all `image-filters` have been applied. See `direct-image-filters` if you want to apply a filter directly to the main canvas. -* * * - -##### direct-image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``colorize-alpha` - -Default Value: none -_(no filters)_ - -A list of image filters to apply to the main canvas (see the `image-filters` doc for how they work on a separate canvas) -* * * - -##### comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current layer on top of other layers)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - -##### opacity `float` - - - -Default Value: 1 -_(no separate buffer will be used and no alpha will be applied to the style after rendering)_ - -An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer) -* * * - - -## map - -##### background-color `color` - - - -Default Value: none -_(transparent)_ - -Map Background color -* * * - -##### background-image `uri` - - - -Default Value: -_(transparent)_ - -An image that is repeated below all features on a map as a background. -* * * - -##### srs `string` - - - -Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs -_(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space)_ - -Map spatial reference (proj4 string) -* * * - -##### buffer-size `float` - - - -Default Value: 0 -_(No buffer will be used)_ - -Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". -* * * - -##### base `string` - - - -Default Value: -_(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)_ - -Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. -* * * - -##### font-directory `uri` - - - -Default Value: none -_(No map-specific fonts will be registered)_ - -Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). -* * * - - -## polygon - -##### polygon-fill `color` - - - -Default Value: rgba(128,128,128,1) -_(gray and fully opaque (alpha = 1), same as rgb(128,128,128))_ - -Fill color to assign to a polygon -* * * - -##### polygon-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of the polygon -* * * - -##### polygon-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of polygon edges -* * * - -##### polygon-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions.h -* * * - -##### polygon-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### polygon-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified)_ - -geometries are simplified by the given tolerance -* * * - -##### polygon-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(geometry will not be simplified using the radial distance algorithm)_ - -geometries are simplified by the given algorithm -* * * - -##### polygon-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(geometry will not be transformed)_ - -Allows transformation functions to be applied to the geometry. -* * * - -##### polygon-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line - -##### line-color `color` - - - -Default Value: rgba(0,0,0,1) -_(black and fully opaque (alpha = 1), same as rgb(0,0,0))_ - -The color of a drawn line -* * * - -##### line-width `float` - - - -Default Value: 1 - - -The width of a line in pixels -* * * - -##### line-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of a line -* * * - -##### line-join `keyword` -`miter``round``bevel` - - -Default Value: miter - - -The behavior of lines when joining -* * * - -##### line-cap `keyword` -`butt``round``square` - - -Default Value: butt - - -The display of line endings -* * * - -##### line-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of stroke line -* * * - -##### line-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions.h -* * * - -##### line-dasharray `numbers` - - - -Default Value: none -_(solid line)_ - -A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. -* * * - -##### line-dash-offset `numbers` - - - -Default Value: none -_(solid line)_ - -valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled) -* * * - -##### line-miterlimit `float` - - - -Default Value: 4 -_(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )')_ - -The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. -* * * - -##### line-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### line-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified)_ - -geometries are simplified by the given tolerance -* * * - -##### line-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(geometry will not be simplified using the radial distance algorithm)_ - -geometries are simplified by the given algorithm -* * * - -##### line-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-offset `float` - - - -Default Value: 0 -_(no offset)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-rasterizer `keyword` -`full``fast` - - -Default Value: full - - -Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. -* * * - -##### line-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(geometry will not be transformed)_ - -Allows transformation functions to be applied to the geometry. -* * * - -##### line-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## markers - -##### marker-file `uri` - - - -Default Value: -_(An ellipse or circle, if width equals height)_ - -An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse. -* * * - -##### marker-opacity `float` - - - -Default Value: 1 -_(The stroke-opacity and fill-opacity will be used)_ - -The overall opacity of the marker, if set, overrides both the opacity of both the fill and stroke -* * * - -##### marker-fill-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The fill opacity of the marker -* * * - -##### marker-line-color `color` - - - -Default Value: black - - -The color of the stroke around a marker shape. -* * * - -##### marker-line-width `float` - - - -Default Value: 0.5 - - -The width of the stroke around a marker shape, in pixels. This is positioned on the boundary, so high values can cover the area itself. -* * * - -##### marker-line-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of a line -* * * - -##### marker-placement `keyword` -`point``line``interior` - - -Default Value: point -_(Place markers at the center point (centroid) of the geometry)_ - -Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior -* * * - -##### marker-multi-policy `keyword` -`each``whole``largest` - - -Default Value: each -_(If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each)_ - -A special setting to allow the user to control rendering behavior for 'multi-geometries' (when a feature contains multiple geometries). This setting does not apply to markers placed along lines. The 'each' policy is default and means all geometries will get a marker. The 'whole' policy means that the aggregate centroid between all geometries will be used. The 'largest' policy means that only the largest (by bounding box areas) feature will get a rendered marker (this is how text labeling behaves by default). -* * * - -##### marker-type `keyword` -`arrow``ellipse` - - -Default Value: ellipse - - -The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width) -* * * - -##### marker-width `float` - - - -Default Value: 10 - - -The width of the marker, if using one of the default types. -* * * - -##### marker-height `float` - - - -Default Value: 10 - - -The height of the marker, if using one of the default types. -* * * - -##### marker-fill `color` - - - -Default Value: blue - - -The color of the area of the marker. -* * * - -##### marker-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow makers to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping markers are shown or hidden. -* * * - -##### marker-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache)_ - -value to control whether the placement of the feature will prevent the placement of other features -* * * - -##### marker-spacing `float` - - - -Default Value: 100 - - -Space between repeated markers in pixels. If the spacing is less than the marker size or larger than the line segment length then no marker will be placed -* * * - -##### marker-max-error `float` - - - -Default Value: 0.2 - - -The maximum difference between actual marker placement and the marker-spacing parameter. Setting a high value can allow the renderer to try to resolve placement conflicts with other symbolizers. -* * * - -##### marker-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation)_ - -SVG transformation definition -* * * - -##### marker-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### marker-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### marker-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(geometry will not be transformed)_ - -Allows transformation functions to be applied to the geometry. -* * * - -##### marker-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## shield - -##### shield-name `string` - - - -Default Value: - - -Value to use for a shield"s text label. Data columns are specified using brackets like [column_name] -* * * - -##### shield-file `uri` - - - -Default Value: none - - -Image file to render behind the shield text -* * * - -##### shield-face-name `string` - - - -Default Value: - - -Font name and style to use for the shield text -* * * - -##### shield-unlock-image `boolean` - - - -Default Value: false -_(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)_ - -This parameter should be set to true if you are trying to position text beside rather than on top of the shield image -* * * - -##### shield-size `float` - - - -Default Value: 10 - - -The size of the shield text in pixels -* * * - -##### shield-fill `color` - - - -Default Value: black - - -The color of the shield text -* * * - -##### shield-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point - - -How this shield should be placed. Point placement attempts to place it on top of points, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of polygons. -* * * - -##### shield-avoid-edges `boolean` - - - -Default Value: false - - -Avoid placing shields that intersect with tile boundaries. -* * * - -##### shield-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow shields to overlap with other map elements already placed.)_ - -Control whether overlapping shields are shown or hidden. -* * * - -##### shield-min-distance `float` - - - -Default Value: 0 - - -Minimum distance to the next shield symbol, not necessarily the same shield. -* * * - -##### shield-spacing `float` - - - -Default Value: 0 - - -The spacing between repeated occurrences of the same shield on a line -* * * - -##### shield-min-padding `float` - - - -Default Value: 0 - - -Minimum distance a shield will be placed from the edge of a metatile. -* * * - -##### shield-wrap-width `unsigned` - - - -Default Value: 0 - - -Length of a chunk of text in characters before wrapping text -* * * - -##### shield-wrap-before `boolean` - - - -Default Value: false - - -Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width. -* * * - -##### shield-wrap-character `string` - - - -Default Value: - - -Use this character instead of a space to wrap long names. -* * * - -##### shield-halo-fill `color` - - - -Default Value: #FFFFFF -_(white)_ - -Specifies the color of the halo around the text. -* * * - -##### shield-halo-radius `float` - - - -Default Value: 0 -_(no halo)_ - -Specify the radius of the halo in pixels -* * * - -##### shield-character-spacing `unsigned` - - - -Default Value: 0 - - -Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. -* * * - -##### shield-line-spacing `unsigned` - - - -Default Value: 0 - - -Vertical spacing between lines of multiline labels (in pixels) -* * * - -##### shield-text-dx `float` - - - -Default Value: 0 - - -Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right -* * * - -##### shield-text-dy `float` - - - -Default Value: 0 - - -Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down -* * * - -##### shield-dx `float` - - - -Default Value: 0 - - -Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right -* * * - -##### shield-dy `float` - - - -Default Value: 0 - - -Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down -* * * - -##### shield-opacity `float` - - - -Default Value: 1 - - -The opacity of the image used for the shield -* * * - -##### shield-text-opacity `float` - - - -Default Value: 1 - - -The opacity of the text placed on top of the shield -* * * - -##### shield-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: auto - - -The shield's horizontal alignment from its centerpoint -* * * - -##### shield-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: middle - - -The shield's vertical alignment from its centerpoint -* * * - -##### shield-placement-type `keyword` -`dummy``simple` - - -Default Value: dummy - - -Re-position and/or re-size shield to avoid overlaps. "simple" for basic algorithm (using shield-placements string,) "dummy" to turn this feature off. -* * * - -##### shield-placements `string` - - - -Default Value: - - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `shield-placements: "E,NE,SE,W,NW,SW";` -* * * - -##### shield-text-transform `keyword` -`none``uppercase``lowercase``capitalize` - - -Default Value: none - - -Transform the case of the characters -* * * - -##### shield-justify-alignment `keyword` -`left``center``right``auto` - - -Default Value: auto - - -Define how text in a shield's label is justified -* * * - -##### shield-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation)_ - -SVG transformation definition -* * * - -##### shield-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### shield-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line-pattern - -##### line-pattern-file `uri` - - - -Default Value: none - - -An image file to be repeated and warped along a line -* * * - -##### line-pattern-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### line-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified)_ - -geometries are simplified by the given tolerance -* * * - -##### line-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(geometry will not be simplified using the radial distance algorithm)_ - -geometries are simplified by the given algorithm -* * * - -##### line-pattern-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(geometry will not be transformed)_ - -Allows transformation functions to be applied to the geometry. -* * * - -##### line-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## polygon-pattern - -##### polygon-pattern-file `uri` - - - -Default Value: none - - -Image to use as a repeated pattern fill within a polygon -* * * - -##### polygon-pattern-alignment `keyword` -`local``global` - - -Default Value: local - - -Specify whether to align pattern fills to the layer or to the map. -* * * - -##### polygon-pattern-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of polygon pattern edges -* * * - -##### polygon-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications)_ - -Apply an opacity level to the image used for the pattern -* * * - -##### polygon-pattern-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### polygon-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified)_ - -geometries are simplified by the given tolerance -* * * - -##### polygon-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(geometry will not be simplified using the radial distance algorithm)_ - -geometries are simplified by the given algorithm -* * * - -##### polygon-pattern-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(geometry will not be transformed)_ - -Allows transformation functions to be applied to the geometry. -* * * - -##### polygon-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## raster - -##### raster-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of the raster symbolizer on top of other symbolizers. -* * * - -##### raster-filter-factor `float` - - - -Default Value: -1 -_(Allow the datasource to choose appropriate downscaling.)_ - -This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. -* * * - -##### raster-scaling `keyword` -`near``fast``bilinear``bilinear8``bicubic``spline16``spline36``hanning``hamming``hermite``kaiser``quadric``catrom``gaussian``bessel``mitchell``sinc``lanczos``blackman` - - -Default Value: near - - -The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. -* * * - -##### raster-mesh-size `unsigned` - - - -Default Value: 16 -_(Reprojection mesh will be 1/16 of the resolution of the source image)_ - -A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. -* * * - -##### raster-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### raster-colorizer-default-mode `keyword` -`discrete``linear``exact` - - -Default Value: linear -_(A linear interpolation is used to generate colors between the two nearest stops.)_ - -This can be either `discrete`, `linear` or `exact`. If it is not specified then the default is `linear`. -* * * - -##### raster-colorizer-default-color `color` - - - -Default Value: transparent -_(Pixels that are not colored by the colorizer stops will be transparent)_ - -This can be any color. Sets the color that is applied to all values outside of the range of the colorizer-stops. If not supplied pixels will be fully transparent -* * * - -##### raster-colorizer-epsilon `float` - - - -Default Value: 1.1920928955078125e-07 -_(Pixels must very closely match the stop filter otherwise they will not be colored.)_ - -This can be any positive floating point value and will be used as a tolerance in floating point comparisions. The higher the value the more likely a stop will match and color data. -* * * - -##### raster-colorizer-stops `tags` - - - -Default Value: -_(No colorization will happen without supplying stops.)_ - -Assigns raster data values to colors. Stops must be listed in ascending order, and contain at a minimum the value and the associated color. You can also include the color-mode as a third argument, like `stop(100,#fff,exact)`. -* * * - - -## point - -##### point-file `uri` - - - -Default Value: none - - -Image file to represent a point -* * * - -##### point-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow points to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping points are shown or hidden. -* * * - -##### point-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache)_ - -value to control whether the placement of the feature will prevent the placement of other features -* * * - -##### point-opacity `float` - - - -Default Value: 1 -_(Fully opaque)_ - -A value from 0 to 1 to control the opacity of the point -* * * - -##### point-placement `keyword` -`centroid``interior` - - -Default Value: centroid - - -How this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. -* * * - -##### point-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation)_ - -SVG transformation definition -* * * - -##### point-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## text - -##### text-name `string` - - - -Default Value: - - -Value to use for a text label. Data columns are specified using brackets like [column_name] -* * * - -##### text-face-name `string` - - - -Default Value: - - -Font name and style to render a label in -* * * - -##### text-size `float` - - - -Default Value: 10 - - -Text size in pixels -* * * - -##### text-ratio `unsigned` - - - -Default Value: 0 - - -Define the amount of text (of the total) present on successive lines when wrapping occurs -* * * - -##### text-wrap-width `unsigned` - - - -Default Value: 0 - - -Length of a chunk of text in characters before wrapping text -* * * - -##### text-wrap-before `boolean` - - - -Default Value: false - - -Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width. -* * * - -##### text-wrap-character `string` - - - -Default Value: - - -Use this character instead of a space to wrap long text. -* * * - -##### text-spacing `unsigned` - - - -Default Value: 0 - - -Distance between repeated text labels on a line (aka. label-spacing) -* * * - -##### text-character-spacing `float` - - - -Default Value: 0 - - -Horizontal spacing adjustment between characters in pixels -* * * - -##### text-line-spacing `unsigned` - - - -Default Value: 0 - - -Vertical spacing adjustment between lines in pixels -* * * - -##### text-label-position-tolerance `unsigned` - - - -Default Value: 0 - - -Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line) -* * * - -##### text-max-char-angle-delta `float` - - - -Default Value: 22.5 - - -The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. -* * * - -##### text-fill `color` - - - -Default Value: #000000 - - -Specifies the color for the text -* * * - -##### text-opacity `float` - - - -Default Value: 1 -_(Fully opaque)_ - -A number from 0 to 1 specifying the opacity for the text -* * * - -##### text-halo-fill `color` - - - -Default Value: #FFFFFF -_(white)_ - -Specifies the color of the halo around the text. -* * * - -##### text-halo-radius `float` - - - -Default Value: 0 -_(no halo)_ - -Specify the radius of the halo in pixels -* * * - -##### text-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full - - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### text-dx `float` - - - -Default Value: 0 - - -Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right -* * * - -##### text-dy `float` - - - -Default Value: 0 - - -Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down -* * * - -##### text-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: auto -_(Default affected by value of dy; "bottom" for dy>0, "top" for dy<0.)_ - -Position of label relative to point position. -* * * - -##### text-avoid-edges `boolean` - - - -Default Value: false - - -Avoid placing labels that intersect with tile boundaries. -* * * - -##### text-min-distance `float` - - - -Default Value: 0 - - -Minimum permitted distance to the next text symbolizer. -* * * - -##### text-min-padding `float` - - - -Default Value: 0 - - -Minimum distance a text label will be placed from the edge of a metatile. -* * * - -##### text-min-path-length `float` - - - -Default Value: 0 -_(place labels on all paths)_ - -Place labels only on paths longer than this value. -* * * - -##### text-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow text to overlap with other text - overlapping markers will not be shown.)_ - -Control whether overlapping text is shown or hidden. -* * * - -##### text-orientation `float` - - - -Default Value: 0 - - -Rotate the text. -* * * - -##### text-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point - - -Control the style of placement of a point versus the geometry it is attached to. -* * * - -##### text-placement-type `keyword` -`dummy``simple` - - -Default Value: dummy - - -Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. -* * * - -##### text-placements `string` - - - -Default Value: - - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `text-placements: "E,NE,SE,W,NW,SW";` -* * * - -##### text-transform `keyword` -`none``uppercase``lowercase``capitalize` - - -Default Value: none - - -Transform the case of the characters -* * * - -##### text-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: auto - - -The text's horizontal alignment from its centerpoint -* * * - -##### text-align `keyword` -`left``right``center``auto` - - -Default Value: auto -_(Auto alignment means that text will be centered by default except when using the `placement-type` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the `text-placements` directives)_ - -Define how text is justified -* * * - -##### text-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### text-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## building - -##### building-fill `color` - - - -Default Value: #FFFFFF - - -The color of the buildings walls. -* * * - -##### building-fill-opacity `float` - - - -Default Value: 1 - - -The opacity of the building as a whole, including all walls. -* * * - -##### building-height `float` - - - -Default Value: 0 - - -The height of the building in pixels. -* * * - - -## debug - -##### debug-mode `string` - - - -Default Value: collision - - -The mode for debug rendering -* * * - - - - -### Values - -Below is a list of values and an explanation of any expression that can be applied to properties in CartCSS. - -### Color - -CartoCSS accepts a variety of syntaxes for colors - HTML-style hex values, rgb, rgba, hsl, hsla, husl, and husla. It also supports the predefined HTML colors names, like `yellow` and `blue`. - -``` css -#line { -line-color: #ff0; -line-color: #ffff00; -line-color: rgb(255, 255, 0); -line-color: rgba(255, 255, 0, 1); -line-color: hsl(100, 50%, 50%); -line-color: hsla(100, 50%, 50%, 1); -line-color: husl(100, 50%, 50%); // same values yield different color than HSL -line-color: husla(100, 50%, 50%, 1); -line-color: yellow; -} -``` - -Especially of note is the support for hsl and husl, which can be [easier to reason about than rgb()](http://mothereffinghsl.com/). Carto also includes several color operation functions [borrowed from less](http://lesscss.org/functions/#color-operations): - -``` css -// lighten and darken colors -lighten(#ace, 10%); -darken(#ace, 10%); - -// saturate and desaturate -saturate(#550000, 10%); -desaturate(#00ff00, 10%); - -// increase or decrease the opacity of a color -fadein(#fafafa, 10%); -fadeout(#fefefe, 14%); - -// spin rotates a color around the color wheel by degrees -spin(#ff00ff, 10); - -// mix generates a color in between two other colors. -mix(#fff, #000, 50%); - -// get color components -hue(#ff00ff); -saturation(#ff00ff); -lightness(#ff00ff); -alpha(hsla(100, 50%, 50%, 0.5)); -``` - -These functions all take arguments which can be color variables, literal colors, or the results of other functions operating on colors. All the above mentioned functions also come in -a `functionp`-variant (e.g. `lightenp`), which force a given color into perceptual color space. - -### Float - -Float is a fancy way of saying 'number'. In CartoCSS, you specify _just a number_ - unlike CSS, there are no units, but everything is specified in pixels. - -``` css -#line { -line-width: 2; -} -``` - -It's also possible to do simple math with number values: - -``` css -#line { -line-width: 4 / 2; // division -line-width: 4 + 2; // addition -line-width: 4 - 2; // subtraction -line-width: 4 * 2; // multiplication -line-width: 4 % 2; // modulus -} -``` - -### URI - -URI is a fancy way of saying URL. When an argument is a URI, you use the same kind of `url('place.png')` notation that you would with HTML. Quotes around the URL aren't required, but are highly recommended. URIs can be paths to places on your computer, or on the internet. - -```css -#markers { -marker-file: url('marker.png'); -} -``` - -### String - -A string is basically just text. In the case of CartoCSS, you're going to put it in quotes. Strings can be anything, though pay attention to the cases of `text-name` and `shield-name` - they actually will refer to features, which you refer to by putting them in brackets, as seen in the example below. - -```css -#labels { -text-name: "[MY_FIELD]"; -} -``` - -### Boolean - -Boolean means yes or no, so it accepts the values `true` or `false`. - -```css -#markers { -marker-allow-overlap:true; -} -``` - -### Expressions - -Expressions are statements that can include fields, numbers, and other types in a really flexible way. You have run into expressions before, in the realm of 'fields', where you'd specify `"[FIELD]"`, but expressions allow you to drop the quotes and also do quick addition, division, multiplication, and concatenation from within Carto syntax. - -```css -#buildings { -building-height: [HEIGHT_FIELD] * 10; -} -``` - -### Numbers -Numbers are comma-separated lists of one or more number in a specific order. They're used in line dash arrays, in which the numbers specify intervals of line, break, and line again. - -```css -#disputedboundary { -line-dasharray: 1, 4, 2; -} -``` - -### Percentages -In Carto, the percentage symbol, `%` universally means `value/100`. It's meant to be used with ratio-related properties, like opacity rules. - -_You should not use percentages as widths, heights, or other properties - unlike CSS, percentages are not relative to cascaded classes or page size, they're, as stated, simply the value divided by one hundred._ - -```css -#world { -// this syntax -polygon-opacity: 50%; - -// is equivalent to -polygon-opacity: 0.5; -} -``` - -### Functions - -Functions are comma-separated lists of one or more functions. For instance, transforms use the `functions` type to allow for transforms within Carto, which are optionally chainable. - -```css -#point { -point-transform: scale(2, 2); -} -``` diff --git a/docs/2.3.0.md b/docs/2.3.0.md deleted file mode 100644 index a90fe1b..0000000 --- a/docs/2.3.0.md +++ /dev/null @@ -1,1883 +0,0 @@ -# Carto documentation - -The following is a list of properties provided in CartoCSS that you can apply to map elements. - -## All elements - -##### image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``colorize-alpha``color-to-alpha``scale-hsla` - -Default Value: none -_(no filters)_ - -A list of image filters that will be applied to the active rendering canvas for a given style. The presence of one more more `image-filters` will trigger a new canvas to be created before starting to render a style and then this canvas will be composited back into the main canvas after rendering all features and after all `image-filters` have been applied. See `direct-image-filters` if you want to apply a filter directly to the main canvas. -* * * - -##### image-filters-inflate `boolean` - - - -Default Value: false -_(No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary)_ - -A property that can be set to true to enable using an inflated image internally for seamless blurring across tiles (requires buffered data). -* * * - -##### direct-image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``colorize-alpha``color-to-alpha``scale-hsla` - -Default Value: none -_(no filters)_ - -A list of image filters to apply to the main canvas (see the `image-filters` doc for how they work on a separate canvas). -* * * - -##### comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current layer on top of other layers)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - -##### opacity `float` - - - -Default Value: 1 -_(no separate buffer will be used and no alpha will be applied to the style after rendering)_ - -An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer). -* * * - - -## map - -##### background-color `color` - - - -Default Value: none -_(transparent)_ - -Map Background color. -* * * - -##### background-image `uri` - - - -Default Value: -_(transparent)_ - -An image that is repeated below all features on a map as a background. Accepted formats: JPG, PNG. -* * * - -##### background-image-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(The background-image will be blended with the background normally (placed on top of any existing background-color))_ - -Set the compositing operation used to blend the image into the background. -* * * - -##### background-image-opacity `float` - - - -Default Value: 1 -_(The image opacity will not be changed when applied to the map background)_ - -Set the opacity of the image. -* * * - -##### srs `string` - - - -Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs -_(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space)_ - -Map spatial reference (proj4 string). -* * * - -##### buffer-size `float` - - - -Default Value: 0 -_(No buffer will be used)_ - -Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". -* * * - -##### base `string` - - - -Default Value: -_(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)_ - -Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. -* * * - -##### font-directory `uri` - - - -Default Value: none -_(No map-specific fonts will be registered)_ - -Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). -* * * - - -## polygon - -##### polygon-fill `color` - - - -Default Value: rgba(128,128,128,1) -_(gray and fully opaque (alpha = 1), same as rgb(128,128,128))_ - -Fill color to assign to a polygon. -* * * - -##### polygon-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of the polygon. -* * * - -##### polygon-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of polygon edges. -* * * - -##### polygon-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. -* * * - -##### polygon-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -Geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### polygon-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified)_ - -Simplify geometries by the given tolerance. -* * * - -##### polygon-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(geometry will be simplified using the radial distance algorithm)_ - -Simplify gemoetries by the given algorithm. -* * * - -##### polygon-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(geometry will not be transformed)_ - -Allows transformation functions to be applied to the geometry. -* * * - -##### polygon-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line - -##### line-color `color` - - - -Default Value: rgba(0,0,0,1) -_(black and fully opaque (alpha = 1), same as rgb(0,0,0))_ - -The color of a drawn line. -* * * - -##### line-width `float` - - - -Default Value: 1 - - -The width of a line in pixels. -* * * - -##### line-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of a line. -* * * - -##### line-join `keyword` -`miter``round``bevel` - - -Default Value: miter - - -The behavior of lines when joining. -* * * - -##### line-cap `keyword` -`butt``round``square` - - -Default Value: butt - - -The display of line endings. -* * * - -##### line-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of stroke line. -* * * - -##### line-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. -* * * - -##### line-dasharray `numbers` - - - -Default Value: none -_(solid line)_ - -A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. -* * * - -##### line-dash-offset `numbers` - - - -Default Value: none -_(solid line)_ - -Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled). -* * * - -##### line-miterlimit `float` - - - -Default Value: 4 -_(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )')_ - -The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. -* * * - -##### line-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -Geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### line-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified)_ - -Simplify gemoetries by the given tolerance -* * * - -##### line-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(geometry will be simplified using the radial distance algorithm)_ - -Simplify gemoetries by the given algorithm. -* * * - -##### line-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-offset `float` - - - -Default Value: 0 -_(no offset)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-rasterizer `keyword` -`full``fast` - - -Default Value: full - - -Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. -* * * - -##### line-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(geometry will not be transformed)_ - -Allows transformation functions to be applied to the geometry. -* * * - -##### line-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## markers - -##### marker-file `uri` - - - -Default Value: none -_(An ellipse or circle, if width equals height.)_ - -A file that this marker shows at each placement. If no file is given, the marker will show an ellipse. Accepted formats: SVG, JPG, PNG. -* * * - -##### marker-opacity `float` - - - -Default Value: 1 -_(The stroke-opacity and fill-opacity of the marker.)_ - -The overall opacity of the marker, if set, overrides both the opacity of both the fill and stroke -* * * - -##### marker-fill-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The fill opacity of the marker. -* * * - -##### marker-line-color `color` - - - -Default Value: black - - -The color of the stroke around the marker. -* * * - -##### marker-line-width `float` - - - -Default Value: 0.5 - - -The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. -* * * - -##### marker-line-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of the line. -* * * - -##### marker-placement `keyword` -`point``line``interior` - - -Default Value: point -_(Place markers at the center point (centroid) of the geometry)_ - -Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior. -* * * - -##### marker-multi-policy `keyword` -`each``whole``largest` - - -Default Value: each -_(If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each)_ - -A special setting to allow the user to control rendering behavior for 'multi-geometries' (when a feature contains multiple geometries). This setting does not apply to markers placed along lines. The 'each' policy is default and means all geometries will get a marker. The 'whole' policy means that the aggregate centroid between all geometries will be used. The 'largest' policy means that only the largest (by bounding box areas) feature will get a rendered marker (this is how text labeling behaves by default). -* * * - -##### marker-type `keyword` -`arrow``ellipse` - - -Default Value: ellipse - - -The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width). -* * * - -##### marker-width `float` - - - -Default Value: 10 - - -The width of the marker, if using one of the default types. -* * * - -##### marker-height `float` - - - -Default Value: 10 - - -The height of the marker, if using one of the default types. -* * * - -##### marker-fill `color` - - - -Default Value: blue - - -The color of the area of the marker. -* * * - -##### marker-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow makers to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping markers are shown or hidden. -* * * - -##### marker-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache)_ - -Value to control whether the placement of the feature will prevent the placement of other features. -* * * - -##### marker-spacing `float` - - - -Default Value: 100 - - -Space between repeated markers in pixels. If the spacing is less than the marker size or larger than the line segment length then no marker will be placed. -* * * - -##### marker-max-error `float` - - - -Default Value: 0.2 - - -The maximum difference between actual marker placement and the marker-spacing parameter. Setting a high value can allow the renderer to try to resolve placement conflicts with other symbolizers. -* * * - -##### marker-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation)_ - -SVG transformation definition. -* * * - -##### marker-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### marker-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### marker-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(geometry will not be transformed)_ - -Allows transformation functions to be applied to the geometry. -* * * - -##### marker-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## shield - -##### shield-name `string` - - - -Default Value: - - -Value to use for a shield"s text label. Data columns are specified using brackets like [column_name]. -* * * - -##### shield-file `uri` - - - -Default Value: none - - -Image file to render behind the shield text. Accepted formats: SVG, JPG, PNG. -* * * - -##### shield-face-name `string` - - - -Default Value: - - -Font name and style to use for the shield text -* * * - -##### shield-unlock-image `boolean` - - - -Default Value: false -_(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)_ - -This parameter should be set to true if you are trying to position text beside rather than on top of the shield image -* * * - -##### shield-size `float` - - - -Default Value: 10 - - -The size of the shield text in pixels. -* * * - -##### shield-fill `color` - - - -Default Value: black - - -The color of the shield text. -* * * - -##### shield-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point - - -How this shield should be placed. Point placement attempts to place it on top of points, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of polygons. -* * * - -##### shield-avoid-edges `boolean` - - - -Default Value: false - - -Avoid placing shields that intersect with tile boundaries. -* * * - -##### shield-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow shields to overlap with other map elements already placed.)_ - -Control whether overlapping shields are shown or hidden. -* * * - -##### shield-min-distance `float` - - - -Default Value: 0 - - -Minimum distance to the next shield symbol, not necessarily the same shield. -* * * - -##### shield-spacing `float` - - - -Default Value: 0 - - -The spacing between repeated occurrences of the same shield on a line. -* * * - -##### shield-min-padding `float` - - - -Default Value: 0 - - -Minimum distance a shield will be placed from the edge of a metatile. This option is similiar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the metatile. -* * * - -##### shield-wrap-width `unsigned` - - - -Default Value: 0 - - -Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. -* * * - -##### shield-wrap-before `boolean` - - - -Default Value: false - - -Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width. -* * * - -##### shield-wrap-character `string` - - - -Default Value: " " - - -Use this character instead of a space to wrap long names. -* * * - -##### shield-halo-fill `color` - - - -Default Value: #FFFFFF -_(white)_ - -Specifies the color of the halo around the text. -* * * - -##### shield-halo-radius `float` - - - -Default Value: 0 -_(no halo)_ - -Specify the radius of the halo in pixels. -* * * - -##### shield-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full - - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### shield-character-spacing `unsigned` - - - -Default Value: 0 - - -Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. -* * * - -##### shield-line-spacing `unsigned` - - - -Default Value: 0 - - -Vertical spacing between lines of multiline labels (in pixels). -* * * - -##### shield-text-dx `float` - - - -Default Value: 0 - - -Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right. -* * * - -##### shield-text-dy `float` - - - -Default Value: 0 - - -Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down. -* * * - -##### shield-dx `float` - - - -Default Value: 0 - - -Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right. -* * * - -##### shield-dy `float` - - - -Default Value: 0 - - -Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down. -* * * - -##### shield-opacity `float` - - - -Default Value: 1 - - -The opacity of the image used for the shield -* * * - -##### shield-text-opacity `float` - - - -Default Value: 1 - - -The opacity of the text placed on top of the shield -* * * - -##### shield-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: auto - - -The shield's horizontal alignment from its centerpoint -* * * - -##### shield-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: middle - - -The shield's vertical alignment from its centerpoint -* * * - -##### shield-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy - - -Re-position and/or re-size shield to avoid overlaps. "simple" for basic algorithm (using shield-placements string,) "dummy" to turn this feature off. -* * * - -##### shield-placements `string` - - - -Default Value: - - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `shield-placements: "E,NE,SE,W,NW,SW";` -* * * - -##### shield-text-transform `keyword` -`none``uppercase``lowercase``capitalize` - - -Default Value: none - - -Transform the case of the characters. -* * * - -##### shield-justify-alignment `keyword` -`left``center``right``auto` - - -Default Value: auto - - -Define how text in a shield's label is justified. -* * * - -##### shield-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation)_ - -SVG transformation definition. -* * * - -##### shield-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### shield-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line-pattern - -##### line-pattern-file `uri` - - - -Default Value: none - - -An image file to be repeated and warped along a line. Accepted formats: JPG, PNG. -* * * - -##### line-pattern-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### line-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified)_ - -geometries are simplified by the given tolerance -* * * - -##### line-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(geometry will be simplified using the radial distance algorithm)_ - -geometries are simplified by the given algorithm. -* * * - -##### line-pattern-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-pattern-offset `float` - - - -Default Value: 0 -_(no offset)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(geometry will not be transformed)_ - -Allows transformation functions to be applied to the geometry. -* * * - -##### line-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## polygon-pattern - -##### polygon-pattern-file `uri` - - - -Default Value: none - - -Image to use as a repeated pattern fill within a polygon. Accepted formats: JPG, PNG. -* * * - -##### polygon-pattern-alignment `keyword` -`local``global` - - -Default Value: local - - -Specify whether to align pattern fills to the layer or to the map. -* * * - -##### polygon-pattern-gamma `float` - - - -Default Value: 1 -_(fully antialiased)_ -Range: 0-1 -Level of antialiasing of polygon pattern edges -* * * - -##### polygon-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications)_ - -Apply an opacity level to the image used for the pattern -* * * - -##### polygon-pattern-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### polygon-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified)_ - -geometries are simplified by the given tolerance -* * * - -##### polygon-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(geometry will be simplified using the radial distance algorithm)_ - -geometries are simplified by the given algorithm -* * * - -##### polygon-pattern-smooth `float` - - - -Default Value: 0 -_(no smoothing)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(geometry will not be transformed)_ - -Allows transformation functions to be applied to the geometry. -* * * - -##### polygon-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## raster - -##### raster-opacity `float` - - - -Default Value: 1 -_(opaque)_ - -The opacity of the raster symbolizer on top of other symbolizers. -* * * - -##### raster-filter-factor `float` - - - -Default Value: -1 -_(Allow the datasource to choose appropriate downscaling.)_ - -This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. -* * * - -##### raster-scaling `keyword` -`near``fast``bilinear``bicubic``spline16``spline36``hanning``hamming``hermite``kaiser``quadric``catrom``gaussian``bessel``mitchell``sinc``lanczos``blackman` - - -Default Value: near - - -The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. -* * * - -##### raster-mesh-size `unsigned` - - - -Default Value: 16 -_(Reprojection mesh will be 1/16 of the resolution of the source image)_ - -A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. -* * * - -##### raster-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### raster-colorizer-default-mode `keyword` -`discrete``linear``exact` - - -Default Value: linear -_(A linear interpolation is used to generate colors between the two nearest stops.)_ - -This can be either `discrete`, `linear` or `exact`. If it is not specified then the default is `linear`. -* * * - -##### raster-colorizer-default-color `color` - - - -Default Value: transparent -_(Pixels that are not colored by the colorizer stops will be transparent)_ - -This can be any color. Sets the color that is applied to all values outside of the range of the colorizer-stops. If not supplied pixels will be fully transparent -* * * - -##### raster-colorizer-epsilon `float` - - - -Default Value: 1.1920928955078125e-07 -_(Pixels must very closely match the stop filter otherwise they will not be colored.)_ - -This can be any positive floating point value and will be used as a tolerance in floating point comparisions. The higher the value the more likely a stop will match and color data. -* * * - -##### raster-colorizer-stops `tags` - - - -Default Value: -_(No colorization will happen without supplying stops.)_ - -Assigns raster data values to colors. Stops must be listed in ascending order, and contain at a minimum the value and the associated color. You can also include the color-mode as a third argument, like `stop(100,#fff,exact)`. -* * * - - -## point - -##### point-file `uri` - - - -Default Value: none - - -Image file to represent a point. Accepted formats: SVG, PNG, JPG. -* * * - -##### point-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow points to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping points are shown or hidden. -* * * - -##### point-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache)_ - -Control whether the placement of the feature will prevent the placement of other features. -* * * - -##### point-opacity `float` - - - -Default Value: 1 -_(Fully opaque)_ - -A value from 0 to 1 to control the opacity of the point. -* * * - -##### point-placement `keyword` -`centroid``interior` - - -Default Value: centroid - - -Control how this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. -* * * - -##### point-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation)_ - -SVG transformation definition. -* * * - -##### point-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## text - -##### text-name `string` - - - -Default Value: - - -Value to use for a text label. Data columns are specified using brackets like [column_name] -* * * - -##### text-face-name `string` - - - -Default Value: - - -Font name and style to render a label in -* * * - -##### text-size `float` - - - -Default Value: 10 - - -Text size in pixels -* * * - -##### text-ratio `unsigned` - - - -Default Value: 0 - - -Define the amount of text (of the total) present on successive lines when wrapping occurs -* * * - -##### text-wrap-width `unsigned` - - - -Default Value: 0 - - -Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. -* * * - -##### text-wrap-before `boolean` - - - -Default Value: false - - -Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width. -* * * - -##### text-wrap-character `string` - - - -Default Value: " " - - -Use this character instead of a space to wrap long text. -* * * - -##### text-spacing `unsigned` - - - -Default Value: 0 - - -Distance between repeated text labels on a line (aka. label-spacing). -* * * - -##### text-character-spacing `float` - - - -Default Value: 0 - - -Horizontal spacing adjustment between characters in pixels. -* * * - -##### text-line-spacing `unsigned` - - - -Default Value: 0 - - -Vertical spacing adjustment between lines in pixels. -* * * - -##### text-label-position-tolerance `float` - - - -Default Value: 0 - - -Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line). -* * * - -##### text-max-char-angle-delta `float` - - - -Default Value: 22.5 - - -The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. -* * * - -##### text-fill `color` - - - -Default Value: #000000 - - -Specifies the color for the text -* * * - -##### text-opacity `float` - - - -Default Value: 1 -_(Fully opaque)_ - -A number from 0 to 1 specifying the opacity for the text -* * * - -##### text-halo-fill `color` - - - -Default Value: #FFFFFF -_(white)_ - -Specifies the color of the halo around the text. -* * * - -##### text-halo-radius `float` - - - -Default Value: 0 -_(no halo)_ - -Specify the radius of the halo in pixels -* * * - -##### text-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full - - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### text-dx `float` - - - -Default Value: 0 - - -Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right. -* * * - -##### text-dy `float` - - - -Default Value: 0 - - -Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text up. -* * * - -##### text-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: auto -_(Default affected by value of dy; "top" for dy>0, "bottom" for dy<0.)_ - -Position of label relative to point position. -* * * - -##### text-avoid-edges `boolean` - - - -Default Value: false - - -Avoid placing labels that intersect with tile boundaries. -* * * - -##### text-min-distance `float` - - - -Default Value: 0 - - -Minimum permitted distance to the next text symbolizer. -* * * - -##### text-min-padding `float` - - - -Default Value: 0 - - -Minimum distance a text label will be placed from the edge of a metatile. This option is similiar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the metatile. -* * * - -##### text-min-path-length `float` - - - -Default Value: 0 -_(place labels on all paths)_ - -Place labels only on paths longer than this value. -* * * - -##### text-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow text to overlap with other text - overlapping markers will not be shown.)_ - -Control whether overlapping text is shown or hidden. -* * * - -##### text-orientation `float` - - - -Default Value: 0 - - -Rotate the text. -* * * - -##### text-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point - - -Control the style of placement of a point versus the geometry it is attached to. -* * * - -##### text-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy - - -Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. -* * * - -##### text-placements `string` - - - -Default Value: - - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `text-placements: "E,NE,SE,W,NW,SW";` -* * * - -##### text-transform `keyword` -`none``uppercase``lowercase``capitalize` - - -Default Value: none - - -Transform the case of the characters. -* * * - -##### text-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: auto - - -The text's horizontal alignment from its centerpoint. -* * * - -##### text-align `keyword` -`left``right``center``auto` - - -Default Value: auto -_(Auto alignment means that text will be centered by default except when using the `placement-type` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the `text-placements` directives.)_ - -Define how text is justified -* * * - -##### text-clip `boolean` - - - -Default Value: true -_(geometry will be clipped to map bounds before rendering)_ - -Geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. -* * * - -##### text-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(add the current symbolizer on top of other symbolizer)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## building - -##### building-fill `color` - - - -Default Value: #FFFFFF - - -The color of the buildings walls. -* * * - -##### building-fill-opacity `float` - - - -Default Value: 1 - - -The opacity of the building as a whole, including all walls. -* * * - -##### building-height `float` - - - -Default Value: 0 - - -The height of the building in pixels. -* * * - - -## debug - -##### debug-mode `string` - - - -Default Value: collision - - -The mode for debug rendering. -* * * - - - - -### Values - -Below is a list of values and an explanation of any expression that can be applied to properties in CartCSS. - -### Color - -CartoCSS accepts a variety of syntaxes for colors - HTML-style hex values, rgb, rgba, hsl, hsla, husl, and husla. It also supports the predefined HTML colors names, like `yellow` and `blue`. - -``` css -#line { -line-color: #ff0; -line-color: #ffff00; -line-color: rgb(255, 255, 0); -line-color: rgba(255, 255, 0, 1); -line-color: hsl(100, 50%, 50%); -line-color: hsla(100, 50%, 50%, 1); -line-color: husl(100, 50%, 50%); // same values yield different color than HSL -line-color: husla(100, 50%, 50%, 1); -line-color: yellow; -} -``` - -Especially of note is the support for hsl and husl, which can be [easier to reason about than rgb()](http://mothereffinghsl.com/). Carto also includes several color operation functions [borrowed from less](http://lesscss.org/functions/#color-operations): - -``` css -// lighten and darken colors -lighten(#ace, 10%); -darken(#ace, 10%); - -// saturate and desaturate -saturate(#550000, 10%); -desaturate(#00ff00, 10%); - -// increase or decrease the opacity of a color -fadein(#fafafa, 10%); -fadeout(#fefefe, 14%); - -// spin rotates a color around the color wheel by degrees -spin(#ff00ff, 10); - -// mix generates a color in between two other colors. -mix(#fff, #000, 50%); - -// get color components -hue(#ff00ff); -saturation(#ff00ff); -lightness(#ff00ff); -alpha(hsla(100, 50%, 50%, 0.5)); -``` - -These functions all take arguments which can be color variables, literal colors, or the results of other functions operating on colors. All the above mentioned functions also come in -a `functionp`-variant (e.g. `lightenp`), which force a given color into perceptual color space. - -### Float - -Float is a fancy way of saying 'number'. In CartoCSS, you specify _just a number_ - unlike CSS, there are no units, but everything is specified in pixels. - -``` css -#line { -line-width: 2; -} -``` - -It's also possible to do simple math with number values: - -``` css -#line { -line-width: 4 / 2; // division -line-width: 4 + 2; // addition -line-width: 4 - 2; // subtraction -line-width: 4 * 2; // multiplication -line-width: 4 % 2; // modulus -} -``` - -### URI - -URI is a fancy way of saying URL. When an argument is a URI, you use the same kind of `url('place.png')` notation that you would with HTML. Quotes around the URL aren't required, but are highly recommended. URIs can be paths to places on your computer, or on the internet. - -```css -#markers { -marker-file: url('marker.png'); -} -``` - -### String - -A string is basically just text. In the case of CartoCSS, you're going to put it in quotes. Strings can be anything, though pay attention to the cases of `text-name` and `shield-name` - they actually will refer to features, which you refer to by putting them in brackets, as seen in the example below. - -```css -#labels { -text-name: "[MY_FIELD]"; -} -``` - -### Boolean - -Boolean means yes or no, so it accepts the values `true` or `false`. - -```css -#markers { -marker-allow-overlap:true; -} -``` - -### Expressions - -Expressions are statements that can include fields, numbers, and other types in a really flexible way. You have run into expressions before, in the realm of 'fields', where you'd specify `"[FIELD]"`, but expressions allow you to drop the quotes and also do quick addition, division, multiplication, and concatenation from within Carto syntax. - -```css -#buildings { -building-height: [HEIGHT_FIELD] * 10; -} -``` - -### Numbers -Numbers are comma-separated lists of one or more number in a specific order. They're used in line dash arrays, in which the numbers specify intervals of line, break, and line again. - -```css -#disputedboundary { -line-dasharray: 1, 4, 2; -} -``` - -### Percentages -In Carto, the percentage symbol, `%` universally means `value/100`. It's meant to be used with ratio-related properties, like opacity rules. - -_You should not use percentages as widths, heights, or other properties - unlike CSS, percentages are not relative to cascaded classes or page size, they're, as stated, simply the value divided by one hundred._ - -```css -#world { -// this syntax -polygon-opacity: 50%; - -// is equivalent to -polygon-opacity: 0.5; -} -``` - -### Functions - -Functions are comma-separated lists of one or more functions. For instance, transforms use the `functions` type to allow for transforms within Carto, which are optionally chainable. - -```css -#point { -point-transform: scale(2, 2); -} -``` diff --git a/docs/3.0.0.md b/docs/3.0.0.md deleted file mode 100644 index 5079f76..0000000 --- a/docs/3.0.0.md +++ /dev/null @@ -1,2226 +0,0 @@ -# Carto documentation - -The following is a list of properties provided in CartoCSS that you can apply to map elements. - -## All elements - -##### image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``colorize-alpha``color-to-alpha``scale-hsla` - -Default Value: none -_(no filters.)_ - -A list of image filters that will be applied to the active rendering canvas for a given style. The presence of one more `image-filters` will trigger a new canvas to be created before starting to render a style and then this canvas will be composited back into the main canvas after rendering all features and after all `image-filters` have been applied. See `direct-image-filters` if you want to apply a filter directly to the main canvas. -* * * - -##### image-filters-inflate `boolean` - - - -Default Value: false -_(No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary.)_ - -A property that can be set to true to enable using an inflated image internally for seamless blurring across tiles (requires buffered data). -* * * - -##### direct-image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``colorize-alpha``color-to-alpha``scale-hsla` - -Default Value: none -_(no filters.)_ - -A list of image filters to apply to the main canvas (see the `image-filters` doc for how they work on a separate canvas). -* * * - -##### comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current layer on top of other layers.)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - -##### opacity `float` - - - -Default Value: 1 -_(No separate buffer will be used and no alpha will be applied to the style after rendering.)_ - -An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer). -* * * - - -## map - -##### background-color `color` - - - -Default Value: none -_(Will be rendered transparent.)_ - -Map Background color. -* * * - -##### background-image `uri` - - - -Default Value: -_(No background image will be used.)_ - -An image that is repeated below all features on a map as a background. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### background-image-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(The background-image will be blended with the background normally (placed on top of any existing background-color).)_ - -Set the compositing operation used to blend the image into the background. -* * * - -##### background-image-opacity `float` - - - -Default Value: 1 -_(The image opacity will not be changed when applied to the map background.)_ - -Set the opacity of the image. -* * * - -##### srs `string` - - - -Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs -_(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space.)_ - -Map spatial reference (proj4 string). -* * * - -##### buffer-size `float` - - - -Default Value: 0 -_(No buffer will be used.)_ - -Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". -* * * - -##### maximum-extent `string` - - - -Default Value: -20037508.34,-20037508.34,20037508.34,20037508.34 -_(All data will be clipped to global mercator extent (default is applied in Carto.js).)_ - -An extent to be used to limit the bounds used to query all layers during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Map. -* * * - -##### base `string` - - - -Default Value: -_(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)_ - -Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. -* * * - -##### font-directory `uri` - - - -Default Value: none -_(No map-specific fonts will be registered.)_ - -Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). -* * * - - -## polygon - -##### polygon-fill `color` - - - -Default Value: The color gray will be used for fill. -_(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)_ - -Fill color to assign to a polygon. -* * * - -##### polygon-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the polygon. -* * * - -##### polygon-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of polygon edges. -* * * - -##### polygon-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. -* * * - -##### polygon-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extend outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### polygon-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify geometries by the given tolerance. -* * * - -##### polygon-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify geometries by the given algorithm. -* * * - -##### polygon-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform polygon geometry with specified function. -* * * - -##### polygon-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line - -##### line-color `color` - - - -Default Value: black -_(black and fully opaque (alpha = 1), same as rgb(0,0,0) or rgba(0,0,0,1).)_ - -The color of a drawn line. -* * * - -##### line-width `float` - - - -Default Value: 1 -_(The line will be rendered 1 pixel wide.)_ - -The width of a line in pixels. -* * * - -##### line-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of a line. -* * * - -##### line-join `keyword` -`miter``miter-revert``round``bevel` - - -Default Value: miter -_(The line joins will be rendered using a miter look.)_ - -The behavior of lines when joining. -* * * - -##### line-cap `keyword` -`butt``round``square` - - -Default Value: butt -_(The line endings will be rendered using a butt look.)_ - -The display of line endings. -* * * - -##### line-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of stroke line. -* * * - -##### line-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. -* * * - -##### line-dasharray `numbers` - - - -Default Value: none -_(The line will be drawn without dashes.)_ - -A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. -* * * - -##### line-dash-offset `numbers` - - - -Default Value: none -_(The line will be drawn without dashes.)_ - -Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled). -* * * - -##### line-miterlimit `float` - - - -Default Value: 4 -_(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )'.)_ - -The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. -* * * - -##### line-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### line-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify geometries by the given tolerance. -* * * - -##### line-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify geometries by the given algorithm. -* * * - -##### line-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-offset `float` - - - -Default Value: 0 -_(Will not be offset.)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The line will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. -* * * - -##### line-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform line geometry with specified function. -* * * - -##### line-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## markers - -##### marker-file `uri` - - - -Default Value: none -_(An ellipse or circle, if width equals height.)_ - -A file that this marker shows at each placement. If no file is given, the marker will show an ellipse. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### marker-opacity `float` - - - -Default Value: 1 -_(The stroke-opacity and fill-opacity of the marker.)_ - -The overall opacity of the marker, if set, overrides both the opacity of both the fill and stroke. -* * * - -##### marker-fill-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The fill opacity of the marker. -* * * - -##### marker-line-color `color` - - - -Default Value: black -_(The marker will be drawn with a black outline.)_ - -The color of the stroke around the marker. -* * * - -##### marker-line-width `float` - - - -Default Value: 0.5 -_(The marker will be drawn with an outline of .5 pixels wide.)_ - -The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. -* * * - -##### marker-line-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of a line. -* * * - -##### marker-placement `keyword` -`point``line``interior``vertex-first``vertex-last` - - -Default Value: point -_(Place markers at the center point (centroid) of the geometry.)_ - -Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior. The 'vertex-first' and 'vertex-last' options can be used to place markers at the first or last vertex of lines or polygons. -* * * - -##### marker-multi-policy `keyword` -`each``whole``largest` - - -Default Value: each -_(If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each.)_ - -A special setting to allow the user to control rendering behavior for 'multi-geometries' (when a feature contains multiple geometries). This setting does not apply to markers placed along lines. The 'each' policy is default and means all geometries will get a marker. The 'whole' policy means that the aggregate centroid between all geometries will be used. The 'largest' policy means that only the largest (by bounding box areas) feature will get a rendered marker (this is how text labeling behaves by default). -* * * - -##### marker-type `keyword` -`arrow``ellipse` - - -Default Value: ellipse -_(The marker shape is an ellipse.)_ - -The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width). -* * * - -##### marker-width `float` - - - -Default Value: 10 -_(The marker width is 10 pixels.)_ - -The width of the marker, if using one of the default types. -* * * - -##### marker-height `float` - - - -Default Value: 10 -_(The marker height is 10 pixels.)_ - -The height of the marker, if using one of the default types. -* * * - -##### marker-fill `color` - - - -Default Value: blue -_(The marker fill color is blue.)_ - -The color of the area of the marker. -* * * - -##### marker-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow markers to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping markers are shown or hidden. -* * * - -##### marker-avoid-edges `boolean` - - - -Default Value: false -_(Markers will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)_ - -Avoid placing markers that intersect with tile boundaries. -* * * - -##### marker-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache.)_ - -Value to control whether the placement of the feature will prevent the placement of other features. -* * * - -##### marker-spacing `float` - - - -Default Value: 100 -_(In the case of marker-placement:line then draw a marker every 100 pixels along a line.)_ - -Space between repeated markers in pixels. If the spacing is less than the marker size or larger than the line segment length then no marker will be placed. Any value less than 1 will be ignored and the default will be used instead. -* * * - -##### marker-max-error `float` - - - -Default Value: 0.2 -_(N/A: not intended to be changed.)_ - -N/A: not intended to be changed. -* * * - -##### marker-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform marker instance with specified function. Ignores map scale factor. -* * * - -##### marker-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### marker-simplify `float` - - - -Default Value: 0 -_(Geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### marker-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### marker-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### marker-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform marker geometry with specified function. -* * * - -##### marker-offset `float` - - - -Default Value: 0 -_(Will not be offset.)_ - -Offsets a marker from a line a number of pixels parallel to its actual path. Positive values move the marker left, negative values move it right (relative to the directionality of the line). -* * * - -##### marker-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### marker-direction `keyword` -`auto``auto-down``left``right``left-only``right-only``up``down` - - -Default Value: right -_(Markers are oriented to the right in the line direction.)_ - -How markers should be placed along lines. With the "auto" setting when marker is upside down the marker is automatically rotated by 180 degrees to keep it upright. The "auto-down" value places marker in the opposite orientation to "auto". The "left" or "right" settings can be used to force marker to always be placed along a line in a given direction and therefore disables rotating if marker appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down markers rather than trying to flip it. The "up" and "down" settings don't adjust marker's orientation to the line direction. -* * * - - -## shield - -##### shield-name `string` - - - -Default Value: -_(No text label will be rendered with the shield.)_ - -Value to use for a shield"s text label. Data columns are specified using brackets like [column_name]. -* * * - -##### shield-file `uri` - - - -Default Value: none - - -Image file to render behind the shield text. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### shield-face-name `string` - - - -Default Value: none - - -Font name and style to use for the shield text. -* * * - -##### shield-unlock-image `boolean` - - - -Default Value: false -_(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)_ - -This parameter should be set to true if you are trying to position text beside rather than on top of the shield image. -* * * - -##### shield-size `float` - - - -Default Value: 10 -_(Font size of 10 will be used to render text.)_ - -The size of the shield text in pixels. -* * * - -##### shield-fill `color` - - - -Default Value: black -_(The shield text will be rendered black.)_ - -The color of the shield text. -* * * - -##### shield-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point -_(One shield will be placed per geometry.)_ - -How this shield should be placed. Point placement places one shield on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. -* * * - -##### shield-avoid-edges `boolean` - - - -Default Value: false -_(Shields will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)_ - -Avoid placing shields that intersect with tile boundaries. -* * * - -##### shield-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow shields to overlap with other map elements already placed.)_ - -Control whether overlapping shields are shown or hidden. -* * * - -##### shield-margin `float` - - - -Default Value: 0 -_(No extra margin will be used to determine if a shield collides with any other text, shield, or marker.)_ - -Minimum distance that a shield can be placed from any other text, shield, or marker. -* * * - -##### shield-repeat-distance `float` - - - -Default Value: 0 -_(Shields with the same text will be rendered without restriction.)_ - -Minimum distance between repeated shields. If set this will prevent shields being rendered nearby each other that contain the same text. Similiar to shield-min-distance with the difference that it works the same no matter what placement strategy is used. -* * * - -##### shield-min-distance `float` - - - -Default Value: 0 -_(Shields with the same text will be rendered without restriction.)_ - -Minimum distance to the next shield with the same text. Only works for line placement. -* * * - -##### shield-spacing `float` - - - -Default Value: 0 -_(Only one shield per line will attempt to be placed.)_ - -Distance the renderer should use to try to place repeated shields on a line. -* * * - -##### shield-min-padding `float` - - - -Default Value: 0 -_(No margin will be used to detect if a shield is nearby a tile boundary.)_ - -Minimum distance a shield will be placed from the edge of a tile. This option is similiar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. -* * * - -##### shield-label-position-tolerance `float` - - - -Default Value: shield-spacing/2.0 -_(If a shield cannot be placed then the renderer will advance by shield-spacing/2.0 to try placement again.)_ - -Allows the shield to be displaced from its ideal position by a number of pixels (only works with placement:line). -* * * - -##### shield-wrap-width `unsigned` - - - -Default Value: 0 -_(Text will not be wrapped.)_ - -Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. -* * * - -##### shield-wrap-before `boolean` - - - -Default Value: false -_(Wrapped lines will be a bit longer than wrap-width.)_ - -Wrap text before wrap-width is reached. -* * * - -##### shield-wrap-character `string` - - - -Default Value: " " -_(Lines will be wrapped when whitespace is encountered.)_ - -Use this character instead of a space to wrap long names. -* * * - -##### shield-halo-fill `color` - - - -Default Value: white -_(The shield halo text will be rendered white.)_ - -Specifies the color of the halo around the text. -* * * - -##### shield-halo-radius `float` - - - -Default Value: 0 -_(no halo.)_ - -Specify the radius of the halo in pixels. -* * * - -##### shield-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The shield will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### shield-halo-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation.)_ - -Transform shield halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. -* * * - -##### shield-halo-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### shield-halo-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text halo. -* * * - -##### shield-character-spacing `unsigned` - - - -Default Value: 0 -_(The default character spacing of the font will be used.)_ - -Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. -* * * - -##### shield-line-spacing `unsigned` - - - -Default Value: 0 -_(The default font spacing will be used.)_ - -Vertical spacing between lines of multiline labels (in pixels). -* * * - -##### shield-text-dx `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right. -* * * - -##### shield-text-dy `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down. -* * * - -##### shield-dx `float` - - - -Default Value: 0 -_(Shield will not be displaced.)_ - -Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right. -* * * - -##### shield-dy `float` - - - -Default Value: 0 -_(Shield will not be displaced.)_ - -Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down. -* * * - -##### shield-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the image used for the shield. -* * * - -##### shield-text-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the text placed on top of the shield. -* * * - -##### shield-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: auto -_(TODO.)_ - -The shield's horizontal alignment from its centerpoint. -* * * - -##### shield-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: middle -_(TODO.)_ - -The shield's vertical alignment from its centerpoint. -* * * - -##### shield-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy -_(Alternative placements will not be enabled.)_ - -Re-position and/or re-size shield to avoid overlaps. "simple" for basic algorithm (using shield-placements string,) "dummy" to turn this feature off. -* * * - -##### shield-placements `string` - - - -Default Value: -_(No alternative placements will be used.)_ - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `shield-placements: "E,NE,SE,W,NW,SW";`. -* * * - -##### shield-text-transform `keyword` -`none``uppercase``lowercase``capitalize``reverse` - - -Default Value: none -_(No text transformation will be applied.)_ - -Transform the case of the characters. -* * * - -##### shield-justify-alignment `keyword` -`left``center``right``auto` - - -Default Value: auto -_(TODO.)_ - -Define how text in a shield's label is justified. -* * * - -##### shield-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform shield instance with specified function. Ignores map scale factor. -* * * - -##### shield-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### shield-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify the geometries used for shield placement by the given tolerance. -* * * - -##### shield-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify the geometries used for shield placement by the given algorithm. -* * * - -##### shield-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out the angles of the geometry used for shield placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### shield-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line-pattern - -##### line-pattern-file `uri` - - - -Default Value: none - - -An image file to be repeated and warped along a line. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### line-pattern-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### line-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications.)_ - -Apply an opacity level to the image used for the pattern. -* * * - -##### line-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### line-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### line-pattern-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-pattern-offset `float` - - - -Default Value: 0 -_(The line will not be offset.)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform line geometry with specified function and apply pattern to transformed geometry. -* * * - -##### line-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## polygon-pattern - -##### polygon-pattern-file `uri` - - - -Default Value: none - - -Image to use as a repeated pattern fill within a polygon. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### polygon-pattern-alignment `keyword` -`global``local` - - -Default Value: global -_(Patterns will be aligned to the map (or tile boundaries) when being repeated across polygons. This is ideal for seamless patterns in tiled rendering.)_ - -Specify whether to align pattern fills to the layer's geometry (local) or to the map (global). -* * * - -##### polygon-pattern-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of polygon pattern edges. -* * * - -##### polygon-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications.)_ - -Apply an opacity level to the image used for the pattern. -* * * - -##### polygon-pattern-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### polygon-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### polygon-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### polygon-pattern-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform polygon geometry with specified function and apply pattern to transformed geometry. -* * * - -##### polygon-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## raster - -##### raster-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the raster symbolizer on top of other symbolizers. -* * * - -##### raster-filter-factor `float` - - - -Default Value: -1 -_(Allow the datasource to choose appropriate downscaling.)_ - -This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. -* * * - -##### raster-scaling `keyword` -`near``fast``bilinear``bicubic``spline16``spline36``hanning``hamming``hermite``kaiser``quadric``catrom``gaussian``bessel``mitchell``sinc``lanczos``blackman` - - -Default Value: near -_(Nearest neighboor resampling will be used to scale the image to the target size of the map.)_ - -The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. -* * * - -##### raster-mesh-size `unsigned` - - - -Default Value: 16 -_(Reprojection mesh will be 1/16 of the resolution of the source image.)_ - -A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. -* * * - -##### raster-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### raster-colorizer-default-mode `keyword` -`discrete``linear``exact` - - -Default Value: linear -_(A linear interpolation is used to generate colors between the two nearest stops.)_ - -This can be either `discrete`, `linear` or `exact`. If it is not specified then the default is `linear`. -* * * - -##### raster-colorizer-default-color `color` - - - -Default Value: transparent -_(Pixels that are not colored by the colorizer stops will be transparent.)_ - -This can be any color. Sets the color that is applied to all values outside of the range of the colorizer-stops. If not supplied pixels will be fully transparent. -* * * - -##### raster-colorizer-epsilon `float` - - - -Default Value: 1.1920928955078125e-07 -_(Pixels must very closely match the stop filter otherwise they will not be colored.)_ - -This can be any positive floating point value and will be used as a tolerance in floating point comparisions. The higher the value the more likely a stop will match and color data. -* * * - -##### raster-colorizer-stops `tags` - - - -Default Value: -_(No colorization will happen without supplying stops.)_ - -Assigns raster data values to colors. Stops must be listed in ascending order, and contain at a minimum the value and the associated color. You can also include the color-mode as a third argument, like `stop(100,#fff,exact)`. -* * * - - -## point - -##### point-file `uri` - - - -Default Value: none -_(A 4x4 black square will be rendered.)_ - -Image file to represent a point. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### point-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow points to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping points are shown or hidden. -* * * - -##### point-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache.)_ - -Control whether the placement of the feature will prevent the placement of other features. -* * * - -##### point-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A value from 0 to 1 to control the opacity of the point. -* * * - -##### point-placement `keyword` -`centroid``interior` - - -Default Value: centroid -_(The centroid of the geometry will be used to place the point.)_ - -Control how this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. -* * * - -##### point-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform point instance with specified function. Ignores map scale factor. -* * * - -##### point-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## text - -##### text-name `string` - - - -Default Value: none - - -Value to use for a text label. Data columns are specified using brackets like [column_name]. -* * * - -##### text-face-name `string` - - - -Default Value: none - - -Font name and style to render a label in. -* * * - -##### text-size `float` - - - -Default Value: 10 -_(Font size of 10 will be used to render text.)_ - -Text size in pixels. -* * * - -##### text-ratio `unsigned` - - - -Default Value: 0 -_(TODO.)_ - -Define the amount of text (of the total) present on successive lines when wrapping occurs. -* * * - -##### text-wrap-width `unsigned` - - - -Default Value: 0 -_(Text will not be wrapped.)_ - -Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. -* * * - -##### text-wrap-before `boolean` - - - -Default Value: false -_(Wrapped lines will be a bit longer than wrap-width.)_ - -Wrap text before wrap-width is reached. -* * * - -##### text-wrap-character `string` - - - -Default Value: " " -_(Lines will be wrapped when whitespace is encountered.)_ - -Use this character instead of a space to wrap long text. -* * * - -##### text-repeat-wrap-character `boolean` - - - -Default Value: false -_(Character will be removed when used to wrap a line.)_ - -Keep the character used to wrap a line instead of removing it, and repeat it on the new line. -* * * - -##### text-spacing `unsigned` - - - -Default Value: 0 -_(Only one label per line will attempt to be placed.)_ - -Distance the renderer should use to try to place repeated text labels on a line. -* * * - -##### text-character-spacing `float` - - - -Default Value: 0 -_(The default character spacing of the font will be used.)_ - -Horizontal spacing adjustment between characters in pixels. This value is ignored when `horizontal-alignment` is set to `adjust`. Typographic ligatures are turned off when this value is greater than zero. -* * * - -##### text-line-spacing `unsigned` - - - -Default Value: 0 -_(The default font spacing will be used.)_ - -Vertical spacing adjustment between lines in pixels. -* * * - -##### text-label-position-tolerance `float` - - - -Default Value: text-spacing/2.0 -_(If a shield cannot be placed then the renderer will advance by text-spacing/2.0 to try placement again.)_ - -Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line). -* * * - -##### text-max-char-angle-delta `float` - - - -Default Value: 22.5 -_(The label will not be placed if a character falls on a line with an angle sharper than 22.5 degrees.)_ - -The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. -* * * - -##### text-fill `color` - - - -Default Value: black -_(The text will be rendered black.)_ - -Specifies the color for the text. -* * * - -##### text-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text. -* * * - -##### text-halo-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text halo. -* * * - -##### text-halo-fill `color` - - - -Default Value: white -_(The halo will be rendered white.)_ - -Specifies the color of the halo around the text. -* * * - -##### text-halo-radius `float` - - - -Default Value: 0 -_(no halo.)_ - -Specify the radius of the halo in pixels. -* * * - -##### text-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The text will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### text-halo-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation.)_ - -Transform text halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. -* * * - -##### text-dx `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text by fixed amount, in pixels, +/- along the X axis. With "dummy" placement-type, a positive value displaces to the right. With "simple" placement-type, it is either left, right or unchanged, depending on the placement selected. Any non-zero value implies "horizontal-alignment" changes to "left" by default. Has no effect with 'line' text-placement-type. -* * * - -##### text-dy `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text by fixed amount, in pixels, +/- along the Y axis. With "dummy" placement-type, a positive value displaces downwards. With "simple" placement-type, it is either up, down or unchanged, depending on the placement selected. With "line" placement-type, a positive value displaces above the path. -* * * - -##### text-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: auto -_(Default affected by value of dy; "top" for dy>0, "bottom" for dy<0.)_ - -Position of label relative to point position. -* * * - -##### text-avoid-edges `boolean` - - - -Default Value: false -_(Text will be potentially placed near tile edges and therefore may look cut off unless the same text label is rendered on each adjacent tile.)_ - -Avoid placing labels that intersect with tile boundaries. -* * * - -##### text-margin `float` - - - -Default Value: 0 -_(No extra margin will be used to determine if a label collides with any other text, shield, or marker.)_ - -Minimum distance that a label can be placed from any other text, shield, or marker. -* * * - -##### text-repeat-distance `float` - - - -Default Value: 0 -_(Labels with the same text will be rendered without restriction.)_ - -Minimum distance between repeated text. If set this will prevent text labels being rendered nearby each other that contain the same text. Similiar to text-min-distance with the difference that it works the same no matter what placement strategy is used. -* * * - -##### text-min-distance `float` - - - -Default Value: 0 -_(Labels with the same text will be rendered without restriction.)_ - -Minimum distance to the next label with the same text. Only works for line placement. Deprecated: replaced by `text-repeat-distance` and `text-margin` -* * * - -##### text-min-padding `float` - - - -Default Value: 0 -_(No margin will be used to detect if a text label is nearby a tile boundary.)_ - -Minimum distance a text label will be placed from the edge of a tile. This option is similiar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. -* * * - -##### text-min-path-length `float` - - - -Default Value: 0 -_(place labels on all geometries no matter how small they are.)_ - -Place labels only on polygons and lines with a bounding width longer than this value (in pixels). -* * * - -##### text-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow text to overlap with other text - overlapping markers will not be shown.)_ - -Control whether overlapping text is shown or hidden. -* * * - -##### text-orientation `float` - - - -Default Value: 0 -_(Text is not rotated and is displayed upright.)_ - -Rotate the text. (only works with text-placement:point). -* * * - -##### text-rotate-displacement `boolean` - - - -Default Value: false -_(Label center is used for rotation.)_ - -Rotates the displacement around the placement origin by the angle given by "orientation". -* * * - -##### text-upright `keyword` -`auto``auto-down``left``right``left-only``right-only` - - -Default Value: auto -_(Text will be positioned upright automatically.)_ - -How this label should be placed along lines. By default when more than half of a label's characters are upside down the label is automatically flipped to keep it upright. By changing this parameter you can prevent this "auto-upright" behavior. The "auto-down" value places text in the opposite orientation to "auto". The "left" or "right" settings can be used to force text to always be placed along a line in a given direction and therefore disables flipping if text appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down text rather than trying to flip it. -* * * - -##### text-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point -_(One shield will be placed per geometry.)_ - -How this label should be placed. Point placement places one label on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. -* * * - -##### text-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy -_(Alternative placements will not be enabled.)_ - -Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. -* * * - -##### text-placements `string` - - - -Default Value: -_(No alternative placements will be used.)_ - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `text-placements: "E,NE,SE,W,NW,SW";`. -* * * - -##### text-transform `keyword` -`none``uppercase``lowercase``capitalize``reverse` - - -Default Value: none -_(Transform text instance with specified function. Ignores map scale factor.)_ - -Transform the case of the characters. -* * * - -##### text-horizontal-alignment `keyword` -`left``middle``right``auto``adjust` - - -Default Value: auto -_(TODO.)_ - -The text's horizontal alignment from it's centerpoint. If `placement` is set to `line`, then `adjust` can be set to auto-fit the text to the length of the path by dynamically calculating `character-spacing`. -* * * - -##### text-align `keyword` -`left``right``center``auto` - - -Default Value: auto -_(Auto alignment means that text will be centered by default except when using the `placement-type` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the `text-placements` directives.)_ - -Define how text is justified. -* * * - -##### text-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### text-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify the geometries used for text placement by the given tolerance. -* * * - -##### text-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify the geometries used for text placement by the given algorithm. -* * * - -##### text-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out the angles of the geometry used for text placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### text-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### text-halo-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### text-font-feature-settings `string` - - - -Default Value: -_(Default set of typographic features recommended by OpenType specification. Ligatures are turned off by default when `character-spacing` is greater than zero.)_ - -Comma separated list of OpenType typographic features. The syntax and semantics conforms to `font-feature-settings` from W3C CSS. -* * * - -##### text-largest-bbox-only `boolean` - - - -Default Value: true -_(For multipolygons only polygon with largest bbox area is labeled (does not apply to other geometries).)_ - -Controls default labeling behavior on multipolygons. The default is true and means that only the polygon with largest bbox is labeled. -* * * - - -## building - -##### building-fill `color` - - - -Default Value: The color gray will be used for fill. -_(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)_ - -The color of the buildings fill. Note: 0.8 will be used to multiply each color component to auto-generate a darkened wall color. -* * * - -##### building-fill-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the building as a whole, including all walls. -* * * - -##### building-height `float` - - - -Default Value: 0 -_(Buildings will not have a visual height and will instead look like flat polygons.)_ - -The height of the building in pixels. -* * * - - -## debug - -##### debug-mode `string` - - - -Default Value: collision -_(The otherwise invisible collision boxes will be rendered as squares on the map.)_ - -The mode for debug rendering. -* * * - - -## dot - -##### dot-fill `color` - - - -Default Value: gray -_(The dot fill color is gray.)_ - -The color of the area of the dot. -* * * - -##### dot-opacity `float` - - - -Default Value: 1 -_(The opacity of the dot.)_ - -The overall opacity of the dot. -* * * - -##### dot-width `float` - - - -Default Value: 1 -_(The marker width is 1 pixel.)_ - -The width of the dot in pixels. -* * * - -##### dot-height `float` - - - -Default Value: 1 -_(The marker height is 1 pixels.)_ - -The height of the dot in pixels. -* * * - -##### dot-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current layer on top of other layers.)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - - - - -### Values - -Below is a list of values and an explanation of any expression that can be applied to properties in CartCSS. - -### Color - -CartoCSS accepts a variety of syntaxes for colors - HTML-style hex values, rgb, rgba, hsl, hsla, husl, and husla. It also supports the predefined HTML colors names, like `yellow` and `blue`. - -``` css -#line { -line-color: #ff0; -line-color: #ffff00; -line-color: rgb(255, 255, 0); -line-color: rgba(255, 255, 0, 1); -line-color: hsl(100, 50%, 50%); -line-color: hsla(100, 50%, 50%, 1); -line-color: husl(100, 50%, 50%); // same values yield different color than HSL -line-color: husla(100, 50%, 50%, 1); -line-color: yellow; -} -``` - -Especially of note is the support for hsl and husl, which can be [easier to reason about than rgb()](http://mothereffinghsl.com/). Carto also includes several color operation functions [borrowed from less](http://lesscss.org/functions/#color-operations): - -``` css -// lighten and darken colors -lighten(#ace, 10%); -darken(#ace, 10%); - -// saturate and desaturate -saturate(#550000, 10%); -desaturate(#00ff00, 10%); - -// increase or decrease the opacity of a color -fadein(#fafafa, 10%); -fadeout(#fefefe, 14%); - -// spin rotates a color around the color wheel by degrees -spin(#ff00ff, 10); - -// mix generates a color in between two other colors. -mix(#fff, #000, 50%); - -// get color components -hue(#ff00ff); -saturation(#ff00ff); -lightness(#ff00ff); -alpha(hsla(100, 50%, 50%, 0.5)); -``` - -These functions all take arguments which can be color variables, literal colors, or the results of other functions operating on colors. All the above mentioned functions also come in -a `functionp`-variant (e.g. `lightenp`), which force a given color into perceptual color space. - -### Float - -Float is a fancy way of saying 'number'. In CartoCSS, you specify _just a number_ - unlike CSS, there are no units, but everything is specified in pixels. - -``` css -#line { -line-width: 2; -} -``` - -It's also possible to do simple math with number values: - -``` css -#line { -line-width: 4 / 2; // division -line-width: 4 + 2; // addition -line-width: 4 - 2; // subtraction -line-width: 4 * 2; // multiplication -line-width: 4 % 2; // modulus -} -``` - -### URI - -URI is a fancy way of saying URL. When an argument is a URI, you use the same kind of `url('place.png')` notation that you would with HTML. Quotes around the URL aren't required, but are highly recommended. URIs can be paths to places on your computer, or on the internet. - -```css -#markers { -marker-file: url('marker.png'); -} -``` - -### String - -A string is basically just text. In the case of CartoCSS, you're going to put it in quotes. Strings can be anything, though pay attention to the cases of `text-name` and `shield-name` - they actually will refer to features, which you refer to by putting them in brackets, as seen in the example below. - -```css -#labels { -text-name: "[MY_FIELD]"; -} -``` - -### Boolean - -Boolean means yes or no, so it accepts the values `true` or `false`. - -```css -#markers { -marker-allow-overlap:true; -} -``` - -### Expressions - -Expressions are statements that can include fields, numbers, and other types in a really flexible way. You have run into expressions before, in the realm of 'fields', where you'd specify `"[FIELD]"`, but expressions allow you to drop the quotes and also do quick addition, division, multiplication, and concatenation from within Carto syntax. - -```css -#buildings { -building-height: [HEIGHT_FIELD] * 10; -} -``` - -### Numbers -Numbers are comma-separated lists of one or more number in a specific order. They're used in line dash arrays, in which the numbers specify intervals of line, break, and line again. - -```css -#disputedboundary { -line-dasharray: 1, 4, 2; -} -``` - -### Percentages -In Carto, the percentage symbol, `%` universally means `value/100`. It's meant to be used with ratio-related properties, like opacity rules. - -_You should not use percentages as widths, heights, or other properties - unlike CSS, percentages are not relative to cascaded classes or page size, they're, as stated, simply the value divided by one hundred._ - -```css -#world { -// this syntax -polygon-opacity: 50%; - -// is equivalent to -polygon-opacity: 0.5; -} -``` - -### Functions - -Functions are comma-separated lists of one or more functions. For instance, transforms use the `functions` type to allow for transforms within Carto, which are optionally chainable. - -```css -#point { -point-transform: scale(2, 2); -} -``` diff --git a/docs/3.0.10.md b/docs/3.0.10.md deleted file mode 100644 index ad7ed30..0000000 --- a/docs/3.0.10.md +++ /dev/null @@ -1,2226 +0,0 @@ -# Carto documentation - -The following is a list of properties provided in CartoCSS that you can apply to map elements. - -## All elements - -##### image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``color-blind-protanope``color-blind-deuteranope``color-blind-tritanope``colorize-alpha``color-to-alpha``scale-hsla` - -Default Value: none -_(no filters.)_ - -A list of image filters that will be applied to the active rendering canvas for a given style. The presence of one more `image-filters` will trigger a new canvas to be created before starting to render a style and then this canvas will be composited back into the main canvas after rendering all features and after all `image-filters` have been applied. See `direct-image-filters` if you want to apply a filter directly to the main canvas. -* * * - -##### image-filters-inflate `boolean` - - - -Default Value: false -_(No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary.)_ - -A property that can be set to true to enable using an inflated image internally for seamless blurring across tiles (requires buffered data). -* * * - -##### direct-image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``color-blind-protanope``color-blind-deuteranope``color-blind-tritanope``colorize-alpha``color-to-alpha``scale-hsla` - -Default Value: none -_(no filters.)_ - -A list of image filters to apply to the main canvas (see the `image-filters` doc for how they work on a separate canvas). -* * * - -##### comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current layer on top of other layers.)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - -##### opacity `float` - - - -Default Value: 1 -_(No separate buffer will be used and no alpha will be applied to the style after rendering.)_ - -An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer). -* * * - - -## map - -##### background-color `color` - - - -Default Value: none -_(Will be rendered transparent.)_ - -Map Background color. -* * * - -##### background-image `uri` - - - -Default Value: -_(No background image will be used.)_ - -An image that is repeated below all features on a map as a background. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### background-image-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(The background-image will be blended with the background normally (placed on top of any existing background-color).)_ - -Set the compositing operation used to blend the image into the background. -* * * - -##### background-image-opacity `float` - - - -Default Value: 1 -_(The image opacity will not be changed when applied to the map background.)_ - -Set the opacity of the image. -* * * - -##### srs `string` - - - -Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs -_(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space.)_ - -Map spatial reference (proj4 string). -* * * - -##### buffer-size `float` - - - -Default Value: 0 -_(No buffer will be used.)_ - -Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". -* * * - -##### maximum-extent `string` - - - -Default Value: -20037508.34,-20037508.34,20037508.34,20037508.34 -_(All data will be clipped to global mercator extent (default is applied in Carto.js).)_ - -An extent to be used to limit the bounds used to query all layers during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Map. -* * * - -##### base `string` - - - -Default Value: -_(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)_ - -Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. -* * * - -##### font-directory `uri` - - - -Default Value: none -_(No map-specific fonts will be registered.)_ - -Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). -* * * - - -## polygon - -##### polygon-fill `color` - - - -Default Value: The color gray will be used for fill. -_(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)_ - -Fill color to assign to a polygon. -* * * - -##### polygon-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the polygon. -* * * - -##### polygon-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of polygon edges. -* * * - -##### polygon-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. -* * * - -##### polygon-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extend outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### polygon-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify geometries by the given tolerance. -* * * - -##### polygon-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify geometries by the given algorithm. -* * * - -##### polygon-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform polygon geometry with specified function. -* * * - -##### polygon-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line - -##### line-color `color` - - - -Default Value: black -_(black and fully opaque (alpha = 1), same as rgb(0,0,0) or rgba(0,0,0,1).)_ - -The color of a drawn line. -* * * - -##### line-width `float` - - - -Default Value: 1 -_(The line will be rendered 1 pixel wide.)_ - -The width of a line in pixels. -* * * - -##### line-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of a line. -* * * - -##### line-join `keyword` -`miter``miter-revert``round``bevel` - - -Default Value: miter -_(The line joins will be rendered using a miter look.)_ - -The behavior of lines when joining. -* * * - -##### line-cap `keyword` -`butt``round``square` - - -Default Value: butt -_(The line endings will be rendered using a butt look.)_ - -The display of line endings. -* * * - -##### line-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of stroke line. -* * * - -##### line-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. -* * * - -##### line-dasharray `numbers` - - - -Default Value: none -_(The line will be drawn without dashes.)_ - -A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. -* * * - -##### line-dash-offset `numbers` - - - -Default Value: none -_(The line will be drawn without dashes.)_ - -Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled). -* * * - -##### line-miterlimit `float` - - - -Default Value: 4 -_(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )'.)_ - -The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. -* * * - -##### line-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### line-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify geometries by the given tolerance. -* * * - -##### line-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify geometries by the given algorithm. -* * * - -##### line-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-offset `float` - - - -Default Value: 0 -_(Will not be offset.)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The line will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. -* * * - -##### line-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform line geometry with specified function. -* * * - -##### line-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## markers - -##### marker-file `uri` - - - -Default Value: none -_(An ellipse or circle, if width equals height.)_ - -A file that this marker shows at each placement. If no file is given, the marker will show an ellipse. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### marker-opacity `float` - - - -Default Value: 1 -_(The stroke-opacity and fill-opacity of the marker.)_ - -The overall opacity of the marker, if set, overrides both the opacity of both the fill and stroke. -* * * - -##### marker-fill-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The fill opacity of the marker. -* * * - -##### marker-line-color `color` - - - -Default Value: black -_(The marker will be drawn with a black outline.)_ - -The color of the stroke around the marker. -* * * - -##### marker-line-width `float` - - - -Default Value: 0.5 -_(The marker will be drawn with an outline of .5 pixels wide.)_ - -The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. -* * * - -##### marker-line-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of a line. -* * * - -##### marker-placement `keyword` -`point``line``interior``vertex-first``vertex-last` - - -Default Value: point -_(Place markers at the center point (centroid) of the geometry.)_ - -Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior. The 'vertex-first' and 'vertex-last' options can be used to place markers at the first or last vertex of lines or polygons. -* * * - -##### marker-multi-policy `keyword` -`each``whole``largest` - - -Default Value: each -_(If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each.)_ - -A special setting to allow the user to control rendering behavior for 'multi-geometries' (when a feature contains multiple geometries). This setting does not apply to markers placed along lines. The 'each' policy is default and means all geometries will get a marker. The 'whole' policy means that the aggregate centroid between all geometries will be used. The 'largest' policy means that only the largest (by bounding box areas) feature will get a rendered marker (this is how text labeling behaves by default). -* * * - -##### marker-type `keyword` -`arrow``ellipse` - - -Default Value: ellipse -_(The marker shape is an ellipse.)_ - -The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width). -* * * - -##### marker-width `float` - - - -Default Value: 10 -_(The marker width is 10 pixels.)_ - -The width of the marker, if using one of the default types. -* * * - -##### marker-height `float` - - - -Default Value: 10 -_(The marker height is 10 pixels.)_ - -The height of the marker, if using one of the default types. -* * * - -##### marker-fill `color` - - - -Default Value: blue -_(The marker fill color is blue.)_ - -The color of the area of the marker. -* * * - -##### marker-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow markers to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping markers are shown or hidden. -* * * - -##### marker-avoid-edges `boolean` - - - -Default Value: false -_(Markers will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)_ - -Avoid placing markers that intersect with tile boundaries. -* * * - -##### marker-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache.)_ - -Value to control whether the placement of the feature will prevent the placement of other features. -* * * - -##### marker-spacing `float` - - - -Default Value: 100 -_(In the case of marker-placement:line then draw a marker every 100 pixels along a line.)_ - -Space between repeated markers in pixels. If the spacing is less than the marker size or larger than the line segment length then no marker will be placed. Any value less than 1 will be ignored and the default will be used instead. -* * * - -##### marker-max-error `float` - - - -Default Value: 0.2 -_(N/A: not intended to be changed.)_ - -N/A: not intended to be changed. -* * * - -##### marker-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform marker instance with specified function. Ignores map scale factor. -* * * - -##### marker-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### marker-simplify `float` - - - -Default Value: 0 -_(Geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### marker-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### marker-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### marker-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform marker geometry with specified function. -* * * - -##### marker-offset `float` - - - -Default Value: 0 -_(Will not be offset.)_ - -Offsets a marker from a line a number of pixels parallel to its actual path. Positive values move the marker left, negative values move it right (relative to the directionality of the line). -* * * - -##### marker-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### marker-direction `keyword` -`auto``auto-down``left``right``left-only``right-only``up``down` - - -Default Value: right -_(Markers are oriented to the right in the line direction.)_ - -How markers should be placed along lines. With the "auto" setting when marker is upside down the marker is automatically rotated by 180 degrees to keep it upright. The "auto-down" value places marker in the opposite orientation to "auto". The "left" or "right" settings can be used to force marker to always be placed along a line in a given direction and therefore disables rotating if marker appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down markers rather than trying to flip it. The "up" and "down" settings don't adjust marker's orientation to the line direction. -* * * - - -## shield - -##### shield-name `string` - - - -Default Value: -_(No text label will be rendered with the shield.)_ - -Value to use for a shield"s text label. Data columns are specified using brackets like [column_name]. -* * * - -##### shield-file `uri` - - - -Default Value: none - - -Image file to render behind the shield text. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### shield-face-name `string` - - - -Default Value: none - - -Font name and style to use for the shield text. -* * * - -##### shield-unlock-image `boolean` - - - -Default Value: false -_(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)_ - -This parameter should be set to true if you are trying to position text beside rather than on top of the shield image. -* * * - -##### shield-size `float` - - - -Default Value: 10 -_(Font size of 10 will be used to render text.)_ - -The size of the shield text in pixels. -* * * - -##### shield-fill `color` - - - -Default Value: black -_(The shield text will be rendered black.)_ - -The color of the shield text. -* * * - -##### shield-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point -_(One shield will be placed per geometry.)_ - -How this shield should be placed. Point placement places one shield on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. -* * * - -##### shield-avoid-edges `boolean` - - - -Default Value: false -_(Shields will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)_ - -Avoid placing shields that intersect with tile boundaries. -* * * - -##### shield-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow shields to overlap with other map elements already placed.)_ - -Control whether overlapping shields are shown or hidden. -* * * - -##### shield-margin `float` - - - -Default Value: 0 -_(No extra margin will be used to determine if a shield collides with any other text, shield, or marker.)_ - -Minimum distance that a shield can be placed from any other text, shield, or marker. -* * * - -##### shield-repeat-distance `float` - - - -Default Value: 0 -_(Shields with the same text will be rendered without restriction.)_ - -Minimum distance between repeated shields. If set this will prevent shields being rendered nearby each other that contain the same text. Similiar to shield-min-distance with the difference that it works the same no matter what placement strategy is used. -* * * - -##### shield-min-distance `float` - - - -Default Value: 0 -_(Shields with the same text will be rendered without restriction.)_ - -Minimum distance to the next shield with the same text. Only works for line placement. -* * * - -##### shield-spacing `float` - - - -Default Value: 0 -_(Only one shield per line will attempt to be placed.)_ - -Distance the renderer should use to try to place repeated shields on a line. -* * * - -##### shield-min-padding `float` - - - -Default Value: 0 -_(No margin will be used to detect if a shield is nearby a tile boundary.)_ - -Minimum distance a shield will be placed from the edge of a tile. This option is similiar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. -* * * - -##### shield-label-position-tolerance `float` - - - -Default Value: shield-spacing/2.0 -_(If a shield cannot be placed then the renderer will advance by shield-spacing/2.0 to try placement again.)_ - -Allows the shield to be displaced from its ideal position by a number of pixels (only works with placement:line). -* * * - -##### shield-wrap-width `unsigned` - - - -Default Value: 0 -_(Text will not be wrapped.)_ - -Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. -* * * - -##### shield-wrap-before `boolean` - - - -Default Value: false -_(Wrapped lines will be a bit longer than wrap-width.)_ - -Wrap text before wrap-width is reached. -* * * - -##### shield-wrap-character `string` - - - -Default Value: " " -_(Lines will be wrapped when whitespace is encountered.)_ - -Use this character instead of a space to wrap long names. -* * * - -##### shield-halo-fill `color` - - - -Default Value: white -_(The shield halo text will be rendered white.)_ - -Specifies the color of the halo around the text. -* * * - -##### shield-halo-radius `float` - - - -Default Value: 0 -_(no halo.)_ - -Specify the radius of the halo in pixels. -* * * - -##### shield-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The shield will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### shield-halo-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation.)_ - -Transform shield halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. -* * * - -##### shield-halo-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### shield-halo-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text halo. -* * * - -##### shield-character-spacing `unsigned` - - - -Default Value: 0 -_(The default character spacing of the font will be used.)_ - -Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. -* * * - -##### shield-line-spacing `unsigned` - - - -Default Value: 0 -_(The default font spacing will be used.)_ - -Vertical spacing between lines of multiline labels (in pixels). -* * * - -##### shield-text-dx `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right. -* * * - -##### shield-text-dy `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down. -* * * - -##### shield-dx `float` - - - -Default Value: 0 -_(Shield will not be displaced.)_ - -Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right. -* * * - -##### shield-dy `float` - - - -Default Value: 0 -_(Shield will not be displaced.)_ - -Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down. -* * * - -##### shield-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the image used for the shield. -* * * - -##### shield-text-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the text placed on top of the shield. -* * * - -##### shield-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: auto -_(TODO.)_ - -The shield's horizontal alignment from its centerpoint. -* * * - -##### shield-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: middle -_(TODO.)_ - -The shield's vertical alignment from its centerpoint. -* * * - -##### shield-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy -_(Alternative placements will not be enabled.)_ - -Re-position and/or re-size shield to avoid overlaps. "simple" for basic algorithm (using shield-placements string,) "dummy" to turn this feature off. -* * * - -##### shield-placements `string` - - - -Default Value: -_(No alternative placements will be used.)_ - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `shield-placements: "E,NE,SE,W,NW,SW";`. -* * * - -##### shield-text-transform `keyword` -`none``uppercase``lowercase``capitalize``reverse` - - -Default Value: none -_(No text transformation will be applied.)_ - -Transform the case of the characters. -* * * - -##### shield-justify-alignment `keyword` -`left``center``right``auto` - - -Default Value: auto -_(TODO.)_ - -Define how text in a shield's label is justified. -* * * - -##### shield-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform shield instance with specified function. Ignores map scale factor. -* * * - -##### shield-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### shield-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify the geometries used for shield placement by the given tolerance. -* * * - -##### shield-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify the geometries used for shield placement by the given algorithm. -* * * - -##### shield-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out the angles of the geometry used for shield placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### shield-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line-pattern - -##### line-pattern-file `uri` - - - -Default Value: none - - -An image file to be repeated and warped along a line. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### line-pattern-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### line-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications.)_ - -Apply an opacity level to the image used for the pattern. -* * * - -##### line-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### line-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### line-pattern-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-pattern-offset `float` - - - -Default Value: 0 -_(The line will not be offset.)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform line geometry with specified function and apply pattern to transformed geometry. -* * * - -##### line-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## polygon-pattern - -##### polygon-pattern-file `uri` - - - -Default Value: none - - -Image to use as a repeated pattern fill within a polygon. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### polygon-pattern-alignment `keyword` -`global``local` - - -Default Value: global -_(Patterns will be aligned to the map (or tile boundaries) when being repeated across polygons. This is ideal for seamless patterns in tiled rendering.)_ - -Specify whether to align pattern fills to the layer's geometry (local) or to the map (global). -* * * - -##### polygon-pattern-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of polygon pattern edges. -* * * - -##### polygon-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications.)_ - -Apply an opacity level to the image used for the pattern. -* * * - -##### polygon-pattern-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### polygon-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### polygon-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### polygon-pattern-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform polygon geometry with specified function and apply pattern to transformed geometry. -* * * - -##### polygon-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## raster - -##### raster-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the raster symbolizer on top of other symbolizers. -* * * - -##### raster-filter-factor `float` - - - -Default Value: -1 -_(Allow the datasource to choose appropriate downscaling.)_ - -This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. -* * * - -##### raster-scaling `keyword` -`near``fast``bilinear``bicubic``spline16``spline36``hanning``hamming``hermite``kaiser``quadric``catrom``gaussian``bessel``mitchell``sinc``lanczos``blackman` - - -Default Value: near -_(Nearest neighboor resampling will be used to scale the image to the target size of the map.)_ - -The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. -* * * - -##### raster-mesh-size `unsigned` - - - -Default Value: 16 -_(Reprojection mesh will be 1/16 of the resolution of the source image.)_ - -A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. -* * * - -##### raster-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### raster-colorizer-default-mode `keyword` -`discrete``linear``exact` - - -Default Value: linear -_(A linear interpolation is used to generate colors between the two nearest stops.)_ - -This can be either `discrete`, `linear` or `exact`. If it is not specified then the default is `linear`. -* * * - -##### raster-colorizer-default-color `color` - - - -Default Value: transparent -_(Pixels that are not colored by the colorizer stops will be transparent.)_ - -This can be any color. Sets the color that is applied to all values outside of the range of the colorizer-stops. If not supplied pixels will be fully transparent. -* * * - -##### raster-colorizer-epsilon `float` - - - -Default Value: 1.1920928955078125e-07 -_(Pixels must very closely match the stop filter otherwise they will not be colored.)_ - -This can be any positive floating point value and will be used as a tolerance in floating point comparisions. The higher the value the more likely a stop will match and color data. -* * * - -##### raster-colorizer-stops `tags` - - - -Default Value: -_(No colorization will happen without supplying stops.)_ - -Assigns raster data values to colors. Stops must be listed in ascending order, and contain at a minimum the value and the associated color. You can also include the color-mode as a third argument, like `stop(100,#fff,exact)`. -* * * - - -## point - -##### point-file `uri` - - - -Default Value: none -_(A 4x4 black square will be rendered.)_ - -Image file to represent a point. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### point-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow points to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping points are shown or hidden. -* * * - -##### point-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache.)_ - -Control whether the placement of the feature will prevent the placement of other features. -* * * - -##### point-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A value from 0 to 1 to control the opacity of the point. -* * * - -##### point-placement `keyword` -`centroid``interior` - - -Default Value: centroid -_(The centroid of the geometry will be used to place the point.)_ - -Control how this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. -* * * - -##### point-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform point instance with specified function. Ignores map scale factor. -* * * - -##### point-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## text - -##### text-name `string` - - - -Default Value: none - - -Value to use for a text label. Data columns are specified using brackets like [column_name]. -* * * - -##### text-face-name `string` - - - -Default Value: none - - -Font name and style to render a label in. -* * * - -##### text-size `float` - - - -Default Value: 10 -_(Font size of 10 will be used to render text.)_ - -Text size in pixels. -* * * - -##### text-ratio `unsigned` - - - -Default Value: 0 -_(TODO.)_ - -Define the amount of text (of the total) present on successive lines when wrapping occurs. -* * * - -##### text-wrap-width `unsigned` - - - -Default Value: 0 -_(Text will not be wrapped.)_ - -Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. -* * * - -##### text-wrap-before `boolean` - - - -Default Value: false -_(Wrapped lines will be a bit longer than wrap-width.)_ - -Wrap text before wrap-width is reached. -* * * - -##### text-wrap-character `string` - - - -Default Value: " " -_(Lines will be wrapped when whitespace is encountered.)_ - -Use this character instead of a space to wrap long text. -* * * - -##### text-repeat-wrap-character `boolean` - - - -Default Value: false -_(Character will be removed when used to wrap a line.)_ - -Keep the character used to wrap a line instead of removing it, and repeat it on the new line. -* * * - -##### text-spacing `unsigned` - - - -Default Value: 0 -_(Only one label per line will attempt to be placed.)_ - -Distance the renderer should use to try to place repeated text labels on a line. -* * * - -##### text-character-spacing `float` - - - -Default Value: 0 -_(The default character spacing of the font will be used.)_ - -Horizontal spacing adjustment between characters in pixels. This value is ignored when `horizontal-alignment` is set to `adjust`. Typographic ligatures are turned off when this value is greater than zero. -* * * - -##### text-line-spacing `unsigned` - - - -Default Value: 0 -_(The default font spacing will be used.)_ - -Vertical spacing adjustment between lines in pixels. -* * * - -##### text-label-position-tolerance `float` - - - -Default Value: text-spacing/2.0 -_(If a shield cannot be placed then the renderer will advance by text-spacing/2.0 to try placement again.)_ - -Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line). -* * * - -##### text-max-char-angle-delta `float` - - - -Default Value: 22.5 -_(The label will not be placed if a character falls on a line with an angle sharper than 22.5 degrees.)_ - -The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. -* * * - -##### text-fill `color` - - - -Default Value: black -_(The text will be rendered black.)_ - -Specifies the color for the text. -* * * - -##### text-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text. -* * * - -##### text-halo-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text halo. -* * * - -##### text-halo-fill `color` - - - -Default Value: white -_(The halo will be rendered white.)_ - -Specifies the color of the halo around the text. -* * * - -##### text-halo-radius `float` - - - -Default Value: 0 -_(no halo.)_ - -Specify the radius of the halo in pixels. -* * * - -##### text-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The text will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### text-halo-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation.)_ - -Transform text halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. -* * * - -##### text-dx `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text by fixed amount, in pixels, +/- along the X axis. With "dummy" placement-type, a positive value displaces to the right. With "simple" placement-type, it is either left, right or unchanged, depending on the placement selected. Any non-zero value implies "horizontal-alignment" changes to "left" by default. Has no effect with 'line' text-placement-type. -* * * - -##### text-dy `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text by fixed amount, in pixels, +/- along the Y axis. With "dummy" placement-type, a positive value displaces downwards. With "simple" placement-type, it is either up, down or unchanged, depending on the placement selected. With "line" placement-type, a positive value displaces above the path. -* * * - -##### text-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: auto -_(Default affected by value of dy; "top" for dy>0, "bottom" for dy<0.)_ - -Position of label relative to point position. -* * * - -##### text-avoid-edges `boolean` - - - -Default Value: false -_(Text will be potentially placed near tile edges and therefore may look cut off unless the same text label is rendered on each adjacent tile.)_ - -Avoid placing labels that intersect with tile boundaries. -* * * - -##### text-margin `float` - - - -Default Value: 0 -_(No extra margin will be used to determine if a label collides with any other text, shield, or marker.)_ - -Minimum distance that a label can be placed from any other text, shield, or marker. -* * * - -##### text-repeat-distance `float` - - - -Default Value: 0 -_(Labels with the same text will be rendered without restriction.)_ - -Minimum distance between repeated text. If set this will prevent text labels being rendered nearby each other that contain the same text. Similiar to text-min-distance with the difference that it works the same no matter what placement strategy is used. -* * * - -##### text-min-distance `float` - - - -Default Value: 0 -_(Labels with the same text will be rendered without restriction.)_ - -Minimum distance to the next label with the same text. Only works for line placement. Deprecated: replaced by `text-repeat-distance` and `text-margin` -* * * - -##### text-min-padding `float` - - - -Default Value: 0 -_(No margin will be used to detect if a text label is nearby a tile boundary.)_ - -Minimum distance a text label will be placed from the edge of a tile. This option is similiar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. -* * * - -##### text-min-path-length `float` - - - -Default Value: 0 -_(place labels on all geometries no matter how small they are.)_ - -Place labels only on polygons and lines with a bounding width longer than this value (in pixels). -* * * - -##### text-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow text to overlap with other text - overlapping markers will not be shown.)_ - -Control whether overlapping text is shown or hidden. -* * * - -##### text-orientation `float` - - - -Default Value: 0 -_(Text is not rotated and is displayed upright.)_ - -Rotate the text. (only works with text-placement:point). -* * * - -##### text-rotate-displacement `boolean` - - - -Default Value: false -_(Label center is used for rotation.)_ - -Rotates the displacement around the placement origin by the angle given by "orientation". -* * * - -##### text-upright `keyword` -`auto``auto-down``left``right``left-only``right-only` - - -Default Value: auto -_(Text will be positioned upright automatically.)_ - -How this label should be placed along lines. By default when more than half of a label's characters are upside down the label is automatically flipped to keep it upright. By changing this parameter you can prevent this "auto-upright" behavior. The "auto-down" value places text in the opposite orientation to "auto". The "left" or "right" settings can be used to force text to always be placed along a line in a given direction and therefore disables flipping if text appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down text rather than trying to flip it. -* * * - -##### text-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point -_(One shield will be placed per geometry.)_ - -How this label should be placed. Point placement places one label on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. -* * * - -##### text-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy -_(Alternative placements will not be enabled.)_ - -Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. -* * * - -##### text-placements `string` - - - -Default Value: -_(No alternative placements will be used.)_ - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `text-placements: "E,NE,SE,W,NW,SW";`. -* * * - -##### text-transform `keyword` -`none``uppercase``lowercase``capitalize``reverse` - - -Default Value: none -_(Transform text instance with specified function. Ignores map scale factor.)_ - -Transform the case of the characters. -* * * - -##### text-horizontal-alignment `keyword` -`left``middle``right``auto``adjust` - - -Default Value: auto -_(TODO.)_ - -The text's horizontal alignment from it's centerpoint. If `placement` is set to `line`, then `adjust` can be set to auto-fit the text to the length of the path by dynamically calculating `character-spacing`. -* * * - -##### text-align `keyword` -`left``right``center``auto` - - -Default Value: auto -_(Auto alignment means that text will be centered by default except when using the `placement-type` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the `text-placements` directives.)_ - -Define how text is justified. -* * * - -##### text-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### text-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify the geometries used for text placement by the given tolerance. -* * * - -##### text-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify the geometries used for text placement by the given algorithm. -* * * - -##### text-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out the angles of the geometry used for text placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### text-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### text-halo-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### text-font-feature-settings `string` - - - -Default Value: -_(Default set of typographic features recommended by OpenType specification. Ligatures are turned off by default when `character-spacing` is greater than zero.)_ - -Comma separated list of OpenType typographic features. The syntax and semantics conforms to `font-feature-settings` from W3C CSS. -* * * - -##### text-largest-bbox-only `boolean` - - - -Default Value: true -_(For multipolygons only polygon with largest bbox area is labeled (does not apply to other geometries).)_ - -Controls default labeling behavior on multipolygons. The default is true and means that only the polygon with largest bbox is labeled. -* * * - - -## building - -##### building-fill `color` - - - -Default Value: The color gray will be used for fill. -_(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)_ - -The color of the buildings fill. Note: 0.8 will be used to multiply each color component to auto-generate a darkened wall color. -* * * - -##### building-fill-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the building as a whole, including all walls. -* * * - -##### building-height `float` - - - -Default Value: 0 -_(Buildings will not have a visual height and will instead look like flat polygons.)_ - -The height of the building in pixels. -* * * - - -## debug - -##### debug-mode `string` - - - -Default Value: collision -_(The otherwise invisible collision boxes will be rendered as squares on the map.)_ - -The mode for debug rendering. -* * * - - -## dot - -##### dot-fill `color` - - - -Default Value: gray -_(The dot fill color is gray.)_ - -The color of the area of the dot. -* * * - -##### dot-opacity `float` - - - -Default Value: 1 -_(The opacity of the dot.)_ - -The overall opacity of the dot. -* * * - -##### dot-width `float` - - - -Default Value: 1 -_(The marker width is 1 pixel.)_ - -The width of the dot in pixels. -* * * - -##### dot-height `float` - - - -Default Value: 1 -_(The marker height is 1 pixels.)_ - -The height of the dot in pixels. -* * * - -##### dot-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current layer on top of other layers.)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - - - - -### Values - -Below is a list of values and an explanation of any expression that can be applied to properties in CartCSS. - -### Color - -CartoCSS accepts a variety of syntaxes for colors - HTML-style hex values, rgb, rgba, hsl, hsla, husl, and husla. It also supports the predefined HTML colors names, like `yellow` and `blue`. - -``` css -#line { -line-color: #ff0; -line-color: #ffff00; -line-color: rgb(255, 255, 0); -line-color: rgba(255, 255, 0, 1); -line-color: hsl(100, 50%, 50%); -line-color: hsla(100, 50%, 50%, 1); -line-color: husl(100, 50%, 50%); // same values yield different color than HSL -line-color: husla(100, 50%, 50%, 1); -line-color: yellow; -} -``` - -Especially of note is the support for hsl and husl, which can be [easier to reason about than rgb()](http://mothereffinghsl.com/). Carto also includes several color operation functions [borrowed from less](http://lesscss.org/functions/#color-operations): - -``` css -// lighten and darken colors -lighten(#ace, 10%); -darken(#ace, 10%); - -// saturate and desaturate -saturate(#550000, 10%); -desaturate(#00ff00, 10%); - -// increase or decrease the opacity of a color -fadein(#fafafa, 10%); -fadeout(#fefefe, 14%); - -// spin rotates a color around the color wheel by degrees -spin(#ff00ff, 10); - -// mix generates a color in between two other colors. -mix(#fff, #000, 50%); - -// get color components -hue(#ff00ff); -saturation(#ff00ff); -lightness(#ff00ff); -alpha(hsla(100, 50%, 50%, 0.5)); -``` - -These functions all take arguments which can be color variables, literal colors, or the results of other functions operating on colors. All the above mentioned functions also come in -a `functionp`-variant (e.g. `lightenp`), which force a given color into perceptual color space. - -### Float - -Float is a fancy way of saying 'number'. In CartoCSS, you specify _just a number_ - unlike CSS, there are no units, but everything is specified in pixels. - -``` css -#line { -line-width: 2; -} -``` - -It's also possible to do simple math with number values: - -``` css -#line { -line-width: 4 / 2; // division -line-width: 4 + 2; // addition -line-width: 4 - 2; // subtraction -line-width: 4 * 2; // multiplication -line-width: 4 % 2; // modulus -} -``` - -### URI - -URI is a fancy way of saying URL. When an argument is a URI, you use the same kind of `url('place.png')` notation that you would with HTML. Quotes around the URL aren't required, but are highly recommended. URIs can be paths to places on your computer, or on the internet. - -```css -#markers { -marker-file: url('marker.png'); -} -``` - -### String - -A string is basically just text. In the case of CartoCSS, you're going to put it in quotes. Strings can be anything, though pay attention to the cases of `text-name` and `shield-name` - they actually will refer to features, which you refer to by putting them in brackets, as seen in the example below. - -```css -#labels { -text-name: "[MY_FIELD]"; -} -``` - -### Boolean - -Boolean means yes or no, so it accepts the values `true` or `false`. - -```css -#markers { -marker-allow-overlap:true; -} -``` - -### Expressions - -Expressions are statements that can include fields, numbers, and other types in a really flexible way. You have run into expressions before, in the realm of 'fields', where you'd specify `"[FIELD]"`, but expressions allow you to drop the quotes and also do quick addition, division, multiplication, and concatenation from within Carto syntax. - -```css -#buildings { -building-height: [HEIGHT_FIELD] * 10; -} -``` - -### Numbers -Numbers are comma-separated lists of one or more number in a specific order. They're used in line dash arrays, in which the numbers specify intervals of line, break, and line again. - -```css -#disputedboundary { -line-dasharray: 1, 4, 2; -} -``` - -### Percentages -In Carto, the percentage symbol, `%` universally means `value/100`. It's meant to be used with ratio-related properties, like opacity rules. - -_You should not use percentages as widths, heights, or other properties - unlike CSS, percentages are not relative to cascaded classes or page size, they're, as stated, simply the value divided by one hundred._ - -```css -#world { -// this syntax -polygon-opacity: 50%; - -// is equivalent to -polygon-opacity: 0.5; -} -``` - -### Functions - -Functions are comma-separated lists of one or more functions. For instance, transforms use the `functions` type to allow for transforms within Carto, which are optionally chainable. - -```css -#point { -point-transform: scale(2, 2); -} -``` diff --git a/docs/3.0.3.md b/docs/3.0.3.md deleted file mode 100644 index ad7ed30..0000000 --- a/docs/3.0.3.md +++ /dev/null @@ -1,2226 +0,0 @@ -# Carto documentation - -The following is a list of properties provided in CartoCSS that you can apply to map elements. - -## All elements - -##### image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``color-blind-protanope``color-blind-deuteranope``color-blind-tritanope``colorize-alpha``color-to-alpha``scale-hsla` - -Default Value: none -_(no filters.)_ - -A list of image filters that will be applied to the active rendering canvas for a given style. The presence of one more `image-filters` will trigger a new canvas to be created before starting to render a style and then this canvas will be composited back into the main canvas after rendering all features and after all `image-filters` have been applied. See `direct-image-filters` if you want to apply a filter directly to the main canvas. -* * * - -##### image-filters-inflate `boolean` - - - -Default Value: false -_(No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary.)_ - -A property that can be set to true to enable using an inflated image internally for seamless blurring across tiles (requires buffered data). -* * * - -##### direct-image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``color-blind-protanope``color-blind-deuteranope``color-blind-tritanope``colorize-alpha``color-to-alpha``scale-hsla` - -Default Value: none -_(no filters.)_ - -A list of image filters to apply to the main canvas (see the `image-filters` doc for how they work on a separate canvas). -* * * - -##### comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current layer on top of other layers.)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - -##### opacity `float` - - - -Default Value: 1 -_(No separate buffer will be used and no alpha will be applied to the style after rendering.)_ - -An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer). -* * * - - -## map - -##### background-color `color` - - - -Default Value: none -_(Will be rendered transparent.)_ - -Map Background color. -* * * - -##### background-image `uri` - - - -Default Value: -_(No background image will be used.)_ - -An image that is repeated below all features on a map as a background. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### background-image-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(The background-image will be blended with the background normally (placed on top of any existing background-color).)_ - -Set the compositing operation used to blend the image into the background. -* * * - -##### background-image-opacity `float` - - - -Default Value: 1 -_(The image opacity will not be changed when applied to the map background.)_ - -Set the opacity of the image. -* * * - -##### srs `string` - - - -Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs -_(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space.)_ - -Map spatial reference (proj4 string). -* * * - -##### buffer-size `float` - - - -Default Value: 0 -_(No buffer will be used.)_ - -Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". -* * * - -##### maximum-extent `string` - - - -Default Value: -20037508.34,-20037508.34,20037508.34,20037508.34 -_(All data will be clipped to global mercator extent (default is applied in Carto.js).)_ - -An extent to be used to limit the bounds used to query all layers during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Map. -* * * - -##### base `string` - - - -Default Value: -_(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)_ - -Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. -* * * - -##### font-directory `uri` - - - -Default Value: none -_(No map-specific fonts will be registered.)_ - -Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). -* * * - - -## polygon - -##### polygon-fill `color` - - - -Default Value: The color gray will be used for fill. -_(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)_ - -Fill color to assign to a polygon. -* * * - -##### polygon-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the polygon. -* * * - -##### polygon-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of polygon edges. -* * * - -##### polygon-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. -* * * - -##### polygon-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extend outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### polygon-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify geometries by the given tolerance. -* * * - -##### polygon-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify geometries by the given algorithm. -* * * - -##### polygon-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform polygon geometry with specified function. -* * * - -##### polygon-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line - -##### line-color `color` - - - -Default Value: black -_(black and fully opaque (alpha = 1), same as rgb(0,0,0) or rgba(0,0,0,1).)_ - -The color of a drawn line. -* * * - -##### line-width `float` - - - -Default Value: 1 -_(The line will be rendered 1 pixel wide.)_ - -The width of a line in pixels. -* * * - -##### line-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of a line. -* * * - -##### line-join `keyword` -`miter``miter-revert``round``bevel` - - -Default Value: miter -_(The line joins will be rendered using a miter look.)_ - -The behavior of lines when joining. -* * * - -##### line-cap `keyword` -`butt``round``square` - - -Default Value: butt -_(The line endings will be rendered using a butt look.)_ - -The display of line endings. -* * * - -##### line-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of stroke line. -* * * - -##### line-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. -* * * - -##### line-dasharray `numbers` - - - -Default Value: none -_(The line will be drawn without dashes.)_ - -A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. -* * * - -##### line-dash-offset `numbers` - - - -Default Value: none -_(The line will be drawn without dashes.)_ - -Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled). -* * * - -##### line-miterlimit `float` - - - -Default Value: 4 -_(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )'.)_ - -The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. -* * * - -##### line-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### line-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify geometries by the given tolerance. -* * * - -##### line-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify geometries by the given algorithm. -* * * - -##### line-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-offset `float` - - - -Default Value: 0 -_(Will not be offset.)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The line will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. -* * * - -##### line-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform line geometry with specified function. -* * * - -##### line-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## markers - -##### marker-file `uri` - - - -Default Value: none -_(An ellipse or circle, if width equals height.)_ - -A file that this marker shows at each placement. If no file is given, the marker will show an ellipse. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### marker-opacity `float` - - - -Default Value: 1 -_(The stroke-opacity and fill-opacity of the marker.)_ - -The overall opacity of the marker, if set, overrides both the opacity of both the fill and stroke. -* * * - -##### marker-fill-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The fill opacity of the marker. -* * * - -##### marker-line-color `color` - - - -Default Value: black -_(The marker will be drawn with a black outline.)_ - -The color of the stroke around the marker. -* * * - -##### marker-line-width `float` - - - -Default Value: 0.5 -_(The marker will be drawn with an outline of .5 pixels wide.)_ - -The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. -* * * - -##### marker-line-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of a line. -* * * - -##### marker-placement `keyword` -`point``line``interior``vertex-first``vertex-last` - - -Default Value: point -_(Place markers at the center point (centroid) of the geometry.)_ - -Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior. The 'vertex-first' and 'vertex-last' options can be used to place markers at the first or last vertex of lines or polygons. -* * * - -##### marker-multi-policy `keyword` -`each``whole``largest` - - -Default Value: each -_(If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each.)_ - -A special setting to allow the user to control rendering behavior for 'multi-geometries' (when a feature contains multiple geometries). This setting does not apply to markers placed along lines. The 'each' policy is default and means all geometries will get a marker. The 'whole' policy means that the aggregate centroid between all geometries will be used. The 'largest' policy means that only the largest (by bounding box areas) feature will get a rendered marker (this is how text labeling behaves by default). -* * * - -##### marker-type `keyword` -`arrow``ellipse` - - -Default Value: ellipse -_(The marker shape is an ellipse.)_ - -The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width). -* * * - -##### marker-width `float` - - - -Default Value: 10 -_(The marker width is 10 pixels.)_ - -The width of the marker, if using one of the default types. -* * * - -##### marker-height `float` - - - -Default Value: 10 -_(The marker height is 10 pixels.)_ - -The height of the marker, if using one of the default types. -* * * - -##### marker-fill `color` - - - -Default Value: blue -_(The marker fill color is blue.)_ - -The color of the area of the marker. -* * * - -##### marker-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow markers to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping markers are shown or hidden. -* * * - -##### marker-avoid-edges `boolean` - - - -Default Value: false -_(Markers will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)_ - -Avoid placing markers that intersect with tile boundaries. -* * * - -##### marker-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache.)_ - -Value to control whether the placement of the feature will prevent the placement of other features. -* * * - -##### marker-spacing `float` - - - -Default Value: 100 -_(In the case of marker-placement:line then draw a marker every 100 pixels along a line.)_ - -Space between repeated markers in pixels. If the spacing is less than the marker size or larger than the line segment length then no marker will be placed. Any value less than 1 will be ignored and the default will be used instead. -* * * - -##### marker-max-error `float` - - - -Default Value: 0.2 -_(N/A: not intended to be changed.)_ - -N/A: not intended to be changed. -* * * - -##### marker-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform marker instance with specified function. Ignores map scale factor. -* * * - -##### marker-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### marker-simplify `float` - - - -Default Value: 0 -_(Geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### marker-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### marker-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### marker-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform marker geometry with specified function. -* * * - -##### marker-offset `float` - - - -Default Value: 0 -_(Will not be offset.)_ - -Offsets a marker from a line a number of pixels parallel to its actual path. Positive values move the marker left, negative values move it right (relative to the directionality of the line). -* * * - -##### marker-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### marker-direction `keyword` -`auto``auto-down``left``right``left-only``right-only``up``down` - - -Default Value: right -_(Markers are oriented to the right in the line direction.)_ - -How markers should be placed along lines. With the "auto" setting when marker is upside down the marker is automatically rotated by 180 degrees to keep it upright. The "auto-down" value places marker in the opposite orientation to "auto". The "left" or "right" settings can be used to force marker to always be placed along a line in a given direction and therefore disables rotating if marker appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down markers rather than trying to flip it. The "up" and "down" settings don't adjust marker's orientation to the line direction. -* * * - - -## shield - -##### shield-name `string` - - - -Default Value: -_(No text label will be rendered with the shield.)_ - -Value to use for a shield"s text label. Data columns are specified using brackets like [column_name]. -* * * - -##### shield-file `uri` - - - -Default Value: none - - -Image file to render behind the shield text. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### shield-face-name `string` - - - -Default Value: none - - -Font name and style to use for the shield text. -* * * - -##### shield-unlock-image `boolean` - - - -Default Value: false -_(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)_ - -This parameter should be set to true if you are trying to position text beside rather than on top of the shield image. -* * * - -##### shield-size `float` - - - -Default Value: 10 -_(Font size of 10 will be used to render text.)_ - -The size of the shield text in pixels. -* * * - -##### shield-fill `color` - - - -Default Value: black -_(The shield text will be rendered black.)_ - -The color of the shield text. -* * * - -##### shield-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point -_(One shield will be placed per geometry.)_ - -How this shield should be placed. Point placement places one shield on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. -* * * - -##### shield-avoid-edges `boolean` - - - -Default Value: false -_(Shields will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)_ - -Avoid placing shields that intersect with tile boundaries. -* * * - -##### shield-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow shields to overlap with other map elements already placed.)_ - -Control whether overlapping shields are shown or hidden. -* * * - -##### shield-margin `float` - - - -Default Value: 0 -_(No extra margin will be used to determine if a shield collides with any other text, shield, or marker.)_ - -Minimum distance that a shield can be placed from any other text, shield, or marker. -* * * - -##### shield-repeat-distance `float` - - - -Default Value: 0 -_(Shields with the same text will be rendered without restriction.)_ - -Minimum distance between repeated shields. If set this will prevent shields being rendered nearby each other that contain the same text. Similiar to shield-min-distance with the difference that it works the same no matter what placement strategy is used. -* * * - -##### shield-min-distance `float` - - - -Default Value: 0 -_(Shields with the same text will be rendered without restriction.)_ - -Minimum distance to the next shield with the same text. Only works for line placement. -* * * - -##### shield-spacing `float` - - - -Default Value: 0 -_(Only one shield per line will attempt to be placed.)_ - -Distance the renderer should use to try to place repeated shields on a line. -* * * - -##### shield-min-padding `float` - - - -Default Value: 0 -_(No margin will be used to detect if a shield is nearby a tile boundary.)_ - -Minimum distance a shield will be placed from the edge of a tile. This option is similiar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. -* * * - -##### shield-label-position-tolerance `float` - - - -Default Value: shield-spacing/2.0 -_(If a shield cannot be placed then the renderer will advance by shield-spacing/2.0 to try placement again.)_ - -Allows the shield to be displaced from its ideal position by a number of pixels (only works with placement:line). -* * * - -##### shield-wrap-width `unsigned` - - - -Default Value: 0 -_(Text will not be wrapped.)_ - -Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. -* * * - -##### shield-wrap-before `boolean` - - - -Default Value: false -_(Wrapped lines will be a bit longer than wrap-width.)_ - -Wrap text before wrap-width is reached. -* * * - -##### shield-wrap-character `string` - - - -Default Value: " " -_(Lines will be wrapped when whitespace is encountered.)_ - -Use this character instead of a space to wrap long names. -* * * - -##### shield-halo-fill `color` - - - -Default Value: white -_(The shield halo text will be rendered white.)_ - -Specifies the color of the halo around the text. -* * * - -##### shield-halo-radius `float` - - - -Default Value: 0 -_(no halo.)_ - -Specify the radius of the halo in pixels. -* * * - -##### shield-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The shield will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### shield-halo-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation.)_ - -Transform shield halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. -* * * - -##### shield-halo-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### shield-halo-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text halo. -* * * - -##### shield-character-spacing `unsigned` - - - -Default Value: 0 -_(The default character spacing of the font will be used.)_ - -Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. -* * * - -##### shield-line-spacing `unsigned` - - - -Default Value: 0 -_(The default font spacing will be used.)_ - -Vertical spacing between lines of multiline labels (in pixels). -* * * - -##### shield-text-dx `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right. -* * * - -##### shield-text-dy `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down. -* * * - -##### shield-dx `float` - - - -Default Value: 0 -_(Shield will not be displaced.)_ - -Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right. -* * * - -##### shield-dy `float` - - - -Default Value: 0 -_(Shield will not be displaced.)_ - -Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down. -* * * - -##### shield-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the image used for the shield. -* * * - -##### shield-text-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the text placed on top of the shield. -* * * - -##### shield-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: auto -_(TODO.)_ - -The shield's horizontal alignment from its centerpoint. -* * * - -##### shield-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: middle -_(TODO.)_ - -The shield's vertical alignment from its centerpoint. -* * * - -##### shield-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy -_(Alternative placements will not be enabled.)_ - -Re-position and/or re-size shield to avoid overlaps. "simple" for basic algorithm (using shield-placements string,) "dummy" to turn this feature off. -* * * - -##### shield-placements `string` - - - -Default Value: -_(No alternative placements will be used.)_ - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `shield-placements: "E,NE,SE,W,NW,SW";`. -* * * - -##### shield-text-transform `keyword` -`none``uppercase``lowercase``capitalize``reverse` - - -Default Value: none -_(No text transformation will be applied.)_ - -Transform the case of the characters. -* * * - -##### shield-justify-alignment `keyword` -`left``center``right``auto` - - -Default Value: auto -_(TODO.)_ - -Define how text in a shield's label is justified. -* * * - -##### shield-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform shield instance with specified function. Ignores map scale factor. -* * * - -##### shield-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### shield-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify the geometries used for shield placement by the given tolerance. -* * * - -##### shield-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify the geometries used for shield placement by the given algorithm. -* * * - -##### shield-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out the angles of the geometry used for shield placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### shield-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line-pattern - -##### line-pattern-file `uri` - - - -Default Value: none - - -An image file to be repeated and warped along a line. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### line-pattern-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### line-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications.)_ - -Apply an opacity level to the image used for the pattern. -* * * - -##### line-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### line-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### line-pattern-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-pattern-offset `float` - - - -Default Value: 0 -_(The line will not be offset.)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform line geometry with specified function and apply pattern to transformed geometry. -* * * - -##### line-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## polygon-pattern - -##### polygon-pattern-file `uri` - - - -Default Value: none - - -Image to use as a repeated pattern fill within a polygon. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### polygon-pattern-alignment `keyword` -`global``local` - - -Default Value: global -_(Patterns will be aligned to the map (or tile boundaries) when being repeated across polygons. This is ideal for seamless patterns in tiled rendering.)_ - -Specify whether to align pattern fills to the layer's geometry (local) or to the map (global). -* * * - -##### polygon-pattern-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of polygon pattern edges. -* * * - -##### polygon-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications.)_ - -Apply an opacity level to the image used for the pattern. -* * * - -##### polygon-pattern-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### polygon-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### polygon-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### polygon-pattern-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform polygon geometry with specified function and apply pattern to transformed geometry. -* * * - -##### polygon-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## raster - -##### raster-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the raster symbolizer on top of other symbolizers. -* * * - -##### raster-filter-factor `float` - - - -Default Value: -1 -_(Allow the datasource to choose appropriate downscaling.)_ - -This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. -* * * - -##### raster-scaling `keyword` -`near``fast``bilinear``bicubic``spline16``spline36``hanning``hamming``hermite``kaiser``quadric``catrom``gaussian``bessel``mitchell``sinc``lanczos``blackman` - - -Default Value: near -_(Nearest neighboor resampling will be used to scale the image to the target size of the map.)_ - -The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. -* * * - -##### raster-mesh-size `unsigned` - - - -Default Value: 16 -_(Reprojection mesh will be 1/16 of the resolution of the source image.)_ - -A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. -* * * - -##### raster-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### raster-colorizer-default-mode `keyword` -`discrete``linear``exact` - - -Default Value: linear -_(A linear interpolation is used to generate colors between the two nearest stops.)_ - -This can be either `discrete`, `linear` or `exact`. If it is not specified then the default is `linear`. -* * * - -##### raster-colorizer-default-color `color` - - - -Default Value: transparent -_(Pixels that are not colored by the colorizer stops will be transparent.)_ - -This can be any color. Sets the color that is applied to all values outside of the range of the colorizer-stops. If not supplied pixels will be fully transparent. -* * * - -##### raster-colorizer-epsilon `float` - - - -Default Value: 1.1920928955078125e-07 -_(Pixels must very closely match the stop filter otherwise they will not be colored.)_ - -This can be any positive floating point value and will be used as a tolerance in floating point comparisions. The higher the value the more likely a stop will match and color data. -* * * - -##### raster-colorizer-stops `tags` - - - -Default Value: -_(No colorization will happen without supplying stops.)_ - -Assigns raster data values to colors. Stops must be listed in ascending order, and contain at a minimum the value and the associated color. You can also include the color-mode as a third argument, like `stop(100,#fff,exact)`. -* * * - - -## point - -##### point-file `uri` - - - -Default Value: none -_(A 4x4 black square will be rendered.)_ - -Image file to represent a point. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### point-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow points to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping points are shown or hidden. -* * * - -##### point-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache.)_ - -Control whether the placement of the feature will prevent the placement of other features. -* * * - -##### point-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A value from 0 to 1 to control the opacity of the point. -* * * - -##### point-placement `keyword` -`centroid``interior` - - -Default Value: centroid -_(The centroid of the geometry will be used to place the point.)_ - -Control how this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. -* * * - -##### point-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform point instance with specified function. Ignores map scale factor. -* * * - -##### point-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## text - -##### text-name `string` - - - -Default Value: none - - -Value to use for a text label. Data columns are specified using brackets like [column_name]. -* * * - -##### text-face-name `string` - - - -Default Value: none - - -Font name and style to render a label in. -* * * - -##### text-size `float` - - - -Default Value: 10 -_(Font size of 10 will be used to render text.)_ - -Text size in pixels. -* * * - -##### text-ratio `unsigned` - - - -Default Value: 0 -_(TODO.)_ - -Define the amount of text (of the total) present on successive lines when wrapping occurs. -* * * - -##### text-wrap-width `unsigned` - - - -Default Value: 0 -_(Text will not be wrapped.)_ - -Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. -* * * - -##### text-wrap-before `boolean` - - - -Default Value: false -_(Wrapped lines will be a bit longer than wrap-width.)_ - -Wrap text before wrap-width is reached. -* * * - -##### text-wrap-character `string` - - - -Default Value: " " -_(Lines will be wrapped when whitespace is encountered.)_ - -Use this character instead of a space to wrap long text. -* * * - -##### text-repeat-wrap-character `boolean` - - - -Default Value: false -_(Character will be removed when used to wrap a line.)_ - -Keep the character used to wrap a line instead of removing it, and repeat it on the new line. -* * * - -##### text-spacing `unsigned` - - - -Default Value: 0 -_(Only one label per line will attempt to be placed.)_ - -Distance the renderer should use to try to place repeated text labels on a line. -* * * - -##### text-character-spacing `float` - - - -Default Value: 0 -_(The default character spacing of the font will be used.)_ - -Horizontal spacing adjustment between characters in pixels. This value is ignored when `horizontal-alignment` is set to `adjust`. Typographic ligatures are turned off when this value is greater than zero. -* * * - -##### text-line-spacing `unsigned` - - - -Default Value: 0 -_(The default font spacing will be used.)_ - -Vertical spacing adjustment between lines in pixels. -* * * - -##### text-label-position-tolerance `float` - - - -Default Value: text-spacing/2.0 -_(If a shield cannot be placed then the renderer will advance by text-spacing/2.0 to try placement again.)_ - -Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line). -* * * - -##### text-max-char-angle-delta `float` - - - -Default Value: 22.5 -_(The label will not be placed if a character falls on a line with an angle sharper than 22.5 degrees.)_ - -The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. -* * * - -##### text-fill `color` - - - -Default Value: black -_(The text will be rendered black.)_ - -Specifies the color for the text. -* * * - -##### text-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text. -* * * - -##### text-halo-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text halo. -* * * - -##### text-halo-fill `color` - - - -Default Value: white -_(The halo will be rendered white.)_ - -Specifies the color of the halo around the text. -* * * - -##### text-halo-radius `float` - - - -Default Value: 0 -_(no halo.)_ - -Specify the radius of the halo in pixels. -* * * - -##### text-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The text will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### text-halo-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation.)_ - -Transform text halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. -* * * - -##### text-dx `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text by fixed amount, in pixels, +/- along the X axis. With "dummy" placement-type, a positive value displaces to the right. With "simple" placement-type, it is either left, right or unchanged, depending on the placement selected. Any non-zero value implies "horizontal-alignment" changes to "left" by default. Has no effect with 'line' text-placement-type. -* * * - -##### text-dy `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text by fixed amount, in pixels, +/- along the Y axis. With "dummy" placement-type, a positive value displaces downwards. With "simple" placement-type, it is either up, down or unchanged, depending on the placement selected. With "line" placement-type, a positive value displaces above the path. -* * * - -##### text-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: auto -_(Default affected by value of dy; "top" for dy>0, "bottom" for dy<0.)_ - -Position of label relative to point position. -* * * - -##### text-avoid-edges `boolean` - - - -Default Value: false -_(Text will be potentially placed near tile edges and therefore may look cut off unless the same text label is rendered on each adjacent tile.)_ - -Avoid placing labels that intersect with tile boundaries. -* * * - -##### text-margin `float` - - - -Default Value: 0 -_(No extra margin will be used to determine if a label collides with any other text, shield, or marker.)_ - -Minimum distance that a label can be placed from any other text, shield, or marker. -* * * - -##### text-repeat-distance `float` - - - -Default Value: 0 -_(Labels with the same text will be rendered without restriction.)_ - -Minimum distance between repeated text. If set this will prevent text labels being rendered nearby each other that contain the same text. Similiar to text-min-distance with the difference that it works the same no matter what placement strategy is used. -* * * - -##### text-min-distance `float` - - - -Default Value: 0 -_(Labels with the same text will be rendered without restriction.)_ - -Minimum distance to the next label with the same text. Only works for line placement. Deprecated: replaced by `text-repeat-distance` and `text-margin` -* * * - -##### text-min-padding `float` - - - -Default Value: 0 -_(No margin will be used to detect if a text label is nearby a tile boundary.)_ - -Minimum distance a text label will be placed from the edge of a tile. This option is similiar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. -* * * - -##### text-min-path-length `float` - - - -Default Value: 0 -_(place labels on all geometries no matter how small they are.)_ - -Place labels only on polygons and lines with a bounding width longer than this value (in pixels). -* * * - -##### text-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow text to overlap with other text - overlapping markers will not be shown.)_ - -Control whether overlapping text is shown or hidden. -* * * - -##### text-orientation `float` - - - -Default Value: 0 -_(Text is not rotated and is displayed upright.)_ - -Rotate the text. (only works with text-placement:point). -* * * - -##### text-rotate-displacement `boolean` - - - -Default Value: false -_(Label center is used for rotation.)_ - -Rotates the displacement around the placement origin by the angle given by "orientation". -* * * - -##### text-upright `keyword` -`auto``auto-down``left``right``left-only``right-only` - - -Default Value: auto -_(Text will be positioned upright automatically.)_ - -How this label should be placed along lines. By default when more than half of a label's characters are upside down the label is automatically flipped to keep it upright. By changing this parameter you can prevent this "auto-upright" behavior. The "auto-down" value places text in the opposite orientation to "auto". The "left" or "right" settings can be used to force text to always be placed along a line in a given direction and therefore disables flipping if text appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down text rather than trying to flip it. -* * * - -##### text-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point -_(One shield will be placed per geometry.)_ - -How this label should be placed. Point placement places one label on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. -* * * - -##### text-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy -_(Alternative placements will not be enabled.)_ - -Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. -* * * - -##### text-placements `string` - - - -Default Value: -_(No alternative placements will be used.)_ - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `text-placements: "E,NE,SE,W,NW,SW";`. -* * * - -##### text-transform `keyword` -`none``uppercase``lowercase``capitalize``reverse` - - -Default Value: none -_(Transform text instance with specified function. Ignores map scale factor.)_ - -Transform the case of the characters. -* * * - -##### text-horizontal-alignment `keyword` -`left``middle``right``auto``adjust` - - -Default Value: auto -_(TODO.)_ - -The text's horizontal alignment from it's centerpoint. If `placement` is set to `line`, then `adjust` can be set to auto-fit the text to the length of the path by dynamically calculating `character-spacing`. -* * * - -##### text-align `keyword` -`left``right``center``auto` - - -Default Value: auto -_(Auto alignment means that text will be centered by default except when using the `placement-type` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the `text-placements` directives.)_ - -Define how text is justified. -* * * - -##### text-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### text-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify the geometries used for text placement by the given tolerance. -* * * - -##### text-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify the geometries used for text placement by the given algorithm. -* * * - -##### text-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out the angles of the geometry used for text placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### text-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### text-halo-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### text-font-feature-settings `string` - - - -Default Value: -_(Default set of typographic features recommended by OpenType specification. Ligatures are turned off by default when `character-spacing` is greater than zero.)_ - -Comma separated list of OpenType typographic features. The syntax and semantics conforms to `font-feature-settings` from W3C CSS. -* * * - -##### text-largest-bbox-only `boolean` - - - -Default Value: true -_(For multipolygons only polygon with largest bbox area is labeled (does not apply to other geometries).)_ - -Controls default labeling behavior on multipolygons. The default is true and means that only the polygon with largest bbox is labeled. -* * * - - -## building - -##### building-fill `color` - - - -Default Value: The color gray will be used for fill. -_(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)_ - -The color of the buildings fill. Note: 0.8 will be used to multiply each color component to auto-generate a darkened wall color. -* * * - -##### building-fill-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the building as a whole, including all walls. -* * * - -##### building-height `float` - - - -Default Value: 0 -_(Buildings will not have a visual height and will instead look like flat polygons.)_ - -The height of the building in pixels. -* * * - - -## debug - -##### debug-mode `string` - - - -Default Value: collision -_(The otherwise invisible collision boxes will be rendered as squares on the map.)_ - -The mode for debug rendering. -* * * - - -## dot - -##### dot-fill `color` - - - -Default Value: gray -_(The dot fill color is gray.)_ - -The color of the area of the dot. -* * * - -##### dot-opacity `float` - - - -Default Value: 1 -_(The opacity of the dot.)_ - -The overall opacity of the dot. -* * * - -##### dot-width `float` - - - -Default Value: 1 -_(The marker width is 1 pixel.)_ - -The width of the dot in pixels. -* * * - -##### dot-height `float` - - - -Default Value: 1 -_(The marker height is 1 pixels.)_ - -The height of the dot in pixels. -* * * - -##### dot-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current layer on top of other layers.)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - - - - -### Values - -Below is a list of values and an explanation of any expression that can be applied to properties in CartCSS. - -### Color - -CartoCSS accepts a variety of syntaxes for colors - HTML-style hex values, rgb, rgba, hsl, hsla, husl, and husla. It also supports the predefined HTML colors names, like `yellow` and `blue`. - -``` css -#line { -line-color: #ff0; -line-color: #ffff00; -line-color: rgb(255, 255, 0); -line-color: rgba(255, 255, 0, 1); -line-color: hsl(100, 50%, 50%); -line-color: hsla(100, 50%, 50%, 1); -line-color: husl(100, 50%, 50%); // same values yield different color than HSL -line-color: husla(100, 50%, 50%, 1); -line-color: yellow; -} -``` - -Especially of note is the support for hsl and husl, which can be [easier to reason about than rgb()](http://mothereffinghsl.com/). Carto also includes several color operation functions [borrowed from less](http://lesscss.org/functions/#color-operations): - -``` css -// lighten and darken colors -lighten(#ace, 10%); -darken(#ace, 10%); - -// saturate and desaturate -saturate(#550000, 10%); -desaturate(#00ff00, 10%); - -// increase or decrease the opacity of a color -fadein(#fafafa, 10%); -fadeout(#fefefe, 14%); - -// spin rotates a color around the color wheel by degrees -spin(#ff00ff, 10); - -// mix generates a color in between two other colors. -mix(#fff, #000, 50%); - -// get color components -hue(#ff00ff); -saturation(#ff00ff); -lightness(#ff00ff); -alpha(hsla(100, 50%, 50%, 0.5)); -``` - -These functions all take arguments which can be color variables, literal colors, or the results of other functions operating on colors. All the above mentioned functions also come in -a `functionp`-variant (e.g. `lightenp`), which force a given color into perceptual color space. - -### Float - -Float is a fancy way of saying 'number'. In CartoCSS, you specify _just a number_ - unlike CSS, there are no units, but everything is specified in pixels. - -``` css -#line { -line-width: 2; -} -``` - -It's also possible to do simple math with number values: - -``` css -#line { -line-width: 4 / 2; // division -line-width: 4 + 2; // addition -line-width: 4 - 2; // subtraction -line-width: 4 * 2; // multiplication -line-width: 4 % 2; // modulus -} -``` - -### URI - -URI is a fancy way of saying URL. When an argument is a URI, you use the same kind of `url('place.png')` notation that you would with HTML. Quotes around the URL aren't required, but are highly recommended. URIs can be paths to places on your computer, or on the internet. - -```css -#markers { -marker-file: url('marker.png'); -} -``` - -### String - -A string is basically just text. In the case of CartoCSS, you're going to put it in quotes. Strings can be anything, though pay attention to the cases of `text-name` and `shield-name` - they actually will refer to features, which you refer to by putting them in brackets, as seen in the example below. - -```css -#labels { -text-name: "[MY_FIELD]"; -} -``` - -### Boolean - -Boolean means yes or no, so it accepts the values `true` or `false`. - -```css -#markers { -marker-allow-overlap:true; -} -``` - -### Expressions - -Expressions are statements that can include fields, numbers, and other types in a really flexible way. You have run into expressions before, in the realm of 'fields', where you'd specify `"[FIELD]"`, but expressions allow you to drop the quotes and also do quick addition, division, multiplication, and concatenation from within Carto syntax. - -```css -#buildings { -building-height: [HEIGHT_FIELD] * 10; -} -``` - -### Numbers -Numbers are comma-separated lists of one or more number in a specific order. They're used in line dash arrays, in which the numbers specify intervals of line, break, and line again. - -```css -#disputedboundary { -line-dasharray: 1, 4, 2; -} -``` - -### Percentages -In Carto, the percentage symbol, `%` universally means `value/100`. It's meant to be used with ratio-related properties, like opacity rules. - -_You should not use percentages as widths, heights, or other properties - unlike CSS, percentages are not relative to cascaded classes or page size, they're, as stated, simply the value divided by one hundred._ - -```css -#world { -// this syntax -polygon-opacity: 50%; - -// is equivalent to -polygon-opacity: 0.5; -} -``` - -### Functions - -Functions are comma-separated lists of one or more functions. For instance, transforms use the `functions` type to allow for transforms within Carto, which are optionally chainable. - -```css -#point { -point-transform: scale(2, 2); -} -``` diff --git a/docs/3.0.4.md b/docs/3.0.4.md deleted file mode 100644 index ad7ed30..0000000 --- a/docs/3.0.4.md +++ /dev/null @@ -1,2226 +0,0 @@ -# Carto documentation - -The following is a list of properties provided in CartoCSS that you can apply to map elements. - -## All elements - -##### image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``color-blind-protanope``color-blind-deuteranope``color-blind-tritanope``colorize-alpha``color-to-alpha``scale-hsla` - -Default Value: none -_(no filters.)_ - -A list of image filters that will be applied to the active rendering canvas for a given style. The presence of one more `image-filters` will trigger a new canvas to be created before starting to render a style and then this canvas will be composited back into the main canvas after rendering all features and after all `image-filters` have been applied. See `direct-image-filters` if you want to apply a filter directly to the main canvas. -* * * - -##### image-filters-inflate `boolean` - - - -Default Value: false -_(No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary.)_ - -A property that can be set to true to enable using an inflated image internally for seamless blurring across tiles (requires buffered data). -* * * - -##### direct-image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``color-blind-protanope``color-blind-deuteranope``color-blind-tritanope``colorize-alpha``color-to-alpha``scale-hsla` - -Default Value: none -_(no filters.)_ - -A list of image filters to apply to the main canvas (see the `image-filters` doc for how they work on a separate canvas). -* * * - -##### comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current layer on top of other layers.)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - -##### opacity `float` - - - -Default Value: 1 -_(No separate buffer will be used and no alpha will be applied to the style after rendering.)_ - -An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer). -* * * - - -## map - -##### background-color `color` - - - -Default Value: none -_(Will be rendered transparent.)_ - -Map Background color. -* * * - -##### background-image `uri` - - - -Default Value: -_(No background image will be used.)_ - -An image that is repeated below all features on a map as a background. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### background-image-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(The background-image will be blended with the background normally (placed on top of any existing background-color).)_ - -Set the compositing operation used to blend the image into the background. -* * * - -##### background-image-opacity `float` - - - -Default Value: 1 -_(The image opacity will not be changed when applied to the map background.)_ - -Set the opacity of the image. -* * * - -##### srs `string` - - - -Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs -_(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space.)_ - -Map spatial reference (proj4 string). -* * * - -##### buffer-size `float` - - - -Default Value: 0 -_(No buffer will be used.)_ - -Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". -* * * - -##### maximum-extent `string` - - - -Default Value: -20037508.34,-20037508.34,20037508.34,20037508.34 -_(All data will be clipped to global mercator extent (default is applied in Carto.js).)_ - -An extent to be used to limit the bounds used to query all layers during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Map. -* * * - -##### base `string` - - - -Default Value: -_(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)_ - -Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. -* * * - -##### font-directory `uri` - - - -Default Value: none -_(No map-specific fonts will be registered.)_ - -Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). -* * * - - -## polygon - -##### polygon-fill `color` - - - -Default Value: The color gray will be used for fill. -_(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)_ - -Fill color to assign to a polygon. -* * * - -##### polygon-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the polygon. -* * * - -##### polygon-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of polygon edges. -* * * - -##### polygon-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. -* * * - -##### polygon-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extend outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### polygon-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify geometries by the given tolerance. -* * * - -##### polygon-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify geometries by the given algorithm. -* * * - -##### polygon-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform polygon geometry with specified function. -* * * - -##### polygon-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line - -##### line-color `color` - - - -Default Value: black -_(black and fully opaque (alpha = 1), same as rgb(0,0,0) or rgba(0,0,0,1).)_ - -The color of a drawn line. -* * * - -##### line-width `float` - - - -Default Value: 1 -_(The line will be rendered 1 pixel wide.)_ - -The width of a line in pixels. -* * * - -##### line-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of a line. -* * * - -##### line-join `keyword` -`miter``miter-revert``round``bevel` - - -Default Value: miter -_(The line joins will be rendered using a miter look.)_ - -The behavior of lines when joining. -* * * - -##### line-cap `keyword` -`butt``round``square` - - -Default Value: butt -_(The line endings will be rendered using a butt look.)_ - -The display of line endings. -* * * - -##### line-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of stroke line. -* * * - -##### line-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. -* * * - -##### line-dasharray `numbers` - - - -Default Value: none -_(The line will be drawn without dashes.)_ - -A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. -* * * - -##### line-dash-offset `numbers` - - - -Default Value: none -_(The line will be drawn without dashes.)_ - -Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled). -* * * - -##### line-miterlimit `float` - - - -Default Value: 4 -_(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )'.)_ - -The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. -* * * - -##### line-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### line-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify geometries by the given tolerance. -* * * - -##### line-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify geometries by the given algorithm. -* * * - -##### line-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-offset `float` - - - -Default Value: 0 -_(Will not be offset.)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The line will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. -* * * - -##### line-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform line geometry with specified function. -* * * - -##### line-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## markers - -##### marker-file `uri` - - - -Default Value: none -_(An ellipse or circle, if width equals height.)_ - -A file that this marker shows at each placement. If no file is given, the marker will show an ellipse. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### marker-opacity `float` - - - -Default Value: 1 -_(The stroke-opacity and fill-opacity of the marker.)_ - -The overall opacity of the marker, if set, overrides both the opacity of both the fill and stroke. -* * * - -##### marker-fill-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The fill opacity of the marker. -* * * - -##### marker-line-color `color` - - - -Default Value: black -_(The marker will be drawn with a black outline.)_ - -The color of the stroke around the marker. -* * * - -##### marker-line-width `float` - - - -Default Value: 0.5 -_(The marker will be drawn with an outline of .5 pixels wide.)_ - -The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. -* * * - -##### marker-line-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of a line. -* * * - -##### marker-placement `keyword` -`point``line``interior``vertex-first``vertex-last` - - -Default Value: point -_(Place markers at the center point (centroid) of the geometry.)_ - -Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior. The 'vertex-first' and 'vertex-last' options can be used to place markers at the first or last vertex of lines or polygons. -* * * - -##### marker-multi-policy `keyword` -`each``whole``largest` - - -Default Value: each -_(If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each.)_ - -A special setting to allow the user to control rendering behavior for 'multi-geometries' (when a feature contains multiple geometries). This setting does not apply to markers placed along lines. The 'each' policy is default and means all geometries will get a marker. The 'whole' policy means that the aggregate centroid between all geometries will be used. The 'largest' policy means that only the largest (by bounding box areas) feature will get a rendered marker (this is how text labeling behaves by default). -* * * - -##### marker-type `keyword` -`arrow``ellipse` - - -Default Value: ellipse -_(The marker shape is an ellipse.)_ - -The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width). -* * * - -##### marker-width `float` - - - -Default Value: 10 -_(The marker width is 10 pixels.)_ - -The width of the marker, if using one of the default types. -* * * - -##### marker-height `float` - - - -Default Value: 10 -_(The marker height is 10 pixels.)_ - -The height of the marker, if using one of the default types. -* * * - -##### marker-fill `color` - - - -Default Value: blue -_(The marker fill color is blue.)_ - -The color of the area of the marker. -* * * - -##### marker-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow markers to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping markers are shown or hidden. -* * * - -##### marker-avoid-edges `boolean` - - - -Default Value: false -_(Markers will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)_ - -Avoid placing markers that intersect with tile boundaries. -* * * - -##### marker-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache.)_ - -Value to control whether the placement of the feature will prevent the placement of other features. -* * * - -##### marker-spacing `float` - - - -Default Value: 100 -_(In the case of marker-placement:line then draw a marker every 100 pixels along a line.)_ - -Space between repeated markers in pixels. If the spacing is less than the marker size or larger than the line segment length then no marker will be placed. Any value less than 1 will be ignored and the default will be used instead. -* * * - -##### marker-max-error `float` - - - -Default Value: 0.2 -_(N/A: not intended to be changed.)_ - -N/A: not intended to be changed. -* * * - -##### marker-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform marker instance with specified function. Ignores map scale factor. -* * * - -##### marker-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### marker-simplify `float` - - - -Default Value: 0 -_(Geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### marker-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### marker-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### marker-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform marker geometry with specified function. -* * * - -##### marker-offset `float` - - - -Default Value: 0 -_(Will not be offset.)_ - -Offsets a marker from a line a number of pixels parallel to its actual path. Positive values move the marker left, negative values move it right (relative to the directionality of the line). -* * * - -##### marker-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### marker-direction `keyword` -`auto``auto-down``left``right``left-only``right-only``up``down` - - -Default Value: right -_(Markers are oriented to the right in the line direction.)_ - -How markers should be placed along lines. With the "auto" setting when marker is upside down the marker is automatically rotated by 180 degrees to keep it upright. The "auto-down" value places marker in the opposite orientation to "auto". The "left" or "right" settings can be used to force marker to always be placed along a line in a given direction and therefore disables rotating if marker appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down markers rather than trying to flip it. The "up" and "down" settings don't adjust marker's orientation to the line direction. -* * * - - -## shield - -##### shield-name `string` - - - -Default Value: -_(No text label will be rendered with the shield.)_ - -Value to use for a shield"s text label. Data columns are specified using brackets like [column_name]. -* * * - -##### shield-file `uri` - - - -Default Value: none - - -Image file to render behind the shield text. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### shield-face-name `string` - - - -Default Value: none - - -Font name and style to use for the shield text. -* * * - -##### shield-unlock-image `boolean` - - - -Default Value: false -_(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)_ - -This parameter should be set to true if you are trying to position text beside rather than on top of the shield image. -* * * - -##### shield-size `float` - - - -Default Value: 10 -_(Font size of 10 will be used to render text.)_ - -The size of the shield text in pixels. -* * * - -##### shield-fill `color` - - - -Default Value: black -_(The shield text will be rendered black.)_ - -The color of the shield text. -* * * - -##### shield-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point -_(One shield will be placed per geometry.)_ - -How this shield should be placed. Point placement places one shield on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. -* * * - -##### shield-avoid-edges `boolean` - - - -Default Value: false -_(Shields will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)_ - -Avoid placing shields that intersect with tile boundaries. -* * * - -##### shield-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow shields to overlap with other map elements already placed.)_ - -Control whether overlapping shields are shown or hidden. -* * * - -##### shield-margin `float` - - - -Default Value: 0 -_(No extra margin will be used to determine if a shield collides with any other text, shield, or marker.)_ - -Minimum distance that a shield can be placed from any other text, shield, or marker. -* * * - -##### shield-repeat-distance `float` - - - -Default Value: 0 -_(Shields with the same text will be rendered without restriction.)_ - -Minimum distance between repeated shields. If set this will prevent shields being rendered nearby each other that contain the same text. Similiar to shield-min-distance with the difference that it works the same no matter what placement strategy is used. -* * * - -##### shield-min-distance `float` - - - -Default Value: 0 -_(Shields with the same text will be rendered without restriction.)_ - -Minimum distance to the next shield with the same text. Only works for line placement. -* * * - -##### shield-spacing `float` - - - -Default Value: 0 -_(Only one shield per line will attempt to be placed.)_ - -Distance the renderer should use to try to place repeated shields on a line. -* * * - -##### shield-min-padding `float` - - - -Default Value: 0 -_(No margin will be used to detect if a shield is nearby a tile boundary.)_ - -Minimum distance a shield will be placed from the edge of a tile. This option is similiar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. -* * * - -##### shield-label-position-tolerance `float` - - - -Default Value: shield-spacing/2.0 -_(If a shield cannot be placed then the renderer will advance by shield-spacing/2.0 to try placement again.)_ - -Allows the shield to be displaced from its ideal position by a number of pixels (only works with placement:line). -* * * - -##### shield-wrap-width `unsigned` - - - -Default Value: 0 -_(Text will not be wrapped.)_ - -Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. -* * * - -##### shield-wrap-before `boolean` - - - -Default Value: false -_(Wrapped lines will be a bit longer than wrap-width.)_ - -Wrap text before wrap-width is reached. -* * * - -##### shield-wrap-character `string` - - - -Default Value: " " -_(Lines will be wrapped when whitespace is encountered.)_ - -Use this character instead of a space to wrap long names. -* * * - -##### shield-halo-fill `color` - - - -Default Value: white -_(The shield halo text will be rendered white.)_ - -Specifies the color of the halo around the text. -* * * - -##### shield-halo-radius `float` - - - -Default Value: 0 -_(no halo.)_ - -Specify the radius of the halo in pixels. -* * * - -##### shield-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The shield will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### shield-halo-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation.)_ - -Transform shield halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. -* * * - -##### shield-halo-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### shield-halo-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text halo. -* * * - -##### shield-character-spacing `unsigned` - - - -Default Value: 0 -_(The default character spacing of the font will be used.)_ - -Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. -* * * - -##### shield-line-spacing `unsigned` - - - -Default Value: 0 -_(The default font spacing will be used.)_ - -Vertical spacing between lines of multiline labels (in pixels). -* * * - -##### shield-text-dx `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right. -* * * - -##### shield-text-dy `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down. -* * * - -##### shield-dx `float` - - - -Default Value: 0 -_(Shield will not be displaced.)_ - -Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right. -* * * - -##### shield-dy `float` - - - -Default Value: 0 -_(Shield will not be displaced.)_ - -Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down. -* * * - -##### shield-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the image used for the shield. -* * * - -##### shield-text-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the text placed on top of the shield. -* * * - -##### shield-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: auto -_(TODO.)_ - -The shield's horizontal alignment from its centerpoint. -* * * - -##### shield-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: middle -_(TODO.)_ - -The shield's vertical alignment from its centerpoint. -* * * - -##### shield-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy -_(Alternative placements will not be enabled.)_ - -Re-position and/or re-size shield to avoid overlaps. "simple" for basic algorithm (using shield-placements string,) "dummy" to turn this feature off. -* * * - -##### shield-placements `string` - - - -Default Value: -_(No alternative placements will be used.)_ - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `shield-placements: "E,NE,SE,W,NW,SW";`. -* * * - -##### shield-text-transform `keyword` -`none``uppercase``lowercase``capitalize``reverse` - - -Default Value: none -_(No text transformation will be applied.)_ - -Transform the case of the characters. -* * * - -##### shield-justify-alignment `keyword` -`left``center``right``auto` - - -Default Value: auto -_(TODO.)_ - -Define how text in a shield's label is justified. -* * * - -##### shield-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform shield instance with specified function. Ignores map scale factor. -* * * - -##### shield-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### shield-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify the geometries used for shield placement by the given tolerance. -* * * - -##### shield-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify the geometries used for shield placement by the given algorithm. -* * * - -##### shield-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out the angles of the geometry used for shield placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### shield-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line-pattern - -##### line-pattern-file `uri` - - - -Default Value: none - - -An image file to be repeated and warped along a line. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### line-pattern-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### line-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications.)_ - -Apply an opacity level to the image used for the pattern. -* * * - -##### line-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### line-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### line-pattern-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-pattern-offset `float` - - - -Default Value: 0 -_(The line will not be offset.)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform line geometry with specified function and apply pattern to transformed geometry. -* * * - -##### line-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## polygon-pattern - -##### polygon-pattern-file `uri` - - - -Default Value: none - - -Image to use as a repeated pattern fill within a polygon. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### polygon-pattern-alignment `keyword` -`global``local` - - -Default Value: global -_(Patterns will be aligned to the map (or tile boundaries) when being repeated across polygons. This is ideal for seamless patterns in tiled rendering.)_ - -Specify whether to align pattern fills to the layer's geometry (local) or to the map (global). -* * * - -##### polygon-pattern-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of polygon pattern edges. -* * * - -##### polygon-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications.)_ - -Apply an opacity level to the image used for the pattern. -* * * - -##### polygon-pattern-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### polygon-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### polygon-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### polygon-pattern-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform polygon geometry with specified function and apply pattern to transformed geometry. -* * * - -##### polygon-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## raster - -##### raster-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the raster symbolizer on top of other symbolizers. -* * * - -##### raster-filter-factor `float` - - - -Default Value: -1 -_(Allow the datasource to choose appropriate downscaling.)_ - -This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. -* * * - -##### raster-scaling `keyword` -`near``fast``bilinear``bicubic``spline16``spline36``hanning``hamming``hermite``kaiser``quadric``catrom``gaussian``bessel``mitchell``sinc``lanczos``blackman` - - -Default Value: near -_(Nearest neighboor resampling will be used to scale the image to the target size of the map.)_ - -The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. -* * * - -##### raster-mesh-size `unsigned` - - - -Default Value: 16 -_(Reprojection mesh will be 1/16 of the resolution of the source image.)_ - -A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. -* * * - -##### raster-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### raster-colorizer-default-mode `keyword` -`discrete``linear``exact` - - -Default Value: linear -_(A linear interpolation is used to generate colors between the two nearest stops.)_ - -This can be either `discrete`, `linear` or `exact`. If it is not specified then the default is `linear`. -* * * - -##### raster-colorizer-default-color `color` - - - -Default Value: transparent -_(Pixels that are not colored by the colorizer stops will be transparent.)_ - -This can be any color. Sets the color that is applied to all values outside of the range of the colorizer-stops. If not supplied pixels will be fully transparent. -* * * - -##### raster-colorizer-epsilon `float` - - - -Default Value: 1.1920928955078125e-07 -_(Pixels must very closely match the stop filter otherwise they will not be colored.)_ - -This can be any positive floating point value and will be used as a tolerance in floating point comparisions. The higher the value the more likely a stop will match and color data. -* * * - -##### raster-colorizer-stops `tags` - - - -Default Value: -_(No colorization will happen without supplying stops.)_ - -Assigns raster data values to colors. Stops must be listed in ascending order, and contain at a minimum the value and the associated color. You can also include the color-mode as a third argument, like `stop(100,#fff,exact)`. -* * * - - -## point - -##### point-file `uri` - - - -Default Value: none -_(A 4x4 black square will be rendered.)_ - -Image file to represent a point. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### point-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow points to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping points are shown or hidden. -* * * - -##### point-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache.)_ - -Control whether the placement of the feature will prevent the placement of other features. -* * * - -##### point-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A value from 0 to 1 to control the opacity of the point. -* * * - -##### point-placement `keyword` -`centroid``interior` - - -Default Value: centroid -_(The centroid of the geometry will be used to place the point.)_ - -Control how this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. -* * * - -##### point-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform point instance with specified function. Ignores map scale factor. -* * * - -##### point-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## text - -##### text-name `string` - - - -Default Value: none - - -Value to use for a text label. Data columns are specified using brackets like [column_name]. -* * * - -##### text-face-name `string` - - - -Default Value: none - - -Font name and style to render a label in. -* * * - -##### text-size `float` - - - -Default Value: 10 -_(Font size of 10 will be used to render text.)_ - -Text size in pixels. -* * * - -##### text-ratio `unsigned` - - - -Default Value: 0 -_(TODO.)_ - -Define the amount of text (of the total) present on successive lines when wrapping occurs. -* * * - -##### text-wrap-width `unsigned` - - - -Default Value: 0 -_(Text will not be wrapped.)_ - -Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. -* * * - -##### text-wrap-before `boolean` - - - -Default Value: false -_(Wrapped lines will be a bit longer than wrap-width.)_ - -Wrap text before wrap-width is reached. -* * * - -##### text-wrap-character `string` - - - -Default Value: " " -_(Lines will be wrapped when whitespace is encountered.)_ - -Use this character instead of a space to wrap long text. -* * * - -##### text-repeat-wrap-character `boolean` - - - -Default Value: false -_(Character will be removed when used to wrap a line.)_ - -Keep the character used to wrap a line instead of removing it, and repeat it on the new line. -* * * - -##### text-spacing `unsigned` - - - -Default Value: 0 -_(Only one label per line will attempt to be placed.)_ - -Distance the renderer should use to try to place repeated text labels on a line. -* * * - -##### text-character-spacing `float` - - - -Default Value: 0 -_(The default character spacing of the font will be used.)_ - -Horizontal spacing adjustment between characters in pixels. This value is ignored when `horizontal-alignment` is set to `adjust`. Typographic ligatures are turned off when this value is greater than zero. -* * * - -##### text-line-spacing `unsigned` - - - -Default Value: 0 -_(The default font spacing will be used.)_ - -Vertical spacing adjustment between lines in pixels. -* * * - -##### text-label-position-tolerance `float` - - - -Default Value: text-spacing/2.0 -_(If a shield cannot be placed then the renderer will advance by text-spacing/2.0 to try placement again.)_ - -Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line). -* * * - -##### text-max-char-angle-delta `float` - - - -Default Value: 22.5 -_(The label will not be placed if a character falls on a line with an angle sharper than 22.5 degrees.)_ - -The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. -* * * - -##### text-fill `color` - - - -Default Value: black -_(The text will be rendered black.)_ - -Specifies the color for the text. -* * * - -##### text-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text. -* * * - -##### text-halo-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text halo. -* * * - -##### text-halo-fill `color` - - - -Default Value: white -_(The halo will be rendered white.)_ - -Specifies the color of the halo around the text. -* * * - -##### text-halo-radius `float` - - - -Default Value: 0 -_(no halo.)_ - -Specify the radius of the halo in pixels. -* * * - -##### text-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The text will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### text-halo-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation.)_ - -Transform text halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. -* * * - -##### text-dx `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text by fixed amount, in pixels, +/- along the X axis. With "dummy" placement-type, a positive value displaces to the right. With "simple" placement-type, it is either left, right or unchanged, depending on the placement selected. Any non-zero value implies "horizontal-alignment" changes to "left" by default. Has no effect with 'line' text-placement-type. -* * * - -##### text-dy `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text by fixed amount, in pixels, +/- along the Y axis. With "dummy" placement-type, a positive value displaces downwards. With "simple" placement-type, it is either up, down or unchanged, depending on the placement selected. With "line" placement-type, a positive value displaces above the path. -* * * - -##### text-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: auto -_(Default affected by value of dy; "top" for dy>0, "bottom" for dy<0.)_ - -Position of label relative to point position. -* * * - -##### text-avoid-edges `boolean` - - - -Default Value: false -_(Text will be potentially placed near tile edges and therefore may look cut off unless the same text label is rendered on each adjacent tile.)_ - -Avoid placing labels that intersect with tile boundaries. -* * * - -##### text-margin `float` - - - -Default Value: 0 -_(No extra margin will be used to determine if a label collides with any other text, shield, or marker.)_ - -Minimum distance that a label can be placed from any other text, shield, or marker. -* * * - -##### text-repeat-distance `float` - - - -Default Value: 0 -_(Labels with the same text will be rendered without restriction.)_ - -Minimum distance between repeated text. If set this will prevent text labels being rendered nearby each other that contain the same text. Similiar to text-min-distance with the difference that it works the same no matter what placement strategy is used. -* * * - -##### text-min-distance `float` - - - -Default Value: 0 -_(Labels with the same text will be rendered without restriction.)_ - -Minimum distance to the next label with the same text. Only works for line placement. Deprecated: replaced by `text-repeat-distance` and `text-margin` -* * * - -##### text-min-padding `float` - - - -Default Value: 0 -_(No margin will be used to detect if a text label is nearby a tile boundary.)_ - -Minimum distance a text label will be placed from the edge of a tile. This option is similiar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. -* * * - -##### text-min-path-length `float` - - - -Default Value: 0 -_(place labels on all geometries no matter how small they are.)_ - -Place labels only on polygons and lines with a bounding width longer than this value (in pixels). -* * * - -##### text-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow text to overlap with other text - overlapping markers will not be shown.)_ - -Control whether overlapping text is shown or hidden. -* * * - -##### text-orientation `float` - - - -Default Value: 0 -_(Text is not rotated and is displayed upright.)_ - -Rotate the text. (only works with text-placement:point). -* * * - -##### text-rotate-displacement `boolean` - - - -Default Value: false -_(Label center is used for rotation.)_ - -Rotates the displacement around the placement origin by the angle given by "orientation". -* * * - -##### text-upright `keyword` -`auto``auto-down``left``right``left-only``right-only` - - -Default Value: auto -_(Text will be positioned upright automatically.)_ - -How this label should be placed along lines. By default when more than half of a label's characters are upside down the label is automatically flipped to keep it upright. By changing this parameter you can prevent this "auto-upright" behavior. The "auto-down" value places text in the opposite orientation to "auto". The "left" or "right" settings can be used to force text to always be placed along a line in a given direction and therefore disables flipping if text appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down text rather than trying to flip it. -* * * - -##### text-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point -_(One shield will be placed per geometry.)_ - -How this label should be placed. Point placement places one label on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. -* * * - -##### text-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy -_(Alternative placements will not be enabled.)_ - -Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. -* * * - -##### text-placements `string` - - - -Default Value: -_(No alternative placements will be used.)_ - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `text-placements: "E,NE,SE,W,NW,SW";`. -* * * - -##### text-transform `keyword` -`none``uppercase``lowercase``capitalize``reverse` - - -Default Value: none -_(Transform text instance with specified function. Ignores map scale factor.)_ - -Transform the case of the characters. -* * * - -##### text-horizontal-alignment `keyword` -`left``middle``right``auto``adjust` - - -Default Value: auto -_(TODO.)_ - -The text's horizontal alignment from it's centerpoint. If `placement` is set to `line`, then `adjust` can be set to auto-fit the text to the length of the path by dynamically calculating `character-spacing`. -* * * - -##### text-align `keyword` -`left``right``center``auto` - - -Default Value: auto -_(Auto alignment means that text will be centered by default except when using the `placement-type` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the `text-placements` directives.)_ - -Define how text is justified. -* * * - -##### text-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### text-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify the geometries used for text placement by the given tolerance. -* * * - -##### text-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify the geometries used for text placement by the given algorithm. -* * * - -##### text-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out the angles of the geometry used for text placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### text-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### text-halo-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### text-font-feature-settings `string` - - - -Default Value: -_(Default set of typographic features recommended by OpenType specification. Ligatures are turned off by default when `character-spacing` is greater than zero.)_ - -Comma separated list of OpenType typographic features. The syntax and semantics conforms to `font-feature-settings` from W3C CSS. -* * * - -##### text-largest-bbox-only `boolean` - - - -Default Value: true -_(For multipolygons only polygon with largest bbox area is labeled (does not apply to other geometries).)_ - -Controls default labeling behavior on multipolygons. The default is true and means that only the polygon with largest bbox is labeled. -* * * - - -## building - -##### building-fill `color` - - - -Default Value: The color gray will be used for fill. -_(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)_ - -The color of the buildings fill. Note: 0.8 will be used to multiply each color component to auto-generate a darkened wall color. -* * * - -##### building-fill-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the building as a whole, including all walls. -* * * - -##### building-height `float` - - - -Default Value: 0 -_(Buildings will not have a visual height and will instead look like flat polygons.)_ - -The height of the building in pixels. -* * * - - -## debug - -##### debug-mode `string` - - - -Default Value: collision -_(The otherwise invisible collision boxes will be rendered as squares on the map.)_ - -The mode for debug rendering. -* * * - - -## dot - -##### dot-fill `color` - - - -Default Value: gray -_(The dot fill color is gray.)_ - -The color of the area of the dot. -* * * - -##### dot-opacity `float` - - - -Default Value: 1 -_(The opacity of the dot.)_ - -The overall opacity of the dot. -* * * - -##### dot-width `float` - - - -Default Value: 1 -_(The marker width is 1 pixel.)_ - -The width of the dot in pixels. -* * * - -##### dot-height `float` - - - -Default Value: 1 -_(The marker height is 1 pixels.)_ - -The height of the dot in pixels. -* * * - -##### dot-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current layer on top of other layers.)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - - - - -### Values - -Below is a list of values and an explanation of any expression that can be applied to properties in CartCSS. - -### Color - -CartoCSS accepts a variety of syntaxes for colors - HTML-style hex values, rgb, rgba, hsl, hsla, husl, and husla. It also supports the predefined HTML colors names, like `yellow` and `blue`. - -``` css -#line { -line-color: #ff0; -line-color: #ffff00; -line-color: rgb(255, 255, 0); -line-color: rgba(255, 255, 0, 1); -line-color: hsl(100, 50%, 50%); -line-color: hsla(100, 50%, 50%, 1); -line-color: husl(100, 50%, 50%); // same values yield different color than HSL -line-color: husla(100, 50%, 50%, 1); -line-color: yellow; -} -``` - -Especially of note is the support for hsl and husl, which can be [easier to reason about than rgb()](http://mothereffinghsl.com/). Carto also includes several color operation functions [borrowed from less](http://lesscss.org/functions/#color-operations): - -``` css -// lighten and darken colors -lighten(#ace, 10%); -darken(#ace, 10%); - -// saturate and desaturate -saturate(#550000, 10%); -desaturate(#00ff00, 10%); - -// increase or decrease the opacity of a color -fadein(#fafafa, 10%); -fadeout(#fefefe, 14%); - -// spin rotates a color around the color wheel by degrees -spin(#ff00ff, 10); - -// mix generates a color in between two other colors. -mix(#fff, #000, 50%); - -// get color components -hue(#ff00ff); -saturation(#ff00ff); -lightness(#ff00ff); -alpha(hsla(100, 50%, 50%, 0.5)); -``` - -These functions all take arguments which can be color variables, literal colors, or the results of other functions operating on colors. All the above mentioned functions also come in -a `functionp`-variant (e.g. `lightenp`), which force a given color into perceptual color space. - -### Float - -Float is a fancy way of saying 'number'. In CartoCSS, you specify _just a number_ - unlike CSS, there are no units, but everything is specified in pixels. - -``` css -#line { -line-width: 2; -} -``` - -It's also possible to do simple math with number values: - -``` css -#line { -line-width: 4 / 2; // division -line-width: 4 + 2; // addition -line-width: 4 - 2; // subtraction -line-width: 4 * 2; // multiplication -line-width: 4 % 2; // modulus -} -``` - -### URI - -URI is a fancy way of saying URL. When an argument is a URI, you use the same kind of `url('place.png')` notation that you would with HTML. Quotes around the URL aren't required, but are highly recommended. URIs can be paths to places on your computer, or on the internet. - -```css -#markers { -marker-file: url('marker.png'); -} -``` - -### String - -A string is basically just text. In the case of CartoCSS, you're going to put it in quotes. Strings can be anything, though pay attention to the cases of `text-name` and `shield-name` - they actually will refer to features, which you refer to by putting them in brackets, as seen in the example below. - -```css -#labels { -text-name: "[MY_FIELD]"; -} -``` - -### Boolean - -Boolean means yes or no, so it accepts the values `true` or `false`. - -```css -#markers { -marker-allow-overlap:true; -} -``` - -### Expressions - -Expressions are statements that can include fields, numbers, and other types in a really flexible way. You have run into expressions before, in the realm of 'fields', where you'd specify `"[FIELD]"`, but expressions allow you to drop the quotes and also do quick addition, division, multiplication, and concatenation from within Carto syntax. - -```css -#buildings { -building-height: [HEIGHT_FIELD] * 10; -} -``` - -### Numbers -Numbers are comma-separated lists of one or more number in a specific order. They're used in line dash arrays, in which the numbers specify intervals of line, break, and line again. - -```css -#disputedboundary { -line-dasharray: 1, 4, 2; -} -``` - -### Percentages -In Carto, the percentage symbol, `%` universally means `value/100`. It's meant to be used with ratio-related properties, like opacity rules. - -_You should not use percentages as widths, heights, or other properties - unlike CSS, percentages are not relative to cascaded classes or page size, they're, as stated, simply the value divided by one hundred._ - -```css -#world { -// this syntax -polygon-opacity: 50%; - -// is equivalent to -polygon-opacity: 0.5; -} -``` - -### Functions - -Functions are comma-separated lists of one or more functions. For instance, transforms use the `functions` type to allow for transforms within Carto, which are optionally chainable. - -```css -#point { -point-transform: scale(2, 2); -} -``` diff --git a/docs/3.0.5.md b/docs/3.0.5.md deleted file mode 100644 index ad7ed30..0000000 --- a/docs/3.0.5.md +++ /dev/null @@ -1,2226 +0,0 @@ -# Carto documentation - -The following is a list of properties provided in CartoCSS that you can apply to map elements. - -## All elements - -##### image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``color-blind-protanope``color-blind-deuteranope``color-blind-tritanope``colorize-alpha``color-to-alpha``scale-hsla` - -Default Value: none -_(no filters.)_ - -A list of image filters that will be applied to the active rendering canvas for a given style. The presence of one more `image-filters` will trigger a new canvas to be created before starting to render a style and then this canvas will be composited back into the main canvas after rendering all features and after all `image-filters` have been applied. See `direct-image-filters` if you want to apply a filter directly to the main canvas. -* * * - -##### image-filters-inflate `boolean` - - - -Default Value: false -_(No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary.)_ - -A property that can be set to true to enable using an inflated image internally for seamless blurring across tiles (requires buffered data). -* * * - -##### direct-image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``color-blind-protanope``color-blind-deuteranope``color-blind-tritanope``colorize-alpha``color-to-alpha``scale-hsla` - -Default Value: none -_(no filters.)_ - -A list of image filters to apply to the main canvas (see the `image-filters` doc for how they work on a separate canvas). -* * * - -##### comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current layer on top of other layers.)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - -##### opacity `float` - - - -Default Value: 1 -_(No separate buffer will be used and no alpha will be applied to the style after rendering.)_ - -An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer). -* * * - - -## map - -##### background-color `color` - - - -Default Value: none -_(Will be rendered transparent.)_ - -Map Background color. -* * * - -##### background-image `uri` - - - -Default Value: -_(No background image will be used.)_ - -An image that is repeated below all features on a map as a background. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### background-image-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(The background-image will be blended with the background normally (placed on top of any existing background-color).)_ - -Set the compositing operation used to blend the image into the background. -* * * - -##### background-image-opacity `float` - - - -Default Value: 1 -_(The image opacity will not be changed when applied to the map background.)_ - -Set the opacity of the image. -* * * - -##### srs `string` - - - -Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs -_(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space.)_ - -Map spatial reference (proj4 string). -* * * - -##### buffer-size `float` - - - -Default Value: 0 -_(No buffer will be used.)_ - -Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". -* * * - -##### maximum-extent `string` - - - -Default Value: -20037508.34,-20037508.34,20037508.34,20037508.34 -_(All data will be clipped to global mercator extent (default is applied in Carto.js).)_ - -An extent to be used to limit the bounds used to query all layers during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Map. -* * * - -##### base `string` - - - -Default Value: -_(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)_ - -Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. -* * * - -##### font-directory `uri` - - - -Default Value: none -_(No map-specific fonts will be registered.)_ - -Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). -* * * - - -## polygon - -##### polygon-fill `color` - - - -Default Value: The color gray will be used for fill. -_(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)_ - -Fill color to assign to a polygon. -* * * - -##### polygon-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the polygon. -* * * - -##### polygon-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of polygon edges. -* * * - -##### polygon-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. -* * * - -##### polygon-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extend outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### polygon-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify geometries by the given tolerance. -* * * - -##### polygon-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify geometries by the given algorithm. -* * * - -##### polygon-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform polygon geometry with specified function. -* * * - -##### polygon-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line - -##### line-color `color` - - - -Default Value: black -_(black and fully opaque (alpha = 1), same as rgb(0,0,0) or rgba(0,0,0,1).)_ - -The color of a drawn line. -* * * - -##### line-width `float` - - - -Default Value: 1 -_(The line will be rendered 1 pixel wide.)_ - -The width of a line in pixels. -* * * - -##### line-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of a line. -* * * - -##### line-join `keyword` -`miter``miter-revert``round``bevel` - - -Default Value: miter -_(The line joins will be rendered using a miter look.)_ - -The behavior of lines when joining. -* * * - -##### line-cap `keyword` -`butt``round``square` - - -Default Value: butt -_(The line endings will be rendered using a butt look.)_ - -The display of line endings. -* * * - -##### line-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of stroke line. -* * * - -##### line-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. -* * * - -##### line-dasharray `numbers` - - - -Default Value: none -_(The line will be drawn without dashes.)_ - -A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. -* * * - -##### line-dash-offset `numbers` - - - -Default Value: none -_(The line will be drawn without dashes.)_ - -Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled). -* * * - -##### line-miterlimit `float` - - - -Default Value: 4 -_(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )'.)_ - -The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. -* * * - -##### line-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### line-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify geometries by the given tolerance. -* * * - -##### line-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify geometries by the given algorithm. -* * * - -##### line-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-offset `float` - - - -Default Value: 0 -_(Will not be offset.)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The line will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. -* * * - -##### line-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform line geometry with specified function. -* * * - -##### line-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## markers - -##### marker-file `uri` - - - -Default Value: none -_(An ellipse or circle, if width equals height.)_ - -A file that this marker shows at each placement. If no file is given, the marker will show an ellipse. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### marker-opacity `float` - - - -Default Value: 1 -_(The stroke-opacity and fill-opacity of the marker.)_ - -The overall opacity of the marker, if set, overrides both the opacity of both the fill and stroke. -* * * - -##### marker-fill-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The fill opacity of the marker. -* * * - -##### marker-line-color `color` - - - -Default Value: black -_(The marker will be drawn with a black outline.)_ - -The color of the stroke around the marker. -* * * - -##### marker-line-width `float` - - - -Default Value: 0.5 -_(The marker will be drawn with an outline of .5 pixels wide.)_ - -The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. -* * * - -##### marker-line-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of a line. -* * * - -##### marker-placement `keyword` -`point``line``interior``vertex-first``vertex-last` - - -Default Value: point -_(Place markers at the center point (centroid) of the geometry.)_ - -Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior. The 'vertex-first' and 'vertex-last' options can be used to place markers at the first or last vertex of lines or polygons. -* * * - -##### marker-multi-policy `keyword` -`each``whole``largest` - - -Default Value: each -_(If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each.)_ - -A special setting to allow the user to control rendering behavior for 'multi-geometries' (when a feature contains multiple geometries). This setting does not apply to markers placed along lines. The 'each' policy is default and means all geometries will get a marker. The 'whole' policy means that the aggregate centroid between all geometries will be used. The 'largest' policy means that only the largest (by bounding box areas) feature will get a rendered marker (this is how text labeling behaves by default). -* * * - -##### marker-type `keyword` -`arrow``ellipse` - - -Default Value: ellipse -_(The marker shape is an ellipse.)_ - -The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width). -* * * - -##### marker-width `float` - - - -Default Value: 10 -_(The marker width is 10 pixels.)_ - -The width of the marker, if using one of the default types. -* * * - -##### marker-height `float` - - - -Default Value: 10 -_(The marker height is 10 pixels.)_ - -The height of the marker, if using one of the default types. -* * * - -##### marker-fill `color` - - - -Default Value: blue -_(The marker fill color is blue.)_ - -The color of the area of the marker. -* * * - -##### marker-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow markers to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping markers are shown or hidden. -* * * - -##### marker-avoid-edges `boolean` - - - -Default Value: false -_(Markers will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)_ - -Avoid placing markers that intersect with tile boundaries. -* * * - -##### marker-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache.)_ - -Value to control whether the placement of the feature will prevent the placement of other features. -* * * - -##### marker-spacing `float` - - - -Default Value: 100 -_(In the case of marker-placement:line then draw a marker every 100 pixels along a line.)_ - -Space between repeated markers in pixels. If the spacing is less than the marker size or larger than the line segment length then no marker will be placed. Any value less than 1 will be ignored and the default will be used instead. -* * * - -##### marker-max-error `float` - - - -Default Value: 0.2 -_(N/A: not intended to be changed.)_ - -N/A: not intended to be changed. -* * * - -##### marker-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform marker instance with specified function. Ignores map scale factor. -* * * - -##### marker-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### marker-simplify `float` - - - -Default Value: 0 -_(Geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### marker-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### marker-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### marker-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform marker geometry with specified function. -* * * - -##### marker-offset `float` - - - -Default Value: 0 -_(Will not be offset.)_ - -Offsets a marker from a line a number of pixels parallel to its actual path. Positive values move the marker left, negative values move it right (relative to the directionality of the line). -* * * - -##### marker-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### marker-direction `keyword` -`auto``auto-down``left``right``left-only``right-only``up``down` - - -Default Value: right -_(Markers are oriented to the right in the line direction.)_ - -How markers should be placed along lines. With the "auto" setting when marker is upside down the marker is automatically rotated by 180 degrees to keep it upright. The "auto-down" value places marker in the opposite orientation to "auto". The "left" or "right" settings can be used to force marker to always be placed along a line in a given direction and therefore disables rotating if marker appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down markers rather than trying to flip it. The "up" and "down" settings don't adjust marker's orientation to the line direction. -* * * - - -## shield - -##### shield-name `string` - - - -Default Value: -_(No text label will be rendered with the shield.)_ - -Value to use for a shield"s text label. Data columns are specified using brackets like [column_name]. -* * * - -##### shield-file `uri` - - - -Default Value: none - - -Image file to render behind the shield text. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### shield-face-name `string` - - - -Default Value: none - - -Font name and style to use for the shield text. -* * * - -##### shield-unlock-image `boolean` - - - -Default Value: false -_(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)_ - -This parameter should be set to true if you are trying to position text beside rather than on top of the shield image. -* * * - -##### shield-size `float` - - - -Default Value: 10 -_(Font size of 10 will be used to render text.)_ - -The size of the shield text in pixels. -* * * - -##### shield-fill `color` - - - -Default Value: black -_(The shield text will be rendered black.)_ - -The color of the shield text. -* * * - -##### shield-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point -_(One shield will be placed per geometry.)_ - -How this shield should be placed. Point placement places one shield on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. -* * * - -##### shield-avoid-edges `boolean` - - - -Default Value: false -_(Shields will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)_ - -Avoid placing shields that intersect with tile boundaries. -* * * - -##### shield-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow shields to overlap with other map elements already placed.)_ - -Control whether overlapping shields are shown or hidden. -* * * - -##### shield-margin `float` - - - -Default Value: 0 -_(No extra margin will be used to determine if a shield collides with any other text, shield, or marker.)_ - -Minimum distance that a shield can be placed from any other text, shield, or marker. -* * * - -##### shield-repeat-distance `float` - - - -Default Value: 0 -_(Shields with the same text will be rendered without restriction.)_ - -Minimum distance between repeated shields. If set this will prevent shields being rendered nearby each other that contain the same text. Similiar to shield-min-distance with the difference that it works the same no matter what placement strategy is used. -* * * - -##### shield-min-distance `float` - - - -Default Value: 0 -_(Shields with the same text will be rendered without restriction.)_ - -Minimum distance to the next shield with the same text. Only works for line placement. -* * * - -##### shield-spacing `float` - - - -Default Value: 0 -_(Only one shield per line will attempt to be placed.)_ - -Distance the renderer should use to try to place repeated shields on a line. -* * * - -##### shield-min-padding `float` - - - -Default Value: 0 -_(No margin will be used to detect if a shield is nearby a tile boundary.)_ - -Minimum distance a shield will be placed from the edge of a tile. This option is similiar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. -* * * - -##### shield-label-position-tolerance `float` - - - -Default Value: shield-spacing/2.0 -_(If a shield cannot be placed then the renderer will advance by shield-spacing/2.0 to try placement again.)_ - -Allows the shield to be displaced from its ideal position by a number of pixels (only works with placement:line). -* * * - -##### shield-wrap-width `unsigned` - - - -Default Value: 0 -_(Text will not be wrapped.)_ - -Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. -* * * - -##### shield-wrap-before `boolean` - - - -Default Value: false -_(Wrapped lines will be a bit longer than wrap-width.)_ - -Wrap text before wrap-width is reached. -* * * - -##### shield-wrap-character `string` - - - -Default Value: " " -_(Lines will be wrapped when whitespace is encountered.)_ - -Use this character instead of a space to wrap long names. -* * * - -##### shield-halo-fill `color` - - - -Default Value: white -_(The shield halo text will be rendered white.)_ - -Specifies the color of the halo around the text. -* * * - -##### shield-halo-radius `float` - - - -Default Value: 0 -_(no halo.)_ - -Specify the radius of the halo in pixels. -* * * - -##### shield-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The shield will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### shield-halo-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation.)_ - -Transform shield halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. -* * * - -##### shield-halo-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### shield-halo-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text halo. -* * * - -##### shield-character-spacing `unsigned` - - - -Default Value: 0 -_(The default character spacing of the font will be used.)_ - -Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. -* * * - -##### shield-line-spacing `unsigned` - - - -Default Value: 0 -_(The default font spacing will be used.)_ - -Vertical spacing between lines of multiline labels (in pixels). -* * * - -##### shield-text-dx `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right. -* * * - -##### shield-text-dy `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down. -* * * - -##### shield-dx `float` - - - -Default Value: 0 -_(Shield will not be displaced.)_ - -Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right. -* * * - -##### shield-dy `float` - - - -Default Value: 0 -_(Shield will not be displaced.)_ - -Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down. -* * * - -##### shield-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the image used for the shield. -* * * - -##### shield-text-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the text placed on top of the shield. -* * * - -##### shield-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: auto -_(TODO.)_ - -The shield's horizontal alignment from its centerpoint. -* * * - -##### shield-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: middle -_(TODO.)_ - -The shield's vertical alignment from its centerpoint. -* * * - -##### shield-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy -_(Alternative placements will not be enabled.)_ - -Re-position and/or re-size shield to avoid overlaps. "simple" for basic algorithm (using shield-placements string,) "dummy" to turn this feature off. -* * * - -##### shield-placements `string` - - - -Default Value: -_(No alternative placements will be used.)_ - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `shield-placements: "E,NE,SE,W,NW,SW";`. -* * * - -##### shield-text-transform `keyword` -`none``uppercase``lowercase``capitalize``reverse` - - -Default Value: none -_(No text transformation will be applied.)_ - -Transform the case of the characters. -* * * - -##### shield-justify-alignment `keyword` -`left``center``right``auto` - - -Default Value: auto -_(TODO.)_ - -Define how text in a shield's label is justified. -* * * - -##### shield-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform shield instance with specified function. Ignores map scale factor. -* * * - -##### shield-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### shield-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify the geometries used for shield placement by the given tolerance. -* * * - -##### shield-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify the geometries used for shield placement by the given algorithm. -* * * - -##### shield-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out the angles of the geometry used for shield placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### shield-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line-pattern - -##### line-pattern-file `uri` - - - -Default Value: none - - -An image file to be repeated and warped along a line. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### line-pattern-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### line-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications.)_ - -Apply an opacity level to the image used for the pattern. -* * * - -##### line-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### line-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### line-pattern-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-pattern-offset `float` - - - -Default Value: 0 -_(The line will not be offset.)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform line geometry with specified function and apply pattern to transformed geometry. -* * * - -##### line-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## polygon-pattern - -##### polygon-pattern-file `uri` - - - -Default Value: none - - -Image to use as a repeated pattern fill within a polygon. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### polygon-pattern-alignment `keyword` -`global``local` - - -Default Value: global -_(Patterns will be aligned to the map (or tile boundaries) when being repeated across polygons. This is ideal for seamless patterns in tiled rendering.)_ - -Specify whether to align pattern fills to the layer's geometry (local) or to the map (global). -* * * - -##### polygon-pattern-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of polygon pattern edges. -* * * - -##### polygon-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications.)_ - -Apply an opacity level to the image used for the pattern. -* * * - -##### polygon-pattern-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### polygon-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### polygon-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### polygon-pattern-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform polygon geometry with specified function and apply pattern to transformed geometry. -* * * - -##### polygon-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## raster - -##### raster-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the raster symbolizer on top of other symbolizers. -* * * - -##### raster-filter-factor `float` - - - -Default Value: -1 -_(Allow the datasource to choose appropriate downscaling.)_ - -This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. -* * * - -##### raster-scaling `keyword` -`near``fast``bilinear``bicubic``spline16``spline36``hanning``hamming``hermite``kaiser``quadric``catrom``gaussian``bessel``mitchell``sinc``lanczos``blackman` - - -Default Value: near -_(Nearest neighboor resampling will be used to scale the image to the target size of the map.)_ - -The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. -* * * - -##### raster-mesh-size `unsigned` - - - -Default Value: 16 -_(Reprojection mesh will be 1/16 of the resolution of the source image.)_ - -A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. -* * * - -##### raster-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### raster-colorizer-default-mode `keyword` -`discrete``linear``exact` - - -Default Value: linear -_(A linear interpolation is used to generate colors between the two nearest stops.)_ - -This can be either `discrete`, `linear` or `exact`. If it is not specified then the default is `linear`. -* * * - -##### raster-colorizer-default-color `color` - - - -Default Value: transparent -_(Pixels that are not colored by the colorizer stops will be transparent.)_ - -This can be any color. Sets the color that is applied to all values outside of the range of the colorizer-stops. If not supplied pixels will be fully transparent. -* * * - -##### raster-colorizer-epsilon `float` - - - -Default Value: 1.1920928955078125e-07 -_(Pixels must very closely match the stop filter otherwise they will not be colored.)_ - -This can be any positive floating point value and will be used as a tolerance in floating point comparisions. The higher the value the more likely a stop will match and color data. -* * * - -##### raster-colorizer-stops `tags` - - - -Default Value: -_(No colorization will happen without supplying stops.)_ - -Assigns raster data values to colors. Stops must be listed in ascending order, and contain at a minimum the value and the associated color. You can also include the color-mode as a third argument, like `stop(100,#fff,exact)`. -* * * - - -## point - -##### point-file `uri` - - - -Default Value: none -_(A 4x4 black square will be rendered.)_ - -Image file to represent a point. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### point-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow points to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping points are shown or hidden. -* * * - -##### point-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache.)_ - -Control whether the placement of the feature will prevent the placement of other features. -* * * - -##### point-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A value from 0 to 1 to control the opacity of the point. -* * * - -##### point-placement `keyword` -`centroid``interior` - - -Default Value: centroid -_(The centroid of the geometry will be used to place the point.)_ - -Control how this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. -* * * - -##### point-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform point instance with specified function. Ignores map scale factor. -* * * - -##### point-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## text - -##### text-name `string` - - - -Default Value: none - - -Value to use for a text label. Data columns are specified using brackets like [column_name]. -* * * - -##### text-face-name `string` - - - -Default Value: none - - -Font name and style to render a label in. -* * * - -##### text-size `float` - - - -Default Value: 10 -_(Font size of 10 will be used to render text.)_ - -Text size in pixels. -* * * - -##### text-ratio `unsigned` - - - -Default Value: 0 -_(TODO.)_ - -Define the amount of text (of the total) present on successive lines when wrapping occurs. -* * * - -##### text-wrap-width `unsigned` - - - -Default Value: 0 -_(Text will not be wrapped.)_ - -Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. -* * * - -##### text-wrap-before `boolean` - - - -Default Value: false -_(Wrapped lines will be a bit longer than wrap-width.)_ - -Wrap text before wrap-width is reached. -* * * - -##### text-wrap-character `string` - - - -Default Value: " " -_(Lines will be wrapped when whitespace is encountered.)_ - -Use this character instead of a space to wrap long text. -* * * - -##### text-repeat-wrap-character `boolean` - - - -Default Value: false -_(Character will be removed when used to wrap a line.)_ - -Keep the character used to wrap a line instead of removing it, and repeat it on the new line. -* * * - -##### text-spacing `unsigned` - - - -Default Value: 0 -_(Only one label per line will attempt to be placed.)_ - -Distance the renderer should use to try to place repeated text labels on a line. -* * * - -##### text-character-spacing `float` - - - -Default Value: 0 -_(The default character spacing of the font will be used.)_ - -Horizontal spacing adjustment between characters in pixels. This value is ignored when `horizontal-alignment` is set to `adjust`. Typographic ligatures are turned off when this value is greater than zero. -* * * - -##### text-line-spacing `unsigned` - - - -Default Value: 0 -_(The default font spacing will be used.)_ - -Vertical spacing adjustment between lines in pixels. -* * * - -##### text-label-position-tolerance `float` - - - -Default Value: text-spacing/2.0 -_(If a shield cannot be placed then the renderer will advance by text-spacing/2.0 to try placement again.)_ - -Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line). -* * * - -##### text-max-char-angle-delta `float` - - - -Default Value: 22.5 -_(The label will not be placed if a character falls on a line with an angle sharper than 22.5 degrees.)_ - -The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. -* * * - -##### text-fill `color` - - - -Default Value: black -_(The text will be rendered black.)_ - -Specifies the color for the text. -* * * - -##### text-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text. -* * * - -##### text-halo-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text halo. -* * * - -##### text-halo-fill `color` - - - -Default Value: white -_(The halo will be rendered white.)_ - -Specifies the color of the halo around the text. -* * * - -##### text-halo-radius `float` - - - -Default Value: 0 -_(no halo.)_ - -Specify the radius of the halo in pixels. -* * * - -##### text-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The text will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### text-halo-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation.)_ - -Transform text halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. -* * * - -##### text-dx `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text by fixed amount, in pixels, +/- along the X axis. With "dummy" placement-type, a positive value displaces to the right. With "simple" placement-type, it is either left, right or unchanged, depending on the placement selected. Any non-zero value implies "horizontal-alignment" changes to "left" by default. Has no effect with 'line' text-placement-type. -* * * - -##### text-dy `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text by fixed amount, in pixels, +/- along the Y axis. With "dummy" placement-type, a positive value displaces downwards. With "simple" placement-type, it is either up, down or unchanged, depending on the placement selected. With "line" placement-type, a positive value displaces above the path. -* * * - -##### text-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: auto -_(Default affected by value of dy; "top" for dy>0, "bottom" for dy<0.)_ - -Position of label relative to point position. -* * * - -##### text-avoid-edges `boolean` - - - -Default Value: false -_(Text will be potentially placed near tile edges and therefore may look cut off unless the same text label is rendered on each adjacent tile.)_ - -Avoid placing labels that intersect with tile boundaries. -* * * - -##### text-margin `float` - - - -Default Value: 0 -_(No extra margin will be used to determine if a label collides with any other text, shield, or marker.)_ - -Minimum distance that a label can be placed from any other text, shield, or marker. -* * * - -##### text-repeat-distance `float` - - - -Default Value: 0 -_(Labels with the same text will be rendered without restriction.)_ - -Minimum distance between repeated text. If set this will prevent text labels being rendered nearby each other that contain the same text. Similiar to text-min-distance with the difference that it works the same no matter what placement strategy is used. -* * * - -##### text-min-distance `float` - - - -Default Value: 0 -_(Labels with the same text will be rendered without restriction.)_ - -Minimum distance to the next label with the same text. Only works for line placement. Deprecated: replaced by `text-repeat-distance` and `text-margin` -* * * - -##### text-min-padding `float` - - - -Default Value: 0 -_(No margin will be used to detect if a text label is nearby a tile boundary.)_ - -Minimum distance a text label will be placed from the edge of a tile. This option is similiar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. -* * * - -##### text-min-path-length `float` - - - -Default Value: 0 -_(place labels on all geometries no matter how small they are.)_ - -Place labels only on polygons and lines with a bounding width longer than this value (in pixels). -* * * - -##### text-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow text to overlap with other text - overlapping markers will not be shown.)_ - -Control whether overlapping text is shown or hidden. -* * * - -##### text-orientation `float` - - - -Default Value: 0 -_(Text is not rotated and is displayed upright.)_ - -Rotate the text. (only works with text-placement:point). -* * * - -##### text-rotate-displacement `boolean` - - - -Default Value: false -_(Label center is used for rotation.)_ - -Rotates the displacement around the placement origin by the angle given by "orientation". -* * * - -##### text-upright `keyword` -`auto``auto-down``left``right``left-only``right-only` - - -Default Value: auto -_(Text will be positioned upright automatically.)_ - -How this label should be placed along lines. By default when more than half of a label's characters are upside down the label is automatically flipped to keep it upright. By changing this parameter you can prevent this "auto-upright" behavior. The "auto-down" value places text in the opposite orientation to "auto". The "left" or "right" settings can be used to force text to always be placed along a line in a given direction and therefore disables flipping if text appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down text rather than trying to flip it. -* * * - -##### text-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point -_(One shield will be placed per geometry.)_ - -How this label should be placed. Point placement places one label on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. -* * * - -##### text-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy -_(Alternative placements will not be enabled.)_ - -Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. -* * * - -##### text-placements `string` - - - -Default Value: -_(No alternative placements will be used.)_ - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `text-placements: "E,NE,SE,W,NW,SW";`. -* * * - -##### text-transform `keyword` -`none``uppercase``lowercase``capitalize``reverse` - - -Default Value: none -_(Transform text instance with specified function. Ignores map scale factor.)_ - -Transform the case of the characters. -* * * - -##### text-horizontal-alignment `keyword` -`left``middle``right``auto``adjust` - - -Default Value: auto -_(TODO.)_ - -The text's horizontal alignment from it's centerpoint. If `placement` is set to `line`, then `adjust` can be set to auto-fit the text to the length of the path by dynamically calculating `character-spacing`. -* * * - -##### text-align `keyword` -`left``right``center``auto` - - -Default Value: auto -_(Auto alignment means that text will be centered by default except when using the `placement-type` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the `text-placements` directives.)_ - -Define how text is justified. -* * * - -##### text-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### text-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify the geometries used for text placement by the given tolerance. -* * * - -##### text-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify the geometries used for text placement by the given algorithm. -* * * - -##### text-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out the angles of the geometry used for text placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### text-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### text-halo-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### text-font-feature-settings `string` - - - -Default Value: -_(Default set of typographic features recommended by OpenType specification. Ligatures are turned off by default when `character-spacing` is greater than zero.)_ - -Comma separated list of OpenType typographic features. The syntax and semantics conforms to `font-feature-settings` from W3C CSS. -* * * - -##### text-largest-bbox-only `boolean` - - - -Default Value: true -_(For multipolygons only polygon with largest bbox area is labeled (does not apply to other geometries).)_ - -Controls default labeling behavior on multipolygons. The default is true and means that only the polygon with largest bbox is labeled. -* * * - - -## building - -##### building-fill `color` - - - -Default Value: The color gray will be used for fill. -_(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)_ - -The color of the buildings fill. Note: 0.8 will be used to multiply each color component to auto-generate a darkened wall color. -* * * - -##### building-fill-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the building as a whole, including all walls. -* * * - -##### building-height `float` - - - -Default Value: 0 -_(Buildings will not have a visual height and will instead look like flat polygons.)_ - -The height of the building in pixels. -* * * - - -## debug - -##### debug-mode `string` - - - -Default Value: collision -_(The otherwise invisible collision boxes will be rendered as squares on the map.)_ - -The mode for debug rendering. -* * * - - -## dot - -##### dot-fill `color` - - - -Default Value: gray -_(The dot fill color is gray.)_ - -The color of the area of the dot. -* * * - -##### dot-opacity `float` - - - -Default Value: 1 -_(The opacity of the dot.)_ - -The overall opacity of the dot. -* * * - -##### dot-width `float` - - - -Default Value: 1 -_(The marker width is 1 pixel.)_ - -The width of the dot in pixels. -* * * - -##### dot-height `float` - - - -Default Value: 1 -_(The marker height is 1 pixels.)_ - -The height of the dot in pixels. -* * * - -##### dot-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current layer on top of other layers.)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - - - - -### Values - -Below is a list of values and an explanation of any expression that can be applied to properties in CartCSS. - -### Color - -CartoCSS accepts a variety of syntaxes for colors - HTML-style hex values, rgb, rgba, hsl, hsla, husl, and husla. It also supports the predefined HTML colors names, like `yellow` and `blue`. - -``` css -#line { -line-color: #ff0; -line-color: #ffff00; -line-color: rgb(255, 255, 0); -line-color: rgba(255, 255, 0, 1); -line-color: hsl(100, 50%, 50%); -line-color: hsla(100, 50%, 50%, 1); -line-color: husl(100, 50%, 50%); // same values yield different color than HSL -line-color: husla(100, 50%, 50%, 1); -line-color: yellow; -} -``` - -Especially of note is the support for hsl and husl, which can be [easier to reason about than rgb()](http://mothereffinghsl.com/). Carto also includes several color operation functions [borrowed from less](http://lesscss.org/functions/#color-operations): - -``` css -// lighten and darken colors -lighten(#ace, 10%); -darken(#ace, 10%); - -// saturate and desaturate -saturate(#550000, 10%); -desaturate(#00ff00, 10%); - -// increase or decrease the opacity of a color -fadein(#fafafa, 10%); -fadeout(#fefefe, 14%); - -// spin rotates a color around the color wheel by degrees -spin(#ff00ff, 10); - -// mix generates a color in between two other colors. -mix(#fff, #000, 50%); - -// get color components -hue(#ff00ff); -saturation(#ff00ff); -lightness(#ff00ff); -alpha(hsla(100, 50%, 50%, 0.5)); -``` - -These functions all take arguments which can be color variables, literal colors, or the results of other functions operating on colors. All the above mentioned functions also come in -a `functionp`-variant (e.g. `lightenp`), which force a given color into perceptual color space. - -### Float - -Float is a fancy way of saying 'number'. In CartoCSS, you specify _just a number_ - unlike CSS, there are no units, but everything is specified in pixels. - -``` css -#line { -line-width: 2; -} -``` - -It's also possible to do simple math with number values: - -``` css -#line { -line-width: 4 / 2; // division -line-width: 4 + 2; // addition -line-width: 4 - 2; // subtraction -line-width: 4 * 2; // multiplication -line-width: 4 % 2; // modulus -} -``` - -### URI - -URI is a fancy way of saying URL. When an argument is a URI, you use the same kind of `url('place.png')` notation that you would with HTML. Quotes around the URL aren't required, but are highly recommended. URIs can be paths to places on your computer, or on the internet. - -```css -#markers { -marker-file: url('marker.png'); -} -``` - -### String - -A string is basically just text. In the case of CartoCSS, you're going to put it in quotes. Strings can be anything, though pay attention to the cases of `text-name` and `shield-name` - they actually will refer to features, which you refer to by putting them in brackets, as seen in the example below. - -```css -#labels { -text-name: "[MY_FIELD]"; -} -``` - -### Boolean - -Boolean means yes or no, so it accepts the values `true` or `false`. - -```css -#markers { -marker-allow-overlap:true; -} -``` - -### Expressions - -Expressions are statements that can include fields, numbers, and other types in a really flexible way. You have run into expressions before, in the realm of 'fields', where you'd specify `"[FIELD]"`, but expressions allow you to drop the quotes and also do quick addition, division, multiplication, and concatenation from within Carto syntax. - -```css -#buildings { -building-height: [HEIGHT_FIELD] * 10; -} -``` - -### Numbers -Numbers are comma-separated lists of one or more number in a specific order. They're used in line dash arrays, in which the numbers specify intervals of line, break, and line again. - -```css -#disputedboundary { -line-dasharray: 1, 4, 2; -} -``` - -### Percentages -In Carto, the percentage symbol, `%` universally means `value/100`. It's meant to be used with ratio-related properties, like opacity rules. - -_You should not use percentages as widths, heights, or other properties - unlike CSS, percentages are not relative to cascaded classes or page size, they're, as stated, simply the value divided by one hundred._ - -```css -#world { -// this syntax -polygon-opacity: 50%; - -// is equivalent to -polygon-opacity: 0.5; -} -``` - -### Functions - -Functions are comma-separated lists of one or more functions. For instance, transforms use the `functions` type to allow for transforms within Carto, which are optionally chainable. - -```css -#point { -point-transform: scale(2, 2); -} -``` diff --git a/docs/3.0.6.md b/docs/3.0.6.md deleted file mode 100644 index ad7ed30..0000000 --- a/docs/3.0.6.md +++ /dev/null @@ -1,2226 +0,0 @@ -# Carto documentation - -The following is a list of properties provided in CartoCSS that you can apply to map elements. - -## All elements - -##### image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``color-blind-protanope``color-blind-deuteranope``color-blind-tritanope``colorize-alpha``color-to-alpha``scale-hsla` - -Default Value: none -_(no filters.)_ - -A list of image filters that will be applied to the active rendering canvas for a given style. The presence of one more `image-filters` will trigger a new canvas to be created before starting to render a style and then this canvas will be composited back into the main canvas after rendering all features and after all `image-filters` have been applied. See `direct-image-filters` if you want to apply a filter directly to the main canvas. -* * * - -##### image-filters-inflate `boolean` - - - -Default Value: false -_(No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary.)_ - -A property that can be set to true to enable using an inflated image internally for seamless blurring across tiles (requires buffered data). -* * * - -##### direct-image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``color-blind-protanope``color-blind-deuteranope``color-blind-tritanope``colorize-alpha``color-to-alpha``scale-hsla` - -Default Value: none -_(no filters.)_ - -A list of image filters to apply to the main canvas (see the `image-filters` doc for how they work on a separate canvas). -* * * - -##### comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current layer on top of other layers.)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - -##### opacity `float` - - - -Default Value: 1 -_(No separate buffer will be used and no alpha will be applied to the style after rendering.)_ - -An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer). -* * * - - -## map - -##### background-color `color` - - - -Default Value: none -_(Will be rendered transparent.)_ - -Map Background color. -* * * - -##### background-image `uri` - - - -Default Value: -_(No background image will be used.)_ - -An image that is repeated below all features on a map as a background. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### background-image-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(The background-image will be blended with the background normally (placed on top of any existing background-color).)_ - -Set the compositing operation used to blend the image into the background. -* * * - -##### background-image-opacity `float` - - - -Default Value: 1 -_(The image opacity will not be changed when applied to the map background.)_ - -Set the opacity of the image. -* * * - -##### srs `string` - - - -Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs -_(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space.)_ - -Map spatial reference (proj4 string). -* * * - -##### buffer-size `float` - - - -Default Value: 0 -_(No buffer will be used.)_ - -Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". -* * * - -##### maximum-extent `string` - - - -Default Value: -20037508.34,-20037508.34,20037508.34,20037508.34 -_(All data will be clipped to global mercator extent (default is applied in Carto.js).)_ - -An extent to be used to limit the bounds used to query all layers during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Map. -* * * - -##### base `string` - - - -Default Value: -_(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)_ - -Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. -* * * - -##### font-directory `uri` - - - -Default Value: none -_(No map-specific fonts will be registered.)_ - -Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). -* * * - - -## polygon - -##### polygon-fill `color` - - - -Default Value: The color gray will be used for fill. -_(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)_ - -Fill color to assign to a polygon. -* * * - -##### polygon-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the polygon. -* * * - -##### polygon-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of polygon edges. -* * * - -##### polygon-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. -* * * - -##### polygon-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extend outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### polygon-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify geometries by the given tolerance. -* * * - -##### polygon-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify geometries by the given algorithm. -* * * - -##### polygon-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform polygon geometry with specified function. -* * * - -##### polygon-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line - -##### line-color `color` - - - -Default Value: black -_(black and fully opaque (alpha = 1), same as rgb(0,0,0) or rgba(0,0,0,1).)_ - -The color of a drawn line. -* * * - -##### line-width `float` - - - -Default Value: 1 -_(The line will be rendered 1 pixel wide.)_ - -The width of a line in pixels. -* * * - -##### line-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of a line. -* * * - -##### line-join `keyword` -`miter``miter-revert``round``bevel` - - -Default Value: miter -_(The line joins will be rendered using a miter look.)_ - -The behavior of lines when joining. -* * * - -##### line-cap `keyword` -`butt``round``square` - - -Default Value: butt -_(The line endings will be rendered using a butt look.)_ - -The display of line endings. -* * * - -##### line-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of stroke line. -* * * - -##### line-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. -* * * - -##### line-dasharray `numbers` - - - -Default Value: none -_(The line will be drawn without dashes.)_ - -A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. -* * * - -##### line-dash-offset `numbers` - - - -Default Value: none -_(The line will be drawn without dashes.)_ - -Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled). -* * * - -##### line-miterlimit `float` - - - -Default Value: 4 -_(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )'.)_ - -The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. -* * * - -##### line-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### line-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify geometries by the given tolerance. -* * * - -##### line-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify geometries by the given algorithm. -* * * - -##### line-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-offset `float` - - - -Default Value: 0 -_(Will not be offset.)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The line will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. -* * * - -##### line-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform line geometry with specified function. -* * * - -##### line-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## markers - -##### marker-file `uri` - - - -Default Value: none -_(An ellipse or circle, if width equals height.)_ - -A file that this marker shows at each placement. If no file is given, the marker will show an ellipse. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### marker-opacity `float` - - - -Default Value: 1 -_(The stroke-opacity and fill-opacity of the marker.)_ - -The overall opacity of the marker, if set, overrides both the opacity of both the fill and stroke. -* * * - -##### marker-fill-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The fill opacity of the marker. -* * * - -##### marker-line-color `color` - - - -Default Value: black -_(The marker will be drawn with a black outline.)_ - -The color of the stroke around the marker. -* * * - -##### marker-line-width `float` - - - -Default Value: 0.5 -_(The marker will be drawn with an outline of .5 pixels wide.)_ - -The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. -* * * - -##### marker-line-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of a line. -* * * - -##### marker-placement `keyword` -`point``line``interior``vertex-first``vertex-last` - - -Default Value: point -_(Place markers at the center point (centroid) of the geometry.)_ - -Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior. The 'vertex-first' and 'vertex-last' options can be used to place markers at the first or last vertex of lines or polygons. -* * * - -##### marker-multi-policy `keyword` -`each``whole``largest` - - -Default Value: each -_(If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each.)_ - -A special setting to allow the user to control rendering behavior for 'multi-geometries' (when a feature contains multiple geometries). This setting does not apply to markers placed along lines. The 'each' policy is default and means all geometries will get a marker. The 'whole' policy means that the aggregate centroid between all geometries will be used. The 'largest' policy means that only the largest (by bounding box areas) feature will get a rendered marker (this is how text labeling behaves by default). -* * * - -##### marker-type `keyword` -`arrow``ellipse` - - -Default Value: ellipse -_(The marker shape is an ellipse.)_ - -The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width). -* * * - -##### marker-width `float` - - - -Default Value: 10 -_(The marker width is 10 pixels.)_ - -The width of the marker, if using one of the default types. -* * * - -##### marker-height `float` - - - -Default Value: 10 -_(The marker height is 10 pixels.)_ - -The height of the marker, if using one of the default types. -* * * - -##### marker-fill `color` - - - -Default Value: blue -_(The marker fill color is blue.)_ - -The color of the area of the marker. -* * * - -##### marker-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow markers to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping markers are shown or hidden. -* * * - -##### marker-avoid-edges `boolean` - - - -Default Value: false -_(Markers will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)_ - -Avoid placing markers that intersect with tile boundaries. -* * * - -##### marker-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache.)_ - -Value to control whether the placement of the feature will prevent the placement of other features. -* * * - -##### marker-spacing `float` - - - -Default Value: 100 -_(In the case of marker-placement:line then draw a marker every 100 pixels along a line.)_ - -Space between repeated markers in pixels. If the spacing is less than the marker size or larger than the line segment length then no marker will be placed. Any value less than 1 will be ignored and the default will be used instead. -* * * - -##### marker-max-error `float` - - - -Default Value: 0.2 -_(N/A: not intended to be changed.)_ - -N/A: not intended to be changed. -* * * - -##### marker-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform marker instance with specified function. Ignores map scale factor. -* * * - -##### marker-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### marker-simplify `float` - - - -Default Value: 0 -_(Geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### marker-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### marker-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### marker-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform marker geometry with specified function. -* * * - -##### marker-offset `float` - - - -Default Value: 0 -_(Will not be offset.)_ - -Offsets a marker from a line a number of pixels parallel to its actual path. Positive values move the marker left, negative values move it right (relative to the directionality of the line). -* * * - -##### marker-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### marker-direction `keyword` -`auto``auto-down``left``right``left-only``right-only``up``down` - - -Default Value: right -_(Markers are oriented to the right in the line direction.)_ - -How markers should be placed along lines. With the "auto" setting when marker is upside down the marker is automatically rotated by 180 degrees to keep it upright. The "auto-down" value places marker in the opposite orientation to "auto". The "left" or "right" settings can be used to force marker to always be placed along a line in a given direction and therefore disables rotating if marker appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down markers rather than trying to flip it. The "up" and "down" settings don't adjust marker's orientation to the line direction. -* * * - - -## shield - -##### shield-name `string` - - - -Default Value: -_(No text label will be rendered with the shield.)_ - -Value to use for a shield"s text label. Data columns are specified using brackets like [column_name]. -* * * - -##### shield-file `uri` - - - -Default Value: none - - -Image file to render behind the shield text. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### shield-face-name `string` - - - -Default Value: none - - -Font name and style to use for the shield text. -* * * - -##### shield-unlock-image `boolean` - - - -Default Value: false -_(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)_ - -This parameter should be set to true if you are trying to position text beside rather than on top of the shield image. -* * * - -##### shield-size `float` - - - -Default Value: 10 -_(Font size of 10 will be used to render text.)_ - -The size of the shield text in pixels. -* * * - -##### shield-fill `color` - - - -Default Value: black -_(The shield text will be rendered black.)_ - -The color of the shield text. -* * * - -##### shield-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point -_(One shield will be placed per geometry.)_ - -How this shield should be placed. Point placement places one shield on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. -* * * - -##### shield-avoid-edges `boolean` - - - -Default Value: false -_(Shields will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)_ - -Avoid placing shields that intersect with tile boundaries. -* * * - -##### shield-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow shields to overlap with other map elements already placed.)_ - -Control whether overlapping shields are shown or hidden. -* * * - -##### shield-margin `float` - - - -Default Value: 0 -_(No extra margin will be used to determine if a shield collides with any other text, shield, or marker.)_ - -Minimum distance that a shield can be placed from any other text, shield, or marker. -* * * - -##### shield-repeat-distance `float` - - - -Default Value: 0 -_(Shields with the same text will be rendered without restriction.)_ - -Minimum distance between repeated shields. If set this will prevent shields being rendered nearby each other that contain the same text. Similiar to shield-min-distance with the difference that it works the same no matter what placement strategy is used. -* * * - -##### shield-min-distance `float` - - - -Default Value: 0 -_(Shields with the same text will be rendered without restriction.)_ - -Minimum distance to the next shield with the same text. Only works for line placement. -* * * - -##### shield-spacing `float` - - - -Default Value: 0 -_(Only one shield per line will attempt to be placed.)_ - -Distance the renderer should use to try to place repeated shields on a line. -* * * - -##### shield-min-padding `float` - - - -Default Value: 0 -_(No margin will be used to detect if a shield is nearby a tile boundary.)_ - -Minimum distance a shield will be placed from the edge of a tile. This option is similiar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. -* * * - -##### shield-label-position-tolerance `float` - - - -Default Value: shield-spacing/2.0 -_(If a shield cannot be placed then the renderer will advance by shield-spacing/2.0 to try placement again.)_ - -Allows the shield to be displaced from its ideal position by a number of pixels (only works with placement:line). -* * * - -##### shield-wrap-width `unsigned` - - - -Default Value: 0 -_(Text will not be wrapped.)_ - -Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. -* * * - -##### shield-wrap-before `boolean` - - - -Default Value: false -_(Wrapped lines will be a bit longer than wrap-width.)_ - -Wrap text before wrap-width is reached. -* * * - -##### shield-wrap-character `string` - - - -Default Value: " " -_(Lines will be wrapped when whitespace is encountered.)_ - -Use this character instead of a space to wrap long names. -* * * - -##### shield-halo-fill `color` - - - -Default Value: white -_(The shield halo text will be rendered white.)_ - -Specifies the color of the halo around the text. -* * * - -##### shield-halo-radius `float` - - - -Default Value: 0 -_(no halo.)_ - -Specify the radius of the halo in pixels. -* * * - -##### shield-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The shield will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### shield-halo-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation.)_ - -Transform shield halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. -* * * - -##### shield-halo-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### shield-halo-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text halo. -* * * - -##### shield-character-spacing `unsigned` - - - -Default Value: 0 -_(The default character spacing of the font will be used.)_ - -Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. -* * * - -##### shield-line-spacing `unsigned` - - - -Default Value: 0 -_(The default font spacing will be used.)_ - -Vertical spacing between lines of multiline labels (in pixels). -* * * - -##### shield-text-dx `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right. -* * * - -##### shield-text-dy `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down. -* * * - -##### shield-dx `float` - - - -Default Value: 0 -_(Shield will not be displaced.)_ - -Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right. -* * * - -##### shield-dy `float` - - - -Default Value: 0 -_(Shield will not be displaced.)_ - -Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down. -* * * - -##### shield-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the image used for the shield. -* * * - -##### shield-text-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the text placed on top of the shield. -* * * - -##### shield-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: auto -_(TODO.)_ - -The shield's horizontal alignment from its centerpoint. -* * * - -##### shield-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: middle -_(TODO.)_ - -The shield's vertical alignment from its centerpoint. -* * * - -##### shield-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy -_(Alternative placements will not be enabled.)_ - -Re-position and/or re-size shield to avoid overlaps. "simple" for basic algorithm (using shield-placements string,) "dummy" to turn this feature off. -* * * - -##### shield-placements `string` - - - -Default Value: -_(No alternative placements will be used.)_ - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `shield-placements: "E,NE,SE,W,NW,SW";`. -* * * - -##### shield-text-transform `keyword` -`none``uppercase``lowercase``capitalize``reverse` - - -Default Value: none -_(No text transformation will be applied.)_ - -Transform the case of the characters. -* * * - -##### shield-justify-alignment `keyword` -`left``center``right``auto` - - -Default Value: auto -_(TODO.)_ - -Define how text in a shield's label is justified. -* * * - -##### shield-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform shield instance with specified function. Ignores map scale factor. -* * * - -##### shield-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### shield-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify the geometries used for shield placement by the given tolerance. -* * * - -##### shield-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify the geometries used for shield placement by the given algorithm. -* * * - -##### shield-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out the angles of the geometry used for shield placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### shield-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line-pattern - -##### line-pattern-file `uri` - - - -Default Value: none - - -An image file to be repeated and warped along a line. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### line-pattern-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### line-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications.)_ - -Apply an opacity level to the image used for the pattern. -* * * - -##### line-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### line-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### line-pattern-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-pattern-offset `float` - - - -Default Value: 0 -_(The line will not be offset.)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform line geometry with specified function and apply pattern to transformed geometry. -* * * - -##### line-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## polygon-pattern - -##### polygon-pattern-file `uri` - - - -Default Value: none - - -Image to use as a repeated pattern fill within a polygon. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### polygon-pattern-alignment `keyword` -`global``local` - - -Default Value: global -_(Patterns will be aligned to the map (or tile boundaries) when being repeated across polygons. This is ideal for seamless patterns in tiled rendering.)_ - -Specify whether to align pattern fills to the layer's geometry (local) or to the map (global). -* * * - -##### polygon-pattern-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of polygon pattern edges. -* * * - -##### polygon-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications.)_ - -Apply an opacity level to the image used for the pattern. -* * * - -##### polygon-pattern-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### polygon-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### polygon-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### polygon-pattern-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform polygon geometry with specified function and apply pattern to transformed geometry. -* * * - -##### polygon-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## raster - -##### raster-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the raster symbolizer on top of other symbolizers. -* * * - -##### raster-filter-factor `float` - - - -Default Value: -1 -_(Allow the datasource to choose appropriate downscaling.)_ - -This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. -* * * - -##### raster-scaling `keyword` -`near``fast``bilinear``bicubic``spline16``spline36``hanning``hamming``hermite``kaiser``quadric``catrom``gaussian``bessel``mitchell``sinc``lanczos``blackman` - - -Default Value: near -_(Nearest neighboor resampling will be used to scale the image to the target size of the map.)_ - -The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. -* * * - -##### raster-mesh-size `unsigned` - - - -Default Value: 16 -_(Reprojection mesh will be 1/16 of the resolution of the source image.)_ - -A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. -* * * - -##### raster-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### raster-colorizer-default-mode `keyword` -`discrete``linear``exact` - - -Default Value: linear -_(A linear interpolation is used to generate colors between the two nearest stops.)_ - -This can be either `discrete`, `linear` or `exact`. If it is not specified then the default is `linear`. -* * * - -##### raster-colorizer-default-color `color` - - - -Default Value: transparent -_(Pixels that are not colored by the colorizer stops will be transparent.)_ - -This can be any color. Sets the color that is applied to all values outside of the range of the colorizer-stops. If not supplied pixels will be fully transparent. -* * * - -##### raster-colorizer-epsilon `float` - - - -Default Value: 1.1920928955078125e-07 -_(Pixels must very closely match the stop filter otherwise they will not be colored.)_ - -This can be any positive floating point value and will be used as a tolerance in floating point comparisions. The higher the value the more likely a stop will match and color data. -* * * - -##### raster-colorizer-stops `tags` - - - -Default Value: -_(No colorization will happen without supplying stops.)_ - -Assigns raster data values to colors. Stops must be listed in ascending order, and contain at a minimum the value and the associated color. You can also include the color-mode as a third argument, like `stop(100,#fff,exact)`. -* * * - - -## point - -##### point-file `uri` - - - -Default Value: none -_(A 4x4 black square will be rendered.)_ - -Image file to represent a point. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### point-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow points to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping points are shown or hidden. -* * * - -##### point-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache.)_ - -Control whether the placement of the feature will prevent the placement of other features. -* * * - -##### point-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A value from 0 to 1 to control the opacity of the point. -* * * - -##### point-placement `keyword` -`centroid``interior` - - -Default Value: centroid -_(The centroid of the geometry will be used to place the point.)_ - -Control how this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. -* * * - -##### point-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform point instance with specified function. Ignores map scale factor. -* * * - -##### point-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## text - -##### text-name `string` - - - -Default Value: none - - -Value to use for a text label. Data columns are specified using brackets like [column_name]. -* * * - -##### text-face-name `string` - - - -Default Value: none - - -Font name and style to render a label in. -* * * - -##### text-size `float` - - - -Default Value: 10 -_(Font size of 10 will be used to render text.)_ - -Text size in pixels. -* * * - -##### text-ratio `unsigned` - - - -Default Value: 0 -_(TODO.)_ - -Define the amount of text (of the total) present on successive lines when wrapping occurs. -* * * - -##### text-wrap-width `unsigned` - - - -Default Value: 0 -_(Text will not be wrapped.)_ - -Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. -* * * - -##### text-wrap-before `boolean` - - - -Default Value: false -_(Wrapped lines will be a bit longer than wrap-width.)_ - -Wrap text before wrap-width is reached. -* * * - -##### text-wrap-character `string` - - - -Default Value: " " -_(Lines will be wrapped when whitespace is encountered.)_ - -Use this character instead of a space to wrap long text. -* * * - -##### text-repeat-wrap-character `boolean` - - - -Default Value: false -_(Character will be removed when used to wrap a line.)_ - -Keep the character used to wrap a line instead of removing it, and repeat it on the new line. -* * * - -##### text-spacing `unsigned` - - - -Default Value: 0 -_(Only one label per line will attempt to be placed.)_ - -Distance the renderer should use to try to place repeated text labels on a line. -* * * - -##### text-character-spacing `float` - - - -Default Value: 0 -_(The default character spacing of the font will be used.)_ - -Horizontal spacing adjustment between characters in pixels. This value is ignored when `horizontal-alignment` is set to `adjust`. Typographic ligatures are turned off when this value is greater than zero. -* * * - -##### text-line-spacing `unsigned` - - - -Default Value: 0 -_(The default font spacing will be used.)_ - -Vertical spacing adjustment between lines in pixels. -* * * - -##### text-label-position-tolerance `float` - - - -Default Value: text-spacing/2.0 -_(If a shield cannot be placed then the renderer will advance by text-spacing/2.0 to try placement again.)_ - -Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line). -* * * - -##### text-max-char-angle-delta `float` - - - -Default Value: 22.5 -_(The label will not be placed if a character falls on a line with an angle sharper than 22.5 degrees.)_ - -The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. -* * * - -##### text-fill `color` - - - -Default Value: black -_(The text will be rendered black.)_ - -Specifies the color for the text. -* * * - -##### text-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text. -* * * - -##### text-halo-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text halo. -* * * - -##### text-halo-fill `color` - - - -Default Value: white -_(The halo will be rendered white.)_ - -Specifies the color of the halo around the text. -* * * - -##### text-halo-radius `float` - - - -Default Value: 0 -_(no halo.)_ - -Specify the radius of the halo in pixels. -* * * - -##### text-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The text will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### text-halo-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation.)_ - -Transform text halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. -* * * - -##### text-dx `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text by fixed amount, in pixels, +/- along the X axis. With "dummy" placement-type, a positive value displaces to the right. With "simple" placement-type, it is either left, right or unchanged, depending on the placement selected. Any non-zero value implies "horizontal-alignment" changes to "left" by default. Has no effect with 'line' text-placement-type. -* * * - -##### text-dy `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text by fixed amount, in pixels, +/- along the Y axis. With "dummy" placement-type, a positive value displaces downwards. With "simple" placement-type, it is either up, down or unchanged, depending on the placement selected. With "line" placement-type, a positive value displaces above the path. -* * * - -##### text-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: auto -_(Default affected by value of dy; "top" for dy>0, "bottom" for dy<0.)_ - -Position of label relative to point position. -* * * - -##### text-avoid-edges `boolean` - - - -Default Value: false -_(Text will be potentially placed near tile edges and therefore may look cut off unless the same text label is rendered on each adjacent tile.)_ - -Avoid placing labels that intersect with tile boundaries. -* * * - -##### text-margin `float` - - - -Default Value: 0 -_(No extra margin will be used to determine if a label collides with any other text, shield, or marker.)_ - -Minimum distance that a label can be placed from any other text, shield, or marker. -* * * - -##### text-repeat-distance `float` - - - -Default Value: 0 -_(Labels with the same text will be rendered without restriction.)_ - -Minimum distance between repeated text. If set this will prevent text labels being rendered nearby each other that contain the same text. Similiar to text-min-distance with the difference that it works the same no matter what placement strategy is used. -* * * - -##### text-min-distance `float` - - - -Default Value: 0 -_(Labels with the same text will be rendered without restriction.)_ - -Minimum distance to the next label with the same text. Only works for line placement. Deprecated: replaced by `text-repeat-distance` and `text-margin` -* * * - -##### text-min-padding `float` - - - -Default Value: 0 -_(No margin will be used to detect if a text label is nearby a tile boundary.)_ - -Minimum distance a text label will be placed from the edge of a tile. This option is similiar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. -* * * - -##### text-min-path-length `float` - - - -Default Value: 0 -_(place labels on all geometries no matter how small they are.)_ - -Place labels only on polygons and lines with a bounding width longer than this value (in pixels). -* * * - -##### text-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow text to overlap with other text - overlapping markers will not be shown.)_ - -Control whether overlapping text is shown or hidden. -* * * - -##### text-orientation `float` - - - -Default Value: 0 -_(Text is not rotated and is displayed upright.)_ - -Rotate the text. (only works with text-placement:point). -* * * - -##### text-rotate-displacement `boolean` - - - -Default Value: false -_(Label center is used for rotation.)_ - -Rotates the displacement around the placement origin by the angle given by "orientation". -* * * - -##### text-upright `keyword` -`auto``auto-down``left``right``left-only``right-only` - - -Default Value: auto -_(Text will be positioned upright automatically.)_ - -How this label should be placed along lines. By default when more than half of a label's characters are upside down the label is automatically flipped to keep it upright. By changing this parameter you can prevent this "auto-upright" behavior. The "auto-down" value places text in the opposite orientation to "auto". The "left" or "right" settings can be used to force text to always be placed along a line in a given direction and therefore disables flipping if text appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down text rather than trying to flip it. -* * * - -##### text-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point -_(One shield will be placed per geometry.)_ - -How this label should be placed. Point placement places one label on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. -* * * - -##### text-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy -_(Alternative placements will not be enabled.)_ - -Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. -* * * - -##### text-placements `string` - - - -Default Value: -_(No alternative placements will be used.)_ - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `text-placements: "E,NE,SE,W,NW,SW";`. -* * * - -##### text-transform `keyword` -`none``uppercase``lowercase``capitalize``reverse` - - -Default Value: none -_(Transform text instance with specified function. Ignores map scale factor.)_ - -Transform the case of the characters. -* * * - -##### text-horizontal-alignment `keyword` -`left``middle``right``auto``adjust` - - -Default Value: auto -_(TODO.)_ - -The text's horizontal alignment from it's centerpoint. If `placement` is set to `line`, then `adjust` can be set to auto-fit the text to the length of the path by dynamically calculating `character-spacing`. -* * * - -##### text-align `keyword` -`left``right``center``auto` - - -Default Value: auto -_(Auto alignment means that text will be centered by default except when using the `placement-type` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the `text-placements` directives.)_ - -Define how text is justified. -* * * - -##### text-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### text-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify the geometries used for text placement by the given tolerance. -* * * - -##### text-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify the geometries used for text placement by the given algorithm. -* * * - -##### text-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out the angles of the geometry used for text placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### text-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### text-halo-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### text-font-feature-settings `string` - - - -Default Value: -_(Default set of typographic features recommended by OpenType specification. Ligatures are turned off by default when `character-spacing` is greater than zero.)_ - -Comma separated list of OpenType typographic features. The syntax and semantics conforms to `font-feature-settings` from W3C CSS. -* * * - -##### text-largest-bbox-only `boolean` - - - -Default Value: true -_(For multipolygons only polygon with largest bbox area is labeled (does not apply to other geometries).)_ - -Controls default labeling behavior on multipolygons. The default is true and means that only the polygon with largest bbox is labeled. -* * * - - -## building - -##### building-fill `color` - - - -Default Value: The color gray will be used for fill. -_(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)_ - -The color of the buildings fill. Note: 0.8 will be used to multiply each color component to auto-generate a darkened wall color. -* * * - -##### building-fill-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the building as a whole, including all walls. -* * * - -##### building-height `float` - - - -Default Value: 0 -_(Buildings will not have a visual height and will instead look like flat polygons.)_ - -The height of the building in pixels. -* * * - - -## debug - -##### debug-mode `string` - - - -Default Value: collision -_(The otherwise invisible collision boxes will be rendered as squares on the map.)_ - -The mode for debug rendering. -* * * - - -## dot - -##### dot-fill `color` - - - -Default Value: gray -_(The dot fill color is gray.)_ - -The color of the area of the dot. -* * * - -##### dot-opacity `float` - - - -Default Value: 1 -_(The opacity of the dot.)_ - -The overall opacity of the dot. -* * * - -##### dot-width `float` - - - -Default Value: 1 -_(The marker width is 1 pixel.)_ - -The width of the dot in pixels. -* * * - -##### dot-height `float` - - - -Default Value: 1 -_(The marker height is 1 pixels.)_ - -The height of the dot in pixels. -* * * - -##### dot-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current layer on top of other layers.)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - - - - -### Values - -Below is a list of values and an explanation of any expression that can be applied to properties in CartCSS. - -### Color - -CartoCSS accepts a variety of syntaxes for colors - HTML-style hex values, rgb, rgba, hsl, hsla, husl, and husla. It also supports the predefined HTML colors names, like `yellow` and `blue`. - -``` css -#line { -line-color: #ff0; -line-color: #ffff00; -line-color: rgb(255, 255, 0); -line-color: rgba(255, 255, 0, 1); -line-color: hsl(100, 50%, 50%); -line-color: hsla(100, 50%, 50%, 1); -line-color: husl(100, 50%, 50%); // same values yield different color than HSL -line-color: husla(100, 50%, 50%, 1); -line-color: yellow; -} -``` - -Especially of note is the support for hsl and husl, which can be [easier to reason about than rgb()](http://mothereffinghsl.com/). Carto also includes several color operation functions [borrowed from less](http://lesscss.org/functions/#color-operations): - -``` css -// lighten and darken colors -lighten(#ace, 10%); -darken(#ace, 10%); - -// saturate and desaturate -saturate(#550000, 10%); -desaturate(#00ff00, 10%); - -// increase or decrease the opacity of a color -fadein(#fafafa, 10%); -fadeout(#fefefe, 14%); - -// spin rotates a color around the color wheel by degrees -spin(#ff00ff, 10); - -// mix generates a color in between two other colors. -mix(#fff, #000, 50%); - -// get color components -hue(#ff00ff); -saturation(#ff00ff); -lightness(#ff00ff); -alpha(hsla(100, 50%, 50%, 0.5)); -``` - -These functions all take arguments which can be color variables, literal colors, or the results of other functions operating on colors. All the above mentioned functions also come in -a `functionp`-variant (e.g. `lightenp`), which force a given color into perceptual color space. - -### Float - -Float is a fancy way of saying 'number'. In CartoCSS, you specify _just a number_ - unlike CSS, there are no units, but everything is specified in pixels. - -``` css -#line { -line-width: 2; -} -``` - -It's also possible to do simple math with number values: - -``` css -#line { -line-width: 4 / 2; // division -line-width: 4 + 2; // addition -line-width: 4 - 2; // subtraction -line-width: 4 * 2; // multiplication -line-width: 4 % 2; // modulus -} -``` - -### URI - -URI is a fancy way of saying URL. When an argument is a URI, you use the same kind of `url('place.png')` notation that you would with HTML. Quotes around the URL aren't required, but are highly recommended. URIs can be paths to places on your computer, or on the internet. - -```css -#markers { -marker-file: url('marker.png'); -} -``` - -### String - -A string is basically just text. In the case of CartoCSS, you're going to put it in quotes. Strings can be anything, though pay attention to the cases of `text-name` and `shield-name` - they actually will refer to features, which you refer to by putting them in brackets, as seen in the example below. - -```css -#labels { -text-name: "[MY_FIELD]"; -} -``` - -### Boolean - -Boolean means yes or no, so it accepts the values `true` or `false`. - -```css -#markers { -marker-allow-overlap:true; -} -``` - -### Expressions - -Expressions are statements that can include fields, numbers, and other types in a really flexible way. You have run into expressions before, in the realm of 'fields', where you'd specify `"[FIELD]"`, but expressions allow you to drop the quotes and also do quick addition, division, multiplication, and concatenation from within Carto syntax. - -```css -#buildings { -building-height: [HEIGHT_FIELD] * 10; -} -``` - -### Numbers -Numbers are comma-separated lists of one or more number in a specific order. They're used in line dash arrays, in which the numbers specify intervals of line, break, and line again. - -```css -#disputedboundary { -line-dasharray: 1, 4, 2; -} -``` - -### Percentages -In Carto, the percentage symbol, `%` universally means `value/100`. It's meant to be used with ratio-related properties, like opacity rules. - -_You should not use percentages as widths, heights, or other properties - unlike CSS, percentages are not relative to cascaded classes or page size, they're, as stated, simply the value divided by one hundred._ - -```css -#world { -// this syntax -polygon-opacity: 50%; - -// is equivalent to -polygon-opacity: 0.5; -} -``` - -### Functions - -Functions are comma-separated lists of one or more functions. For instance, transforms use the `functions` type to allow for transforms within Carto, which are optionally chainable. - -```css -#point { -point-transform: scale(2, 2); -} -``` diff --git a/docs/3.0.7.md b/docs/3.0.7.md deleted file mode 100644 index ad7ed30..0000000 --- a/docs/3.0.7.md +++ /dev/null @@ -1,2226 +0,0 @@ -# Carto documentation - -The following is a list of properties provided in CartoCSS that you can apply to map elements. - -## All elements - -##### image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``color-blind-protanope``color-blind-deuteranope``color-blind-tritanope``colorize-alpha``color-to-alpha``scale-hsla` - -Default Value: none -_(no filters.)_ - -A list of image filters that will be applied to the active rendering canvas for a given style. The presence of one more `image-filters` will trigger a new canvas to be created before starting to render a style and then this canvas will be composited back into the main canvas after rendering all features and after all `image-filters` have been applied. See `direct-image-filters` if you want to apply a filter directly to the main canvas. -* * * - -##### image-filters-inflate `boolean` - - - -Default Value: false -_(No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary.)_ - -A property that can be set to true to enable using an inflated image internally for seamless blurring across tiles (requires buffered data). -* * * - -##### direct-image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``color-blind-protanope``color-blind-deuteranope``color-blind-tritanope``colorize-alpha``color-to-alpha``scale-hsla` - -Default Value: none -_(no filters.)_ - -A list of image filters to apply to the main canvas (see the `image-filters` doc for how they work on a separate canvas). -* * * - -##### comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current layer on top of other layers.)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - -##### opacity `float` - - - -Default Value: 1 -_(No separate buffer will be used and no alpha will be applied to the style after rendering.)_ - -An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer). -* * * - - -## map - -##### background-color `color` - - - -Default Value: none -_(Will be rendered transparent.)_ - -Map Background color. -* * * - -##### background-image `uri` - - - -Default Value: -_(No background image will be used.)_ - -An image that is repeated below all features on a map as a background. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### background-image-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(The background-image will be blended with the background normally (placed on top of any existing background-color).)_ - -Set the compositing operation used to blend the image into the background. -* * * - -##### background-image-opacity `float` - - - -Default Value: 1 -_(The image opacity will not be changed when applied to the map background.)_ - -Set the opacity of the image. -* * * - -##### srs `string` - - - -Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs -_(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space.)_ - -Map spatial reference (proj4 string). -* * * - -##### buffer-size `float` - - - -Default Value: 0 -_(No buffer will be used.)_ - -Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". -* * * - -##### maximum-extent `string` - - - -Default Value: -20037508.34,-20037508.34,20037508.34,20037508.34 -_(All data will be clipped to global mercator extent (default is applied in Carto.js).)_ - -An extent to be used to limit the bounds used to query all layers during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Map. -* * * - -##### base `string` - - - -Default Value: -_(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)_ - -Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. -* * * - -##### font-directory `uri` - - - -Default Value: none -_(No map-specific fonts will be registered.)_ - -Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). -* * * - - -## polygon - -##### polygon-fill `color` - - - -Default Value: The color gray will be used for fill. -_(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)_ - -Fill color to assign to a polygon. -* * * - -##### polygon-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the polygon. -* * * - -##### polygon-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of polygon edges. -* * * - -##### polygon-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. -* * * - -##### polygon-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extend outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### polygon-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify geometries by the given tolerance. -* * * - -##### polygon-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify geometries by the given algorithm. -* * * - -##### polygon-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform polygon geometry with specified function. -* * * - -##### polygon-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line - -##### line-color `color` - - - -Default Value: black -_(black and fully opaque (alpha = 1), same as rgb(0,0,0) or rgba(0,0,0,1).)_ - -The color of a drawn line. -* * * - -##### line-width `float` - - - -Default Value: 1 -_(The line will be rendered 1 pixel wide.)_ - -The width of a line in pixels. -* * * - -##### line-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of a line. -* * * - -##### line-join `keyword` -`miter``miter-revert``round``bevel` - - -Default Value: miter -_(The line joins will be rendered using a miter look.)_ - -The behavior of lines when joining. -* * * - -##### line-cap `keyword` -`butt``round``square` - - -Default Value: butt -_(The line endings will be rendered using a butt look.)_ - -The display of line endings. -* * * - -##### line-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of stroke line. -* * * - -##### line-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. -* * * - -##### line-dasharray `numbers` - - - -Default Value: none -_(The line will be drawn without dashes.)_ - -A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. -* * * - -##### line-dash-offset `numbers` - - - -Default Value: none -_(The line will be drawn without dashes.)_ - -Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled). -* * * - -##### line-miterlimit `float` - - - -Default Value: 4 -_(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )'.)_ - -The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. -* * * - -##### line-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### line-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify geometries by the given tolerance. -* * * - -##### line-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify geometries by the given algorithm. -* * * - -##### line-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-offset `float` - - - -Default Value: 0 -_(Will not be offset.)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The line will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. -* * * - -##### line-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform line geometry with specified function. -* * * - -##### line-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## markers - -##### marker-file `uri` - - - -Default Value: none -_(An ellipse or circle, if width equals height.)_ - -A file that this marker shows at each placement. If no file is given, the marker will show an ellipse. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### marker-opacity `float` - - - -Default Value: 1 -_(The stroke-opacity and fill-opacity of the marker.)_ - -The overall opacity of the marker, if set, overrides both the opacity of both the fill and stroke. -* * * - -##### marker-fill-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The fill opacity of the marker. -* * * - -##### marker-line-color `color` - - - -Default Value: black -_(The marker will be drawn with a black outline.)_ - -The color of the stroke around the marker. -* * * - -##### marker-line-width `float` - - - -Default Value: 0.5 -_(The marker will be drawn with an outline of .5 pixels wide.)_ - -The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. -* * * - -##### marker-line-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of a line. -* * * - -##### marker-placement `keyword` -`point``line``interior``vertex-first``vertex-last` - - -Default Value: point -_(Place markers at the center point (centroid) of the geometry.)_ - -Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior. The 'vertex-first' and 'vertex-last' options can be used to place markers at the first or last vertex of lines or polygons. -* * * - -##### marker-multi-policy `keyword` -`each``whole``largest` - - -Default Value: each -_(If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each.)_ - -A special setting to allow the user to control rendering behavior for 'multi-geometries' (when a feature contains multiple geometries). This setting does not apply to markers placed along lines. The 'each' policy is default and means all geometries will get a marker. The 'whole' policy means that the aggregate centroid between all geometries will be used. The 'largest' policy means that only the largest (by bounding box areas) feature will get a rendered marker (this is how text labeling behaves by default). -* * * - -##### marker-type `keyword` -`arrow``ellipse` - - -Default Value: ellipse -_(The marker shape is an ellipse.)_ - -The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width). -* * * - -##### marker-width `float` - - - -Default Value: 10 -_(The marker width is 10 pixels.)_ - -The width of the marker, if using one of the default types. -* * * - -##### marker-height `float` - - - -Default Value: 10 -_(The marker height is 10 pixels.)_ - -The height of the marker, if using one of the default types. -* * * - -##### marker-fill `color` - - - -Default Value: blue -_(The marker fill color is blue.)_ - -The color of the area of the marker. -* * * - -##### marker-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow markers to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping markers are shown or hidden. -* * * - -##### marker-avoid-edges `boolean` - - - -Default Value: false -_(Markers will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)_ - -Avoid placing markers that intersect with tile boundaries. -* * * - -##### marker-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache.)_ - -Value to control whether the placement of the feature will prevent the placement of other features. -* * * - -##### marker-spacing `float` - - - -Default Value: 100 -_(In the case of marker-placement:line then draw a marker every 100 pixels along a line.)_ - -Space between repeated markers in pixels. If the spacing is less than the marker size or larger than the line segment length then no marker will be placed. Any value less than 1 will be ignored and the default will be used instead. -* * * - -##### marker-max-error `float` - - - -Default Value: 0.2 -_(N/A: not intended to be changed.)_ - -N/A: not intended to be changed. -* * * - -##### marker-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform marker instance with specified function. Ignores map scale factor. -* * * - -##### marker-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### marker-simplify `float` - - - -Default Value: 0 -_(Geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### marker-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### marker-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### marker-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform marker geometry with specified function. -* * * - -##### marker-offset `float` - - - -Default Value: 0 -_(Will not be offset.)_ - -Offsets a marker from a line a number of pixels parallel to its actual path. Positive values move the marker left, negative values move it right (relative to the directionality of the line). -* * * - -##### marker-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### marker-direction `keyword` -`auto``auto-down``left``right``left-only``right-only``up``down` - - -Default Value: right -_(Markers are oriented to the right in the line direction.)_ - -How markers should be placed along lines. With the "auto" setting when marker is upside down the marker is automatically rotated by 180 degrees to keep it upright. The "auto-down" value places marker in the opposite orientation to "auto". The "left" or "right" settings can be used to force marker to always be placed along a line in a given direction and therefore disables rotating if marker appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down markers rather than trying to flip it. The "up" and "down" settings don't adjust marker's orientation to the line direction. -* * * - - -## shield - -##### shield-name `string` - - - -Default Value: -_(No text label will be rendered with the shield.)_ - -Value to use for a shield"s text label. Data columns are specified using brackets like [column_name]. -* * * - -##### shield-file `uri` - - - -Default Value: none - - -Image file to render behind the shield text. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### shield-face-name `string` - - - -Default Value: none - - -Font name and style to use for the shield text. -* * * - -##### shield-unlock-image `boolean` - - - -Default Value: false -_(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)_ - -This parameter should be set to true if you are trying to position text beside rather than on top of the shield image. -* * * - -##### shield-size `float` - - - -Default Value: 10 -_(Font size of 10 will be used to render text.)_ - -The size of the shield text in pixels. -* * * - -##### shield-fill `color` - - - -Default Value: black -_(The shield text will be rendered black.)_ - -The color of the shield text. -* * * - -##### shield-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point -_(One shield will be placed per geometry.)_ - -How this shield should be placed. Point placement places one shield on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. -* * * - -##### shield-avoid-edges `boolean` - - - -Default Value: false -_(Shields will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)_ - -Avoid placing shields that intersect with tile boundaries. -* * * - -##### shield-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow shields to overlap with other map elements already placed.)_ - -Control whether overlapping shields are shown or hidden. -* * * - -##### shield-margin `float` - - - -Default Value: 0 -_(No extra margin will be used to determine if a shield collides with any other text, shield, or marker.)_ - -Minimum distance that a shield can be placed from any other text, shield, or marker. -* * * - -##### shield-repeat-distance `float` - - - -Default Value: 0 -_(Shields with the same text will be rendered without restriction.)_ - -Minimum distance between repeated shields. If set this will prevent shields being rendered nearby each other that contain the same text. Similiar to shield-min-distance with the difference that it works the same no matter what placement strategy is used. -* * * - -##### shield-min-distance `float` - - - -Default Value: 0 -_(Shields with the same text will be rendered without restriction.)_ - -Minimum distance to the next shield with the same text. Only works for line placement. -* * * - -##### shield-spacing `float` - - - -Default Value: 0 -_(Only one shield per line will attempt to be placed.)_ - -Distance the renderer should use to try to place repeated shields on a line. -* * * - -##### shield-min-padding `float` - - - -Default Value: 0 -_(No margin will be used to detect if a shield is nearby a tile boundary.)_ - -Minimum distance a shield will be placed from the edge of a tile. This option is similiar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. -* * * - -##### shield-label-position-tolerance `float` - - - -Default Value: shield-spacing/2.0 -_(If a shield cannot be placed then the renderer will advance by shield-spacing/2.0 to try placement again.)_ - -Allows the shield to be displaced from its ideal position by a number of pixels (only works with placement:line). -* * * - -##### shield-wrap-width `unsigned` - - - -Default Value: 0 -_(Text will not be wrapped.)_ - -Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. -* * * - -##### shield-wrap-before `boolean` - - - -Default Value: false -_(Wrapped lines will be a bit longer than wrap-width.)_ - -Wrap text before wrap-width is reached. -* * * - -##### shield-wrap-character `string` - - - -Default Value: " " -_(Lines will be wrapped when whitespace is encountered.)_ - -Use this character instead of a space to wrap long names. -* * * - -##### shield-halo-fill `color` - - - -Default Value: white -_(The shield halo text will be rendered white.)_ - -Specifies the color of the halo around the text. -* * * - -##### shield-halo-radius `float` - - - -Default Value: 0 -_(no halo.)_ - -Specify the radius of the halo in pixels. -* * * - -##### shield-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The shield will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### shield-halo-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation.)_ - -Transform shield halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. -* * * - -##### shield-halo-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### shield-halo-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text halo. -* * * - -##### shield-character-spacing `unsigned` - - - -Default Value: 0 -_(The default character spacing of the font will be used.)_ - -Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. -* * * - -##### shield-line-spacing `unsigned` - - - -Default Value: 0 -_(The default font spacing will be used.)_ - -Vertical spacing between lines of multiline labels (in pixels). -* * * - -##### shield-text-dx `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right. -* * * - -##### shield-text-dy `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down. -* * * - -##### shield-dx `float` - - - -Default Value: 0 -_(Shield will not be displaced.)_ - -Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right. -* * * - -##### shield-dy `float` - - - -Default Value: 0 -_(Shield will not be displaced.)_ - -Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down. -* * * - -##### shield-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the image used for the shield. -* * * - -##### shield-text-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the text placed on top of the shield. -* * * - -##### shield-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: auto -_(TODO.)_ - -The shield's horizontal alignment from its centerpoint. -* * * - -##### shield-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: middle -_(TODO.)_ - -The shield's vertical alignment from its centerpoint. -* * * - -##### shield-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy -_(Alternative placements will not be enabled.)_ - -Re-position and/or re-size shield to avoid overlaps. "simple" for basic algorithm (using shield-placements string,) "dummy" to turn this feature off. -* * * - -##### shield-placements `string` - - - -Default Value: -_(No alternative placements will be used.)_ - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `shield-placements: "E,NE,SE,W,NW,SW";`. -* * * - -##### shield-text-transform `keyword` -`none``uppercase``lowercase``capitalize``reverse` - - -Default Value: none -_(No text transformation will be applied.)_ - -Transform the case of the characters. -* * * - -##### shield-justify-alignment `keyword` -`left``center``right``auto` - - -Default Value: auto -_(TODO.)_ - -Define how text in a shield's label is justified. -* * * - -##### shield-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform shield instance with specified function. Ignores map scale factor. -* * * - -##### shield-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### shield-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify the geometries used for shield placement by the given tolerance. -* * * - -##### shield-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify the geometries used for shield placement by the given algorithm. -* * * - -##### shield-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out the angles of the geometry used for shield placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### shield-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line-pattern - -##### line-pattern-file `uri` - - - -Default Value: none - - -An image file to be repeated and warped along a line. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### line-pattern-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### line-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications.)_ - -Apply an opacity level to the image used for the pattern. -* * * - -##### line-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### line-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### line-pattern-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-pattern-offset `float` - - - -Default Value: 0 -_(The line will not be offset.)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform line geometry with specified function and apply pattern to transformed geometry. -* * * - -##### line-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## polygon-pattern - -##### polygon-pattern-file `uri` - - - -Default Value: none - - -Image to use as a repeated pattern fill within a polygon. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### polygon-pattern-alignment `keyword` -`global``local` - - -Default Value: global -_(Patterns will be aligned to the map (or tile boundaries) when being repeated across polygons. This is ideal for seamless patterns in tiled rendering.)_ - -Specify whether to align pattern fills to the layer's geometry (local) or to the map (global). -* * * - -##### polygon-pattern-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of polygon pattern edges. -* * * - -##### polygon-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications.)_ - -Apply an opacity level to the image used for the pattern. -* * * - -##### polygon-pattern-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### polygon-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### polygon-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### polygon-pattern-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform polygon geometry with specified function and apply pattern to transformed geometry. -* * * - -##### polygon-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## raster - -##### raster-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the raster symbolizer on top of other symbolizers. -* * * - -##### raster-filter-factor `float` - - - -Default Value: -1 -_(Allow the datasource to choose appropriate downscaling.)_ - -This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. -* * * - -##### raster-scaling `keyword` -`near``fast``bilinear``bicubic``spline16``spline36``hanning``hamming``hermite``kaiser``quadric``catrom``gaussian``bessel``mitchell``sinc``lanczos``blackman` - - -Default Value: near -_(Nearest neighboor resampling will be used to scale the image to the target size of the map.)_ - -The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. -* * * - -##### raster-mesh-size `unsigned` - - - -Default Value: 16 -_(Reprojection mesh will be 1/16 of the resolution of the source image.)_ - -A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. -* * * - -##### raster-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### raster-colorizer-default-mode `keyword` -`discrete``linear``exact` - - -Default Value: linear -_(A linear interpolation is used to generate colors between the two nearest stops.)_ - -This can be either `discrete`, `linear` or `exact`. If it is not specified then the default is `linear`. -* * * - -##### raster-colorizer-default-color `color` - - - -Default Value: transparent -_(Pixels that are not colored by the colorizer stops will be transparent.)_ - -This can be any color. Sets the color that is applied to all values outside of the range of the colorizer-stops. If not supplied pixels will be fully transparent. -* * * - -##### raster-colorizer-epsilon `float` - - - -Default Value: 1.1920928955078125e-07 -_(Pixels must very closely match the stop filter otherwise they will not be colored.)_ - -This can be any positive floating point value and will be used as a tolerance in floating point comparisions. The higher the value the more likely a stop will match and color data. -* * * - -##### raster-colorizer-stops `tags` - - - -Default Value: -_(No colorization will happen without supplying stops.)_ - -Assigns raster data values to colors. Stops must be listed in ascending order, and contain at a minimum the value and the associated color. You can also include the color-mode as a third argument, like `stop(100,#fff,exact)`. -* * * - - -## point - -##### point-file `uri` - - - -Default Value: none -_(A 4x4 black square will be rendered.)_ - -Image file to represent a point. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### point-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow points to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping points are shown or hidden. -* * * - -##### point-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache.)_ - -Control whether the placement of the feature will prevent the placement of other features. -* * * - -##### point-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A value from 0 to 1 to control the opacity of the point. -* * * - -##### point-placement `keyword` -`centroid``interior` - - -Default Value: centroid -_(The centroid of the geometry will be used to place the point.)_ - -Control how this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. -* * * - -##### point-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform point instance with specified function. Ignores map scale factor. -* * * - -##### point-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## text - -##### text-name `string` - - - -Default Value: none - - -Value to use for a text label. Data columns are specified using brackets like [column_name]. -* * * - -##### text-face-name `string` - - - -Default Value: none - - -Font name and style to render a label in. -* * * - -##### text-size `float` - - - -Default Value: 10 -_(Font size of 10 will be used to render text.)_ - -Text size in pixels. -* * * - -##### text-ratio `unsigned` - - - -Default Value: 0 -_(TODO.)_ - -Define the amount of text (of the total) present on successive lines when wrapping occurs. -* * * - -##### text-wrap-width `unsigned` - - - -Default Value: 0 -_(Text will not be wrapped.)_ - -Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. -* * * - -##### text-wrap-before `boolean` - - - -Default Value: false -_(Wrapped lines will be a bit longer than wrap-width.)_ - -Wrap text before wrap-width is reached. -* * * - -##### text-wrap-character `string` - - - -Default Value: " " -_(Lines will be wrapped when whitespace is encountered.)_ - -Use this character instead of a space to wrap long text. -* * * - -##### text-repeat-wrap-character `boolean` - - - -Default Value: false -_(Character will be removed when used to wrap a line.)_ - -Keep the character used to wrap a line instead of removing it, and repeat it on the new line. -* * * - -##### text-spacing `unsigned` - - - -Default Value: 0 -_(Only one label per line will attempt to be placed.)_ - -Distance the renderer should use to try to place repeated text labels on a line. -* * * - -##### text-character-spacing `float` - - - -Default Value: 0 -_(The default character spacing of the font will be used.)_ - -Horizontal spacing adjustment between characters in pixels. This value is ignored when `horizontal-alignment` is set to `adjust`. Typographic ligatures are turned off when this value is greater than zero. -* * * - -##### text-line-spacing `unsigned` - - - -Default Value: 0 -_(The default font spacing will be used.)_ - -Vertical spacing adjustment between lines in pixels. -* * * - -##### text-label-position-tolerance `float` - - - -Default Value: text-spacing/2.0 -_(If a shield cannot be placed then the renderer will advance by text-spacing/2.0 to try placement again.)_ - -Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line). -* * * - -##### text-max-char-angle-delta `float` - - - -Default Value: 22.5 -_(The label will not be placed if a character falls on a line with an angle sharper than 22.5 degrees.)_ - -The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. -* * * - -##### text-fill `color` - - - -Default Value: black -_(The text will be rendered black.)_ - -Specifies the color for the text. -* * * - -##### text-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text. -* * * - -##### text-halo-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text halo. -* * * - -##### text-halo-fill `color` - - - -Default Value: white -_(The halo will be rendered white.)_ - -Specifies the color of the halo around the text. -* * * - -##### text-halo-radius `float` - - - -Default Value: 0 -_(no halo.)_ - -Specify the radius of the halo in pixels. -* * * - -##### text-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The text will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### text-halo-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation.)_ - -Transform text halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. -* * * - -##### text-dx `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text by fixed amount, in pixels, +/- along the X axis. With "dummy" placement-type, a positive value displaces to the right. With "simple" placement-type, it is either left, right or unchanged, depending on the placement selected. Any non-zero value implies "horizontal-alignment" changes to "left" by default. Has no effect with 'line' text-placement-type. -* * * - -##### text-dy `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text by fixed amount, in pixels, +/- along the Y axis. With "dummy" placement-type, a positive value displaces downwards. With "simple" placement-type, it is either up, down or unchanged, depending on the placement selected. With "line" placement-type, a positive value displaces above the path. -* * * - -##### text-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: auto -_(Default affected by value of dy; "top" for dy>0, "bottom" for dy<0.)_ - -Position of label relative to point position. -* * * - -##### text-avoid-edges `boolean` - - - -Default Value: false -_(Text will be potentially placed near tile edges and therefore may look cut off unless the same text label is rendered on each adjacent tile.)_ - -Avoid placing labels that intersect with tile boundaries. -* * * - -##### text-margin `float` - - - -Default Value: 0 -_(No extra margin will be used to determine if a label collides with any other text, shield, or marker.)_ - -Minimum distance that a label can be placed from any other text, shield, or marker. -* * * - -##### text-repeat-distance `float` - - - -Default Value: 0 -_(Labels with the same text will be rendered without restriction.)_ - -Minimum distance between repeated text. If set this will prevent text labels being rendered nearby each other that contain the same text. Similiar to text-min-distance with the difference that it works the same no matter what placement strategy is used. -* * * - -##### text-min-distance `float` - - - -Default Value: 0 -_(Labels with the same text will be rendered without restriction.)_ - -Minimum distance to the next label with the same text. Only works for line placement. Deprecated: replaced by `text-repeat-distance` and `text-margin` -* * * - -##### text-min-padding `float` - - - -Default Value: 0 -_(No margin will be used to detect if a text label is nearby a tile boundary.)_ - -Minimum distance a text label will be placed from the edge of a tile. This option is similiar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. -* * * - -##### text-min-path-length `float` - - - -Default Value: 0 -_(place labels on all geometries no matter how small they are.)_ - -Place labels only on polygons and lines with a bounding width longer than this value (in pixels). -* * * - -##### text-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow text to overlap with other text - overlapping markers will not be shown.)_ - -Control whether overlapping text is shown or hidden. -* * * - -##### text-orientation `float` - - - -Default Value: 0 -_(Text is not rotated and is displayed upright.)_ - -Rotate the text. (only works with text-placement:point). -* * * - -##### text-rotate-displacement `boolean` - - - -Default Value: false -_(Label center is used for rotation.)_ - -Rotates the displacement around the placement origin by the angle given by "orientation". -* * * - -##### text-upright `keyword` -`auto``auto-down``left``right``left-only``right-only` - - -Default Value: auto -_(Text will be positioned upright automatically.)_ - -How this label should be placed along lines. By default when more than half of a label's characters are upside down the label is automatically flipped to keep it upright. By changing this parameter you can prevent this "auto-upright" behavior. The "auto-down" value places text in the opposite orientation to "auto". The "left" or "right" settings can be used to force text to always be placed along a line in a given direction and therefore disables flipping if text appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down text rather than trying to flip it. -* * * - -##### text-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point -_(One shield will be placed per geometry.)_ - -How this label should be placed. Point placement places one label on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. -* * * - -##### text-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy -_(Alternative placements will not be enabled.)_ - -Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. -* * * - -##### text-placements `string` - - - -Default Value: -_(No alternative placements will be used.)_ - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `text-placements: "E,NE,SE,W,NW,SW";`. -* * * - -##### text-transform `keyword` -`none``uppercase``lowercase``capitalize``reverse` - - -Default Value: none -_(Transform text instance with specified function. Ignores map scale factor.)_ - -Transform the case of the characters. -* * * - -##### text-horizontal-alignment `keyword` -`left``middle``right``auto``adjust` - - -Default Value: auto -_(TODO.)_ - -The text's horizontal alignment from it's centerpoint. If `placement` is set to `line`, then `adjust` can be set to auto-fit the text to the length of the path by dynamically calculating `character-spacing`. -* * * - -##### text-align `keyword` -`left``right``center``auto` - - -Default Value: auto -_(Auto alignment means that text will be centered by default except when using the `placement-type` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the `text-placements` directives.)_ - -Define how text is justified. -* * * - -##### text-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### text-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify the geometries used for text placement by the given tolerance. -* * * - -##### text-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify the geometries used for text placement by the given algorithm. -* * * - -##### text-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out the angles of the geometry used for text placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### text-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### text-halo-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### text-font-feature-settings `string` - - - -Default Value: -_(Default set of typographic features recommended by OpenType specification. Ligatures are turned off by default when `character-spacing` is greater than zero.)_ - -Comma separated list of OpenType typographic features. The syntax and semantics conforms to `font-feature-settings` from W3C CSS. -* * * - -##### text-largest-bbox-only `boolean` - - - -Default Value: true -_(For multipolygons only polygon with largest bbox area is labeled (does not apply to other geometries).)_ - -Controls default labeling behavior on multipolygons. The default is true and means that only the polygon with largest bbox is labeled. -* * * - - -## building - -##### building-fill `color` - - - -Default Value: The color gray will be used for fill. -_(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)_ - -The color of the buildings fill. Note: 0.8 will be used to multiply each color component to auto-generate a darkened wall color. -* * * - -##### building-fill-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the building as a whole, including all walls. -* * * - -##### building-height `float` - - - -Default Value: 0 -_(Buildings will not have a visual height and will instead look like flat polygons.)_ - -The height of the building in pixels. -* * * - - -## debug - -##### debug-mode `string` - - - -Default Value: collision -_(The otherwise invisible collision boxes will be rendered as squares on the map.)_ - -The mode for debug rendering. -* * * - - -## dot - -##### dot-fill `color` - - - -Default Value: gray -_(The dot fill color is gray.)_ - -The color of the area of the dot. -* * * - -##### dot-opacity `float` - - - -Default Value: 1 -_(The opacity of the dot.)_ - -The overall opacity of the dot. -* * * - -##### dot-width `float` - - - -Default Value: 1 -_(The marker width is 1 pixel.)_ - -The width of the dot in pixels. -* * * - -##### dot-height `float` - - - -Default Value: 1 -_(The marker height is 1 pixels.)_ - -The height of the dot in pixels. -* * * - -##### dot-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current layer on top of other layers.)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - - - - -### Values - -Below is a list of values and an explanation of any expression that can be applied to properties in CartCSS. - -### Color - -CartoCSS accepts a variety of syntaxes for colors - HTML-style hex values, rgb, rgba, hsl, hsla, husl, and husla. It also supports the predefined HTML colors names, like `yellow` and `blue`. - -``` css -#line { -line-color: #ff0; -line-color: #ffff00; -line-color: rgb(255, 255, 0); -line-color: rgba(255, 255, 0, 1); -line-color: hsl(100, 50%, 50%); -line-color: hsla(100, 50%, 50%, 1); -line-color: husl(100, 50%, 50%); // same values yield different color than HSL -line-color: husla(100, 50%, 50%, 1); -line-color: yellow; -} -``` - -Especially of note is the support for hsl and husl, which can be [easier to reason about than rgb()](http://mothereffinghsl.com/). Carto also includes several color operation functions [borrowed from less](http://lesscss.org/functions/#color-operations): - -``` css -// lighten and darken colors -lighten(#ace, 10%); -darken(#ace, 10%); - -// saturate and desaturate -saturate(#550000, 10%); -desaturate(#00ff00, 10%); - -// increase or decrease the opacity of a color -fadein(#fafafa, 10%); -fadeout(#fefefe, 14%); - -// spin rotates a color around the color wheel by degrees -spin(#ff00ff, 10); - -// mix generates a color in between two other colors. -mix(#fff, #000, 50%); - -// get color components -hue(#ff00ff); -saturation(#ff00ff); -lightness(#ff00ff); -alpha(hsla(100, 50%, 50%, 0.5)); -``` - -These functions all take arguments which can be color variables, literal colors, or the results of other functions operating on colors. All the above mentioned functions also come in -a `functionp`-variant (e.g. `lightenp`), which force a given color into perceptual color space. - -### Float - -Float is a fancy way of saying 'number'. In CartoCSS, you specify _just a number_ - unlike CSS, there are no units, but everything is specified in pixels. - -``` css -#line { -line-width: 2; -} -``` - -It's also possible to do simple math with number values: - -``` css -#line { -line-width: 4 / 2; // division -line-width: 4 + 2; // addition -line-width: 4 - 2; // subtraction -line-width: 4 * 2; // multiplication -line-width: 4 % 2; // modulus -} -``` - -### URI - -URI is a fancy way of saying URL. When an argument is a URI, you use the same kind of `url('place.png')` notation that you would with HTML. Quotes around the URL aren't required, but are highly recommended. URIs can be paths to places on your computer, or on the internet. - -```css -#markers { -marker-file: url('marker.png'); -} -``` - -### String - -A string is basically just text. In the case of CartoCSS, you're going to put it in quotes. Strings can be anything, though pay attention to the cases of `text-name` and `shield-name` - they actually will refer to features, which you refer to by putting them in brackets, as seen in the example below. - -```css -#labels { -text-name: "[MY_FIELD]"; -} -``` - -### Boolean - -Boolean means yes or no, so it accepts the values `true` or `false`. - -```css -#markers { -marker-allow-overlap:true; -} -``` - -### Expressions - -Expressions are statements that can include fields, numbers, and other types in a really flexible way. You have run into expressions before, in the realm of 'fields', where you'd specify `"[FIELD]"`, but expressions allow you to drop the quotes and also do quick addition, division, multiplication, and concatenation from within Carto syntax. - -```css -#buildings { -building-height: [HEIGHT_FIELD] * 10; -} -``` - -### Numbers -Numbers are comma-separated lists of one or more number in a specific order. They're used in line dash arrays, in which the numbers specify intervals of line, break, and line again. - -```css -#disputedboundary { -line-dasharray: 1, 4, 2; -} -``` - -### Percentages -In Carto, the percentage symbol, `%` universally means `value/100`. It's meant to be used with ratio-related properties, like opacity rules. - -_You should not use percentages as widths, heights, or other properties - unlike CSS, percentages are not relative to cascaded classes or page size, they're, as stated, simply the value divided by one hundred._ - -```css -#world { -// this syntax -polygon-opacity: 50%; - -// is equivalent to -polygon-opacity: 0.5; -} -``` - -### Functions - -Functions are comma-separated lists of one or more functions. For instance, transforms use the `functions` type to allow for transforms within Carto, which are optionally chainable. - -```css -#point { -point-transform: scale(2, 2); -} -``` diff --git a/docs/3.0.9.md b/docs/3.0.9.md deleted file mode 100644 index ad7ed30..0000000 --- a/docs/3.0.9.md +++ /dev/null @@ -1,2226 +0,0 @@ -# Carto documentation - -The following is a list of properties provided in CartoCSS that you can apply to map elements. - -## All elements - -##### image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``color-blind-protanope``color-blind-deuteranope``color-blind-tritanope``colorize-alpha``color-to-alpha``scale-hsla` - -Default Value: none -_(no filters.)_ - -A list of image filters that will be applied to the active rendering canvas for a given style. The presence of one more `image-filters` will trigger a new canvas to be created before starting to render a style and then this canvas will be composited back into the main canvas after rendering all features and after all `image-filters` have been applied. See `direct-image-filters` if you want to apply a filter directly to the main canvas. -* * * - -##### image-filters-inflate `boolean` - - - -Default Value: false -_(No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary.)_ - -A property that can be set to true to enable using an inflated image internally for seamless blurring across tiles (requires buffered data). -* * * - -##### direct-image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``color-blind-protanope``color-blind-deuteranope``color-blind-tritanope``colorize-alpha``color-to-alpha``scale-hsla` - -Default Value: none -_(no filters.)_ - -A list of image filters to apply to the main canvas (see the `image-filters` doc for how they work on a separate canvas). -* * * - -##### comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current layer on top of other layers.)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - -##### opacity `float` - - - -Default Value: 1 -_(No separate buffer will be used and no alpha will be applied to the style after rendering.)_ - -An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer). -* * * - - -## map - -##### background-color `color` - - - -Default Value: none -_(Will be rendered transparent.)_ - -Map Background color. -* * * - -##### background-image `uri` - - - -Default Value: -_(No background image will be used.)_ - -An image that is repeated below all features on a map as a background. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### background-image-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(The background-image will be blended with the background normally (placed on top of any existing background-color).)_ - -Set the compositing operation used to blend the image into the background. -* * * - -##### background-image-opacity `float` - - - -Default Value: 1 -_(The image opacity will not be changed when applied to the map background.)_ - -Set the opacity of the image. -* * * - -##### srs `string` - - - -Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs -_(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space.)_ - -Map spatial reference (proj4 string). -* * * - -##### buffer-size `float` - - - -Default Value: 0 -_(No buffer will be used.)_ - -Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". -* * * - -##### maximum-extent `string` - - - -Default Value: -20037508.34,-20037508.34,20037508.34,20037508.34 -_(All data will be clipped to global mercator extent (default is applied in Carto.js).)_ - -An extent to be used to limit the bounds used to query all layers during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Map. -* * * - -##### base `string` - - - -Default Value: -_(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)_ - -Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. -* * * - -##### font-directory `uri` - - - -Default Value: none -_(No map-specific fonts will be registered.)_ - -Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). -* * * - - -## polygon - -##### polygon-fill `color` - - - -Default Value: The color gray will be used for fill. -_(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)_ - -Fill color to assign to a polygon. -* * * - -##### polygon-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the polygon. -* * * - -##### polygon-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of polygon edges. -* * * - -##### polygon-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. -* * * - -##### polygon-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extend outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### polygon-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify geometries by the given tolerance. -* * * - -##### polygon-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify geometries by the given algorithm. -* * * - -##### polygon-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform polygon geometry with specified function. -* * * - -##### polygon-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line - -##### line-color `color` - - - -Default Value: black -_(black and fully opaque (alpha = 1), same as rgb(0,0,0) or rgba(0,0,0,1).)_ - -The color of a drawn line. -* * * - -##### line-width `float` - - - -Default Value: 1 -_(The line will be rendered 1 pixel wide.)_ - -The width of a line in pixels. -* * * - -##### line-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of a line. -* * * - -##### line-join `keyword` -`miter``miter-revert``round``bevel` - - -Default Value: miter -_(The line joins will be rendered using a miter look.)_ - -The behavior of lines when joining. -* * * - -##### line-cap `keyword` -`butt``round``square` - - -Default Value: butt -_(The line endings will be rendered using a butt look.)_ - -The display of line endings. -* * * - -##### line-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of stroke line. -* * * - -##### line-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. -* * * - -##### line-dasharray `numbers` - - - -Default Value: none -_(The line will be drawn without dashes.)_ - -A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. -* * * - -##### line-dash-offset `numbers` - - - -Default Value: none -_(The line will be drawn without dashes.)_ - -Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled). -* * * - -##### line-miterlimit `float` - - - -Default Value: 4 -_(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )'.)_ - -The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. -* * * - -##### line-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### line-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify geometries by the given tolerance. -* * * - -##### line-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify geometries by the given algorithm. -* * * - -##### line-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-offset `float` - - - -Default Value: 0 -_(Will not be offset.)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The line will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. -* * * - -##### line-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform line geometry with specified function. -* * * - -##### line-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## markers - -##### marker-file `uri` - - - -Default Value: none -_(An ellipse or circle, if width equals height.)_ - -A file that this marker shows at each placement. If no file is given, the marker will show an ellipse. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### marker-opacity `float` - - - -Default Value: 1 -_(The stroke-opacity and fill-opacity of the marker.)_ - -The overall opacity of the marker, if set, overrides both the opacity of both the fill and stroke. -* * * - -##### marker-fill-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The fill opacity of the marker. -* * * - -##### marker-line-color `color` - - - -Default Value: black -_(The marker will be drawn with a black outline.)_ - -The color of the stroke around the marker. -* * * - -##### marker-line-width `float` - - - -Default Value: 0.5 -_(The marker will be drawn with an outline of .5 pixels wide.)_ - -The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. -* * * - -##### marker-line-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of a line. -* * * - -##### marker-placement `keyword` -`point``line``interior``vertex-first``vertex-last` - - -Default Value: point -_(Place markers at the center point (centroid) of the geometry.)_ - -Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior. The 'vertex-first' and 'vertex-last' options can be used to place markers at the first or last vertex of lines or polygons. -* * * - -##### marker-multi-policy `keyword` -`each``whole``largest` - - -Default Value: each -_(If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each.)_ - -A special setting to allow the user to control rendering behavior for 'multi-geometries' (when a feature contains multiple geometries). This setting does not apply to markers placed along lines. The 'each' policy is default and means all geometries will get a marker. The 'whole' policy means that the aggregate centroid between all geometries will be used. The 'largest' policy means that only the largest (by bounding box areas) feature will get a rendered marker (this is how text labeling behaves by default). -* * * - -##### marker-type `keyword` -`arrow``ellipse` - - -Default Value: ellipse -_(The marker shape is an ellipse.)_ - -The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width). -* * * - -##### marker-width `float` - - - -Default Value: 10 -_(The marker width is 10 pixels.)_ - -The width of the marker, if using one of the default types. -* * * - -##### marker-height `float` - - - -Default Value: 10 -_(The marker height is 10 pixels.)_ - -The height of the marker, if using one of the default types. -* * * - -##### marker-fill `color` - - - -Default Value: blue -_(The marker fill color is blue.)_ - -The color of the area of the marker. -* * * - -##### marker-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow markers to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping markers are shown or hidden. -* * * - -##### marker-avoid-edges `boolean` - - - -Default Value: false -_(Markers will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)_ - -Avoid placing markers that intersect with tile boundaries. -* * * - -##### marker-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache.)_ - -Value to control whether the placement of the feature will prevent the placement of other features. -* * * - -##### marker-spacing `float` - - - -Default Value: 100 -_(In the case of marker-placement:line then draw a marker every 100 pixels along a line.)_ - -Space between repeated markers in pixels. If the spacing is less than the marker size or larger than the line segment length then no marker will be placed. Any value less than 1 will be ignored and the default will be used instead. -* * * - -##### marker-max-error `float` - - - -Default Value: 0.2 -_(N/A: not intended to be changed.)_ - -N/A: not intended to be changed. -* * * - -##### marker-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform marker instance with specified function. Ignores map scale factor. -* * * - -##### marker-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### marker-simplify `float` - - - -Default Value: 0 -_(Geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### marker-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### marker-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### marker-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform marker geometry with specified function. -* * * - -##### marker-offset `float` - - - -Default Value: 0 -_(Will not be offset.)_ - -Offsets a marker from a line a number of pixels parallel to its actual path. Positive values move the marker left, negative values move it right (relative to the directionality of the line). -* * * - -##### marker-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### marker-direction `keyword` -`auto``auto-down``left``right``left-only``right-only``up``down` - - -Default Value: right -_(Markers are oriented to the right in the line direction.)_ - -How markers should be placed along lines. With the "auto" setting when marker is upside down the marker is automatically rotated by 180 degrees to keep it upright. The "auto-down" value places marker in the opposite orientation to "auto". The "left" or "right" settings can be used to force marker to always be placed along a line in a given direction and therefore disables rotating if marker appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down markers rather than trying to flip it. The "up" and "down" settings don't adjust marker's orientation to the line direction. -* * * - - -## shield - -##### shield-name `string` - - - -Default Value: -_(No text label will be rendered with the shield.)_ - -Value to use for a shield"s text label. Data columns are specified using brackets like [column_name]. -* * * - -##### shield-file `uri` - - - -Default Value: none - - -Image file to render behind the shield text. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### shield-face-name `string` - - - -Default Value: none - - -Font name and style to use for the shield text. -* * * - -##### shield-unlock-image `boolean` - - - -Default Value: false -_(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)_ - -This parameter should be set to true if you are trying to position text beside rather than on top of the shield image. -* * * - -##### shield-size `float` - - - -Default Value: 10 -_(Font size of 10 will be used to render text.)_ - -The size of the shield text in pixels. -* * * - -##### shield-fill `color` - - - -Default Value: black -_(The shield text will be rendered black.)_ - -The color of the shield text. -* * * - -##### shield-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point -_(One shield will be placed per geometry.)_ - -How this shield should be placed. Point placement places one shield on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. -* * * - -##### shield-avoid-edges `boolean` - - - -Default Value: false -_(Shields will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)_ - -Avoid placing shields that intersect with tile boundaries. -* * * - -##### shield-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow shields to overlap with other map elements already placed.)_ - -Control whether overlapping shields are shown or hidden. -* * * - -##### shield-margin `float` - - - -Default Value: 0 -_(No extra margin will be used to determine if a shield collides with any other text, shield, or marker.)_ - -Minimum distance that a shield can be placed from any other text, shield, or marker. -* * * - -##### shield-repeat-distance `float` - - - -Default Value: 0 -_(Shields with the same text will be rendered without restriction.)_ - -Minimum distance between repeated shields. If set this will prevent shields being rendered nearby each other that contain the same text. Similiar to shield-min-distance with the difference that it works the same no matter what placement strategy is used. -* * * - -##### shield-min-distance `float` - - - -Default Value: 0 -_(Shields with the same text will be rendered without restriction.)_ - -Minimum distance to the next shield with the same text. Only works for line placement. -* * * - -##### shield-spacing `float` - - - -Default Value: 0 -_(Only one shield per line will attempt to be placed.)_ - -Distance the renderer should use to try to place repeated shields on a line. -* * * - -##### shield-min-padding `float` - - - -Default Value: 0 -_(No margin will be used to detect if a shield is nearby a tile boundary.)_ - -Minimum distance a shield will be placed from the edge of a tile. This option is similiar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. -* * * - -##### shield-label-position-tolerance `float` - - - -Default Value: shield-spacing/2.0 -_(If a shield cannot be placed then the renderer will advance by shield-spacing/2.0 to try placement again.)_ - -Allows the shield to be displaced from its ideal position by a number of pixels (only works with placement:line). -* * * - -##### shield-wrap-width `unsigned` - - - -Default Value: 0 -_(Text will not be wrapped.)_ - -Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. -* * * - -##### shield-wrap-before `boolean` - - - -Default Value: false -_(Wrapped lines will be a bit longer than wrap-width.)_ - -Wrap text before wrap-width is reached. -* * * - -##### shield-wrap-character `string` - - - -Default Value: " " -_(Lines will be wrapped when whitespace is encountered.)_ - -Use this character instead of a space to wrap long names. -* * * - -##### shield-halo-fill `color` - - - -Default Value: white -_(The shield halo text will be rendered white.)_ - -Specifies the color of the halo around the text. -* * * - -##### shield-halo-radius `float` - - - -Default Value: 0 -_(no halo.)_ - -Specify the radius of the halo in pixels. -* * * - -##### shield-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The shield will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### shield-halo-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation.)_ - -Transform shield halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. -* * * - -##### shield-halo-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### shield-halo-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text halo. -* * * - -##### shield-character-spacing `unsigned` - - - -Default Value: 0 -_(The default character spacing of the font will be used.)_ - -Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. -* * * - -##### shield-line-spacing `unsigned` - - - -Default Value: 0 -_(The default font spacing will be used.)_ - -Vertical spacing between lines of multiline labels (in pixels). -* * * - -##### shield-text-dx `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right. -* * * - -##### shield-text-dy `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down. -* * * - -##### shield-dx `float` - - - -Default Value: 0 -_(Shield will not be displaced.)_ - -Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right. -* * * - -##### shield-dy `float` - - - -Default Value: 0 -_(Shield will not be displaced.)_ - -Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down. -* * * - -##### shield-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the image used for the shield. -* * * - -##### shield-text-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the text placed on top of the shield. -* * * - -##### shield-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: auto -_(TODO.)_ - -The shield's horizontal alignment from its centerpoint. -* * * - -##### shield-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: middle -_(TODO.)_ - -The shield's vertical alignment from its centerpoint. -* * * - -##### shield-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy -_(Alternative placements will not be enabled.)_ - -Re-position and/or re-size shield to avoid overlaps. "simple" for basic algorithm (using shield-placements string,) "dummy" to turn this feature off. -* * * - -##### shield-placements `string` - - - -Default Value: -_(No alternative placements will be used.)_ - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `shield-placements: "E,NE,SE,W,NW,SW";`. -* * * - -##### shield-text-transform `keyword` -`none``uppercase``lowercase``capitalize``reverse` - - -Default Value: none -_(No text transformation will be applied.)_ - -Transform the case of the characters. -* * * - -##### shield-justify-alignment `keyword` -`left``center``right``auto` - - -Default Value: auto -_(TODO.)_ - -Define how text in a shield's label is justified. -* * * - -##### shield-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform shield instance with specified function. Ignores map scale factor. -* * * - -##### shield-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### shield-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify the geometries used for shield placement by the given tolerance. -* * * - -##### shield-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify the geometries used for shield placement by the given algorithm. -* * * - -##### shield-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out the angles of the geometry used for shield placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### shield-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line-pattern - -##### line-pattern-file `uri` - - - -Default Value: none - - -An image file to be repeated and warped along a line. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### line-pattern-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### line-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications.)_ - -Apply an opacity level to the image used for the pattern. -* * * - -##### line-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### line-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### line-pattern-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-pattern-offset `float` - - - -Default Value: 0 -_(The line will not be offset.)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform line geometry with specified function and apply pattern to transformed geometry. -* * * - -##### line-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## polygon-pattern - -##### polygon-pattern-file `uri` - - - -Default Value: none - - -Image to use as a repeated pattern fill within a polygon. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### polygon-pattern-alignment `keyword` -`global``local` - - -Default Value: global -_(Patterns will be aligned to the map (or tile boundaries) when being repeated across polygons. This is ideal for seamless patterns in tiled rendering.)_ - -Specify whether to align pattern fills to the layer's geometry (local) or to the map (global). -* * * - -##### polygon-pattern-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of polygon pattern edges. -* * * - -##### polygon-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications.)_ - -Apply an opacity level to the image used for the pattern. -* * * - -##### polygon-pattern-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### polygon-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### polygon-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### polygon-pattern-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform polygon geometry with specified function and apply pattern to transformed geometry. -* * * - -##### polygon-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## raster - -##### raster-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the raster symbolizer on top of other symbolizers. -* * * - -##### raster-filter-factor `float` - - - -Default Value: -1 -_(Allow the datasource to choose appropriate downscaling.)_ - -This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. -* * * - -##### raster-scaling `keyword` -`near``fast``bilinear``bicubic``spline16``spline36``hanning``hamming``hermite``kaiser``quadric``catrom``gaussian``bessel``mitchell``sinc``lanczos``blackman` - - -Default Value: near -_(Nearest neighboor resampling will be used to scale the image to the target size of the map.)_ - -The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. -* * * - -##### raster-mesh-size `unsigned` - - - -Default Value: 16 -_(Reprojection mesh will be 1/16 of the resolution of the source image.)_ - -A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. -* * * - -##### raster-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### raster-colorizer-default-mode `keyword` -`discrete``linear``exact` - - -Default Value: linear -_(A linear interpolation is used to generate colors between the two nearest stops.)_ - -This can be either `discrete`, `linear` or `exact`. If it is not specified then the default is `linear`. -* * * - -##### raster-colorizer-default-color `color` - - - -Default Value: transparent -_(Pixels that are not colored by the colorizer stops will be transparent.)_ - -This can be any color. Sets the color that is applied to all values outside of the range of the colorizer-stops. If not supplied pixels will be fully transparent. -* * * - -##### raster-colorizer-epsilon `float` - - - -Default Value: 1.1920928955078125e-07 -_(Pixels must very closely match the stop filter otherwise they will not be colored.)_ - -This can be any positive floating point value and will be used as a tolerance in floating point comparisions. The higher the value the more likely a stop will match and color data. -* * * - -##### raster-colorizer-stops `tags` - - - -Default Value: -_(No colorization will happen without supplying stops.)_ - -Assigns raster data values to colors. Stops must be listed in ascending order, and contain at a minimum the value and the associated color. You can also include the color-mode as a third argument, like `stop(100,#fff,exact)`. -* * * - - -## point - -##### point-file `uri` - - - -Default Value: none -_(A 4x4 black square will be rendered.)_ - -Image file to represent a point. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### point-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow points to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping points are shown or hidden. -* * * - -##### point-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache.)_ - -Control whether the placement of the feature will prevent the placement of other features. -* * * - -##### point-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A value from 0 to 1 to control the opacity of the point. -* * * - -##### point-placement `keyword` -`centroid``interior` - - -Default Value: centroid -_(The centroid of the geometry will be used to place the point.)_ - -Control how this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. -* * * - -##### point-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform point instance with specified function. Ignores map scale factor. -* * * - -##### point-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## text - -##### text-name `string` - - - -Default Value: none - - -Value to use for a text label. Data columns are specified using brackets like [column_name]. -* * * - -##### text-face-name `string` - - - -Default Value: none - - -Font name and style to render a label in. -* * * - -##### text-size `float` - - - -Default Value: 10 -_(Font size of 10 will be used to render text.)_ - -Text size in pixels. -* * * - -##### text-ratio `unsigned` - - - -Default Value: 0 -_(TODO.)_ - -Define the amount of text (of the total) present on successive lines when wrapping occurs. -* * * - -##### text-wrap-width `unsigned` - - - -Default Value: 0 -_(Text will not be wrapped.)_ - -Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. -* * * - -##### text-wrap-before `boolean` - - - -Default Value: false -_(Wrapped lines will be a bit longer than wrap-width.)_ - -Wrap text before wrap-width is reached. -* * * - -##### text-wrap-character `string` - - - -Default Value: " " -_(Lines will be wrapped when whitespace is encountered.)_ - -Use this character instead of a space to wrap long text. -* * * - -##### text-repeat-wrap-character `boolean` - - - -Default Value: false -_(Character will be removed when used to wrap a line.)_ - -Keep the character used to wrap a line instead of removing it, and repeat it on the new line. -* * * - -##### text-spacing `unsigned` - - - -Default Value: 0 -_(Only one label per line will attempt to be placed.)_ - -Distance the renderer should use to try to place repeated text labels on a line. -* * * - -##### text-character-spacing `float` - - - -Default Value: 0 -_(The default character spacing of the font will be used.)_ - -Horizontal spacing adjustment between characters in pixels. This value is ignored when `horizontal-alignment` is set to `adjust`. Typographic ligatures are turned off when this value is greater than zero. -* * * - -##### text-line-spacing `unsigned` - - - -Default Value: 0 -_(The default font spacing will be used.)_ - -Vertical spacing adjustment between lines in pixels. -* * * - -##### text-label-position-tolerance `float` - - - -Default Value: text-spacing/2.0 -_(If a shield cannot be placed then the renderer will advance by text-spacing/2.0 to try placement again.)_ - -Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line). -* * * - -##### text-max-char-angle-delta `float` - - - -Default Value: 22.5 -_(The label will not be placed if a character falls on a line with an angle sharper than 22.5 degrees.)_ - -The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. -* * * - -##### text-fill `color` - - - -Default Value: black -_(The text will be rendered black.)_ - -Specifies the color for the text. -* * * - -##### text-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text. -* * * - -##### text-halo-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text halo. -* * * - -##### text-halo-fill `color` - - - -Default Value: white -_(The halo will be rendered white.)_ - -Specifies the color of the halo around the text. -* * * - -##### text-halo-radius `float` - - - -Default Value: 0 -_(no halo.)_ - -Specify the radius of the halo in pixels. -* * * - -##### text-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The text will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### text-halo-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation.)_ - -Transform text halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. -* * * - -##### text-dx `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text by fixed amount, in pixels, +/- along the X axis. With "dummy" placement-type, a positive value displaces to the right. With "simple" placement-type, it is either left, right or unchanged, depending on the placement selected. Any non-zero value implies "horizontal-alignment" changes to "left" by default. Has no effect with 'line' text-placement-type. -* * * - -##### text-dy `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text by fixed amount, in pixels, +/- along the Y axis. With "dummy" placement-type, a positive value displaces downwards. With "simple" placement-type, it is either up, down or unchanged, depending on the placement selected. With "line" placement-type, a positive value displaces above the path. -* * * - -##### text-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: auto -_(Default affected by value of dy; "top" for dy>0, "bottom" for dy<0.)_ - -Position of label relative to point position. -* * * - -##### text-avoid-edges `boolean` - - - -Default Value: false -_(Text will be potentially placed near tile edges and therefore may look cut off unless the same text label is rendered on each adjacent tile.)_ - -Avoid placing labels that intersect with tile boundaries. -* * * - -##### text-margin `float` - - - -Default Value: 0 -_(No extra margin will be used to determine if a label collides with any other text, shield, or marker.)_ - -Minimum distance that a label can be placed from any other text, shield, or marker. -* * * - -##### text-repeat-distance `float` - - - -Default Value: 0 -_(Labels with the same text will be rendered without restriction.)_ - -Minimum distance between repeated text. If set this will prevent text labels being rendered nearby each other that contain the same text. Similiar to text-min-distance with the difference that it works the same no matter what placement strategy is used. -* * * - -##### text-min-distance `float` - - - -Default Value: 0 -_(Labels with the same text will be rendered without restriction.)_ - -Minimum distance to the next label with the same text. Only works for line placement. Deprecated: replaced by `text-repeat-distance` and `text-margin` -* * * - -##### text-min-padding `float` - - - -Default Value: 0 -_(No margin will be used to detect if a text label is nearby a tile boundary.)_ - -Minimum distance a text label will be placed from the edge of a tile. This option is similiar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. -* * * - -##### text-min-path-length `float` - - - -Default Value: 0 -_(place labels on all geometries no matter how small they are.)_ - -Place labels only on polygons and lines with a bounding width longer than this value (in pixels). -* * * - -##### text-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow text to overlap with other text - overlapping markers will not be shown.)_ - -Control whether overlapping text is shown or hidden. -* * * - -##### text-orientation `float` - - - -Default Value: 0 -_(Text is not rotated and is displayed upright.)_ - -Rotate the text. (only works with text-placement:point). -* * * - -##### text-rotate-displacement `boolean` - - - -Default Value: false -_(Label center is used for rotation.)_ - -Rotates the displacement around the placement origin by the angle given by "orientation". -* * * - -##### text-upright `keyword` -`auto``auto-down``left``right``left-only``right-only` - - -Default Value: auto -_(Text will be positioned upright automatically.)_ - -How this label should be placed along lines. By default when more than half of a label's characters are upside down the label is automatically flipped to keep it upright. By changing this parameter you can prevent this "auto-upright" behavior. The "auto-down" value places text in the opposite orientation to "auto". The "left" or "right" settings can be used to force text to always be placed along a line in a given direction and therefore disables flipping if text appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down text rather than trying to flip it. -* * * - -##### text-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point -_(One shield will be placed per geometry.)_ - -How this label should be placed. Point placement places one label on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. -* * * - -##### text-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy -_(Alternative placements will not be enabled.)_ - -Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. -* * * - -##### text-placements `string` - - - -Default Value: -_(No alternative placements will be used.)_ - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `text-placements: "E,NE,SE,W,NW,SW";`. -* * * - -##### text-transform `keyword` -`none``uppercase``lowercase``capitalize``reverse` - - -Default Value: none -_(Transform text instance with specified function. Ignores map scale factor.)_ - -Transform the case of the characters. -* * * - -##### text-horizontal-alignment `keyword` -`left``middle``right``auto``adjust` - - -Default Value: auto -_(TODO.)_ - -The text's horizontal alignment from it's centerpoint. If `placement` is set to `line`, then `adjust` can be set to auto-fit the text to the length of the path by dynamically calculating `character-spacing`. -* * * - -##### text-align `keyword` -`left``right``center``auto` - - -Default Value: auto -_(Auto alignment means that text will be centered by default except when using the `placement-type` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the `text-placements` directives.)_ - -Define how text is justified. -* * * - -##### text-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### text-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify the geometries used for text placement by the given tolerance. -* * * - -##### text-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify the geometries used for text placement by the given algorithm. -* * * - -##### text-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out the angles of the geometry used for text placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### text-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### text-halo-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### text-font-feature-settings `string` - - - -Default Value: -_(Default set of typographic features recommended by OpenType specification. Ligatures are turned off by default when `character-spacing` is greater than zero.)_ - -Comma separated list of OpenType typographic features. The syntax and semantics conforms to `font-feature-settings` from W3C CSS. -* * * - -##### text-largest-bbox-only `boolean` - - - -Default Value: true -_(For multipolygons only polygon with largest bbox area is labeled (does not apply to other geometries).)_ - -Controls default labeling behavior on multipolygons. The default is true and means that only the polygon with largest bbox is labeled. -* * * - - -## building - -##### building-fill `color` - - - -Default Value: The color gray will be used for fill. -_(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)_ - -The color of the buildings fill. Note: 0.8 will be used to multiply each color component to auto-generate a darkened wall color. -* * * - -##### building-fill-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the building as a whole, including all walls. -* * * - -##### building-height `float` - - - -Default Value: 0 -_(Buildings will not have a visual height and will instead look like flat polygons.)_ - -The height of the building in pixels. -* * * - - -## debug - -##### debug-mode `string` - - - -Default Value: collision -_(The otherwise invisible collision boxes will be rendered as squares on the map.)_ - -The mode for debug rendering. -* * * - - -## dot - -##### dot-fill `color` - - - -Default Value: gray -_(The dot fill color is gray.)_ - -The color of the area of the dot. -* * * - -##### dot-opacity `float` - - - -Default Value: 1 -_(The opacity of the dot.)_ - -The overall opacity of the dot. -* * * - -##### dot-width `float` - - - -Default Value: 1 -_(The marker width is 1 pixel.)_ - -The width of the dot in pixels. -* * * - -##### dot-height `float` - - - -Default Value: 1 -_(The marker height is 1 pixels.)_ - -The height of the dot in pixels. -* * * - -##### dot-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current layer on top of other layers.)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - - - - -### Values - -Below is a list of values and an explanation of any expression that can be applied to properties in CartCSS. - -### Color - -CartoCSS accepts a variety of syntaxes for colors - HTML-style hex values, rgb, rgba, hsl, hsla, husl, and husla. It also supports the predefined HTML colors names, like `yellow` and `blue`. - -``` css -#line { -line-color: #ff0; -line-color: #ffff00; -line-color: rgb(255, 255, 0); -line-color: rgba(255, 255, 0, 1); -line-color: hsl(100, 50%, 50%); -line-color: hsla(100, 50%, 50%, 1); -line-color: husl(100, 50%, 50%); // same values yield different color than HSL -line-color: husla(100, 50%, 50%, 1); -line-color: yellow; -} -``` - -Especially of note is the support for hsl and husl, which can be [easier to reason about than rgb()](http://mothereffinghsl.com/). Carto also includes several color operation functions [borrowed from less](http://lesscss.org/functions/#color-operations): - -``` css -// lighten and darken colors -lighten(#ace, 10%); -darken(#ace, 10%); - -// saturate and desaturate -saturate(#550000, 10%); -desaturate(#00ff00, 10%); - -// increase or decrease the opacity of a color -fadein(#fafafa, 10%); -fadeout(#fefefe, 14%); - -// spin rotates a color around the color wheel by degrees -spin(#ff00ff, 10); - -// mix generates a color in between two other colors. -mix(#fff, #000, 50%); - -// get color components -hue(#ff00ff); -saturation(#ff00ff); -lightness(#ff00ff); -alpha(hsla(100, 50%, 50%, 0.5)); -``` - -These functions all take arguments which can be color variables, literal colors, or the results of other functions operating on colors. All the above mentioned functions also come in -a `functionp`-variant (e.g. `lightenp`), which force a given color into perceptual color space. - -### Float - -Float is a fancy way of saying 'number'. In CartoCSS, you specify _just a number_ - unlike CSS, there are no units, but everything is specified in pixels. - -``` css -#line { -line-width: 2; -} -``` - -It's also possible to do simple math with number values: - -``` css -#line { -line-width: 4 / 2; // division -line-width: 4 + 2; // addition -line-width: 4 - 2; // subtraction -line-width: 4 * 2; // multiplication -line-width: 4 % 2; // modulus -} -``` - -### URI - -URI is a fancy way of saying URL. When an argument is a URI, you use the same kind of `url('place.png')` notation that you would with HTML. Quotes around the URL aren't required, but are highly recommended. URIs can be paths to places on your computer, or on the internet. - -```css -#markers { -marker-file: url('marker.png'); -} -``` - -### String - -A string is basically just text. In the case of CartoCSS, you're going to put it in quotes. Strings can be anything, though pay attention to the cases of `text-name` and `shield-name` - they actually will refer to features, which you refer to by putting them in brackets, as seen in the example below. - -```css -#labels { -text-name: "[MY_FIELD]"; -} -``` - -### Boolean - -Boolean means yes or no, so it accepts the values `true` or `false`. - -```css -#markers { -marker-allow-overlap:true; -} -``` - -### Expressions - -Expressions are statements that can include fields, numbers, and other types in a really flexible way. You have run into expressions before, in the realm of 'fields', where you'd specify `"[FIELD]"`, but expressions allow you to drop the quotes and also do quick addition, division, multiplication, and concatenation from within Carto syntax. - -```css -#buildings { -building-height: [HEIGHT_FIELD] * 10; -} -``` - -### Numbers -Numbers are comma-separated lists of one or more number in a specific order. They're used in line dash arrays, in which the numbers specify intervals of line, break, and line again. - -```css -#disputedboundary { -line-dasharray: 1, 4, 2; -} -``` - -### Percentages -In Carto, the percentage symbol, `%` universally means `value/100`. It's meant to be used with ratio-related properties, like opacity rules. - -_You should not use percentages as widths, heights, or other properties - unlike CSS, percentages are not relative to cascaded classes or page size, they're, as stated, simply the value divided by one hundred._ - -```css -#world { -// this syntax -polygon-opacity: 50%; - -// is equivalent to -polygon-opacity: 0.5; -} -``` - -### Functions - -Functions are comma-separated lists of one or more functions. For instance, transforms use the `functions` type to allow for transforms within Carto, which are optionally chainable. - -```css -#point { -point-transform: scale(2, 2); -} -``` diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..a7ca4aa --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = carto +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/api/mapnik/2.0.0.rst b/docs/api/mapnik/2.0.0.rst new file mode 100644 index 0000000..ee15eec --- /dev/null +++ b/docs/api/mapnik/2.0.0.rst @@ -0,0 +1,1912 @@ +2.0.0 +===== +Style +----- + + + + + +Symbolizers +----------- + + +map +^^^ + +background-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: none +*(transparent)* + +Map Background color + +------------ + + +background-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: +*(transparent)* + +An image that is repeated below all features on a map as a background. + +------------ + + +srs +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs +*(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space)* + +Map spatial reference (proj4 string) + +------------ + + +buffer-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No buffer will be used)* + +Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". + +------------ + + +base +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)* + +Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. + +------------ + + +font-directory +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none +*(No map-specific fonts will be registered)* + +Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). + +------------ + + + +polygon +^^^^^^^ + +polygon-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: rgba(128,128,128,1) +*(gray and fully opaque (alpha = 1), same as rgb(128,128,128))* + +Fill color to assign to a polygon + +------------ + + +polygon-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of polygon edges + +------------ + + +polygon-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of the polygon + +------------ + + +polygon-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Amount of smoothing applied + +------------ + + + +line +^^^^ + +line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: rgba(0,0,0,1) +*(black and fully opaque (alpha = 1), same as rgb(0,0,0))* + +The color of a drawn line + +------------ + + +line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +The width of a line in pixels + +------------ + + +line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of a line + +------------ + + +line-join +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``miter`` ``round`` ``bevel`` + + +Default Value: miter + + +The behavior of lines when joining + +------------ + + +line-cap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``butt`` ``round`` ``square`` + + +Default Value: butt + + +The display of line endings + +------------ + + +line-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of stroke line + +------------ + + +line-dasharray +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(solid line)* + +A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. + +------------ + + +line-dash-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(solid line)* + +valid parameter but not currently used in renderers + +------------ + + +line-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full + + +Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. + +------------ + + + +markers +^^^^^^^ + +marker-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: +*(An ellipse or circle, if width equals height)* + +An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse. + +------------ + + +marker-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The overall opacity of the marker + +------------ + + +marker-line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black + + +The color of the stroke around a marker shape. + +------------ + + +marker-line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.5 + + +The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. + +------------ + + +marker-line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of a line + +------------ + + +marker-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` + + +Default Value: line + + +Attempt to place markers on a point once or on a line repeatedly + +------------ + + +marker-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``arrow`` ``ellipse`` + + +Default Value: ellipse + + +The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width) + +------------ + + +marker-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +The width of the marker, if using one of the default types. + +------------ + + +marker-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +The height of the marker, if using one of the default types. + +------------ + + +marker-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: blue + + +The color of the area of the marker. + +------------ + + +marker-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow makers to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping markers are shown or hidden. + +------------ + + +marker-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache)* + +value to control whether the placement of the feature will prevent the placement of other features + +------------ + + +marker-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 100 + + +Space between repeated labels + +------------ + + +marker-max-error +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.2 + + +The maximum difference between actual marker placement and the marker-spacing parameter. Setting a high value can allow the renderer to try to resolve placement conflicts with other symbolizers. + +------------ + + +marker-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(no transformation)* + +An SVG transformation definition + +------------ + + + +shield +^^^^^^ + +shield-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Value to use for a shield"s text label. Data columns are specified using brackets like [column_name] + +------------ + + +shield-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Font name and style to use for the shield text + +------------ + + +shield-unlock-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)* + +This parameter should be set to true if you are trying to position text beside rather than on top of the shield image + +------------ + + +shield-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +The size of the shield text in pixels + +------------ + + +shield-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black + + +The color of the shield text + +------------ + + +shield-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` + + +Default Value: point + + +How this shield should be placed. Point placement attempts to place it on top of points, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of polygons. + +------------ + + +shield-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Tell positioning algorithm to avoid labeling near intersection edges. + +------------ + + +shield-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Minimum distance to the next shield symbol, not necessarily the same shield. + +------------ + + +shield-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +The spacing between repeated occurrences of the same shield on a line + +------------ + + +shield-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Determines the minimum amount of padding that a shield gets relative to other shields + +------------ + + +shield-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Length before wrapping long names. + +------------ + + +shield-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Use this character instead of a space to wrap long names. + +------------ + + +shield-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF +*(white)* + +Specifies the color of the halo around the text. + +------------ + + +shield-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo)* + +Specify the radius of the halo in pixels + +------------ + + +shield-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. + +------------ + + +shield-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Vertical spacing between lines of multiline labels (in pixels) + +------------ + + +shield-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image file to render behind the shield text + +------------ + + +shield-text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right + +------------ + + +shield-text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down + +------------ + + +shield-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right + +------------ + + +shield-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down + +------------ + + +shield-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +(Default 1.0) - opacity of the image used for the shield + +------------ + + +shield-text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +(Default 1.0) - opacity of the text placed on top of the shield + +------------ + + +shield-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` + + +Default Value: middle + + +The shield's horizontal alignment from its centerpoint + +------------ + + +shield-text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` + + +Default Value: none + + +Transform the case of the characters + +------------ + + +shield-no-text +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Whether the shield should make room for a text label. + +------------ + + +shield-justify-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: middle + + +Define how text in a shield's label is justified + +------------ + + + +line-pattern +^^^^^^^^^^^^ + +line-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +An image file to be repeated and warped along a line + +------------ + + + +polygon-pattern +^^^^^^^^^^^^^^^ + +polygon-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image to use as a repeated pattern fill within a polygon + +------------ + + +polygon-pattern-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``local`` ``global`` + + +Default Value: local + + +Specify whether to align pattern fills to the layer or to the map. + +------------ + + +polygon-pattern-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of polygon pattern edges + +------------ + + + +raster +^^^^^^ + +raster-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of the raster symbolizer on top of other symbolizers. + +------------ + + +raster-mode +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``normal`` ``grain_merge`` ``grain_merge2`` ``multiply`` ``multiply2`` ``divide`` ``divide2`` ``screen`` ``hard_light`` + + +Default Value: normal + + +The blending technique used to overlay this raster image on the layer below. Normal simply covers the layer. Grain merge adds the two layers together and subtracts 128 from the value, making the resulting area sometimes high-contrast. Screen often gives a lighter, washed-out appearance. Multiply multiplies the pixels, giving a high-contrast result. Divide divides the upper layer by the lower layer, making a lighter version. + +------------ + + +raster-filter-factor +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: -1 +*(Allow the datasource to choose appropriate downscaling.)* + +This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. + +------------ + + +raster-scaling +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``fast`` ``bilinear`` ``bilinear8`` ``bicubic`` ``spline16`` ``gaussian`` ``lanczos`` + + +Default Value: fast + + +The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. + +------------ + + +raster-mesh-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``integer`` + + + + + +Default Value: 16 +*(Reprojection mesh will be 1/16 of the resolution of the source image)* + +A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. + +------------ + + + +point +^^^^^ + +point-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image file to represent a point + +------------ + + +point-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow points to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping points are shown or hidden. + +------------ + + +point-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache)* + +value to control whether the placement of the feature will prevent the placement of other features + +------------ + + +point-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque)* + +A value from 0 to 1 to control the opacity of the point + +------------ + + +point-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``centroid`` ``interior`` + + +Default Value: centroid + + +How this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. + +------------ + + +point-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(No transformation)* + +SVG transformation definition + +------------ + + + +text +^^^^ + +text-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Value to use for a text label. Data columns are specified using brackets like [column_name] + +------------ + + +text-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Font name and style to render a label in + +------------ + + +text-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +Text size in pixels + +------------ + + +text-ratio +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Define the amount of text (of the total) present on successive lines when wrapping occurs + +------------ + + +text-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Length of a chunk of text in characters before wrapping text + +------------ + + +text-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Use this character instead of a space to wrap long text. + +------------ + + +text-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Distance between repeated text labels on a line + +------------ + + +text-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Horizontal spacing adjustment between characters in pixels + +------------ + + +text-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Vertical spacing adjustment between lines in pixels + +------------ + + +text-label-position-tolerance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Allows the label to be displaced from its ideal position by a number of pixels + +------------ + + +text-max-char-angle-delta +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: none + + +If present, the maximum angle change, in degrees, allowed between adjacent characters in a label. This will stop label placement around sharp corners. + +------------ + + +text-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #000000 + + +Specifies the color for the text + +------------ + + +text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque)* + +A number from 0 to 1 specifying the opacity for the text + +------------ + + +text-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF +*(white)* + +Specifies the color of the halo around the text. + +------------ + + +text-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo)* + +Specify the radius of the halo in pixels + +------------ + + +text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right + +------------ + + +text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down + +------------ + + +text-vertical-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``top`` ``middle`` ``bottom`` + + +Default Value: middle +*(Default affected by value of dy; "bottom" for dy>0, "top" for dy<0.)* + +Position of label relative to point position. + +------------ + + +text-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Tell positioning algorithm to avoid labeling near intersection edges. + +------------ + + +text-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Minimum permitted distance to the next text symbolizer. + +------------ + + +text-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Determines the minimum amount of padding that a text symbolizer gets relative to other text + +------------ + + +text-min-path-length +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(place labels on all paths)* + +Place labels only on paths longer than this value. + +------------ + + +text-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow text to overlap with other text - overlapping markers will not be shown.)* + +Control whether overlapping text is shown or hidden. + +------------ + + +text-orientation +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Rotate the text. + +------------ + + +text-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` + + +Default Value: point + + +Control the style of placement of a point versus the geometry it is attached to. + +------------ + + +text-placement-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``dummy`` ``simple`` + + +Default Value: dummy + + +Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. + +------------ + + +text-placements +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. See TextSymbolizer docs for format. + +------------ + + +text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` + + +Default Value: none + + +Transform the case of the characters + +------------ + + +text-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` + + +Default Value: middle + + +The text's horizontal alignment from its centerpoint + +------------ + + +text-align +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``right`` ``center`` + + +Default Value: center + + +Set the text alignment. + +------------ + + + +building +^^^^^^^^ + +building-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF + + +The color of the buildings walls. + +------------ + + +building-fill-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +The opacity of the building as a whole, including all walls. + +------------ + + +building-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +The height of the building in pixels. + +------------ + + + + + diff --git a/docs/api/mapnik/2.0.1.rst b/docs/api/mapnik/2.0.1.rst new file mode 100644 index 0000000..e12d36b --- /dev/null +++ b/docs/api/mapnik/2.0.1.rst @@ -0,0 +1,1912 @@ +2.0.1 +===== +Style +----- + + + + + +Symbolizers +----------- + + +map +^^^ + +background-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: none +*(transparent)* + +Map Background color + +------------ + + +background-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: +*(transparent)* + +An image that is repeated below all features on a map as a background. + +------------ + + +srs +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs +*(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space)* + +Map spatial reference (proj4 string) + +------------ + + +buffer-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No buffer will be used)* + +Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". + +------------ + + +base +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)* + +Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. + +------------ + + +font-directory +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none +*(No map-specific fonts will be registered)* + +Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). + +------------ + + + +polygon +^^^^^^^ + +polygon-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: rgba(128,128,128,1) +*(gray and fully opaque (alpha = 1), same as rgb(128,128,128))* + +Fill color to assign to a polygon + +------------ + + +polygon-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of polygon edges + +------------ + + +polygon-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of the polygon + +------------ + + +polygon-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Amount of smoothing applied + +------------ + + + +line +^^^^ + +line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: rgba(0,0,0,1) +*(black and fully opaque (alpha = 1), same as rgb(0,0,0))* + +The color of a drawn line + +------------ + + +line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +The width of a line in pixels + +------------ + + +line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of a line + +------------ + + +line-join +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``miter`` ``round`` ``bevel`` + + +Default Value: miter + + +The behavior of lines when joining + +------------ + + +line-cap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``butt`` ``round`` ``square`` + + +Default Value: butt + + +The display of line endings + +------------ + + +line-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of stroke line + +------------ + + +line-dasharray +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(solid line)* + +A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. + +------------ + + +line-dash-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(solid line)* + +valid parameter but not currently used in renderers + +------------ + + +line-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full + + +Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. + +------------ + + + +markers +^^^^^^^ + +marker-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: +*(An ellipse or circle, if width equals height)* + +An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse. + +------------ + + +marker-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The overall opacity of the marker + +------------ + + +marker-line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black + + +The color of the stroke around a marker shape. + +------------ + + +marker-line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.5 + + +The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. + +------------ + + +marker-line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of a line + +------------ + + +marker-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` + + +Default Value: line + + +Attempt to place markers on a point once or on a line repeatedly + +------------ + + +marker-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``arrow`` ``ellipse`` + + +Default Value: ellipse + + +The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width) + +------------ + + +marker-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +The width of the marker, if using one of the default types. + +------------ + + +marker-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +The height of the marker, if using one of the default types. + +------------ + + +marker-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: blue + + +The color of the area of the marker. + +------------ + + +marker-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow makers to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping markers are shown or hidden. + +------------ + + +marker-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache)* + +value to control whether the placement of the feature will prevent the placement of other features + +------------ + + +marker-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 100 + + +Space between repeated labels + +------------ + + +marker-max-error +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.2 + + +The maximum difference between actual marker placement and the marker-spacing parameter. Setting a high value can allow the renderer to try to resolve placement conflicts with other symbolizers. + +------------ + + +marker-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(no transformation)* + +An SVG transformation definition + +------------ + + + +shield +^^^^^^ + +shield-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Value to use for a shield"s text label. Data columns are specified using brackets like [column_name] + +------------ + + +shield-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Font name and style to use for the shield text + +------------ + + +shield-unlock-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)* + +This parameter should be set to true if you are trying to position text beside rather than on top of the shield image + +------------ + + +shield-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +The size of the shield text in pixels + +------------ + + +shield-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black + + +The color of the shield text + +------------ + + +shield-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` + + +Default Value: point + + +How this shield should be placed. Point placement attempts to place it on top of points, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of polygons. + +------------ + + +shield-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Tell positioning algorithm to avoid labeling near intersection edges. + +------------ + + +shield-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Minimum distance to the next shield symbol, not necessarily the same shield. + +------------ + + +shield-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +The spacing between repeated occurrences of the same shield on a line + +------------ + + +shield-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Determines the minimum amount of padding that a shield gets relative to other shields + +------------ + + +shield-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Length before wrapping long names. + +------------ + + +shield-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Use this character instead of a space to wrap long names. + +------------ + + +shield-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF +*(white)* + +Specifies the color of the halo around the text. + +------------ + + +shield-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo)* + +Specify the radius of the halo in pixels + +------------ + + +shield-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. + +------------ + + +shield-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Vertical spacing between lines of multiline labels (in pixels) + +------------ + + +shield-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image file to render behind the shield text + +------------ + + +shield-text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right + +------------ + + +shield-text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down + +------------ + + +shield-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right + +------------ + + +shield-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down + +------------ + + +shield-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +(Default 1.0) - opacity of the image used for the shield + +------------ + + +shield-text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +(Default 1.0) - opacity of the text placed on top of the shield + +------------ + + +shield-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` + + +Default Value: middle + + +The shield's horizontal alignment from its centerpoint + +------------ + + +shield-text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` + + +Default Value: none + + +Transform the case of the characters + +------------ + + +shield-no-text +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Whether the shield should make room for a text label. + +------------ + + +shield-justify-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: middle + + +Define how text in a shield's label is justified + +------------ + + + +line-pattern +^^^^^^^^^^^^ + +line-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +An image file to be repeated and warped along a line + +------------ + + + +polygon-pattern +^^^^^^^^^^^^^^^ + +polygon-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image to use as a repeated pattern fill within a polygon + +------------ + + +polygon-pattern-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``local`` ``global`` + + +Default Value: local + + +Specify whether to align pattern fills to the layer or to the map. + +------------ + + +polygon-pattern-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of polygon pattern edges + +------------ + + + +raster +^^^^^^ + +raster-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of the raster symbolizer on top of other symbolizers. + +------------ + + +raster-mode +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``normal`` ``grain_merge`` ``grain_merge2`` ``multiply`` ``multiply2`` ``divide`` ``divide2`` ``screen`` ``hard_light`` + + +Default Value: normal + + +The blending technique used to overlay this raster image on the layer below. Normal simply covers the layer. Grain merge adds the two layers together and subtracts 128 from the value, making the resulting area sometimes high-contrast. Screen often gives a lighter, washed-out appearance. Multiply multiplies the pixels, giving a high-contrast result. Divide divides the upper layer by the lower layer, making a lighter version. + +------------ + + +raster-filter-factor +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: -1 +*(Allow the datasource to choose appropriate downscaling.)* + +This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. + +------------ + + +raster-scaling +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``fast`` ``bilinear`` ``bilinear8`` ``bicubic`` ``spline16`` ``gaussian`` ``lanczos`` + + +Default Value: fast + + +The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. + +------------ + + +raster-mesh-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``integer`` + + + + + +Default Value: 16 +*(Reprojection mesh will be 1/16 of the resolution of the source image)* + +A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. + +------------ + + + +point +^^^^^ + +point-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image file to represent a point + +------------ + + +point-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow points to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping points are shown or hidden. + +------------ + + +point-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache)* + +value to control whether the placement of the feature will prevent the placement of other features + +------------ + + +point-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque)* + +A value from 0 to 1 to control the opacity of the point + +------------ + + +point-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``centroid`` ``interior`` + + +Default Value: centroid + + +How this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. + +------------ + + +point-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(No transformation)* + +SVG transformation definition + +------------ + + + +text +^^^^ + +text-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Value to use for a text label. Data columns are specified using brackets like [column_name] + +------------ + + +text-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Font name and style to render a label in + +------------ + + +text-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +Text size in pixels + +------------ + + +text-ratio +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Define the amount of text (of the total) present on successive lines when wrapping occurs + +------------ + + +text-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Length of a chunk of text in characters before wrapping text + +------------ + + +text-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Use this character instead of a space to wrap long text. + +------------ + + +text-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Distance between repeated text labels on a line + +------------ + + +text-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Horizontal spacing adjustment between characters in pixels + +------------ + + +text-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Vertical spacing adjustment between lines in pixels + +------------ + + +text-label-position-tolerance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Allows the label to be displaced from its ideal position by a number of pixels + +------------ + + +text-max-char-angle-delta +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: none + + +If present, the maximum angle change, in degrees, allowed between adjacent characters in a label. This will stop label placement around sharp corners. + +------------ + + +text-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #000000 + + +Specifies the color for the text + +------------ + + +text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque)* + +A number from 0 to 1 specifying the opacity for the text + +------------ + + +text-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF +*(white)* + +Specifies the color of the halo around the text. + +------------ + + +text-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo)* + +Specify the radius of the halo in pixels + +------------ + + +text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right + +------------ + + +text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down + +------------ + + +text-vertical-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``top`` ``middle`` ``bottom`` + + +Default Value: middle +*(Default affected by value of dy; "bottom" for dy>0, "top" for dy<0.)* + +Position of label relative to point position. + +------------ + + +text-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Tell positioning algorithm to avoid labeling near intersection edges. + +------------ + + +text-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Minimum permitted distance to the next text symbolizer. + +------------ + + +text-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Determines the minimum amount of padding that a text symbolizer gets relative to other text + +------------ + + +text-min-path-length +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(place labels on all paths)* + +Place labels only on paths longer than this value. + +------------ + + +text-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow text to overlap with other text - overlapping markers will not be shown.)* + +Control whether overlapping text is shown or hidden. + +------------ + + +text-orientation +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Rotate the text. + +------------ + + +text-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` + + +Default Value: point + + +Control the style of placement of a point versus the geometry it is attached to. + +------------ + + +text-placement-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``dummy`` ``simple`` + + +Default Value: dummy + + +Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. + +------------ + + +text-placements +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. See TextSymbolizer docs for format. + +------------ + + +text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` + + +Default Value: none + + +Transform the case of the characters + +------------ + + +text-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` + + +Default Value: middle + + +The text's horizontal alignment from its centerpoint + +------------ + + +text-align +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``right`` ``center`` + + +Default Value: center + + +Set the text alignment. + +------------ + + + +building +^^^^^^^^ + +building-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF + + +The color of the buildings walls. + +------------ + + +building-fill-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +The opacity of the building as a whole, including all walls. + +------------ + + +building-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +The height of the building in pixels. + +------------ + + + + + diff --git a/docs/api/mapnik/2.0.2.rst b/docs/api/mapnik/2.0.2.rst new file mode 100644 index 0000000..e9cb006 --- /dev/null +++ b/docs/api/mapnik/2.0.2.rst @@ -0,0 +1,1912 @@ +2.0.2 +===== +Style +----- + + + + + +Symbolizers +----------- + + +map +^^^ + +background-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: none +*(transparent)* + +Map Background color + +------------ + + +background-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: +*(transparent)* + +An image that is repeated below all features on a map as a background. + +------------ + + +srs +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs +*(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space)* + +Map spatial reference (proj4 string) + +------------ + + +buffer-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No buffer will be used)* + +Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". + +------------ + + +base +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)* + +Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. + +------------ + + +font-directory +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none +*(No map-specific fonts will be registered)* + +Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). + +------------ + + + +polygon +^^^^^^^ + +polygon-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: rgba(128,128,128,1) +*(gray and fully opaque (alpha = 1), same as rgb(128,128,128))* + +Fill color to assign to a polygon + +------------ + + +polygon-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of polygon edges + +------------ + + +polygon-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of the polygon + +------------ + + +polygon-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Amount of smoothing applied + +------------ + + + +line +^^^^ + +line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: rgba(0,0,0,1) +*(black and fully opaque (alpha = 1), same as rgb(0,0,0))* + +The color of a drawn line + +------------ + + +line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +The width of a line in pixels + +------------ + + +line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of a line + +------------ + + +line-join +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``miter`` ``round`` ``bevel`` + + +Default Value: miter + + +The behavior of lines when joining + +------------ + + +line-cap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``butt`` ``round`` ``square`` + + +Default Value: butt + + +The display of line endings + +------------ + + +line-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of stroke line + +------------ + + +line-dasharray +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(solid line)* + +A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. + +------------ + + +line-dash-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(solid line)* + +valid parameter but not currently used in renderers + +------------ + + +line-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full + + +Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. + +------------ + + + +markers +^^^^^^^ + +marker-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: +*(An ellipse or circle, if width equals height)* + +An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse. + +------------ + + +marker-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The overall opacity of the marker + +------------ + + +marker-line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black + + +The color of the stroke around a marker shape. + +------------ + + +marker-line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.5 + + +The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. + +------------ + + +marker-line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of a line + +------------ + + +marker-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` + + +Default Value: line + + +Attempt to place markers on a point once or on a line repeatedly + +------------ + + +marker-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``arrow`` ``ellipse`` + + +Default Value: ellipse + + +The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width) + +------------ + + +marker-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +The width of the marker, if using one of the default types. + +------------ + + +marker-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +The height of the marker, if using one of the default types. + +------------ + + +marker-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: blue + + +The color of the area of the marker. + +------------ + + +marker-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow makers to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping markers are shown or hidden. + +------------ + + +marker-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache)* + +value to control whether the placement of the feature will prevent the placement of other features + +------------ + + +marker-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 100 + + +Space between repeated labels + +------------ + + +marker-max-error +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.2 + + +The maximum difference between actual marker placement and the marker-spacing parameter. Setting a high value can allow the renderer to try to resolve placement conflicts with other symbolizers. + +------------ + + +marker-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(no transformation)* + +An SVG transformation definition + +------------ + + + +shield +^^^^^^ + +shield-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Value to use for a shield"s text label. Data columns are specified using brackets like [column_name] + +------------ + + +shield-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Font name and style to use for the shield text + +------------ + + +shield-unlock-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)* + +This parameter should be set to true if you are trying to position text beside rather than on top of the shield image + +------------ + + +shield-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +The size of the shield text in pixels + +------------ + + +shield-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black + + +The color of the shield text + +------------ + + +shield-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` + + +Default Value: point + + +How this shield should be placed. Point placement attempts to place it on top of points, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of polygons. + +------------ + + +shield-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Tell positioning algorithm to avoid labeling near intersection edges. + +------------ + + +shield-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Minimum distance to the next shield symbol, not necessarily the same shield. + +------------ + + +shield-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +The spacing between repeated occurrences of the same shield on a line + +------------ + + +shield-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Determines the minimum amount of padding that a shield gets relative to other shields + +------------ + + +shield-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Length before wrapping long names. + +------------ + + +shield-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Use this character instead of a space to wrap long names. + +------------ + + +shield-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF +*(white)* + +Specifies the color of the halo around the text. + +------------ + + +shield-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo)* + +Specify the radius of the halo in pixels + +------------ + + +shield-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. + +------------ + + +shield-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Vertical spacing between lines of multiline labels (in pixels) + +------------ + + +shield-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image file to render behind the shield text + +------------ + + +shield-text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right + +------------ + + +shield-text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down + +------------ + + +shield-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right + +------------ + + +shield-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down + +------------ + + +shield-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +(Default 1.0) - opacity of the image used for the shield + +------------ + + +shield-text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +(Default 1.0) - opacity of the text placed on top of the shield + +------------ + + +shield-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` + + +Default Value: middle + + +The shield's horizontal alignment from its centerpoint + +------------ + + +shield-text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` + + +Default Value: none + + +Transform the case of the characters + +------------ + + +shield-no-text +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Whether the shield should make room for a text label. + +------------ + + +shield-justify-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: middle + + +Define how text in a shield's label is justified + +------------ + + + +line-pattern +^^^^^^^^^^^^ + +line-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +An image file to be repeated and warped along a line + +------------ + + + +polygon-pattern +^^^^^^^^^^^^^^^ + +polygon-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image to use as a repeated pattern fill within a polygon + +------------ + + +polygon-pattern-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``local`` ``global`` + + +Default Value: local + + +Specify whether to align pattern fills to the layer or to the map. + +------------ + + +polygon-pattern-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of polygon pattern edges + +------------ + + + +raster +^^^^^^ + +raster-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of the raster symbolizer on top of other symbolizers. + +------------ + + +raster-mode +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``normal`` ``grain_merge`` ``grain_merge2`` ``multiply`` ``multiply2`` ``divide`` ``divide2`` ``screen`` ``hard_light`` + + +Default Value: normal + + +The blending technique used to overlay this raster image on the layer below. Normal simply covers the layer. Grain merge adds the two layers together and subtracts 128 from the value, making the resulting area sometimes high-contrast. Screen often gives a lighter, washed-out appearance. Multiply multiplies the pixels, giving a high-contrast result. Divide divides the upper layer by the lower layer, making a lighter version. + +------------ + + +raster-filter-factor +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: -1 +*(Allow the datasource to choose appropriate downscaling.)* + +This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. + +------------ + + +raster-scaling +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``fast`` ``bilinear`` ``bilinear8`` ``bicubic`` ``spline16`` ``gaussian`` ``lanczos`` + + +Default Value: fast + + +The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. + +------------ + + +raster-mesh-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``integer`` + + + + + +Default Value: 16 +*(Reprojection mesh will be 1/16 of the resolution of the source image)* + +A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. + +------------ + + + +point +^^^^^ + +point-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image file to represent a point + +------------ + + +point-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow points to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping points are shown or hidden. + +------------ + + +point-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache)* + +value to control whether the placement of the feature will prevent the placement of other features + +------------ + + +point-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque)* + +A value from 0 to 1 to control the opacity of the point + +------------ + + +point-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``centroid`` ``interior`` + + +Default Value: centroid + + +How this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. + +------------ + + +point-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(No transformation)* + +SVG transformation definition + +------------ + + + +text +^^^^ + +text-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Value to use for a text label. Data columns are specified using brackets like [column_name] + +------------ + + +text-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Font name and style to render a label in + +------------ + + +text-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +Text size in pixels + +------------ + + +text-ratio +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Define the amount of text (of the total) present on successive lines when wrapping occurs + +------------ + + +text-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Length of a chunk of text in characters before wrapping text + +------------ + + +text-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Use this character instead of a space to wrap long text. + +------------ + + +text-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Distance between repeated text labels on a line + +------------ + + +text-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Horizontal spacing adjustment between characters in pixels + +------------ + + +text-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Vertical spacing adjustment between lines in pixels + +------------ + + +text-label-position-tolerance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Allows the label to be displaced from its ideal position by a number of pixels + +------------ + + +text-max-char-angle-delta +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: none + + +If present, the maximum angle change, in degrees, allowed between adjacent characters in a label. This will stop label placement around sharp corners. + +------------ + + +text-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #000000 + + +Specifies the color for the text + +------------ + + +text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque)* + +A number from 0 to 1 specifying the opacity for the text + +------------ + + +text-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF +*(white)* + +Specifies the color of the halo around the text. + +------------ + + +text-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo)* + +Specify the radius of the halo in pixels + +------------ + + +text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right + +------------ + + +text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down + +------------ + + +text-vertical-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``top`` ``middle`` ``bottom`` + + +Default Value: middle +*(Default affected by value of dy; "bottom" for dy>0, "top" for dy<0.)* + +Position of label relative to point position. + +------------ + + +text-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Tell positioning algorithm to avoid labeling near intersection edges. + +------------ + + +text-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Minimum permitted distance to the next text symbolizer. + +------------ + + +text-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Determines the minimum amount of padding that a text symbolizer gets relative to other text + +------------ + + +text-min-path-length +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(place labels on all paths)* + +Place labels only on paths longer than this value. + +------------ + + +text-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow text to overlap with other text - overlapping markers will not be shown.)* + +Control whether overlapping text is shown or hidden. + +------------ + + +text-orientation +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Rotate the text. + +------------ + + +text-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` + + +Default Value: point + + +Control the style of placement of a point versus the geometry it is attached to. + +------------ + + +text-placement-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``dummy`` ``simple`` + + +Default Value: dummy + + +Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. + +------------ + + +text-placements +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. See TextSymbolizer docs for format. + +------------ + + +text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` + + +Default Value: none + + +Transform the case of the characters + +------------ + + +text-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` + + +Default Value: middle + + +The text's horizontal alignment from its centerpoint + +------------ + + +text-align +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``right`` ``center`` + + +Default Value: center + + +Set the text alignment. + +------------ + + + +building +^^^^^^^^ + +building-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF + + +The color of the buildings walls. + +------------ + + +building-fill-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +The opacity of the building as a whole, including all walls. + +------------ + + +building-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +The height of the building in pixels. + +------------ + + + + + diff --git a/docs/api/mapnik/2.1.0.rst b/docs/api/mapnik/2.1.0.rst new file mode 100644 index 0000000..7767290 --- /dev/null +++ b/docs/api/mapnik/2.1.0.rst @@ -0,0 +1,2527 @@ +2.1.0 +===== +Style +----- + + + + + +image-filters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``functions`` + + + +Possible values: ``agg-stack-blur`` ``emboss`` ``blur`` ``gray`` ``sobel`` ``edge-detect`` ``x-gradient`` ``y-gradient`` ``invert`` ``sharpen`` + +Default Value: none +*(no filters)* + +A list of image filters. + +------------ + + + +comp-op +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current layer on top of other layers)* + +Composite operation. This defines how this layer should behave relative to layers atop or below it. + +------------ + + + +opacity +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``float`` + + + + + +Default Value: 1 +*(no separate buffer will be used and no alpha will be applied to the style after rendering)* + +An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer) + +------------ + + + +Symbolizers +----------- + + +map +^^^ + +background-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: none +*(transparent)* + +Map Background color + +------------ + + +background-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: +*(transparent)* + +An image that is repeated below all features on a map as a background. + +------------ + + +srs +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs +*(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space)* + +Map spatial reference (proj4 string) + +------------ + + +buffer-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No buffer will be used)* + +Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". + +------------ + + +base +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)* + +Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. + +------------ + + +font-directory +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none +*(No map-specific fonts will be registered)* + +Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). + +------------ + + + +polygon +^^^^^^^ + +polygon-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: rgba(128,128,128,1) +*(gray and fully opaque (alpha = 1), same as rgb(128,128,128))* + +Fill color to assign to a polygon + +------------ + + +polygon-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of the polygon + +------------ + + +polygon-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of polygon edges + +------------ + + +polygon-gamma-method +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``power`` ``linear`` ``none`` ``threshold`` ``multiply`` + + +Default Value: power +*(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA)* + +An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions.h + +------------ + + +polygon-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +polygon-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +polygon-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(geometry will not be transformed)* + +Allows transformation functions to be applied to the geometry. + +------------ + + +polygon-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +line +^^^^ + +line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: rgba(0,0,0,1) +*(black and fully opaque (alpha = 1), same as rgb(0,0,0))* + +The color of a drawn line + +------------ + + +line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +The width of a line in pixels + +------------ + + +line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of a line + +------------ + + +line-join +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``miter`` ``round`` ``bevel`` + + +Default Value: miter + + +The behavior of lines when joining + +------------ + + +line-cap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``butt`` ``round`` ``square`` + + +Default Value: butt + + +The display of line endings + +------------ + + +line-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of stroke line + +------------ + + +line-gamma-method +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``power`` ``linear`` ``none`` ``threshold`` ``multiply`` + + +Default Value: power +*(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA)* + +An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions.h + +------------ + + +line-dasharray +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(solid line)* + +A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. + +------------ + + +line-dash-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(solid line)* + +valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled) + +------------ + + +line-miterlimit +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 4 +*(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )')* + +The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. + +------------ + + +line-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +line-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +line-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no offset)* + +Offsets a line a number of pixels parallel to its actual path. Postive values move the line left, negative values move it right (relative to the directionality of the line). + +------------ + + +line-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full + + +Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. + +------------ + + +line-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(geometry will not be transformed)* + +Allows transformation functions to be applied to the geometry. + +------------ + + +line-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +markers +^^^^^^^ + +marker-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: +*(An ellipse or circle, if width equals height)* + +An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse. + +------------ + + +marker-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The stroke-opacity and fill-opacity will be used)* + +The overall opacity of the marker, if set, overrides both the opacity of the fill and the opacity of the stroke. + +------------ + + +marker-fill-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The fill opacity of the marker + +------------ + + +marker-line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black + + +The color of the stroke around a marker shape. + +------------ + + +marker-line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.5 + + +The width of the stroke around a marker shape, in pixels. This is positioned on the boundary, so high values can cover the area itself. + +------------ + + +marker-line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of a line + +------------ + + +marker-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``interior`` + + +Default Value: point +*(Place markers at the center point (centroid) of the geometry)* + +Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior + +------------ + + +marker-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``arrow`` ``ellipse`` + + +Default Value: ellipse + + +The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width) + +------------ + + +marker-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +The width of the marker, if using one of the default types. + +------------ + + +marker-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +The height of the marker, if using one of the default types. + +------------ + + +marker-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: blue + + +The color of the area of the marker. + +------------ + + +marker-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow makers to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping markers are shown or hidden. + +------------ + + +marker-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache)* + +value to control whether the placement of the feature will prevent the placement of other features + +------------ + + +marker-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 100 + + +Space between repeated labels + +------------ + + +marker-max-error +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.2 + + +The maximum difference between actual marker placement and the marker-spacing parameter. Setting a high value can allow the renderer to try to resolve placement conflicts with other symbolizers. + +------------ + + +marker-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: +*(No transformation)* + +SVG transformation definition + +------------ + + +marker-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +marker-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +marker-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(geometry will not be transformed)* + +Allows transformation functions to be applied to the geometry. + +------------ + + +marker-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +shield +^^^^^^ + +shield-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Value to use for a shield"s text label. Data columns are specified using brackets like [column_name] + +------------ + + +shield-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image file to render behind the shield text + +------------ + + +shield-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Font name and style to use for the shield text + +------------ + + +shield-unlock-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)* + +This parameter should be set to true if you are trying to position text beside rather than on top of the shield image + +------------ + + +shield-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +The size of the shield text in pixels + +------------ + + +shield-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black + + +The color of the shield text + +------------ + + +shield-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` + + +Default Value: point + + +How this shield should be placed. Point placement attempts to place it on top of points, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of polygons. + +------------ + + +shield-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Tell positioning algorithm to avoid labeling near intersection edges. + +------------ + + +shield-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow shields to overlap with other map elements already placed.)* + +Control whether overlapping shields are shown or hidden. + +------------ + + +shield-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Minimum distance to the next shield symbol, not necessarily the same shield. + +------------ + + +shield-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +The spacing between repeated occurrences of the same shield on a line + +------------ + + +shield-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Determines the minimum amount of padding that a shield gets relative to other shields + +------------ + + +shield-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Length of a chunk of text in characters before wrapping text + +------------ + + +shield-wrap-before +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width. + +------------ + + +shield-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Use this character instead of a space to wrap long names. + +------------ + + +shield-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF +*(white)* + +Specifies the color of the halo around the text. + +------------ + + +shield-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo)* + +Specify the radius of the halo in pixels + +------------ + + +shield-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. + +------------ + + +shield-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Vertical spacing between lines of multiline labels (in pixels) + +------------ + + +shield-text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right + +------------ + + +shield-text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down + +------------ + + +shield-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right + +------------ + + +shield-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down + +------------ + + +shield-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +(Default 1.0) - opacity of the image used for the shield + +------------ + + +shield-text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +(Default 1.0) - opacity of the text placed on top of the shield + +------------ + + +shield-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` + + +Default Value: auto + + +The shield's horizontal alignment from its centerpoint + +------------ + + +shield-vertical-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``top`` ``middle`` ``bottom`` ``auto`` + + +Default Value: middle + + +The shield's vertical alignment from its centerpoint + +------------ + + +shield-text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` + + +Default Value: none + + +Transform the case of the characters + +------------ + + +shield-justify-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``center`` ``right`` ``auto`` + + +Default Value: auto + + +Define how text in a shield's label is justified + +------------ + + +shield-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +shield-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +line-pattern +^^^^^^^^^^^^ + +line-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +An image file to be repeated and warped along a line + +------------ + + +line-pattern-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +line-pattern-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +line-pattern-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(geometry will not be transformed)* + +Allows transformation functions to be applied to the geometry. + +------------ + + +line-pattern-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +polygon-pattern +^^^^^^^^^^^^^^^ + +polygon-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image to use as a repeated pattern fill within a polygon + +------------ + + +polygon-pattern-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``local`` ``global`` + + +Default Value: local + + +Specify whether to align pattern fills to the layer or to the map. + +------------ + + +polygon-pattern-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of polygon pattern edges + +------------ + + +polygon-pattern-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The image is rendered without modifications)* + +(Default 1.0) - Apply an opacity level to the image used for the pattern + +------------ + + +polygon-pattern-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +polygon-pattern-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +polygon-pattern-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(geometry will not be transformed)* + +Allows transformation functions to be applied to the geometry. + +------------ + + +polygon-pattern-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +raster +^^^^^^ + +raster-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of the raster symbolizer on top of other symbolizers. + +------------ + + +raster-filter-factor +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: -1 +*(Allow the datasource to choose appropriate downscaling.)* + +This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. + +------------ + + +raster-scaling +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``near`` ``fast`` ``bilinear`` ``bilinear8`` ``bicubic`` ``spline16`` ``spline36`` ``hanning`` ``hamming`` ``hermite`` ``kaiser`` ``quadric`` ``catrom`` ``gaussian`` ``bessel`` ``mitchell`` ``sinc`` ``lanczos`` ``blackman`` + + +Default Value: near + + +The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. + +------------ + + +raster-mesh-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 16 +*(Reprojection mesh will be 1/16 of the resolution of the source image)* + +A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. + +------------ + + +raster-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +point +^^^^^ + +point-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image file to represent a point + +------------ + + +point-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow points to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping points are shown or hidden. + +------------ + + +point-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache)* + +value to control whether the placement of the feature will prevent the placement of other features + +------------ + + +point-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque)* + +A value from 0 to 1 to control the opacity of the point + +------------ + + +point-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``centroid`` ``interior`` + + +Default Value: centroid + + +How this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. + +------------ + + +point-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: +*(No transformation)* + +SVG transformation definition + +------------ + + +point-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +text +^^^^ + +text-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Value to use for a text label. Data columns are specified using brackets like [column_name] + +------------ + + +text-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Font name and style to render a label in + +------------ + + +text-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +Text size in pixels + +------------ + + +text-ratio +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Define the amount of text (of the total) present on successive lines when wrapping occurs + +------------ + + +text-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Length of a chunk of text in characters before wrapping text + +------------ + + +text-wrap-before +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width. + +------------ + + +text-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Use this character instead of a space to wrap long text. + +------------ + + +text-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Distance between repeated text labels on a line (aka. label-spacing) + +------------ + + +text-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Horizontal spacing adjustment between characters in pixels + +------------ + + +text-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Vertical spacing adjustment between lines in pixels + +------------ + + +text-label-position-tolerance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line) + +------------ + + +text-max-char-angle-delta +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 22.5 + + +The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. + +------------ + + +text-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #000000 + + +Specifies the color for the text + +------------ + + +text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque)* + +A number from 0 to 1 specifying the opacity for the text + +------------ + + +text-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF +*(white)* + +Specifies the color of the halo around the text. + +------------ + + +text-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo)* + +Specify the radius of the halo in pixels + +------------ + + +text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right + +------------ + + +text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down + +------------ + + +text-vertical-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``top`` ``middle`` ``bottom`` ``auto`` + + +Default Value: auto +*(Default affected by value of dy; "bottom" for dy>0, "top" for dy<0.)* + +Position of label relative to point position. + +------------ + + +text-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Tell positioning algorithm to avoid labeling near intersection edges. + +------------ + + +text-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Minimum permitted distance to the next text symbolizer. + +------------ + + +text-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Determines the minimum amount of padding that a text symbolizer gets relative to other text + +------------ + + +text-min-path-length +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(place labels on all paths)* + +Place labels only on paths longer than this value. + +------------ + + +text-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow text to overlap with other text - overlapping markers will not be shown.)* + +Control whether overlapping text is shown or hidden. + +------------ + + +text-orientation +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Rotate the text. + +------------ + + +text-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` + + +Default Value: point + + +Control the style of placement of a point versus the geometry it is attached to. + +------------ + + +text-placement-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``dummy`` ``simple`` ``list`` + + +Default Value: dummy + + +Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. + +------------ + + +text-placements +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is ``text-placements: "E,NE,SE,W,NW,SW";`` + +------------ + + +text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` + + +Default Value: none + + +Transform the case of the characters + +------------ + + +text-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` + + +Default Value: auto + + +The text's horizontal alignment from its centerpoint + +------------ + + +text-align +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``right`` ``center`` ``auto`` + + +Default Value: auto +*(Auto alignment means that text will be centered by default except when using the ``placement-type`` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the ``text-placements`` directives)* + +Define how text is justified + +------------ + + +text-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +text-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +building +^^^^^^^^ + +building-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF + + +The color of the buildings walls. + +------------ + + +building-fill-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +The opacity of the building as a whole, including all walls. + +------------ + + +building-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +The height of the building in pixels. + +------------ + + + + + diff --git a/docs/api/mapnik/2.1.1.rst b/docs/api/mapnik/2.1.1.rst new file mode 100644 index 0000000..571356c --- /dev/null +++ b/docs/api/mapnik/2.1.1.rst @@ -0,0 +1,2544 @@ +2.1.1 +===== +Style +----- + + + + + +image-filters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``functions`` + + + +Possible values: ``agg-stack-blur`` ``emboss`` ``blur`` ``gray`` ``sobel`` ``edge-detect`` ``x-gradient`` ``y-gradient`` ``invert`` ``sharpen`` + +Default Value: none +*(no filters)* + +A list of image filters. + +------------ + + + +comp-op +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current layer on top of other layers)* + +Composite operation. This defines how this layer should behave relative to layers atop or below it. + +------------ + + + +opacity +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``float`` + + + + + +Default Value: 1 +*(no separate buffer will be used and no alpha will be applied to the style after rendering)* + +An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer) + +------------ + + + +Symbolizers +----------- + + +map +^^^ + +background-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: none +*(transparent)* + +Map Background color + +------------ + + +background-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: +*(transparent)* + +An image that is repeated below all features on a map as a background. + +------------ + + +srs +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs +*(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space)* + +Map spatial reference (proj4 string) + +------------ + + +buffer-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No buffer will be used)* + +Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". + +------------ + + +base +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)* + +Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. + +------------ + + +font-directory +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none +*(No map-specific fonts will be registered)* + +Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). + +------------ + + + +polygon +^^^^^^^ + +polygon-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: rgba(128,128,128,1) +*(gray and fully opaque (alpha = 1), same as rgb(128,128,128))* + +Fill color to assign to a polygon + +------------ + + +polygon-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of the polygon + +------------ + + +polygon-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of polygon edges + +------------ + + +polygon-gamma-method +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``power`` ``linear`` ``none`` ``threshold`` ``multiply`` + + +Default Value: power +*(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA)* + +An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions.h + +------------ + + +polygon-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +polygon-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +polygon-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(geometry will not be transformed)* + +Allows transformation functions to be applied to the geometry. + +------------ + + +polygon-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +line +^^^^ + +line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: rgba(0,0,0,1) +*(black and fully opaque (alpha = 1), same as rgb(0,0,0))* + +The color of a drawn line + +------------ + + +line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +The width of a line in pixels + +------------ + + +line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of a line + +------------ + + +line-join +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``miter`` ``round`` ``bevel`` + + +Default Value: miter + + +The behavior of lines when joining + +------------ + + +line-cap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``butt`` ``round`` ``square`` + + +Default Value: butt + + +The display of line endings + +------------ + + +line-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of stroke line + +------------ + + +line-gamma-method +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``power`` ``linear`` ``none`` ``threshold`` ``multiply`` + + +Default Value: power +*(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA)* + +An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions.h + +------------ + + +line-dasharray +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(solid line)* + +A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. + +------------ + + +line-dash-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(solid line)* + +valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled) + +------------ + + +line-miterlimit +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 4 +*(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )')* + +The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. + +------------ + + +line-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +line-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +line-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no offset)* + +Offsets a line a number of pixels parallel to its actual path. Postive values move the line left, negative values move it right (relative to the directionality of the line). + +------------ + + +line-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full + + +Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. + +------------ + + +line-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(geometry will not be transformed)* + +Allows transformation functions to be applied to the geometry. + +------------ + + +line-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +markers +^^^^^^^ + +marker-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: +*(An ellipse or circle, if width equals height)* + +An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse. + +------------ + + +marker-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The stroke-opacity and fill-opacity will be used)* + +The overall opacity of the marker, if set, overrides both the opacity of the fill and the opacity of the stroke. + +------------ + + +marker-fill-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The fill opacity of the marker + +------------ + + +marker-line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black + + +The color of the stroke around a marker shape. + +------------ + + +marker-line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.5 + + +The width of the stroke around a marker shape, in pixels. This is positioned on the boundary, so high values can cover the area itself. + +------------ + + +marker-line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of a line + +------------ + + +marker-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``interior`` + + +Default Value: point +*(Place markers at the center point (centroid) of the geometry)* + +Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior + +------------ + + +marker-multi-policy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``each`` ``whole`` ``largest`` + + +Default Value: each +*(If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each)* + +A special setting to allow the user to control rendering behavior for 'multi-geometries' (when a feature contains multiple geometries). This setting does not apply to markers placed along lines. The 'each' policy is default and means all geometries will get a marker. The 'whole' policy means that the aggregate centroid between all geometries will be used. The 'largest' policy means that only the largest (by bounding box areas) feature will get a rendered marker (this is how text labeling behaves by default). + +------------ + + +marker-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``arrow`` ``ellipse`` + + +Default Value: ellipse + + +The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width) + +------------ + + +marker-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``expression`` + + + + + +Default Value: 10 + + +The width of the marker, if using one of the default types. + +------------ + + +marker-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``expression`` + + + + + +Default Value: 10 + + +The height of the marker, if using one of the default types. + +------------ + + +marker-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: blue + + +The color of the area of the marker. + +------------ + + +marker-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow makers to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping markers are shown or hidden. + +------------ + + +marker-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache)* + +value to control whether the placement of the feature will prevent the placement of other features + +------------ + + +marker-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 100 + + +Space between repeated labels + +------------ + + +marker-max-error +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.2 + + +The maximum difference between actual marker placement and the marker-spacing parameter. Setting a high value can allow the renderer to try to resolve placement conflicts with other symbolizers. + +------------ + + +marker-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: +*(No transformation)* + +SVG transformation definition + +------------ + + +marker-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +marker-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +marker-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(geometry will not be transformed)* + +Allows transformation functions to be applied to the geometry. + +------------ + + +marker-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +shield +^^^^^^ + +shield-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``expression`` + + + + + +Default Value: + + +Value to use for a shield"s text label. Data columns are specified using brackets like [column_name] + +------------ + + +shield-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image file to render behind the shield text + +------------ + + +shield-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Font name and style to use for the shield text + +------------ + + +shield-unlock-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)* + +This parameter should be set to true if you are trying to position text beside rather than on top of the shield image + +------------ + + +shield-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +The size of the shield text in pixels + +------------ + + +shield-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black + + +The color of the shield text + +------------ + + +shield-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` + + +Default Value: point + + +How this shield should be placed. Point placement attempts to place it on top of points, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of polygons. + +------------ + + +shield-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Tell positioning algorithm to avoid labeling near intersection edges. + +------------ + + +shield-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow shields to overlap with other map elements already placed.)* + +Control whether overlapping shields are shown or hidden. + +------------ + + +shield-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Minimum distance to the next shield symbol, not necessarily the same shield. + +------------ + + +shield-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +The spacing between repeated occurrences of the same shield on a line + +------------ + + +shield-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Determines the minimum amount of padding that a shield gets relative to other shields + +------------ + + +shield-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Length of a chunk of text in characters before wrapping text + +------------ + + +shield-wrap-before +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width. + +------------ + + +shield-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Use this character instead of a space to wrap long names. + +------------ + + +shield-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF +*(white)* + +Specifies the color of the halo around the text. + +------------ + + +shield-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo)* + +Specify the radius of the halo in pixels + +------------ + + +shield-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. + +------------ + + +shield-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Vertical spacing between lines of multiline labels (in pixels) + +------------ + + +shield-text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right + +------------ + + +shield-text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down + +------------ + + +shield-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right + +------------ + + +shield-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down + +------------ + + +shield-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +(Default 1.0) - opacity of the image used for the shield + +------------ + + +shield-text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +(Default 1.0) - opacity of the text placed on top of the shield + +------------ + + +shield-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` + + +Default Value: auto + + +The shield's horizontal alignment from its centerpoint + +------------ + + +shield-vertical-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``top`` ``middle`` ``bottom`` ``auto`` + + +Default Value: middle + + +The shield's vertical alignment from its centerpoint + +------------ + + +shield-text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` + + +Default Value: none + + +Transform the case of the characters + +------------ + + +shield-justify-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``center`` ``right`` ``auto`` + + +Default Value: auto + + +Define how text in a shield's label is justified + +------------ + + +shield-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +shield-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +line-pattern +^^^^^^^^^^^^ + +line-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +An image file to be repeated and warped along a line + +------------ + + +line-pattern-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +line-pattern-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +line-pattern-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(geometry will not be transformed)* + +Allows transformation functions to be applied to the geometry. + +------------ + + +line-pattern-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +polygon-pattern +^^^^^^^^^^^^^^^ + +polygon-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image to use as a repeated pattern fill within a polygon + +------------ + + +polygon-pattern-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``local`` ``global`` + + +Default Value: local + + +Specify whether to align pattern fills to the layer or to the map. + +------------ + + +polygon-pattern-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of polygon pattern edges + +------------ + + +polygon-pattern-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The image is rendered without modifications)* + +(Default 1.0) - Apply an opacity level to the image used for the pattern + +------------ + + +polygon-pattern-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +polygon-pattern-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +polygon-pattern-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(geometry will not be transformed)* + +Allows transformation functions to be applied to the geometry. + +------------ + + +polygon-pattern-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +raster +^^^^^^ + +raster-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of the raster symbolizer on top of other symbolizers. + +------------ + + +raster-filter-factor +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: -1 +*(Allow the datasource to choose appropriate downscaling.)* + +This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. + +------------ + + +raster-scaling +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``near`` ``fast`` ``bilinear`` ``bilinear8`` ``bicubic`` ``spline16`` ``spline36`` ``hanning`` ``hamming`` ``hermite`` ``kaiser`` ``quadric`` ``catrom`` ``gaussian`` ``bessel`` ``mitchell`` ``sinc`` ``lanczos`` ``blackman`` + + +Default Value: near + + +The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. + +------------ + + +raster-mesh-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 16 +*(Reprojection mesh will be 1/16 of the resolution of the source image)* + +A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. + +------------ + + +raster-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +point +^^^^^ + +point-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image file to represent a point + +------------ + + +point-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow points to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping points are shown or hidden. + +------------ + + +point-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache)* + +value to control whether the placement of the feature will prevent the placement of other features + +------------ + + +point-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque)* + +A value from 0 to 1 to control the opacity of the point + +------------ + + +point-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``centroid`` ``interior`` + + +Default Value: centroid + + +How this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. + +------------ + + +point-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: +*(No transformation)* + +SVG transformation definition + +------------ + + +point-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +text +^^^^ + +text-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``expression`` + + + + + +Default Value: + + +Value to use for a text label. Data columns are specified using brackets like [column_name] + +------------ + + +text-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Font name and style to render a label in + +------------ + + +text-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +Text size in pixels + +------------ + + +text-ratio +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Define the amount of text (of the total) present on successive lines when wrapping occurs + +------------ + + +text-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Length of a chunk of text in characters before wrapping text + +------------ + + +text-wrap-before +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width. + +------------ + + +text-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Use this character instead of a space to wrap long text. + +------------ + + +text-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Distance between repeated text labels on a line (aka. label-spacing) + +------------ + + +text-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Horizontal spacing adjustment between characters in pixels + +------------ + + +text-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Vertical spacing adjustment between lines in pixels + +------------ + + +text-label-position-tolerance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line) + +------------ + + +text-max-char-angle-delta +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 22.5 + + +The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. + +------------ + + +text-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #000000 + + +Specifies the color for the text + +------------ + + +text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque)* + +A number from 0 to 1 specifying the opacity for the text + +------------ + + +text-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF +*(white)* + +Specifies the color of the halo around the text. + +------------ + + +text-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo)* + +Specify the radius of the halo in pixels + +------------ + + +text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right + +------------ + + +text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down + +------------ + + +text-vertical-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``top`` ``middle`` ``bottom`` ``auto`` + + +Default Value: auto +*(Default affected by value of dy; "bottom" for dy>0, "top" for dy<0.)* + +Position of label relative to point position. + +------------ + + +text-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Tell positioning algorithm to avoid labeling near intersection edges. + +------------ + + +text-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Minimum permitted distance to the next text symbolizer. + +------------ + + +text-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Determines the minimum amount of padding that a text symbolizer gets relative to other text + +------------ + + +text-min-path-length +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(place labels on all paths)* + +Place labels only on paths longer than this value. + +------------ + + +text-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow text to overlap with other text - overlapping markers will not be shown.)* + +Control whether overlapping text is shown or hidden. + +------------ + + +text-orientation +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``expression`` + + + + + +Default Value: 0 + + +Rotate the text. + +------------ + + +text-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` + + +Default Value: point + + +Control the style of placement of a point versus the geometry it is attached to. + +------------ + + +text-placement-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``dummy`` ``simple`` ``list`` + + +Default Value: dummy + + +Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. + +------------ + + +text-placements +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is ``text-placements: "E,NE,SE,W,NW,SW";`` + +------------ + + +text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` + + +Default Value: none + + +Transform the case of the characters + +------------ + + +text-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` + + +Default Value: auto + + +The text's horizontal alignment from its centerpoint + +------------ + + +text-align +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``right`` ``center`` ``auto`` + + +Default Value: auto +*(Auto alignment means that text will be centered by default except when using the ``placement-type`` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the ``text-placements`` directives)* + +Define how text is justified + +------------ + + +text-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +text-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +building +^^^^^^^^ + +building-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF + + +The color of the buildings walls. + +------------ + + +building-fill-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +The opacity of the building as a whole, including all walls. + +------------ + + +building-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``expression`` + + + + + +Default Value: 0 + + +The height of the building in pixels. + +------------ + + + + + diff --git a/docs/api/mapnik/2.2.0.rst b/docs/api/mapnik/2.2.0.rst new file mode 100644 index 0000000..8798cf3 --- /dev/null +++ b/docs/api/mapnik/2.2.0.rst @@ -0,0 +1,3045 @@ +2.2.0 +===== +Style +----- + + + + + +image-filters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``functions`` + + + +Possible values: ``agg-stack-blur`` ``emboss`` ``blur`` ``gray`` ``sobel`` ``edge-detect`` ``x-gradient`` ``y-gradient`` ``invert`` ``sharpen`` ``colorize-alpha`` + +Default Value: none +*(no filters)* + +A list of image filters that will be applied to the active rendering canvas for a given style. The presence of one more more ``image-filters`` will trigger a new canvas to be created before starting to render a style and then this canvas will be composited back into the main canvas after rendering all features and after all ``image-filters`` have been applied. See ``direct-image-filters`` if you want to apply a filter directly to the main canvas. + +------------ + + + +direct-image-filters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``functions`` + + + +Possible values: ``agg-stack-blur`` ``emboss`` ``blur`` ``gray`` ``sobel`` ``edge-detect`` ``x-gradient`` ``y-gradient`` ``invert`` ``sharpen`` ``colorize-alpha`` + +Default Value: none +*(no filters)* + +A list of image filters to apply to the main canvas (see the ``image-filters`` doc for how they work on a separate canvas) + +------------ + + + +comp-op +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current layer on top of other layers)* + +Composite operation. This defines how this layer should behave relative to layers atop or below it. + +------------ + + + +opacity +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``float`` + + + + + +Default Value: 1 +*(no separate buffer will be used and no alpha will be applied to the style after rendering)* + +An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer) + +------------ + + + +Symbolizers +----------- + + +map +^^^ + +background-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: none +*(transparent)* + +Map Background color + +------------ + + +background-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: +*(transparent)* + +An image that is repeated below all features on a map as a background. + +------------ + + +srs +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs +*(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space)* + +Map spatial reference (proj4 string) + +------------ + + +buffer-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No buffer will be used)* + +Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". + +------------ + + +base +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)* + +Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. + +------------ + + +font-directory +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none +*(No map-specific fonts will be registered)* + +Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). + +------------ + + + +polygon +^^^^^^^ + +polygon +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a polygon symbolizer rule or emitting it with default values. + +------------ + + +polygon-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: rgba(128,128,128,1) +*(gray and fully opaque (alpha = 1), same as rgb(128,128,128))* + +Fill color to assign to a polygon + +------------ + + +polygon-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of the polygon + +------------ + + +polygon-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of polygon edges + +------------ + + +polygon-gamma-method +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``power`` ``linear`` ``none`` ``threshold`` ``multiply`` + + +Default Value: power +*(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA)* + +An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions.h + +------------ + + +polygon-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +polygon-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified)* + +geometries are simplified by the given tolerance + +------------ + + +polygon-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` + + +Default Value: radial-distance +*(geometry will not be simplified using the radial distance algorithm)* + +geometries are simplified by the given algorithm + +------------ + + +polygon-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +polygon-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(geometry will not be transformed)* + +Allows transformation functions to be applied to the geometry. + +------------ + + +polygon-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +line +^^^^ + +line +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a line symbolizer rule or emitting it with default values. + +------------ + + +line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: rgba(0,0,0,1) +*(black and fully opaque (alpha = 1), same as rgb(0,0,0))* + +The color of a drawn line + +------------ + + +line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +The width of a line in pixels + +------------ + + +line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of a line + +------------ + + +line-join +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``miter`` ``round`` ``bevel`` + + +Default Value: miter + + +The behavior of lines when joining + +------------ + + +line-cap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``butt`` ``round`` ``square`` + + +Default Value: butt + + +The display of line endings + +------------ + + +line-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of stroke line + +------------ + + +line-gamma-method +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``power`` ``linear`` ``none`` ``threshold`` ``multiply`` + + +Default Value: power +*(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA)* + +An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions.h + +------------ + + +line-dasharray +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(solid line)* + +A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. + +------------ + + +line-dash-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(solid line)* + +valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled) + +------------ + + +line-miterlimit +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 4 +*(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )')* + +The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. + +------------ + + +line-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +line-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified)* + +geometries are simplified by the given tolerance + +------------ + + +line-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` + + +Default Value: radial-distance +*(geometry will not be simplified using the radial distance algorithm)* + +geometries are simplified by the given algorithm + +------------ + + +line-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +line-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no offset)* + +Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). + +------------ + + +line-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full + + +Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. + +------------ + + +line-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(geometry will not be transformed)* + +Allows transformation functions to be applied to the geometry. + +------------ + + +line-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +markers +^^^^^^^ + +marker +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a marker symbolizer rule or emitting it with default values. + +------------ + + +marker-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: +*(An ellipse or circle, if width equals height)* + +An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse. + +------------ + + +marker-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The stroke-opacity and fill-opacity will be used)* + +The overall opacity of the marker, overrides both the opacity of the fill and the opacity of the stroke. + +------------ + + +marker-fill-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The fill opacity of the marker + +------------ + + +marker-line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black + + +The color of the stroke around a marker shape. + +------------ + + +marker-line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.5 + + +The width of the stroke around a marker shape, in pixels. This is positioned on the boundary, so high values can cover the area itself. + +------------ + + +marker-line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of a line + +------------ + + +marker-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``interior`` + + +Default Value: point +*(Place markers at the center point (centroid) of the geometry)* + +Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior + +------------ + + +marker-multi-policy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``each`` ``whole`` ``largest`` + + +Default Value: each +*(If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each)* + +A special setting to allow the user to control rendering behavior for 'multi-geometries' (when a feature contains multiple geometries). This setting does not apply to markers placed along lines. The 'each' policy is default and means all geometries will get a marker. The 'whole' policy means that the aggregate centroid between all geometries will be used. The 'largest' policy means that only the largest (by bounding box areas) feature will get a rendered marker (this is how text labeling behaves by default). + +------------ + + +marker-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``arrow`` ``ellipse`` + + +Default Value: ellipse + + +The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width) + +------------ + + +marker-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +The width of the marker, if using one of the default types. + +------------ + + +marker-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +The height of the marker, if using one of the default types. + +------------ + + +marker-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: blue + + +The color of the area of the marker. + +------------ + + +marker-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow makers to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping markers are shown or hidden. + +------------ + + +marker-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache)* + +value to control whether the placement of the feature will prevent the placement of other features + +------------ + + +marker-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 100 + + +Space between repeated markers in pixels. If the spacing is less than the marker size or larger than the line segment length then no marker will be placed + +------------ + + +marker-max-error +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.2 + + +The maximum difference between actual marker placement and the marker-spacing parameter. Setting a high value can allow the renderer to try to resolve placement conflicts with other symbolizers. + +------------ + + +marker-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: +*(No transformation)* + +SVG transformation definition + +------------ + + +marker-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +marker-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +marker-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(geometry will not be transformed)* + +Allows transformation functions to be applied to the geometry. + +------------ + + +marker-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +shield +^^^^^^ + +shield +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a shield symbolizer. + +------------ + + +shield-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Value to use for a shield"s text label. Data columns are specified using brackets like [column_name] + +------------ + + +shield-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image file to render behind the shield text + +------------ + + +shield-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Font name and style to use for the shield text + +------------ + + +shield-unlock-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)* + +This parameter should be set to true if you are trying to position text beside rather than on top of the shield image + +------------ + + +shield-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +The size of the shield text in pixels + +------------ + + +shield-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black + + +The color of the shield text + +------------ + + +shield-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` + + +Default Value: point + + +How this shield should be placed. Point placement attempts to place it on top of points, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of polygons. + +------------ + + +shield-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Avoid placing shields that intersect with tile boundaries. + +------------ + + +shield-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow shields to overlap with other map elements already placed.)* + +Control whether overlapping shields are shown or hidden. + +------------ + + +shield-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Minimum distance to the next shield symbol, not necessarily the same shield. + +------------ + + +shield-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +The spacing between repeated occurrences of the same shield on a line + +------------ + + +shield-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Minimum distance a shield will be placed from the edge of a metatile. + +------------ + + +shield-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Length of a chunk of text in characters before wrapping text + +------------ + + +shield-wrap-before +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width. + +------------ + + +shield-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Use this character instead of a space to wrap long names. + +------------ + + +shield-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF +*(white)* + +Specifies the color of the halo around the text. + +------------ + + +shield-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo)* + +Specify the radius of the halo in pixels + +------------ + + +shield-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. + +------------ + + +shield-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Vertical spacing between lines of multiline labels (in pixels) + +------------ + + +shield-text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right + +------------ + + +shield-text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down + +------------ + + +shield-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right + +------------ + + +shield-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down + +------------ + + +shield-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +The opacity of the image used for the shield + +------------ + + +shield-text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +The opacity of the text placed on top of the shield + +------------ + + +shield-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` + + +Default Value: auto + + +The shield's horizontal alignment from its centerpoint + +------------ + + +shield-vertical-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``top`` ``middle`` ``bottom`` ``auto`` + + +Default Value: middle + + +The shield's vertical alignment from its centerpoint + +------------ + + +shield-placement-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``dummy`` ``simple`` + + +Default Value: dummy + + +Re-position and/or re-size shield to avoid overlaps. "simple" for basic algorithm (using shield-placements string,) "dummy" to turn this feature off. + +------------ + + +shield-placements +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is ``shield-placements: "E,NE,SE,W,NW,SW";`` + +------------ + + +shield-text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` + + +Default Value: none + + +Transform the case of the characters + +------------ + + +shield-justify-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``center`` ``right`` ``auto`` + + +Default Value: auto + + +Define how text in a shield's label is justified + +------------ + + +shield-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: +*(No transformation)* + +SVG transformation definition + +------------ + + +shield-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +shield-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +line-pattern +^^^^^^^^^^^^ + +line-pattern +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a line pattern symbolizer rule or emitting it with default values. + +------------ + + +line-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +An image file to be repeated and warped along a line + +------------ + + +line-pattern-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +line-pattern-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified)* + +geometries are simplified by the given tolerance + +------------ + + +line-pattern-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` + + +Default Value: radial-distance +*(geometry will not be simplified using the radial distance algorithm)* + +geometries are simplified by the given algorithm + +------------ + + +line-pattern-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +line-pattern-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(geometry will not be transformed)* + +Allows transformation functions to be applied to the geometry. + +------------ + + +line-pattern-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +polygon-pattern +^^^^^^^^^^^^^^^ + +polygon-pattern +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a polygon pattern symbolizer rule or emitting it with default values. + +------------ + + +polygon-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image to use as a repeated pattern fill within a polygon + +------------ + + +polygon-pattern-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``local`` ``global`` + + +Default Value: local + + +Specify whether to align pattern fills to the layer or to the map. + +------------ + + +polygon-pattern-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of polygon pattern edges + +------------ + + +polygon-pattern-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The image is rendered without modifications)* + +Apply an opacity level to the image used for the pattern + +------------ + + +polygon-pattern-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +polygon-pattern-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified)* + +geometries are simplified by the given tolerance + +------------ + + +polygon-pattern-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` + + +Default Value: radial-distance +*(geometry will not be simplified using the radial distance algorithm)* + +geometries are simplified by the given algorithm + +------------ + + +polygon-pattern-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +polygon-pattern-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(geometry will not be transformed)* + +Allows transformation functions to be applied to the geometry. + +------------ + + +polygon-pattern-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +raster +^^^^^^ + +raster +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a raster symbolizer rule or emitting it with default values. + +------------ + + +raster-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of the raster symbolizer on top of other symbolizers. + +------------ + + +raster-filter-factor +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: -1 +*(Allow the datasource to choose appropriate downscaling.)* + +This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. + +------------ + + +raster-scaling +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``near`` ``fast`` ``bilinear`` ``bilinear8`` ``bicubic`` ``spline16`` ``spline36`` ``hanning`` ``hamming`` ``hermite`` ``kaiser`` ``quadric`` ``catrom`` ``gaussian`` ``bessel`` ``mitchell`` ``sinc`` ``lanczos`` ``blackman`` + + +Default Value: near + + +The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. + +------------ + + +raster-mesh-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 16 +*(Reprojection mesh will be 1/16 of the resolution of the source image)* + +A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. + +------------ + + +raster-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +raster-colorizer-default-mode +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``discrete`` ``linear`` ``exact`` + + +Default Value: linear +*(A linear interpolation is used to generate colors between the two nearest stops.)* + +This can be either ``discrete``, ``linear`` or ``exact``. If it is not specified then the default is ``linear``. + +------------ + + +raster-colorizer-default-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: transparent +*(Pixels that are not colored by the colorizer stops will be transparent)* + +This can be any color. Sets the color that is applied to all values outside of the range of the colorizer-stops. If not supplied pixels will be fully transparent + +------------ + + +raster-colorizer-epsilon +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1.1920928955078125e-07 +*(Pixels must very closely match the stop filter otherwise they will not be colored.)* + +This can be any positive floating point value and will be used as a tolerance in floating point comparisions. The higher the value the more likely a stop will match and color data. + +------------ + + +raster-colorizer-stops +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``tags`` + + + + + +Default Value: +*(No colorization will happen without supplying stops.)* + +Assigns raster data values to colors. Stops must be listed in ascending order, and contain at a minimum the value and the associated color. You can also include the color-mode as a third argument, like ``stop(100,#fff,exact)``. + +------------ + + + +point +^^^^^ + +point +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a point symbolizer rule or emitting it with default values. + +------------ + + +point-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image file to represent a point + +------------ + + +point-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow points to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping points are shown or hidden. + +------------ + + +point-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache)* + +value to control whether the placement of the feature will prevent the placement of other features + +------------ + + +point-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque)* + +A value from 0 to 1 to control the opacity of the point + +------------ + + +point-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``centroid`` ``interior`` + + +Default Value: centroid + + +How this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. + +------------ + + +point-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: +*(No transformation)* + +SVG transformation definition + +------------ + + +point-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +text +^^^^ + +text +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a text symbolizer rule. + +------------ + + +text-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Value to use for a text label. Data columns are specified using brackets like [column_name] + +------------ + + +text-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Font name and style to render a label in + +------------ + + +text-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +Text size in pixels + +------------ + + +text-ratio +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Define the amount of text (of the total) present on successive lines when wrapping occurs + +------------ + + +text-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Length of a chunk of text in characters before wrapping text + +------------ + + +text-wrap-before +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width. + +------------ + + +text-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Use this character instead of a space to wrap long text. + +------------ + + +text-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Distance between repeated text labels on a line (aka. label-spacing) + +------------ + + +text-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Horizontal spacing adjustment between characters in pixels + +------------ + + +text-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Vertical spacing adjustment between lines in pixels + +------------ + + +text-label-position-tolerance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line) + +------------ + + +text-max-char-angle-delta +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 22.5 + + +The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. + +------------ + + +text-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #000000 + + +Specifies the color for the text + +------------ + + +text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque)* + +A number from 0 to 1 specifying the opacity for the text + +------------ + + +text-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF +*(white)* + +Specifies the color of the halo around the text. + +------------ + + +text-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo)* + +Specify the radius of the halo in pixels + +------------ + + +text-halo-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full + + +Exposes an alternate text halo rendering method that sacrifices quality for speed. + +------------ + + +text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right + +------------ + + +text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down + +------------ + + +text-vertical-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``top`` ``middle`` ``bottom`` ``auto`` + + +Default Value: auto +*(Default affected by value of dy; "bottom" for dy>0, "top" for dy<0.)* + +Position of label relative to point position. + +------------ + + +text-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Avoid placing labels that intersect with tile boundaries. + +------------ + + +text-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Minimum permitted distance to the next text symbolizer. + +------------ + + +text-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Minimum distance a text label will be placed from the edge of a metatile. + +------------ + + +text-min-path-length +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(place labels on all paths)* + +Place labels only on paths longer than this value. + +------------ + + +text-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow text to overlap with other text - overlapping markers will not be shown.)* + +Control whether overlapping text is shown or hidden. + +------------ + + +text-orientation +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Rotate the text. + +------------ + + +text-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` + + +Default Value: point + + +Control the style of placement of a point versus the geometry it is attached to. + +------------ + + +text-placement-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``dummy`` ``simple`` + + +Default Value: dummy + + +Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. + +------------ + + +text-placements +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is ``text-placements: "E,NE,SE,W,NW,SW";`` + +------------ + + +text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` + + +Default Value: none + + +Transform the case of the characters + +------------ + + +text-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` + + +Default Value: auto + + +The text's horizontal alignment from its centerpoint + +------------ + + +text-align +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``right`` ``center`` ``auto`` + + +Default Value: auto +*(Auto alignment means that text will be centered by default except when using the ``placement-type`` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the ``text-placements`` directives)* + +Define how text is justified + +------------ + + +text-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +text-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +building +^^^^^^^^ + +building +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a building symbolizer rule or emitting it with default values. + +------------ + + +building-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF + + +The color of the buildings walls. + +------------ + + +building-fill-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +The opacity of the building as a whole, including all walls. + +------------ + + +building-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +The height of the building in pixels. + +------------ + + + +debug +^^^^^ + +debug-mode +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``collision`` ``vertex`` + + +Default Value: collision + + +The mode for debug rendering + +------------ + + + + + diff --git a/docs/api/mapnik/2.3.0.rst b/docs/api/mapnik/2.3.0.rst new file mode 100644 index 0000000..a1d5444 --- /dev/null +++ b/docs/api/mapnik/2.3.0.rst @@ -0,0 +1,3131 @@ +2.3.0 +===== +Style +----- + + + + + +image-filters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``functions`` + + + +Possible values: ``agg-stack-blur`` ``emboss`` ``blur`` ``gray`` ``sobel`` ``edge-detect`` ``x-gradient`` ``y-gradient`` ``invert`` ``sharpen`` ``colorize-alpha`` ``color-to-alpha`` ``scale-hsla`` + +Default Value: none +*(no filters)* + +A list of image filters that will be applied to the active rendering canvas for a given style. The presence of one more more ``image-filters`` will trigger a new canvas to be created before starting to render a style and then this canvas will be composited back into the main canvas after rendering all features and after all ``image-filters`` have been applied. See ``direct-image-filters`` if you want to apply a filter directly to the main canvas. + +------------ + + + +image-filters-inflate +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``boolean`` + + + + + +Default Value: false +*(No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary)* + +A property that can be set to true to enable using an inflated image internally for seamless blurring across tiles (requires buffered data). + +------------ + + + +direct-image-filters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``functions`` + + + +Possible values: ``agg-stack-blur`` ``emboss`` ``blur`` ``gray`` ``sobel`` ``edge-detect`` ``x-gradient`` ``y-gradient`` ``invert`` ``sharpen`` ``colorize-alpha`` ``color-to-alpha`` ``scale-hsla`` + +Default Value: none +*(no filters)* + +A list of image filters to apply to the main canvas (see the ``image-filters`` doc for how they work on a separate canvas). + +------------ + + + +comp-op +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current layer on top of other layers)* + +Composite operation. This defines how this layer should behave relative to layers atop or below it. + +------------ + + + +opacity +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``float`` + + + + + +Default Value: 1 +*(no separate buffer will be used and no alpha will be applied to the style after rendering)* + +An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer). + +------------ + + + +Symbolizers +----------- + + +map +^^^ + +background-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: none +*(transparent)* + +Map Background color. + +------------ + + +background-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: +*(transparent)* + +An image that is repeated below all features on a map as a background. Accepted formats: JPG, PNG. + +------------ + + +background-image-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(The background-image will be blended with the background normally (placed on top of any existing background-color))* + +Set the compositing operation used to blend the image into the background. + +------------ + + +background-image-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The image opacity will not be changed when applied to the map background)* + +Set the opacity of the image. + +------------ + + +srs +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs +*(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space)* + +Map spatial reference (proj4 string). + +------------ + + +buffer-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No buffer will be used)* + +Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". + +------------ + + +base +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)* + +Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. + +------------ + + +font-directory +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none +*(No map-specific fonts will be registered)* + +Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). + +------------ + + + +polygon +^^^^^^^ + +polygon +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a polygon symbolizer rule or emitting it with default values. + +------------ + + +polygon-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: rgba(128,128,128,1) +*(gray and fully opaque (alpha = 1), same as rgb(128,128,128))* + +Fill color to assign to a polygon. + +------------ + + +polygon-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of the polygon. + +------------ + + +polygon-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of polygon edges. + +------------ + + +polygon-gamma-method +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``power`` ``linear`` ``none`` ``threshold`` ``multiply`` + + +Default Value: power +*(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA)* + +An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. + +------------ + + +polygon-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +Geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +polygon-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified)* + +Simplify geometries by the given tolerance. + +------------ + + +polygon-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` + + +Default Value: radial-distance +*(geometry will be simplified using the radial distance algorithm)* + +Simplify gemoetries by the given algorithm. + +------------ + + +polygon-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +polygon-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(geometry will not be transformed)* + +Allows transformation functions to be applied to the geometry. + +------------ + + +polygon-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +line +^^^^ + +line +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a line symbolizer rule or emitting it with default values. + +------------ + + +line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: rgba(0,0,0,1) +*(black and fully opaque (alpha = 1), same as rgb(0,0,0))* + +The color of a drawn line. + +------------ + + +line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +The width of a line in pixels. + +------------ + + +line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of a line. + +------------ + + +line-join +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``miter`` ``round`` ``bevel`` + + +Default Value: miter + + +The behavior of lines when joining. + +------------ + + +line-cap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``butt`` ``round`` ``square`` + + +Default Value: butt + + +The display of line endings. + +------------ + + +line-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of stroke line. + +------------ + + +line-gamma-method +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``power`` ``linear`` ``none`` ``threshold`` ``multiply`` + + +Default Value: power +*(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA)* + +An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. + +------------ + + +line-dasharray +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(solid line)* + +A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. + +------------ + + +line-dash-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(solid line)* + +Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled). + +------------ + + +line-miterlimit +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 4 +*(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )')* + +The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. + +------------ + + +line-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +Geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +line-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified)* + +Simplify gemoetries by the given tolerance + +------------ + + +line-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` + + +Default Value: radial-distance +*(geometry will be simplified using the radial distance algorithm)* + +Simplify gemoetries by the given algorithm. + +------------ + + +line-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +line-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no offset)* + +Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). + +------------ + + +line-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full + + +Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. + +------------ + + +line-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(geometry will not be transformed)* + +Allows transformation functions to be applied to the geometry. + +------------ + + +line-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +markers +^^^^^^^ + +marker +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a marker symbolizer rule or emitting it with default values. + +------------ + + +marker-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none +*(An ellipse or circle, if width equals height.)* + +A file that this marker shows at each placement. If no file is given, the marker will show an ellipse. Accepted formats: SVG, JPG, PNG. + +------------ + + +marker-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The stroke-opacity and fill-opacity of the marker.)* + +The overall opacity of the marker, if set, overrides both the opacity of the fill and the opacity of the stroke. + +------------ + + +marker-fill-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The fill opacity of the marker. + +------------ + + +marker-line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black + + +The color of the stroke around the marker. + +------------ + + +marker-line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.5 + + +The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. + +------------ + + +marker-line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of the line. + +------------ + + +marker-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``interior`` + + +Default Value: point +*(Place markers at the center point (centroid) of the geometry)* + +Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior. + +------------ + + +marker-multi-policy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``each`` ``whole`` ``largest`` + + +Default Value: each +*(If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each)* + +A special setting to allow the user to control rendering behavior for 'multi-geometries' (when a feature contains multiple geometries). This setting does not apply to markers placed along lines. The 'each' policy is default and means all geometries will get a marker. The 'whole' policy means that the aggregate centroid between all geometries will be used. The 'largest' policy means that only the largest (by bounding box areas) feature will get a rendered marker (this is how text labeling behaves by default). + +------------ + + +marker-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``arrow`` ``ellipse`` + + +Default Value: ellipse + + +The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width). + +------------ + + +marker-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +The width of the marker, if using one of the default types. + +------------ + + +marker-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +The height of the marker, if using one of the default types. + +------------ + + +marker-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: blue + + +The color of the area of the marker. + +------------ + + +marker-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow makers to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping markers are shown or hidden. + +------------ + + +marker-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache)* + +Value to control whether the placement of the feature will prevent the placement of other features. + +------------ + + +marker-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 100 + + +Space between repeated markers in pixels. If the spacing is less than the marker size or larger than the line segment length then no marker will be placed. + +------------ + + +marker-max-error +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.2 + + +The maximum difference between actual marker placement and the marker-spacing parameter. Setting a high value can allow the renderer to try to resolve placement conflicts with other symbolizers. + +------------ + + +marker-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation)* + +SVG transformation definition. + +------------ + + +marker-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +marker-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +marker-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(geometry will not be transformed)* + +Allows transformation functions to be applied to the geometry. + +------------ + + +marker-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +shield +^^^^^^ + +shield +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a shield symbolizer. + +------------ + + +shield-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Value to use for a shield"s text label. Data columns are specified using brackets like [column_name]. + +------------ + + +shield-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image file to render behind the shield text. Accepted formats: SVG, JPG, PNG. + +------------ + + +shield-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Font name and style to use for the shield text + +------------ + + +shield-unlock-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)* + +This parameter should be set to true if you are trying to position text beside rather than on top of the shield image + +------------ + + +shield-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +The size of the shield text in pixels. + +------------ + + +shield-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black + + +The color of the shield text. + +------------ + + +shield-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` + + +Default Value: point + + +How this shield should be placed. Point placement attempts to place it on top of points, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of polygons. + +------------ + + +shield-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Avoid placing shields that intersect with tile boundaries. + +------------ + + +shield-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow shields to overlap with other map elements already placed.)* + +Control whether overlapping shields are shown or hidden. + +------------ + + +shield-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Minimum distance to the next shield symbol, not necessarily the same shield. + +------------ + + +shield-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +The spacing between repeated occurrences of the same shield on a line. + +------------ + + +shield-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Minimum distance a shield will be placed from the edge of a metatile. This option is similar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the metatile. + +------------ + + +shield-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. + +------------ + + +shield-wrap-before +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width. + +------------ + + +shield-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: " " + + +Use this character instead of a space to wrap long names. + +------------ + + +shield-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF +*(white)* + +Specifies the color of the halo around the text. + +------------ + + +shield-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo)* + +Specify the radius of the halo in pixels. + +------------ + + +shield-halo-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full + + +Exposes an alternate text halo rendering method that sacrifices quality for speed. + +------------ + + +shield-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. + +------------ + + +shield-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Vertical spacing between lines of multiline labels (in pixels). + +------------ + + +shield-text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right. + +------------ + + +shield-text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down. + +------------ + + +shield-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right. + +------------ + + +shield-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down. + +------------ + + +shield-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +The opacity of the image used for the shield + +------------ + + +shield-text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +The opacity of the text placed on top of the shield + +------------ + + +shield-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` + + +Default Value: auto + + +The shield's horizontal alignment from its centerpoint + +------------ + + +shield-vertical-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``top`` ``middle`` ``bottom`` ``auto`` + + +Default Value: middle + + +The shield's vertical alignment from its centerpoint + +------------ + + +shield-placement-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``dummy`` ``simple`` ``list`` + + +Default Value: dummy + + +Re-position and/or re-size shield to avoid overlaps. "simple" for basic algorithm (using shield-placements string,) "dummy" to turn this feature off. + +------------ + + +shield-placements +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is ``shield-placements: "E,NE,SE,W,NW,SW";`` + +------------ + + +shield-text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` + + +Default Value: none + + +Transform the case of the characters. + +------------ + + +shield-justify-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``center`` ``right`` ``auto`` + + +Default Value: auto + + +Define how text in a shield's label is justified. + +------------ + + +shield-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation)* + +SVG transformation definition. + +------------ + + +shield-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +shield-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +line-pattern +^^^^^^^^^^^^ + +line-pattern +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a line pattern symbolizer rule or emitting it with default values. + +------------ + + +line-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +An image file to be repeated and warped along a line. Accepted formats: JPG, PNG. + +------------ + + +line-pattern-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +line-pattern-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified)* + +geometries are simplified by the given tolerance + +------------ + + +line-pattern-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` + + +Default Value: radial-distance +*(geometry will be simplified using the radial distance algorithm)* + +geometries are simplified by the given algorithm. + +------------ + + +line-pattern-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +line-pattern-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no offset)* + +Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). + +------------ + + +line-pattern-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(geometry will not be transformed)* + +Allows transformation functions to be applied to the geometry. + +------------ + + +line-pattern-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +polygon-pattern +^^^^^^^^^^^^^^^ + +polygon-pattern +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a polygon pattern symbolizer rule or emitting it with default values. + +------------ + + +polygon-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image to use as a repeated pattern fill within a polygon. Accepted formats: JPG, PNG. + +------------ + + +polygon-pattern-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``local`` ``global`` + + +Default Value: local + + +Specify whether to align pattern fills to the layer or to the map. + +------------ + + +polygon-pattern-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(fully antialiased)* +Range: 0-1 +Level of antialiasing of polygon pattern edges + +------------ + + +polygon-pattern-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The image is rendered without modifications)* + +Apply an opacity level to the image used for the pattern + +------------ + + +polygon-pattern-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +polygon-pattern-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified)* + +geometries are simplified by the given tolerance + +------------ + + +polygon-pattern-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` + + +Default Value: radial-distance +*(geometry will be simplified using the radial distance algorithm)* + +geometries are simplified by the given algorithm + +------------ + + +polygon-pattern-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no smoothing)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +polygon-pattern-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(geometry will not be transformed)* + +Allows transformation functions to be applied to the geometry. + +------------ + + +polygon-pattern-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +raster +^^^^^^ + +raster +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a raster symbolizer rule or emitting it with default values. + +------------ + + +raster-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(opaque)* + +The opacity of the raster symbolizer on top of other symbolizers. + +------------ + + +raster-filter-factor +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: -1 +*(Allow the datasource to choose appropriate downscaling.)* + +This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. + +------------ + + +raster-scaling +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``near`` ``fast`` ``bilinear`` ``bicubic`` ``spline16`` ``spline36`` ``hanning`` ``hamming`` ``hermite`` ``kaiser`` ``quadric`` ``catrom`` ``gaussian`` ``bessel`` ``mitchell`` ``sinc`` ``lanczos`` ``blackman`` + + +Default Value: near + + +The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. + +------------ + + +raster-mesh-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 16 +*(Reprojection mesh will be 1/16 of the resolution of the source image)* + +A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. + +------------ + + +raster-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +raster-colorizer-default-mode +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``discrete`` ``linear`` ``exact`` + + +Default Value: linear +*(A linear interpolation is used to generate colors between the two nearest stops.)* + +This can be either ``discrete``, ``linear`` or ``exact``. If it is not specified then the default is ``linear``. + +------------ + + +raster-colorizer-default-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: transparent +*(Pixels that are not colored by the colorizer stops will be transparent)* + +This can be any color. Sets the color that is applied to all values outside of the range of the colorizer-stops. If not supplied pixels will be fully transparent + +------------ + + +raster-colorizer-epsilon +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1.1920928955078125e-07 +*(Pixels must very closely match the stop filter otherwise they will not be colored.)* + +This can be any positive floating point value and will be used as a tolerance in floating point comparisions. The higher the value the more likely a stop will match and color data. + +------------ + + +raster-colorizer-stops +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``tags`` + + + + + +Default Value: +*(No colorization will happen without supplying stops.)* + +Assigns raster data values to colors. Stops must be listed in ascending order, and contain at a minimum the value and the associated color. You can also include the color-mode as a third argument, like ``stop(100,#fff,exact)``. + +------------ + + + +point +^^^^^ + +point +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a point symbolizer rule or emitting it with default values. + +------------ + + +point-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image file to represent a point. Accepted formats: SVG, PNG, JPG. + +------------ + + +point-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow points to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping points are shown or hidden. + +------------ + + +point-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache)* + +Control whether the placement of the feature will prevent the placement of other features. + +------------ + + +point-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque)* + +A value from 0 to 1 to control the opacity of the point. + +------------ + + +point-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``centroid`` ``interior`` + + +Default Value: centroid + + +Control how this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. + +------------ + + +point-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation)* + +SVG transformation definition. + +------------ + + +point-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +text +^^^^ + +text +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a text symbolizer rule. + +------------ + + +text-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Value to use for a text label. Data columns are specified using brackets like [column_name] + +------------ + + +text-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +Font name and style to render a label in + +------------ + + +text-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 + + +Text size in pixels + +------------ + + +text-ratio +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Define the amount of text (of the total) present on successive lines when wrapping occurs + +------------ + + +text-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. + +------------ + + +text-wrap-before +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width. + +------------ + + +text-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: " " + + +Use this character instead of a space to wrap long text. + +------------ + + +text-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 + + +Distance between repeated text labels on a line (aka. label-spacing). + +------------ + + +text-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Horizontal spacing adjustment between characters in pixels. + +------------ + + +text-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Vertical spacing adjustment between lines in pixels. + +------------ + + +text-label-position-tolerance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line). + +------------ + + +text-max-char-angle-delta +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 22.5 + + +The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. + +------------ + + +text-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #000000 + + +Specifies the color for the text + +------------ + + +text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque)* + +A number from 0 to 1 specifying the opacity for the text + +------------ + + +text-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF +*(white)* + +Specifies the color of the halo around the text. + +------------ + + +text-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo)* + +Specify the radius of the halo in pixels + +------------ + + +text-halo-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full + + +Exposes an alternate text halo rendering method that sacrifices quality for speed. + +------------ + + +text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right. + +------------ + + +text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text up. + +------------ + + +text-vertical-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``top`` ``middle`` ``bottom`` ``auto`` + + +Default Value: auto +*(Default affected by value of dy; "top" for dy>0, "bottom" for dy<0.)* + +Position of label relative to point position. + +------------ + + +text-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false + + +Avoid placing labels that intersect with tile boundaries. + +------------ + + +text-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Minimum permitted distance to the next text symbolizer. + +------------ + + +text-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Minimum distance a text label will be placed from the edge of a metatile. This option is similar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the metatile. + +------------ + + +text-min-path-length +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(place labels on all paths)* + +Place labels only on paths longer than this value. + +------------ + + +text-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow text to overlap with other text - overlapping markers will not be shown.)* + +Control whether overlapping text is shown or hidden. + +------------ + + +text-orientation +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +Rotate the text. + +------------ + + +text-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` + + +Default Value: point + + +Control the style of placement of a point versus the geometry it is attached to. + +------------ + + +text-placement-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``dummy`` ``simple`` ``list`` + + +Default Value: dummy + + +Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. + +------------ + + +text-placements +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: + + +If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is ``text-placements: "E,NE,SE,W,NW,SW";`` + +------------ + + +text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` + + +Default Value: none + + +Transform the case of the characters. + +------------ + + +text-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` + + +Default Value: auto + + +The text's horizontal alignment from its centerpoint. + +------------ + + +text-align +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``right`` ``center`` ``auto`` + + +Default Value: auto +*(Auto alignment means that text will be centered by default except when using the ``placement-type`` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the ``text-placements`` directives.)* + +Define how text is justified + +------------ + + +text-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: true +*(geometry will be clipped to map bounds before rendering)* + +Geometries are clipped to map bounds by default for best rendering performance. In some cases users may wish to disable this to avoid rendering artifacts. + +------------ + + +text-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current symbolizer on top of other symbolizer)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +building +^^^^^^^^ + +building +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a building symbolizer rule or emitting it with default values. + +------------ + + +building-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: #FFFFFF + + +The color of the buildings walls. + +------------ + + +building-fill-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 + + +The opacity of the building as a whole, including all walls. + +------------ + + +building-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 + + +The height of the building in pixels. + +------------ + + + +debug +^^^^^ + +debug-mode +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``collision`` ``vertex`` + + +Default Value: collision + + +The mode for debug rendering. + +------------ + + + + + diff --git a/docs/api/mapnik/3.0.0.rst b/docs/api/mapnik/3.0.0.rst new file mode 100644 index 0000000..9818635 --- /dev/null +++ b/docs/api/mapnik/3.0.0.rst @@ -0,0 +1,3778 @@ +3.0.0 +===== +Style +----- + + + + + +image-filters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``functions`` + + + +Possible values: ``agg-stack-blur`` ``emboss`` ``blur`` ``gray`` ``sobel`` ``edge-detect`` ``x-gradient`` ``y-gradient`` ``invert`` ``sharpen`` ``colorize-alpha`` ``color-to-alpha`` ``scale-hsla`` + +Default Value: none +*(no filters)* + +A list of image filters that will be applied to the active rendering canvas for a given style. The presence of one more ``image-filters`` will trigger a new canvas to be created before starting to render a style and then this canvas will be composited back into the main canvas after rendering all features and after all ``image-filters`` have been applied. See ``direct-image-filters`` if you want to apply a filter directly to the main canvas. + +------------ + + + +image-filters-inflate +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``boolean`` + + + + + +Default Value: false +*(No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary)* + +A property that can be set to true to enable using an inflated image internally for seamless blurring across tiles (requires buffered data). + +------------ + + + +direct-image-filters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``functions`` + + + +Possible values: ``agg-stack-blur`` ``emboss`` ``blur`` ``gray`` ``sobel`` ``edge-detect`` ``x-gradient`` ``y-gradient`` ``invert`` ``sharpen`` ``colorize-alpha`` ``color-to-alpha`` ``scale-hsla`` + +Default Value: none +*(no filters)* + +A list of image filters to apply to the main canvas (see the ``image-filters`` doc for how they work on a separate canvas). + +------------ + + + +comp-op +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current layer on top of other layers)* + +Composite operation. This defines how this layer should behave relative to layers atop or below it. + +------------ + + + +opacity +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``float`` + + + + + +Default Value: 1 +*(No separate buffer will be used and no alpha will be applied to the style after rendering.)* + +An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer). + +------------ + + + +Symbolizers +----------- + + +map +^^^ + +background-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: none +*(Will be rendered transparent.)* + +Map Background color. + +------------ + + +background-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: +*(No background image will be used.)* + +An image that is repeated below all features on a map as a background. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +background-image-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(The background-image will be blended with the background normally (placed on top of any existing background-color).)* + +Set the compositing operation used to blend the image into the background. + +------------ + + +background-image-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The image opacity will not be changed when applied to the map background.)* + +Set the opacity of the image. + +------------ + + +srs +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs +*(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space.)* + +Map spatial reference (proj4 string). + +------------ + + +buffer-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No buffer will be used.)* + +Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". + +------------ + + +maximum-extent +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: -20037508.34,-20037508.34,20037508.34,20037508.34 +*(All data will be clipped to global mercator extent (default is applied in Carto.js).)* + +An extent to be used to limit the bounds used to query all layers during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Map. + +------------ + + +base +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)* + +Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. + +------------ + + +font-directory +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none +*(No map-specific fonts will be registered.)* + +Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). + +------------ + + + +polygon +^^^^^^^ + +polygon +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a polygon symbolizer rule or emitting it with default values. + +------------ + + +polygon-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: The color gray will be used for fill. +*(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)* + +Fill color to assign to a polygon. + +------------ + + +polygon-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of the polygon. + +------------ + + +polygon-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully antialiased.)* +Range: 0-1 +Level of antialiasing of polygon edges. + +------------ + + +polygon-gamma-method +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``power`` ``linear`` ``none`` ``threshold`` ``multiply`` + + +Default Value: power +*(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)* + +An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. + +------------ + + +polygon-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extend outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +polygon-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +Simplify geometries by the given tolerance. + +------------ + + +polygon-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +Simplify geometries by the given algorithm. + +------------ + + +polygon-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +polygon-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(The geometry will not be transformed.)* + +Transform polygon geometry with specified function. + +------------ + + +polygon-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +line +^^^^ + +line +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a line symbolizer rule or emitting it with default values. + +------------ + + +line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black +*(black and fully opaque (alpha = 1), same as rgb(0,0,0) or rgba(0,0,0,1).)* + +The color of a drawn line. + +------------ + + +line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The line will be rendered 1 pixel wide.)* + +The width of a line in pixels. + +------------ + + +line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of a line. + +------------ + + +line-join +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``miter`` ``miter-revert`` ``round`` ``bevel`` + + +Default Value: miter +*(The line joins will be rendered using a miter look.)* + +The behavior of lines when joining. + +------------ + + +line-cap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``butt`` ``round`` ``square`` + + +Default Value: butt +*(The line endings will be rendered using a butt look.)* + +The display of line endings. + +------------ + + +line-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully antialiased.)* +Range: 0-1 +Level of antialiasing of stroke line. + +------------ + + +line-gamma-method +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``power`` ``linear`` ``none`` ``threshold`` ``multiply`` + + +Default Value: power +*(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)* + +An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. + +------------ + + +line-dasharray +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(The line will be drawn without dashes.)* + +A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. + +------------ + + +line-dash-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(The line will be drawn without dashes.)* + +Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled). + +------------ + + +line-miterlimit +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 4 +*(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )'.)* + +The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. + +------------ + + +line-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +line-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +Simplify geometries by the given tolerance. + +------------ + + +line-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +Simplify geometries by the given algorithm. + +------------ + + +line-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +line-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + +**Status: unstable** + + + + + +Default Value: 0 +*(Will not be offset.)* + +Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). + +------------ + + +line-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full +*(The line will be rendered using the highest quality method rather than the fastest.)* + +Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. + +------------ + + +line-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(The geometry will not be transformed.)* + +Transform line geometry with specified function. + +------------ + + +line-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +markers +^^^^^^^ + +marker +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a marker symbolizer rule or emitting it with default values. + +------------ + + +marker-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none +*(An ellipse or circle, if width equals height.)* + +A file that this marker shows at each placement. If no file is given, the marker will show an ellipse. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +marker-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The stroke-opacity and fill-opacity of the marker.)* + +The overall opacity of the marker, if set, overrides both the opacity of the fill and the opacity of the stroke. + +------------ + + +marker-fill-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The fill opacity of the marker. This property will also set the ``fill-opacity`` of elements in an SVG loaded from a file. + +------------ + + +marker-line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black +*(The marker will be drawn with a black outline.)* + +The color of the stroke around the marker. This property will also set the ``stroke`` of elements in an SVG loaded from a file. + +------------ + + +marker-line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.5 +*(The marker will be drawn with an outline of .5 pixels wide.)* + +The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. This property will also set the ``stroke-width`` of elements in an SVG loaded from a file. + +------------ + + +marker-line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque. This property will also set the ``stroke-opacity`` of elements in an SVG loaded from a file.)* + +The opacity of a line. + +------------ + + +marker-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``interior`` ``vertex-first`` ``vertex-last`` + + +Default Value: point +*(Place markers at the center point (centroid) of the geometry.)* + +Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior. The 'vertex-first' and 'vertex-last' options can be used to place markers at the first or last vertex of lines or polygons. + +------------ + + +marker-multi-policy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``each`` ``whole`` ``largest`` + + +Default Value: each +*(If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each.)* + +A special setting to allow the user to control rendering behavior for 'multi-geometries' (when a feature contains multiple geometries). This setting does not apply to markers placed along lines. The 'each' policy is default and means all geometries will get a marker. The 'whole' policy means that the aggregate centroid between all geometries will be used. The 'largest' policy means that only the largest (by bounding box areas) feature will get a rendered marker (this is how text labeling behaves by default). + +------------ + + +marker-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: deprecated** + + +Possible values: ``arrow`` ``ellipse`` + + +Default Value: ellipse +*(The marker shape is an ellipse.)* + +The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width). + +------------ + + +marker-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 +*(The marker width is 10 pixels.)* + +The width of the marker, if using one of the default types. + +------------ + + +marker-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 +*(The marker height is 10 pixels.)* + +The height of the marker, if using one of the default types. + +------------ + + +marker-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: blue +*(The marker fill color is blue.)* + +The color of the area of the marker. This property will also set the ``fill`` of elements in an SVG loaded from a file. + +------------ + + +marker-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow markers to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping markers are shown or hidden. + +------------ + + +marker-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Markers will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)* + +Avoid placing markers that intersect with tile boundaries. + +------------ + + +marker-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache.)* + +Value to control whether the placement of the feature will prevent the placement of other features. + +------------ + + +marker-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 100 +*(In the case of marker-placement:line then draw a marker every 100 pixels along a line.)* + +Space between repeated markers in pixels. If the spacing is less than the marker size or larger than the line segment length then no marker will be placed. Any value less than 1 will be ignored and the default will be used instead. + +------------ + + +marker-max-error +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.2 +*(N/A: not intended to be changed.)* + +N/A: not intended to be changed. + +------------ + + +marker-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation.)* + +Transform marker instance with specified function. Ignores map scale factor. + +------------ + + +marker-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +marker-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Geometry will not be simplified.)* + +geometries are simplified by the given tolerance. + +------------ + + +marker-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +geometries are simplified by the given algorithm. + +------------ + + +marker-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +marker-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(The geometry will not be transformed.)* + +Transform marker geometry with specified function. + +------------ + + +marker-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Will not be offset.)* + +Offsets a marker from a line a number of pixels parallel to its actual path. Positive values move the marker left, negative values move it right (relative to the directionality of the line). + +------------ + + +marker-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +marker-direction +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``auto`` ``auto-down`` ``left`` ``right`` ``left-only`` ``right-only`` ``up`` ``down`` + + +Default Value: right +*(Markers are oriented to the right in the line direction.)* + +How markers should be placed along lines. With the "auto" setting when marker is upside down the marker is automatically rotated by 180 degrees to keep it upright. The "auto-down" value places marker in the opposite orientation to "auto". The "left" or "right" settings can be used to force marker to always be placed along a line in a given direction and therefore disables rotating if marker appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down markers rather than trying to flip it. The "up" and "down" settings don't adjust marker's orientation to the line direction. + +------------ + + + +shield +^^^^^^ + +shield +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a shield symbolizer. + +------------ + + +shield-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(No text label will be rendered with the shield.)* + +Value to use for a shield"s text label. Data columns are specified using brackets like [column_name]. + +------------ + + +shield-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image file to render behind the shield text. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +shield-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: none + + +Font name and style to use for the shield text. + +------------ + + +shield-unlock-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)* + +This parameter should be set to true if you are trying to position text beside rather than on top of the shield image. + +------------ + + +shield-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 +*(Font size of 10 will be used to render text.)* + +The size of the shield text in pixels. + +------------ + + +shield-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black +*(The shield text will be rendered black.)* + +The color of the shield text. + +------------ + + +shield-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` + + +Default Value: point +*(One shield will be placed per geometry.)* + +How this shield should be placed. Point placement places one shield on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. + +------------ + + +shield-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Shields will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)* + +Avoid placing shields that intersect with tile boundaries. + +------------ + + +shield-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow shields to overlap with other map elements already placed.)* + +Control whether overlapping shields are shown or hidden. + +------------ + + +shield-margin +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No extra margin will be used to determine if a shield collides with any other text, shield, or marker.)* + +Minimum distance that a shield can be placed from any other text, shield, or marker. + +------------ + + +shield-repeat-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Shields with the same text will be rendered without restriction.)* + +Minimum distance between repeated shields. If set this will prevent shields being rendered nearby each other that contain the same text. Similar to shield-min-distance with the difference that it works the same no matter what placement strategy is used. + +------------ + + +shield-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + +**Status: deprecated** + + + + + +Default Value: 0 +*(Shields with the same text will be rendered without restriction.)* + +Minimum distance to any other collision object. Deprecated: replaced by ``text-margin``. + +------------ + + +shield-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Only one shield per line will attempt to be placed.)* + +Distance the renderer should use to try to place repeated shields on a line. + +------------ + + +shield-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No margin will be used to detect if a shield is nearby a tile boundary.)* + +Minimum distance a shield will be placed from the edge of a tile. This option is similar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. + +------------ + + +shield-label-position-tolerance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: shield-spacing/2.0 +*(If a shield cannot be placed then the renderer will advance by shield-spacing/2.0 to try placement again.)* + +Allows the shield to be displaced from its ideal position by a number of pixels (only works with placement:line). + +------------ + + +shield-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 +*(Text will not be wrapped.)* + +Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. + +------------ + + +shield-wrap-before +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Wrapped lines will be a bit longer than wrap-width.)* + +Wrap text before wrap-width is reached. + +------------ + + +shield-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: " " +*(Lines will be wrapped conforming to the (untailored) Unicode Line Break Algorithm provided by ICU BreakIterator.)* + +Must be a single character. If you set it to other than the space character, Mapnik will wrap strictly on that character without involving any additional rules. + +------------ + + +shield-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: white +*(The shield halo text will be rendered white.)* + +Specifies the color of the halo around the text. + +------------ + + +shield-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo.)* + +Specify the radius of the halo in pixels. + +------------ + + +shield-halo-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full +*(The shield will be rendered using the highest quality method rather than the fastest.)* + +Exposes an alternate text halo rendering method that sacrifices quality for speed. + +------------ + + +shield-halo-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: +*(No transformation.)* + +Transform shield halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. + +------------ + + +shield-halo-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +shield-halo-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque.)* + +A number from 0 to 1 specifying the opacity for the text halo. + +------------ + + +shield-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 +*(The default character spacing of the font will be used.)* + +Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. + +------------ + + +shield-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(The default font spacing will be used.)* + +Vertical spacing between lines of multiline labels (in pixels). + +------------ + + +shield-text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Text will not be displaced.)* + +Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right. + +------------ + + +shield-text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Text will not be displaced.)* + +Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down. + +------------ + + +shield-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Shield will not be displaced.)* + +Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right. + +------------ + + +shield-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Shield will not be displaced.)* + +Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down. + +------------ + + +shield-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of the image used for the shield. + +------------ + + +shield-text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of the text placed on top of the shield. + +------------ + + +shield-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` + + +Default Value: auto +*(TODO.)* + +The shield's horizontal alignment from its centerpoint. + +------------ + + +shield-vertical-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``top`` ``middle`` ``bottom`` ``auto`` + + +Default Value: middle +*(TODO.)* + +The shield's vertical alignment from its centerpoint. + +------------ + + +shield-placement-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``dummy`` ``simple`` ``list`` + + +Default Value: dummy +*(Alternative placements will not be enabled.)* + +Re-position and/or re-size shield to avoid overlaps. "simple" for basic algorithm (using shield-placements string,) "dummy" to turn this feature off. + +------------ + + +shield-placements +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(No alternative placements will be used.)* + +If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is ``shield-placements: "E,NE,SE,W,NW,SW";``. + +------------ + + +shield-text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` ``reverse`` + + +Default Value: none +*(No text transformation will be applied.)* + +Transform the case of the characters. + +------------ + + +shield-justify-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``center`` ``right`` ``auto`` + + +Default Value: auto +*(TODO.)* + +Define how text in a shield's label is justified. + +------------ + + +shield-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation.)* + +Transform shield instance with specified function. Ignores map scale factor. + +------------ + + +shield-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +shield-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +Simplify the geometries used for shield placement by the given tolerance. + +------------ + + +shield-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +Simplify the geometries used for shield placement by the given algorithm. + +------------ + + +shield-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out the angles of the geometry used for shield placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +shield-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +line-pattern +^^^^^^^^^^^^ + +line-pattern +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a line pattern symbolizer rule or emitting it with default values. + +------------ + + +line-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +An image file to be repeated and warped along a line. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +line-pattern-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +line-pattern-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The image is rendered without modifications.)* + +Apply an opacity level to the image used for the pattern. + +------------ + + +line-pattern-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +geometries are simplified by the given tolerance. + +------------ + + +line-pattern-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +geometries are simplified by the given algorithm. + +------------ + + +line-pattern-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +line-pattern-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(The line will not be offset.)* + +Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). + +------------ + + +line-pattern-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(The geometry will not be transformed.)* + +Transform line geometry with specified function and apply pattern to transformed geometry. + +------------ + + +line-pattern-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation.)* + +Transform line pattern instance with specified function. + +------------ + + +line-pattern-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +polygon-pattern +^^^^^^^^^^^^^^^ + +polygon-pattern +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a polygon pattern symbolizer rule or emitting it with default values. + +------------ + + +polygon-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image to use as a repeated pattern fill within a polygon. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +polygon-pattern-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``global`` ``local`` + + +Default Value: global +*(Patterns will be aligned to the map (or tile boundaries) when being repeated across polygons. This is ideal for seamless patterns in tiled rendering.)* + +Specify whether to align pattern fills to the layer's geometry (local) or to the map (global). + +------------ + + +polygon-pattern-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully antialiased.)* +Range: 0-1 +Level of antialiasing of polygon pattern edges. + +------------ + + +polygon-pattern-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The image is rendered without modifications.)* + +Apply an opacity level to the image used for the pattern. + +------------ + + +polygon-pattern-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +polygon-pattern-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +geometries are simplified by the given tolerance. + +------------ + + +polygon-pattern-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +geometries are simplified by the given algorithm. + +------------ + + +polygon-pattern-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +polygon-pattern-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(The geometry will not be transformed.)* + +Transform polygon geometry with specified function and apply pattern to transformed geometry. + +------------ + + +polygon-pattern-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation.)* + +Transform polygon pattern instance with specified function. + +------------ + + +polygon-pattern-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +raster +^^^^^^ + +raster +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a raster symbolizer rule or emitting it with default values. + +------------ + + +raster-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of the raster symbolizer on top of other symbolizers. + +------------ + + +raster-filter-factor +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: -1 +*(Allow the datasource to choose appropriate downscaling.)* + +This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. + +------------ + + +raster-scaling +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``near`` ``fast`` ``bilinear`` ``bicubic`` ``spline16`` ``spline36`` ``hanning`` ``hamming`` ``hermite`` ``kaiser`` ``quadric`` ``catrom`` ``gaussian`` ``bessel`` ``mitchell`` ``sinc`` ``lanczos`` ``blackman`` + + +Default Value: near +*(Nearest neighboor resampling will be used to scale the image to the target size of the map.)* + +The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. + +------------ + + +raster-mesh-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 16 +*(Reprojection mesh will be 1/16 of the resolution of the source image.)* + +A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. + +------------ + + +raster-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +raster-colorizer-default-mode +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``discrete`` ``linear`` ``exact`` + + +Default Value: linear +*(A linear interpolation is used to generate colors between the two nearest stops.)* + +This can be either ``discrete``, ``linear`` or ``exact``. If it is not specified then the default is ``linear``. + +------------ + + +raster-colorizer-default-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: transparent +*(Pixels that are not colored by the colorizer stops will be transparent.)* + +This can be any color. Sets the color that is applied to all values outside of the range of the colorizer-stops. If not supplied pixels will be fully transparent. + +------------ + + +raster-colorizer-epsilon +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1.1920928955078125e-07 +*(Pixels must very closely match the stop filter otherwise they will not be colored.)* + +This can be any positive floating point value and will be used as a tolerance in floating point comparisions. The higher the value the more likely a stop will match and color data. + +------------ + + +raster-colorizer-stops +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``tags`` + + + + + +Default Value: +*(No colorization will happen without supplying stops.)* + +Assigns raster data values to colors. Stops must be listed in ascending order, and contain at a minimum the value and the associated color. You can also include the color-mode as a third argument, like ``stop(100,#fff,exact)``. + +------------ + + + +point +^^^^^ + +point +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a point symbolizer rule or emitting it with default values. + +------------ + + +point-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none +*(A 4x4 black square will be rendered.)* + +Image file to represent a point. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +point-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow points to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping points are shown or hidden. + +------------ + + +point-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache.)* + +Control whether the placement of the feature will prevent the placement of other features. + +------------ + + +point-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque.)* + +A value from 0 to 1 to control the opacity of the point. + +------------ + + +point-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``centroid`` ``interior`` + + +Default Value: centroid +*(The centroid of the geometry will be used to place the point.)* + +Control how this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. + +------------ + + +point-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation.)* + +Transform point instance with specified function. Ignores map scale factor. + +------------ + + +point-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +text +^^^^ + +text +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a text symbolizer rule. + +------------ + + +text-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: none + + +Value to use for a text label. Data columns are specified using brackets like [column_name]. + +------------ + + +text-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: none + + +Font name and style to render a label in. + +------------ + + +text-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 +*(Font size of 10 will be used to render text.)* + +Text size in pixels. + +------------ + + +text-ratio +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 +*(TODO.)* + +Define the amount of text (of the total) present on successive lines when wrapping occurs. + +------------ + + +text-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 +*(Text will not be wrapped.)* + +Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. + +------------ + + +text-wrap-before +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Wrapped lines will be a bit longer than wrap-width.)* + +Wrap text before wrap-width is reached. + +------------ + + +text-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: " " +*(Lines will be wrapped conforming to the (untailored) Unicode Line Break Algorithm provided by ICU BreakIterator.)* + +Must be a single character. If you set it to other than the space character, Mapnik will wrap strictly on that character without involving any additional rules. + +------------ + + +text-repeat-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + +**Status: unstable** + + + + + +Default Value: false +*(Character will be removed when used to wrap a line.)* + +Keep the character used to wrap a line instead of removing it, and repeat it on the new line. + +------------ + + +text-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 +*(Only one label per line will attempt to be placed.)* + +Distance the renderer should use to try to place repeated text labels on a line. + +------------ + + +text-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(The default character spacing of the font will be used.)* + +Horizontal spacing adjustment between characters in pixels. This value is ignored when ``horizontal-alignment`` is set to ``adjust``. Typographic ligatures are turned off when this value is greater than zero. + +------------ + + +text-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(The default font spacing will be used.)* + +Vertical spacing adjustment between lines in pixels. + +------------ + + +text-label-position-tolerance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: text-spacing/2.0 +*(If a shield cannot be placed then the renderer will advance by text-spacing/2.0 to try placement again.)* + +Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line). + +------------ + + +text-max-char-angle-delta +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 22.5 +*(The label will not be placed if a character falls on a line with an angle sharper than 22.5 degrees.)* + +The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. + +------------ + + +text-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black +*(The text will be rendered black.)* + +Specifies the color for the text. + +------------ + + +text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque.)* + +A number from 0 to 1 specifying the opacity for the text. + +------------ + + +text-halo-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque.)* + +A number from 0 to 1 specifying the opacity for the text halo. + +------------ + + +text-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: white +*(The halo will be rendered white.)* + +Specifies the color of the halo around the text. + +------------ + + +text-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo.)* + +Specify the radius of the halo in pixels. + +------------ + + +text-halo-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full +*(The text will be rendered using the highest quality method rather than the fastest.)* + +Exposes an alternate text halo rendering method that sacrifices quality for speed. + +------------ + + +text-halo-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: +*(No transformation.)* + +Transform text halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. + +------------ + + +text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Text will not be displaced.)* + +Displace text by fixed amount, in pixels, +/- along the X axis. With "dummy" placement-type, a positive value displaces to the right. With "simple" placement-type, it is either left, right or unchanged, depending on the placement selected. Any non-zero value implies "horizontal-alignment" changes to "left" by default. Has no effect with 'line' text-placement-type. + +------------ + + +text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Text will not be displaced.)* + +Displace text by fixed amount, in pixels, +/- along the Y axis. With "dummy" placement-type, a positive value displaces downwards. With "simple" placement-type, it is either up, down or unchanged, depending on the placement selected. With "line" placement-type, a positive value displaces above the path. + +------------ + + +text-vertical-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``top`` ``middle`` ``bottom`` ``auto`` + + +Default Value: auto +*(Default affected by value of dy; "top" for dy>0, "bottom" for dy<0.)* + +Position of label relative to point position. + +------------ + + +text-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Text will be potentially placed near tile edges and therefore may look cut off unless the same text label is rendered on each adjacent tile.)* + +Avoid placing labels that intersect with tile boundaries. + +------------ + + +text-margin +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No extra margin will be used to determine if a label collides with any other text, shield, or marker.)* + +Minimum distance that a label can be placed from any other text, shield, or marker. + +------------ + + +text-repeat-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Labels with the same text will be rendered without restriction.)* + +Minimum distance between repeated text. If set this will prevent text labels being rendered nearby each other that contain the same text. Similar to text-min-distance with the difference that it works the same no matter what placement strategy is used. + +------------ + + +text-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + +**Status: deprecated** + + + + + +Default Value: 0 +*(Labels with the same text will be rendered without restriction.)* + +Minimum distance to the next label with the same text. Only works for line placement. Deprecated: replaced by ``text-repeat-distance`` and ``text-margin`` + +------------ + + +text-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No margin will be used to detect if a text label is nearby a tile boundary.)* + +Minimum distance a text label will be placed from the edge of a tile. This option is similar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. + +------------ + + +text-min-path-length +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(place labels on all geometries no matter how small they are.)* + +Place labels only on polygons and lines with a bounding width longer than this value (in pixels). + +------------ + + +text-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow text to overlap with other text - overlapping markers will not be shown.)* + +Control whether overlapping text is shown or hidden. + +------------ + + +text-orientation +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Text is not rotated and is displayed upright.)* + +Rotate the text. (only works with text-placement:point). + +------------ + + +text-rotate-displacement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Label center is used for rotation.)* + +Rotates the displacement around the placement origin by the angle given by "orientation". + +------------ + + +text-upright +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``auto`` ``auto-down`` ``left`` ``right`` ``left-only`` ``right-only`` + + +Default Value: auto +*(Text will be positioned upright automatically.)* + +How this label should be placed along lines. By default when more than half of a label's characters are upside down the label is automatically flipped to keep it upright. By changing this parameter you can prevent this "auto-upright" behavior. The "auto-down" value places text in the opposite orientation to "auto". The "left" or "right" settings can be used to force text to always be placed along a line in a given direction and therefore disables flipping if text appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down text rather than trying to flip it. + +------------ + + +text-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` + + +Default Value: point +*(One shield will be placed per geometry.)* + +How this label should be placed. Point placement places one label on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. + +------------ + + +text-placement-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``dummy`` ``simple`` ``list`` + + +Default Value: dummy +*(Alternative placements will not be enabled.)* + +Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. + +------------ + + +text-placements +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(No alternative placements will be used.)* + +If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is ``text-placements: "E,NE,SE,W,NW,SW";``. + +------------ + + +text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` ``reverse`` + + +Default Value: none +*(Transform text instance with specified function. Ignores map scale factor.)* + +Transform the case of the characters. + +------------ + + +text-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` ``adjust`` + + +Default Value: auto +*(TODO.)* + +The text's horizontal alignment from it's centerpoint. If ``placement`` is set to ``line``, then ``adjust`` can be set to auto-fit the text to the length of the path by dynamically calculating ``character-spacing``. + +------------ + + +text-align +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``right`` ``center`` ``auto`` + + +Default Value: auto +*(Auto alignment means that text will be centered by default except when using the ``placement-type`` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the ``text-placements`` directives.)* + +Define how text is justified. + +------------ + + +text-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +text-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +Simplify the geometries used for text placement by the given tolerance. + +------------ + + +text-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +Simplify the geometries used for text placement by the given algorithm. + +------------ + + +text-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out the angles of the geometry used for text placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +text-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +text-halo-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +text-font-feature-settings +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(Default set of typographic features recommended by OpenType specification. Ligatures are turned off by default when ``character-spacing`` is greater than zero.)* + +Comma separated list of OpenType typographic features. The syntax and semantics conforms to ``font-feature-settings`` from W3C CSS. + +------------ + + +text-largest-bbox-only +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + +**Status: experimental** + + + + + +Default Value: true +*(For multipolygons only polygon with largest bbox area is labeled (does not apply to other geometries).)* + +Controls default labeling behavior on multipolygons. The default is true and means that only the polygon with largest bbox is labeled. + +------------ + + + +building +^^^^^^^^ + +building +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a building symbolizer rule or emitting it with default values. + +------------ + + +building-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: The color gray will be used for fill. +*(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)* + +The color of the buildings fill. Note: 0.8 will be used to multiply each color component to auto-generate a darkened wall color. + +------------ + + +building-fill-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of the building as a whole, including all walls. + +------------ + + +building-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Buildings will not have a visual height and will instead look like flat polygons.)* + +The height of the building in pixels. + +------------ + + + +debug +^^^^^ + +debug-mode +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``collision`` ``vertex`` + + +Default Value: collision +*(The otherwise invisible collision boxes will be rendered as squares on the map.)* + +The mode for debug rendering. + +------------ + + + +dot +^^^ + +dot +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a dot symbolizer rule or emitting it with default values. + +------------ + + +dot-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: gray +*(The dot fill color is gray.)* + +The color of the area of the dot. + +------------ + + +dot-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The opacity of the dot.)* + +The overall opacity of the dot. + +------------ + + +dot-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The marker width is 1 pixel.)* + +The width of the dot in pixels. + +------------ + + +dot-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The marker height is 1 pixels.)* + +The height of the dot in pixels. + +------------ + + +dot-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current layer on top of other layers.)* + +Composite operation. This defines how this layer should behave relative to layers atop or below it. + +------------ + + + + + diff --git a/docs/api/mapnik/3.0.20.rst b/docs/api/mapnik/3.0.20.rst new file mode 100644 index 0000000..93b8154 --- /dev/null +++ b/docs/api/mapnik/3.0.20.rst @@ -0,0 +1,3846 @@ +3.0.20 +====== +Style +----- + + + + + +image-filters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``functions`` + + + +Possible values: ``agg-stack-blur`` ``emboss`` ``blur`` ``gray`` ``sobel`` ``edge-detect`` ``x-gradient`` ``y-gradient`` ``invert`` ``sharpen`` ``color-blind-protanope`` ``color-blind-deuteranope`` ``color-blind-tritanope`` ``colorize-alpha`` ``color-to-alpha`` ``scale-hsla`` + +Default Value: none +*(no filters)* + +A list of image filters that will be applied to the active rendering canvas for a given style. The presence of one more ``image-filters`` will trigger a new canvas to be created before starting to render a style and then this canvas will be composited back into the main canvas after rendering all features and after all ``image-filters`` have been applied. See ``direct-image-filters`` if you want to apply a filter directly to the main canvas. + +------------ + + + +image-filters-inflate +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``boolean`` + + + + + +Default Value: false +*(No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary)* + +A property that can be set to true to enable using an inflated image internally for seamless blurring across tiles (requires buffered data). + +------------ + + + +direct-image-filters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``functions`` + + + +Possible values: ``agg-stack-blur`` ``emboss`` ``blur`` ``gray`` ``sobel`` ``edge-detect`` ``x-gradient`` ``y-gradient`` ``invert`` ``sharpen`` ``color-blind-protanope`` ``color-blind-deuteranope`` ``color-blind-tritanope`` ``colorize-alpha`` ``color-to-alpha`` ``scale-hsla`` + +Default Value: none +*(no filters)* + +A list of image filters to apply to the main canvas (see the ``image-filters`` doc for how they work on a separate canvas). + +------------ + + + +comp-op +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current layer on top of other layers)* + +Composite operation. This defines how this layer should behave relative to layers atop or below it. + +------------ + + + +opacity +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``float`` + + + + + +Default Value: 1 +*(No separate buffer will be used and no alpha will be applied to the style after rendering.)* + +An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer). + +------------ + + + +Symbolizers +----------- + + +map +^^^ + +background-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: none +*(Will be rendered transparent.)* + +Map Background color. + +------------ + + +background-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: +*(No background image will be used.)* + +An image that is repeated below all features on a map as a background. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +background-image-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(The background-image will be blended with the background normally (placed on top of any existing background-color).)* + +Set the compositing operation used to blend the image into the background. + +------------ + + +background-image-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The image opacity will not be changed when applied to the map background.)* + +Set the opacity of the image. + +------------ + + +srs +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs +*(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space.)* + +Map spatial reference (proj4 string). + +------------ + + +buffer-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No buffer will be used.)* + +Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". + +------------ + + +maximum-extent +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: -20037508.34,-20037508.34,20037508.34,20037508.34 +*(All data will be clipped to global mercator extent (default is applied in Carto.js).)* + +An extent to be used to limit the bounds used to query all layers during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Map. + +------------ + + +base +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)* + +Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. + +------------ + + +font-directory +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none +*(No map-specific fonts will be registered.)* + +Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). + +------------ + + + +polygon +^^^^^^^ + +polygon +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a polygon symbolizer rule or emitting it with default values. + +------------ + + +polygon-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: rgba(128,128,128,1) +*(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)* + +Fill color to assign to a polygon. + +------------ + + +polygon-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of the polygon. + +------------ + + +polygon-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully antialiased.)* +Range: 0-1 +Level of antialiasing of polygon edges. + +------------ + + +polygon-gamma-method +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``power`` ``linear`` ``none`` ``threshold`` ``multiply`` + + +Default Value: power +*(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)* + +An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. + +------------ + + +polygon-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extend outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +polygon-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +Simplify geometries by the given tolerance. + +------------ + + +polygon-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +Simplify geometries by the given algorithm. + +------------ + + +polygon-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +polygon-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(The geometry will not be transformed.)* + +Transform polygon geometry with specified function. + +------------ + + +polygon-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +line +^^^^ + +line +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a line symbolizer rule or emitting it with default values. + +------------ + + +line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black +*(black and fully opaque (alpha = 1), same as rgb(0,0,0) or rgba(0,0,0,1).)* + +The color of a drawn line. + +------------ + + +line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The line will be rendered 1 pixel wide.)* + +The width of a line in pixels. + +------------ + + +line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of a line. + +------------ + + +line-join +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``miter`` ``miter-revert`` ``round`` ``bevel`` + + +Default Value: miter +*(The line joins will be rendered using a miter look.)* + +The behavior of lines when joining. + +------------ + + +line-cap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``butt`` ``round`` ``square`` + + +Default Value: butt +*(The line endings will be rendered using a butt look.)* + +The display of line endings. + +------------ + + +line-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully antialiased.)* +Range: 0-1 +Level of antialiasing of stroke line. + +------------ + + +line-gamma-method +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``power`` ``linear`` ``none`` ``threshold`` ``multiply`` + + +Default Value: power +*(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)* + +An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. + +------------ + + +line-dasharray +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(The line will be drawn without dashes.)* + +A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. + +------------ + + +line-dash-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(The line will be drawn without dashes.)* + +Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled). + +------------ + + +line-miterlimit +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 4 +*(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )'.)* + +The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. + +------------ + + +line-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +line-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +Simplify geometries by the given tolerance. + +------------ + + +line-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +Simplify geometries by the given algorithm. + +------------ + + +line-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +line-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + +**Status: unstable** + + + + + +Default Value: 0 +*(Will not be offset.)* + +Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). + +------------ + + +line-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full +*(The line will be rendered using the highest quality method rather than the fastest.)* + +Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. + +------------ + + +line-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(The geometry will not be transformed.)* + +Transform line geometry with specified function. + +------------ + + +line-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +markers +^^^^^^^ + +marker +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a marker symbolizer rule or emitting it with default values. + +------------ + + +marker-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none +*(An ellipse or circle, if width equals height.)* + +A file that this marker shows at each placement. If no file is given, the marker will show an ellipse. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +marker-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The stroke-opacity and fill-opacity of the marker.)* + +The overall opacity of the marker, if set, overrides both the opacity of the fill and the opacity of the stroke. + +------------ + + +marker-fill-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The fill opacity of the marker. This property will also set the ``fill-opacity`` of elements in an SVG loaded from a file. + +------------ + + +marker-line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black +*(The marker will be drawn with a black outline.)* + +The color of the stroke around the marker. This property will also set the ``stroke`` of elements in an SVG loaded from a file. + +------------ + + +marker-line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.5 +*(The marker will be drawn with an outline of .5 pixels wide.)* + +The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. This property will also set the ``stroke-width`` of elements in an SVG loaded from a file. + +------------ + + +marker-line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque. This property will also set the ``stroke-opacity`` of elements in an SVG loaded from a file.)* + +The opacity of a line. + +------------ + + +marker-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``interior`` ``vertex-first`` ``vertex-last`` + + +Default Value: point +*(Place markers at the center point (centroid) of the geometry.)* + +Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior. The 'vertex-first' and 'vertex-last' options can be used to place markers at the first or last vertex of lines or polygons. + +------------ + + +marker-multi-policy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``each`` ``whole`` ``largest`` + + +Default Value: each +*(If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each.)* + +A special setting to allow the user to control rendering behavior for 'multi-geometries' (when a feature contains multiple geometries). This setting does not apply to markers placed along lines. The 'each' policy is default and means all geometries will get a marker. The 'whole' policy means that the aggregate centroid between all geometries will be used. The 'largest' policy means that only the largest (by bounding box areas) feature will get a rendered marker (this is how text labeling behaves by default). + +------------ + + +marker-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: deprecated** + + +Possible values: ``arrow`` ``ellipse`` + + +Default Value: ellipse +*(The marker shape is an ellipse.)* + +The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width). + +------------ + + +marker-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 +*(The marker width is 10 pixels.)* + +The width of the marker, if using one of the default types. + +------------ + + +marker-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 +*(The marker height is 10 pixels.)* + +The height of the marker, if using one of the default types. + +------------ + + +marker-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: blue +*(The marker fill color is blue.)* + +The color of the area of the marker. This property will also set the ``fill`` of elements in an SVG loaded from a file. + +------------ + + +marker-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow markers to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping markers are shown or hidden. + +------------ + + +marker-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Markers will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)* + +Avoid placing markers that intersect with tile boundaries. + +------------ + + +marker-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache.)* + +Value to control whether the placement of the feature will prevent the placement of other features. + +------------ + + +marker-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 100 +*(In the case of marker-placement:line then draw a marker every 100 pixels along a line.)* + +Space between repeated markers in pixels. If the spacing is less than the marker size or larger than the line segment length then no marker will be placed. Any value less than 1 will be ignored and the default will be used instead. + +------------ + + +marker-max-error +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.2 +*(N/A: not intended to be changed.)* + +N/A: not intended to be changed. + +------------ + + +marker-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation.)* + +Transform marker instance with specified function. Ignores map scale factor. + +------------ + + +marker-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +marker-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Geometry will not be simplified.)* + +geometries are simplified by the given tolerance. + +------------ + + +marker-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +geometries are simplified by the given algorithm. + +------------ + + +marker-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +marker-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(The geometry will not be transformed.)* + +Transform marker geometry with specified function. + +------------ + + +marker-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Will not be offset.)* + +Offsets a marker from a line a number of pixels parallel to its actual path. Positive values move the marker left, negative values move it right (relative to the directionality of the line). + +------------ + + +marker-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +marker-direction +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``auto`` ``auto-down`` ``left`` ``right`` ``left-only`` ``right-only`` ``up`` ``down`` + + +Default Value: right +*(Markers are oriented to the right in the line direction.)* + +How markers should be placed along lines. With the "auto" setting when marker is upside down the marker is automatically rotated by 180 degrees to keep it upright. The "auto-down" value places marker in the opposite orientation to "auto". The "left" or "right" settings can be used to force marker to always be placed along a line in a given direction and therefore disables rotating if marker appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down markers rather than trying to flip it. The "up" and "down" settings don't adjust marker's orientation to the line direction. + +------------ + + + +shield +^^^^^^ + +shield +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a shield symbolizer rule. + +------------ + + +shield-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(No text label will be rendered with the shield.)* + +Value to use for a shield"s text label. Data columns are specified using brackets like [column_name]. + +------------ + + +shield-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image file to render behind the shield text. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +shield-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: none + + +Font name and style to use for the shield text. + +------------ + + +shield-unlock-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)* + +This parameter should be set to true if you are trying to position text beside rather than on top of the shield image. + +------------ + + +shield-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 +*(Font size of 10 will be used to render text.)* + +The size of the shield text in pixels. + +------------ + + +shield-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black +*(The shield text will be rendered black.)* + +The color of the shield text. + +------------ + + +shield-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` ``grid`` ``alternating-grid`` + + +Default Value: point +*(One shield will be placed per geometry.)* + +How this shield should be placed. Point placement places one shield on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. + +------------ + + +shield-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Shields will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)* + +Avoid placing shields that intersect with tile boundaries. + +------------ + + +shield-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow shields to overlap with other map elements already placed.)* + +Control whether overlapping shields are shown or hidden. + +------------ + + +shield-margin +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No extra margin will be used to determine if a shield collides with any other text, shield, or marker.)* + +Minimum distance that a shield can be placed from any other text, shield, or marker. + +------------ + + +shield-repeat-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Shields with the same text will be rendered without restriction.)* + +Minimum distance between repeated shields. If set this will prevent shields being rendered nearby each other that contain the same text. Similar to shield-min-distance with the difference that it works the same no matter what placement strategy is used. + +------------ + + +shield-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + +**Status: deprecated** + + + + + +Default Value: 0 +*(Shields with the same text will be rendered without restriction.)* + +Minimum distance to any other collision object. Deprecated: replaced by ``text-margin``. + +------------ + + +shield-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Only one shield per line will attempt to be placed.)* + +Distance the renderer should use to try to place repeated shields on a line. + +------------ + + +shield-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No margin will be used to detect if a shield is nearby a tile boundary.)* + +Minimum distance a shield will be placed from the edge of a tile. This option is similar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. + +------------ + + +shield-label-position-tolerance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: shield-spacing/2.0 +*(If a shield cannot be placed then the renderer will advance by shield-spacing/2.0 to try placement again.)* + +Allows the shield to be displaced from its ideal position by a number of pixels (only works with placement:line). + +------------ + + +shield-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 +*(Text will not be wrapped.)* + +Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. + +------------ + + +shield-wrap-before +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Wrapped lines will be a bit longer than wrap-width.)* + +Wrap text before wrap-width is reached. + +------------ + + +shield-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: " " +*(Lines will be wrapped conforming to the (untailored) Unicode Line Break Algorithm provided by ICU BreakIterator.)* + +Must be a single character. If you set it to other than the space character, Mapnik will wrap strictly on that character without involving any additional rules. + +------------ + + +shield-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: white +*(The shield halo text will be rendered white.)* + +Specifies the color of the halo around the text. + +------------ + + +shield-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo.)* + +Specify the radius of the halo in pixels. + +------------ + + +shield-halo-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full +*(The shield will be rendered using the highest quality method rather than the fastest.)* + +Exposes an alternate text halo rendering method that sacrifices quality for speed. + +------------ + + +shield-halo-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: +*(No transformation.)* + +Transform shield halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. + +------------ + + +shield-halo-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +shield-halo-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque.)* + +A number from 0 to 1 specifying the opacity for the text halo. + +------------ + + +shield-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 +*(The default character spacing of the font will be used.)* + +Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. + +------------ + + +shield-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(The default font spacing will be used.)* + +Vertical spacing between lines of multiline labels (in pixels). + +------------ + + +shield-text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Text will not be displaced.)* + +Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right. + +------------ + + +shield-text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Text will not be displaced.)* + +Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down. + +------------ + + +shield-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Shield will not be displaced.)* + +Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right. + +------------ + + +shield-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Shield will not be displaced.)* + +Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down. + +------------ + + +shield-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of the image used for the shield. + +------------ + + +shield-text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of the text placed on top of the shield. + +------------ + + +shield-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` + + +Default Value: auto +*(TODO.)* + +The shield's horizontal alignment from its centerpoint. + +------------ + + +shield-vertical-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``top`` ``middle`` ``bottom`` ``auto`` + + +Default Value: middle +*(TODO.)* + +The shield's vertical alignment from its centerpoint. + +------------ + + +shield-placement-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``dummy`` ``simple`` ``list`` + + +Default Value: dummy +*(Alternative placements will not be enabled.)* + +Re-position and/or re-size shield to avoid overlaps. "simple" for basic algorithm (using shield-placements string,) "dummy" to turn this feature off. + +------------ + + +shield-placements +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(No alternative placements will be used.)* + +If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is ``shield-placements: "E,NE,SE,W,NW,SW";``. + +------------ + + +shield-text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` ``reverse`` + + +Default Value: none +*(No text transformation will be applied.)* + +Transform the case of the characters. + +------------ + + +shield-justify-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``center`` ``right`` ``auto`` + + +Default Value: auto +*(TODO.)* + +Define how text in a shield's label is justified. + +------------ + + +shield-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation.)* + +Transform shield instance with specified function. Ignores map scale factor. + +------------ + + +shield-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +shield-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +Simplify the geometries used for shield placement by the given tolerance. + +------------ + + +shield-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +Simplify the geometries used for shield placement by the given algorithm. + +------------ + + +shield-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out the angles of the geometry used for shield placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +shield-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +shield-grid-cell-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No placement will be done.)* + +Controls horizontal spacing between placements of placement type ``grid`` or ``alternating-grid``. + +------------ + + +shield-grid-cell-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No placement will be done.)* + +Controls vertical spacing between placements of placement type ``grid`` or ``alternating-grid``. + +------------ + + + +line-pattern +^^^^^^^^^^^^ + +line-pattern +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a line pattern symbolizer rule or emitting it with default values. + +------------ + + +line-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +An image file to be repeated and warped along a line. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +line-pattern-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +line-pattern-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The image is rendered without modifications.)* + +Apply an opacity level to the image used for the pattern. + +------------ + + +line-pattern-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +geometries are simplified by the given tolerance. + +------------ + + +line-pattern-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +geometries are simplified by the given algorithm. + +------------ + + +line-pattern-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +line-pattern-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(The line will not be offset.)* + +Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). + +------------ + + +line-pattern-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(The geometry will not be transformed.)* + +Transform line geometry with specified function and apply pattern to transformed geometry. + +------------ + + +line-pattern-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation.)* + +Transform line pattern instance with specified function. + +------------ + + +line-pattern-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +polygon-pattern +^^^^^^^^^^^^^^^ + +polygon-pattern +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a polygon pattern symbolizer rule or emitting it with default values. + +------------ + + +polygon-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image to use as a repeated pattern fill within a polygon. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +polygon-pattern-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``global`` ``local`` + + +Default Value: global +*(Patterns will be aligned to the map (or tile boundaries) when being repeated across polygons. This is ideal for seamless patterns in tiled rendering.)* + +Specify whether to align pattern fills to the layer's geometry (local) or to the map (global). + +------------ + + +polygon-pattern-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully antialiased.)* +Range: 0-1 +Level of antialiasing of polygon pattern edges. + +------------ + + +polygon-pattern-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The image is rendered without modifications.)* + +Apply an opacity level to the image used for the pattern. + +------------ + + +polygon-pattern-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +polygon-pattern-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +geometries are simplified by the given tolerance. + +------------ + + +polygon-pattern-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +geometries are simplified by the given algorithm. + +------------ + + +polygon-pattern-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +polygon-pattern-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(The geometry will not be transformed.)* + +Transform polygon geometry with specified function and apply pattern to transformed geometry. + +------------ + + +polygon-pattern-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation.)* + +Transform polygon pattern instance with specified function. + +------------ + + +polygon-pattern-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +raster +^^^^^^ + +raster +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a raster symbolizer rule or emitting it with default values. + +------------ + + +raster-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of the raster symbolizer on top of other symbolizers. + +------------ + + +raster-filter-factor +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: -1 +*(Allow the datasource to choose appropriate downscaling.)* + +This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. + +------------ + + +raster-scaling +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``near`` ``fast`` ``bilinear`` ``bicubic`` ``spline16`` ``spline36`` ``hanning`` ``hamming`` ``hermite`` ``kaiser`` ``quadric`` ``catrom`` ``gaussian`` ``bessel`` ``mitchell`` ``sinc`` ``lanczos`` ``blackman`` + + +Default Value: near +*(Nearest neighboor resampling will be used to scale the image to the target size of the map.)* + +The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. + +------------ + + +raster-mesh-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 16 +*(Reprojection mesh will be 1/16 of the resolution of the source image.)* + +A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. + +------------ + + +raster-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +raster-colorizer-default-mode +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``discrete`` ``linear`` ``exact`` + + +Default Value: linear +*(A linear interpolation is used to generate colors between the two nearest stops.)* + +This can be either ``discrete``, ``linear`` or ``exact``. If it is not specified then the default is ``linear``. + +------------ + + +raster-colorizer-default-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: transparent +*(Pixels that are not colored by the colorizer stops will be transparent.)* + +This can be any color. Sets the color that is applied to all values outside of the range of the colorizer-stops. If not supplied pixels will be fully transparent. + +------------ + + +raster-colorizer-epsilon +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1.1920928955078125e-07 +*(Pixels must very closely match the stop filter otherwise they will not be colored.)* + +This can be any positive floating point value and will be used as a tolerance in floating point comparisions. The higher the value the more likely a stop will match and color data. + +------------ + + +raster-colorizer-stops +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``tags`` + + + + + +Default Value: +*(No colorization will happen without supplying stops.)* + +Assigns raster data values to colors. Stops must be listed in ascending order, and contain at a minimum the value and the associated color. You can also include the color-mode as a third argument, like ``stop(100,#fff,exact)``. + +------------ + + + +point +^^^^^ + +point +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a point symbolizer rule or emitting it with default values. + +------------ + + +point-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none +*(A 4x4 black square will be rendered.)* + +Image file to represent a point. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +point-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow points to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping points are shown or hidden. + +------------ + + +point-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache.)* + +Control whether the placement of the feature will prevent the placement of other features. + +------------ + + +point-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque.)* + +A value from 0 to 1 to control the opacity of the point. + +------------ + + +point-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``centroid`` ``interior`` + + +Default Value: centroid +*(The centroid of the geometry will be used to place the point.)* + +Control how this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. + +------------ + + +point-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation.)* + +Transform point instance with specified function. Ignores map scale factor. + +------------ + + +point-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +text +^^^^ + +text +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a text symbolizer rule. + +------------ + + +text-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: none + + +Value to use for a text label. Data columns are specified using brackets like [column_name]. + +------------ + + +text-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: none + + +Font name and style to render a label in. + +------------ + + +text-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 +*(Font size of 10 will be used to render text.)* + +Text size in pixels. + +------------ + + +text-ratio +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 +*(TODO.)* + +Define the amount of text (of the total) present on successive lines when wrapping occurs. + +------------ + + +text-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 +*(Text will not be wrapped.)* + +Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. + +------------ + + +text-wrap-before +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Wrapped lines will be a bit longer than wrap-width.)* + +Wrap text before wrap-width is reached. + +------------ + + +text-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: " " +*(Lines will be wrapped conforming to the (untailored) Unicode Line Break Algorithm provided by ICU BreakIterator.)* + +Must be a single character. If you set it to other than the space character, Mapnik will wrap strictly on that character without involving any additional rules. + +------------ + + +text-repeat-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + +**Status: unstable** + + + + + +Default Value: false +*(Character will be removed when used to wrap a line.)* + +Keep the character used to wrap a line instead of removing it, and repeat it on the new line. + +------------ + + +text-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 +*(Only one label per line will attempt to be placed.)* + +Distance the renderer should use to try to place repeated text labels on a line. + +------------ + + +text-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(The default character spacing of the font will be used.)* + +Horizontal spacing adjustment between characters in pixels. This value is ignored when ``horizontal-alignment`` is set to ``adjust``. Typographic ligatures are turned off when this value is greater than zero. + +------------ + + +text-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(The default font spacing will be used.)* + +Vertical spacing adjustment between lines in pixels. + +------------ + + +text-label-position-tolerance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: text-spacing/2.0 +*(If a shield cannot be placed then the renderer will advance by text-spacing/2.0 to try placement again.)* + +Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line). + +------------ + + +text-max-char-angle-delta +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 22.5 +*(The label will not be placed if a character falls on a line with an angle sharper than 22.5 degrees.)* + +The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. + +------------ + + +text-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black +*(The text will be rendered black.)* + +Specifies the color for the text. + +------------ + + +text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque.)* + +A number from 0 to 1 specifying the opacity for the text. + +------------ + + +text-halo-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque.)* + +A number from 0 to 1 specifying the opacity for the text halo. + +------------ + + +text-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: white +*(The halo will be rendered white.)* + +Specifies the color of the halo around the text. + +------------ + + +text-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo.)* + +Specify the radius of the halo in pixels. + +------------ + + +text-halo-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full +*(The text will be rendered using the highest quality method rather than the fastest.)* + +Exposes an alternate text halo rendering method that sacrifices quality for speed. + +------------ + + +text-halo-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: +*(No transformation.)* + +Transform text halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. + +------------ + + +text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Text will not be displaced.)* + +Displace text by fixed amount, in pixels, +/- along the X axis. With "dummy" placement-type, a positive value displaces to the right. With "simple" placement-type, it is either left, right or unchanged, depending on the placement selected. Any non-zero value implies "horizontal-alignment" changes to "left" by default. Has no effect with 'line' text-placement-type. + +------------ + + +text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Text will not be displaced.)* + +Displace text by fixed amount, in pixels, +/- along the Y axis. With "dummy" placement-type, a positive value displaces downwards. With "simple" placement-type, it is either up, down or unchanged, depending on the placement selected. With "line" placement-type, a positive value displaces above the path. + +------------ + + +text-vertical-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``top`` ``middle`` ``bottom`` ``auto`` + + +Default Value: auto +*(Default affected by value of dy; "top" for dy>0, "bottom" for dy<0.)* + +Position of label relative to point position. + +------------ + + +text-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Text will be potentially placed near tile edges and therefore may look cut off unless the same text label is rendered on each adjacent tile.)* + +Avoid placing labels that intersect with tile boundaries. + +------------ + + +text-margin +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No extra margin will be used to determine if a label collides with any other text, shield, or marker.)* + +Minimum distance that a label can be placed from any other text, shield, or marker. + +------------ + + +text-repeat-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Labels with the same text will be rendered without restriction.)* + +Minimum distance between repeated text. If set this will prevent text labels being rendered nearby each other that contain the same text. Similar to text-min-distance with the difference that it works the same no matter what placement strategy is used. + +------------ + + +text-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + +**Status: deprecated** + + + + + +Default Value: 0 +*(Labels with the same text will be rendered without restriction.)* + +Minimum distance to the next label with the same text. Only works for line placement. Deprecated: replaced by ``text-repeat-distance`` and ``text-margin`` + +------------ + + +text-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No margin will be used to detect if a text label is nearby a tile boundary.)* + +Minimum distance a text label will be placed from the edge of a tile. This option is similar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. + +------------ + + +text-min-path-length +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(place labels on all geometries no matter how small they are.)* + +Place labels only on polygons and lines with a bounding width longer than this value (in pixels). + +------------ + + +text-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow text to overlap with other text - overlapping markers will not be shown.)* + +Control whether overlapping text is shown or hidden. + +------------ + + +text-orientation +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Text is not rotated and is displayed upright.)* + +Rotate the text. (only works with text-placement:point). + +------------ + + +text-rotate-displacement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Label center is used for rotation.)* + +Rotates the displacement around the placement origin by the angle given by "orientation". + +------------ + + +text-upright +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``auto`` ``auto-down`` ``left`` ``right`` ``left-only`` ``right-only`` + + +Default Value: auto +*(Text will be positioned upright automatically.)* + +How this label should be placed along lines. By default when more than half of a label's characters are upside down the label is automatically flipped to keep it upright. By changing this parameter you can prevent this "auto-upright" behavior. The "auto-down" value places text in the opposite orientation to "auto". The "left" or "right" settings can be used to force text to always be placed along a line in a given direction and therefore disables flipping if text appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down text rather than trying to flip it. + +------------ + + +text-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` ``grid`` ``alternating-grid`` + + +Default Value: point +*(One shield will be placed per geometry.)* + +How this label should be placed. Point placement places one label on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. + +------------ + + +text-placement-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``dummy`` ``simple`` ``list`` + + +Default Value: dummy +*(Alternative placements will not be enabled.)* + +Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. + +------------ + + +text-placements +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(No alternative placements will be used.)* + +If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is ``text-placements: "E,NE,SE,W,NW,SW";``. + +------------ + + +text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` ``reverse`` + + +Default Value: none +*(Transform text instance with specified function. Ignores map scale factor.)* + +Transform the case of the characters. + +------------ + + +text-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` ``adjust`` + + +Default Value: auto +*(TODO.)* + +The text's horizontal alignment from it's centerpoint. If ``placement`` is set to ``line``, then ``adjust`` can be set to auto-fit the text to the length of the path by dynamically calculating ``character-spacing``. + +------------ + + +text-align +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``right`` ``center`` ``auto`` + + +Default Value: auto +*(Auto alignment means that text will be centered by default except when using the ``placement-type`` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the ``text-placements`` directives.)* + +Define how text is justified. + +------------ + + +text-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +text-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +Simplify the geometries used for text placement by the given tolerance. + +------------ + + +text-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +Simplify the geometries used for text placement by the given algorithm. + +------------ + + +text-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out the angles of the geometry used for text placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +text-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +text-halo-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +text-font-feature-settings +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(Default set of typographic features recommended by OpenType specification. Ligatures are turned off by default when ``character-spacing`` is greater than zero.)* + +Comma separated list of OpenType typographic features. The syntax and semantics conforms to ``font-feature-settings`` from W3C CSS. + +------------ + + +text-largest-bbox-only +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + +**Status: experimental** + + + + + +Default Value: true +*(For multipolygons only polygon with largest bbox area is labeled (does not apply to other geometries).)* + +Controls default labeling behavior on multipolygons. The default is true and means that only the polygon with largest bbox is labeled. + +------------ + + +text-grid-cell-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No placement will be done.)* + +Controls horizontal spacing between placements of placement type ``grid`` or ``alternating-grid``. + +------------ + + +text-grid-cell-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No placement will be done.)* + +Controls vertical spacing between placements of placement type ``grid`` or ``alternating-grid``. + +------------ + + + +building +^^^^^^^^ + +building +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a building symbolizer rule or emitting it with default values. + +------------ + + +building-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: The color gray will be used for fill. +*(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)* + +The color of the buildings fill. Note: 0.8 will be used to multiply each color component to auto-generate a darkened wall color. + +------------ + + +building-fill-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of the building as a whole, including all walls. + +------------ + + +building-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Buildings will not have a visual height and will instead look like flat polygons.)* + +The height of the building in pixels. + +------------ + + + +debug +^^^^^ + +debug-mode +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``collision`` ``vertex`` + + +Default Value: collision +*(The otherwise invisible collision boxes will be rendered as squares on the map.)* + +The mode for debug rendering. + +------------ + + + +dot +^^^ + +dot +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a dot symbolizer rule or emitting it with default values. + +------------ + + +dot-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: gray +*(The dot fill color is gray.)* + +The color of the area of the dot. + +------------ + + +dot-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The opacity of the dot.)* + +The overall opacity of the dot. + +------------ + + +dot-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The marker width is 1 pixel.)* + +The width of the dot in pixels. + +------------ + + +dot-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The marker height is 1 pixels.)* + +The height of the dot in pixels. + +------------ + + +dot-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current layer on top of other layers.)* + +Composite operation. This defines how this layer should behave relative to layers atop or below it. + +------------ + + + + + diff --git a/docs/api/mapnik/3.0.3.rst b/docs/api/mapnik/3.0.3.rst new file mode 100644 index 0000000..04453d7 --- /dev/null +++ b/docs/api/mapnik/3.0.3.rst @@ -0,0 +1,3778 @@ +3.0.3 +===== +Style +----- + + + + + +image-filters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``functions`` + + + +Possible values: ``agg-stack-blur`` ``emboss`` ``blur`` ``gray`` ``sobel`` ``edge-detect`` ``x-gradient`` ``y-gradient`` ``invert`` ``sharpen`` ``color-blind-protanope`` ``color-blind-deuteranope`` ``color-blind-tritanope`` ``colorize-alpha`` ``color-to-alpha`` ``scale-hsla`` + +Default Value: none +*(no filters)* + +A list of image filters that will be applied to the active rendering canvas for a given style. The presence of one more ``image-filters`` will trigger a new canvas to be created before starting to render a style and then this canvas will be composited back into the main canvas after rendering all features and after all ``image-filters`` have been applied. See ``direct-image-filters`` if you want to apply a filter directly to the main canvas. + +------------ + + + +image-filters-inflate +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``boolean`` + + + + + +Default Value: false +*(No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary)* + +A property that can be set to true to enable using an inflated image internally for seamless blurring across tiles (requires buffered data). + +------------ + + + +direct-image-filters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``functions`` + + + +Possible values: ``agg-stack-blur`` ``emboss`` ``blur`` ``gray`` ``sobel`` ``edge-detect`` ``x-gradient`` ``y-gradient`` ``invert`` ``sharpen`` ``color-blind-protanope`` ``color-blind-deuteranope`` ``color-blind-tritanope`` ``colorize-alpha`` ``color-to-alpha`` ``scale-hsla`` + +Default Value: none +*(no filters)* + +A list of image filters to apply to the main canvas (see the ``image-filters`` doc for how they work on a separate canvas). + +------------ + + + +comp-op +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current layer on top of other layers)* + +Composite operation. This defines how this layer should behave relative to layers atop or below it. + +------------ + + + +opacity +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``float`` + + + + + +Default Value: 1 +*(No separate buffer will be used and no alpha will be applied to the style after rendering.)* + +An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer). + +------------ + + + +Symbolizers +----------- + + +map +^^^ + +background-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: none +*(Will be rendered transparent.)* + +Map Background color. + +------------ + + +background-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: +*(No background image will be used.)* + +An image that is repeated below all features on a map as a background. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +background-image-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(The background-image will be blended with the background normally (placed on top of any existing background-color).)* + +Set the compositing operation used to blend the image into the background. + +------------ + + +background-image-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The image opacity will not be changed when applied to the map background.)* + +Set the opacity of the image. + +------------ + + +srs +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs +*(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space.)* + +Map spatial reference (proj4 string). + +------------ + + +buffer-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No buffer will be used.)* + +Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". + +------------ + + +maximum-extent +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: -20037508.34,-20037508.34,20037508.34,20037508.34 +*(All data will be clipped to global mercator extent (default is applied in Carto.js).)* + +An extent to be used to limit the bounds used to query all layers during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Map. + +------------ + + +base +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)* + +Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. + +------------ + + +font-directory +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none +*(No map-specific fonts will be registered.)* + +Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). + +------------ + + + +polygon +^^^^^^^ + +polygon +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a polygon symbolizer rule or emitting it with default values. + +------------ + + +polygon-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: The color gray will be used for fill. +*(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)* + +Fill color to assign to a polygon. + +------------ + + +polygon-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of the polygon. + +------------ + + +polygon-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully antialiased.)* +Range: 0-1 +Level of antialiasing of polygon edges. + +------------ + + +polygon-gamma-method +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``power`` ``linear`` ``none`` ``threshold`` ``multiply`` + + +Default Value: power +*(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)* + +An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. + +------------ + + +polygon-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extend outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +polygon-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +Simplify geometries by the given tolerance. + +------------ + + +polygon-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +Simplify geometries by the given algorithm. + +------------ + + +polygon-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +polygon-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(The geometry will not be transformed.)* + +Transform polygon geometry with specified function. + +------------ + + +polygon-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +line +^^^^ + +line +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a line symbolizer rule or emitting it with default values. + +------------ + + +line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black +*(black and fully opaque (alpha = 1), same as rgb(0,0,0) or rgba(0,0,0,1).)* + +The color of a drawn line. + +------------ + + +line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The line will be rendered 1 pixel wide.)* + +The width of a line in pixels. + +------------ + + +line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of a line. + +------------ + + +line-join +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``miter`` ``miter-revert`` ``round`` ``bevel`` + + +Default Value: miter +*(The line joins will be rendered using a miter look.)* + +The behavior of lines when joining. + +------------ + + +line-cap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``butt`` ``round`` ``square`` + + +Default Value: butt +*(The line endings will be rendered using a butt look.)* + +The display of line endings. + +------------ + + +line-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully antialiased.)* +Range: 0-1 +Level of antialiasing of stroke line. + +------------ + + +line-gamma-method +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``power`` ``linear`` ``none`` ``threshold`` ``multiply`` + + +Default Value: power +*(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)* + +An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. + +------------ + + +line-dasharray +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(The line will be drawn without dashes.)* + +A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. + +------------ + + +line-dash-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(The line will be drawn without dashes.)* + +Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled). + +------------ + + +line-miterlimit +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 4 +*(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )'.)* + +The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. + +------------ + + +line-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +line-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +Simplify geometries by the given tolerance. + +------------ + + +line-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +Simplify geometries by the given algorithm. + +------------ + + +line-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +line-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + +**Status: unstable** + + + + + +Default Value: 0 +*(Will not be offset.)* + +Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). + +------------ + + +line-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full +*(The line will be rendered using the highest quality method rather than the fastest.)* + +Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. + +------------ + + +line-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(The geometry will not be transformed.)* + +Transform line geometry with specified function. + +------------ + + +line-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +markers +^^^^^^^ + +marker +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a marker symbolizer rule or emitting it with default values. + +------------ + + +marker-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none +*(An ellipse or circle, if width equals height.)* + +A file that this marker shows at each placement. If no file is given, the marker will show an ellipse. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +marker-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The stroke-opacity and fill-opacity of the marker.)* + +The overall opacity of the marker, if set, overrides both the opacity of the fill and the opacity of the stroke. + +------------ + + +marker-fill-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The fill opacity of the marker. This property will also set the ``fill-opacity`` of elements in an SVG loaded from a file. + +------------ + + +marker-line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black +*(The marker will be drawn with a black outline.)* + +The color of the stroke around the marker. This property will also set the ``stroke`` of elements in an SVG loaded from a file. + +------------ + + +marker-line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.5 +*(The marker will be drawn with an outline of .5 pixels wide.)* + +The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. This property will also set the ``stroke-width`` of elements in an SVG loaded from a file. + +------------ + + +marker-line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque. This property will also set the ``stroke-opacity`` of elements in an SVG loaded from a file.)* + +The opacity of a line. + +------------ + + +marker-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``interior`` ``vertex-first`` ``vertex-last`` + + +Default Value: point +*(Place markers at the center point (centroid) of the geometry.)* + +Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior. The 'vertex-first' and 'vertex-last' options can be used to place markers at the first or last vertex of lines or polygons. + +------------ + + +marker-multi-policy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``each`` ``whole`` ``largest`` + + +Default Value: each +*(If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each.)* + +A special setting to allow the user to control rendering behavior for 'multi-geometries' (when a feature contains multiple geometries). This setting does not apply to markers placed along lines. The 'each' policy is default and means all geometries will get a marker. The 'whole' policy means that the aggregate centroid between all geometries will be used. The 'largest' policy means that only the largest (by bounding box areas) feature will get a rendered marker (this is how text labeling behaves by default). + +------------ + + +marker-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: deprecated** + + +Possible values: ``arrow`` ``ellipse`` + + +Default Value: ellipse +*(The marker shape is an ellipse.)* + +The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width). + +------------ + + +marker-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 +*(The marker width is 10 pixels.)* + +The width of the marker, if using one of the default types. + +------------ + + +marker-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 +*(The marker height is 10 pixels.)* + +The height of the marker, if using one of the default types. + +------------ + + +marker-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: blue +*(The marker fill color is blue.)* + +The color of the area of the marker. This property will also set the ``fill`` of elements in an SVG loaded from a file. + +------------ + + +marker-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow markers to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping markers are shown or hidden. + +------------ + + +marker-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Markers will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)* + +Avoid placing markers that intersect with tile boundaries. + +------------ + + +marker-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache.)* + +Value to control whether the placement of the feature will prevent the placement of other features. + +------------ + + +marker-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 100 +*(In the case of marker-placement:line then draw a marker every 100 pixels along a line.)* + +Space between repeated markers in pixels. If the spacing is less than the marker size or larger than the line segment length then no marker will be placed. Any value less than 1 will be ignored and the default will be used instead. + +------------ + + +marker-max-error +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.2 +*(N/A: not intended to be changed.)* + +N/A: not intended to be changed. + +------------ + + +marker-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation.)* + +Transform marker instance with specified function. Ignores map scale factor. + +------------ + + +marker-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +marker-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Geometry will not be simplified.)* + +geometries are simplified by the given tolerance. + +------------ + + +marker-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +geometries are simplified by the given algorithm. + +------------ + + +marker-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +marker-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(The geometry will not be transformed.)* + +Transform marker geometry with specified function. + +------------ + + +marker-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Will not be offset.)* + +Offsets a marker from a line a number of pixels parallel to its actual path. Positive values move the marker left, negative values move it right (relative to the directionality of the line). + +------------ + + +marker-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +marker-direction +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``auto`` ``auto-down`` ``left`` ``right`` ``left-only`` ``right-only`` ``up`` ``down`` + + +Default Value: right +*(Markers are oriented to the right in the line direction.)* + +How markers should be placed along lines. With the "auto" setting when marker is upside down the marker is automatically rotated by 180 degrees to keep it upright. The "auto-down" value places marker in the opposite orientation to "auto". The "left" or "right" settings can be used to force marker to always be placed along a line in a given direction and therefore disables rotating if marker appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down markers rather than trying to flip it. The "up" and "down" settings don't adjust marker's orientation to the line direction. + +------------ + + + +shield +^^^^^^ + +shield +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a shield symbolizer rule. + +------------ + + +shield-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(No text label will be rendered with the shield.)* + +Value to use for a shield"s text label. Data columns are specified using brackets like [column_name]. + +------------ + + +shield-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image file to render behind the shield text. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +shield-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: none + + +Font name and style to use for the shield text. + +------------ + + +shield-unlock-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)* + +This parameter should be set to true if you are trying to position text beside rather than on top of the shield image. + +------------ + + +shield-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 +*(Font size of 10 will be used to render text.)* + +The size of the shield text in pixels. + +------------ + + +shield-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black +*(The shield text will be rendered black.)* + +The color of the shield text. + +------------ + + +shield-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` + + +Default Value: point +*(One shield will be placed per geometry.)* + +How this shield should be placed. Point placement places one shield on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. + +------------ + + +shield-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Shields will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)* + +Avoid placing shields that intersect with tile boundaries. + +------------ + + +shield-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow shields to overlap with other map elements already placed.)* + +Control whether overlapping shields are shown or hidden. + +------------ + + +shield-margin +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No extra margin will be used to determine if a shield collides with any other text, shield, or marker.)* + +Minimum distance that a shield can be placed from any other text, shield, or marker. + +------------ + + +shield-repeat-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Shields with the same text will be rendered without restriction.)* + +Minimum distance between repeated shields. If set this will prevent shields being rendered nearby each other that contain the same text. Similar to shield-min-distance with the difference that it works the same no matter what placement strategy is used. + +------------ + + +shield-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + +**Status: deprecated** + + + + + +Default Value: 0 +*(Shields with the same text will be rendered without restriction.)* + +Minimum distance to any other collision object. Deprecated: replaced by ``text-margin``. + +------------ + + +shield-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Only one shield per line will attempt to be placed.)* + +Distance the renderer should use to try to place repeated shields on a line. + +------------ + + +shield-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No margin will be used to detect if a shield is nearby a tile boundary.)* + +Minimum distance a shield will be placed from the edge of a tile. This option is similar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. + +------------ + + +shield-label-position-tolerance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: shield-spacing/2.0 +*(If a shield cannot be placed then the renderer will advance by shield-spacing/2.0 to try placement again.)* + +Allows the shield to be displaced from its ideal position by a number of pixels (only works with placement:line). + +------------ + + +shield-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 +*(Text will not be wrapped.)* + +Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. + +------------ + + +shield-wrap-before +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Wrapped lines will be a bit longer than wrap-width.)* + +Wrap text before wrap-width is reached. + +------------ + + +shield-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: " " +*(Lines will be wrapped conforming to the (untailored) Unicode Line Break Algorithm provided by ICU BreakIterator.)* + +Must be a single character. If you set it to other than the space character, Mapnik will wrap strictly on that character without involving any additional rules. + +------------ + + +shield-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: white +*(The shield halo text will be rendered white.)* + +Specifies the color of the halo around the text. + +------------ + + +shield-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo.)* + +Specify the radius of the halo in pixels. + +------------ + + +shield-halo-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full +*(The shield will be rendered using the highest quality method rather than the fastest.)* + +Exposes an alternate text halo rendering method that sacrifices quality for speed. + +------------ + + +shield-halo-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: +*(No transformation.)* + +Transform shield halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. + +------------ + + +shield-halo-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +shield-halo-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque.)* + +A number from 0 to 1 specifying the opacity for the text halo. + +------------ + + +shield-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 +*(The default character spacing of the font will be used.)* + +Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. + +------------ + + +shield-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(The default font spacing will be used.)* + +Vertical spacing between lines of multiline labels (in pixels). + +------------ + + +shield-text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Text will not be displaced.)* + +Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right. + +------------ + + +shield-text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Text will not be displaced.)* + +Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down. + +------------ + + +shield-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Shield will not be displaced.)* + +Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right. + +------------ + + +shield-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Shield will not be displaced.)* + +Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down. + +------------ + + +shield-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of the image used for the shield. + +------------ + + +shield-text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of the text placed on top of the shield. + +------------ + + +shield-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` + + +Default Value: auto +*(TODO.)* + +The shield's horizontal alignment from its centerpoint. + +------------ + + +shield-vertical-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``top`` ``middle`` ``bottom`` ``auto`` + + +Default Value: middle +*(TODO.)* + +The shield's vertical alignment from its centerpoint. + +------------ + + +shield-placement-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``dummy`` ``simple`` ``list`` + + +Default Value: dummy +*(Alternative placements will not be enabled.)* + +Re-position and/or re-size shield to avoid overlaps. "simple" for basic algorithm (using shield-placements string,) "dummy" to turn this feature off. + +------------ + + +shield-placements +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(No alternative placements will be used.)* + +If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is ``shield-placements: "E,NE,SE,W,NW,SW";``. + +------------ + + +shield-text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` ``reverse`` + + +Default Value: none +*(No text transformation will be applied.)* + +Transform the case of the characters. + +------------ + + +shield-justify-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``center`` ``right`` ``auto`` + + +Default Value: auto +*(TODO.)* + +Define how text in a shield's label is justified. + +------------ + + +shield-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation.)* + +Transform shield instance with specified function. Ignores map scale factor. + +------------ + + +shield-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +shield-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +Simplify the geometries used for shield placement by the given tolerance. + +------------ + + +shield-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +Simplify the geometries used for shield placement by the given algorithm. + +------------ + + +shield-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out the angles of the geometry used for shield placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +shield-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +line-pattern +^^^^^^^^^^^^ + +line-pattern +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a line pattern symbolizer rule. + +------------ + + +line-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +An image file to be repeated and warped along a line. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +line-pattern-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +line-pattern-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The image is rendered without modifications.)* + +Apply an opacity level to the image used for the pattern. + +------------ + + +line-pattern-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +geometries are simplified by the given tolerance. + +------------ + + +line-pattern-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +geometries are simplified by the given algorithm. + +------------ + + +line-pattern-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +line-pattern-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(The line will not be offset.)* + +Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). + +------------ + + +line-pattern-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(The geometry will not be transformed.)* + +Transform line geometry with specified function and apply pattern to transformed geometry. + +------------ + + +line-pattern-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation.)* + +Transform line pattern instance with specified function. + +------------ + + +line-pattern-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +polygon-pattern +^^^^^^^^^^^^^^^ + +polygon-pattern +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a polygon pattern symbolizer rule or emitting it with default values. + +------------ + + +polygon-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image to use as a repeated pattern fill within a polygon. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +polygon-pattern-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``global`` ``local`` + + +Default Value: global +*(Patterns will be aligned to the map (or tile boundaries) when being repeated across polygons. This is ideal for seamless patterns in tiled rendering.)* + +Specify whether to align pattern fills to the layer's geometry (local) or to the map (global). + +------------ + + +polygon-pattern-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully antialiased.)* +Range: 0-1 +Level of antialiasing of polygon pattern edges. + +------------ + + +polygon-pattern-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The image is rendered without modifications.)* + +Apply an opacity level to the image used for the pattern. + +------------ + + +polygon-pattern-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +polygon-pattern-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +geometries are simplified by the given tolerance. + +------------ + + +polygon-pattern-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +geometries are simplified by the given algorithm. + +------------ + + +polygon-pattern-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +polygon-pattern-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(The geometry will not be transformed.)* + +Transform polygon geometry with specified function and apply pattern to transformed geometry. + +------------ + + +polygon-pattern-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation.)* + +Transform polygon pattern instance with specified function. + +------------ + + +polygon-pattern-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +raster +^^^^^^ + +raster +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a raster symbolizer rule or emitting it with default values. + +------------ + + +raster-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of the raster symbolizer on top of other symbolizers. + +------------ + + +raster-filter-factor +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: -1 +*(Allow the datasource to choose appropriate downscaling.)* + +This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. + +------------ + + +raster-scaling +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``near`` ``fast`` ``bilinear`` ``bicubic`` ``spline16`` ``spline36`` ``hanning`` ``hamming`` ``hermite`` ``kaiser`` ``quadric`` ``catrom`` ``gaussian`` ``bessel`` ``mitchell`` ``sinc`` ``lanczos`` ``blackman`` + + +Default Value: near +*(Nearest neighboor resampling will be used to scale the image to the target size of the map.)* + +The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. + +------------ + + +raster-mesh-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 16 +*(Reprojection mesh will be 1/16 of the resolution of the source image.)* + +A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. + +------------ + + +raster-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +raster-colorizer-default-mode +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``discrete`` ``linear`` ``exact`` + + +Default Value: linear +*(A linear interpolation is used to generate colors between the two nearest stops.)* + +This can be either ``discrete``, ``linear`` or ``exact``. If it is not specified then the default is ``linear``. + +------------ + + +raster-colorizer-default-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: transparent +*(Pixels that are not colored by the colorizer stops will be transparent.)* + +This can be any color. Sets the color that is applied to all values outside of the range of the colorizer-stops. If not supplied pixels will be fully transparent. + +------------ + + +raster-colorizer-epsilon +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1.1920928955078125e-07 +*(Pixels must very closely match the stop filter otherwise they will not be colored.)* + +This can be any positive floating point value and will be used as a tolerance in floating point comparisions. The higher the value the more likely a stop will match and color data. + +------------ + + +raster-colorizer-stops +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``tags`` + + + + + +Default Value: +*(No colorization will happen without supplying stops.)* + +Assigns raster data values to colors. Stops must be listed in ascending order, and contain at a minimum the value and the associated color. You can also include the color-mode as a third argument, like ``stop(100,#fff,exact)``. + +------------ + + + +point +^^^^^ + +point +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a point symbolizer rule or emitting it with default values. + +------------ + + +point-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none +*(A 4x4 black square will be rendered.)* + +Image file to represent a point. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +point-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow points to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping points are shown or hidden. + +------------ + + +point-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache.)* + +Control whether the placement of the feature will prevent the placement of other features. + +------------ + + +point-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque.)* + +A value from 0 to 1 to control the opacity of the point. + +------------ + + +point-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``centroid`` ``interior`` + + +Default Value: centroid +*(The centroid of the geometry will be used to place the point.)* + +Control how this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. + +------------ + + +point-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation.)* + +Transform point instance with specified function. Ignores map scale factor. + +------------ + + +point-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +text +^^^^ + +text +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a text symbolizer rule or emitting it with default values. + +------------ + + +text-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: none + + +Value to use for a text label. Data columns are specified using brackets like [column_name]. + +------------ + + +text-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: none + + +Font name and style to render a label in. + +------------ + + +text-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 +*(Font size of 10 will be used to render text.)* + +Text size in pixels. + +------------ + + +text-ratio +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 +*(TODO.)* + +Define the amount of text (of the total) present on successive lines when wrapping occurs. + +------------ + + +text-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 +*(Text will not be wrapped.)* + +Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. + +------------ + + +text-wrap-before +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Wrapped lines will be a bit longer than wrap-width.)* + +Wrap text before wrap-width is reached. + +------------ + + +text-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: " " +*(Lines will be wrapped conforming to the (untailored) Unicode Line Break Algorithm provided by ICU BreakIterator.)* + +Must be a single character. If you set it to other than the space character, Mapnik will wrap strictly on that character without involving any additional rules. + +------------ + + +text-repeat-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + +**Status: unstable** + + + + + +Default Value: false +*(Character will be removed when used to wrap a line.)* + +Keep the character used to wrap a line instead of removing it, and repeat it on the new line. + +------------ + + +text-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 +*(Only one label per line will attempt to be placed.)* + +Distance the renderer should use to try to place repeated text labels on a line. + +------------ + + +text-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(The default character spacing of the font will be used.)* + +Horizontal spacing adjustment between characters in pixels. This value is ignored when ``horizontal-alignment`` is set to ``adjust``. Typographic ligatures are turned off when this value is greater than zero. + +------------ + + +text-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(The default font spacing will be used.)* + +Vertical spacing adjustment between lines in pixels. + +------------ + + +text-label-position-tolerance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: text-spacing/2.0 +*(If a shield cannot be placed then the renderer will advance by text-spacing/2.0 to try placement again.)* + +Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line). + +------------ + + +text-max-char-angle-delta +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 22.5 +*(The label will not be placed if a character falls on a line with an angle sharper than 22.5 degrees.)* + +The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. + +------------ + + +text-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black +*(The text will be rendered black.)* + +Specifies the color for the text. + +------------ + + +text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque.)* + +A number from 0 to 1 specifying the opacity for the text. + +------------ + + +text-halo-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque.)* + +A number from 0 to 1 specifying the opacity for the text halo. + +------------ + + +text-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: white +*(The halo will be rendered white.)* + +Specifies the color of the halo around the text. + +------------ + + +text-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo.)* + +Specify the radius of the halo in pixels. + +------------ + + +text-halo-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full +*(The text will be rendered using the highest quality method rather than the fastest.)* + +Exposes an alternate text halo rendering method that sacrifices quality for speed. + +------------ + + +text-halo-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: +*(No transformation.)* + +Transform text halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. + +------------ + + +text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Text will not be displaced.)* + +Displace text by fixed amount, in pixels, +/- along the X axis. With "dummy" placement-type, a positive value displaces to the right. With "simple" placement-type, it is either left, right or unchanged, depending on the placement selected. Any non-zero value implies "horizontal-alignment" changes to "left" by default. Has no effect with 'line' text-placement-type. + +------------ + + +text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Text will not be displaced.)* + +Displace text by fixed amount, in pixels, +/- along the Y axis. With "dummy" placement-type, a positive value displaces downwards. With "simple" placement-type, it is either up, down or unchanged, depending on the placement selected. With "line" placement-type, a positive value displaces above the path. + +------------ + + +text-vertical-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``top`` ``middle`` ``bottom`` ``auto`` + + +Default Value: auto +*(Default affected by value of dy; "top" for dy>0, "bottom" for dy<0.)* + +Position of label relative to point position. + +------------ + + +text-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Text will be potentially placed near tile edges and therefore may look cut off unless the same text label is rendered on each adjacent tile.)* + +Avoid placing labels that intersect with tile boundaries. + +------------ + + +text-margin +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No extra margin will be used to determine if a label collides with any other text, shield, or marker.)* + +Minimum distance that a label can be placed from any other text, shield, or marker. + +------------ + + +text-repeat-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Labels with the same text will be rendered without restriction.)* + +Minimum distance between repeated text. If set this will prevent text labels being rendered nearby each other that contain the same text. Similar to text-min-distance with the difference that it works the same no matter what placement strategy is used. + +------------ + + +text-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + +**Status: deprecated** + + + + + +Default Value: 0 +*(Labels with the same text will be rendered without restriction.)* + +Minimum distance to the next label with the same text. Only works for line placement. Deprecated: replaced by ``text-repeat-distance`` and ``text-margin`` + +------------ + + +text-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No margin will be used to detect if a text label is nearby a tile boundary.)* + +Minimum distance a text label will be placed from the edge of a tile. This option is similar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. + +------------ + + +text-min-path-length +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(place labels on all geometries no matter how small they are.)* + +Place labels only on polygons and lines with a bounding width longer than this value (in pixels). + +------------ + + +text-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow text to overlap with other text - overlapping markers will not be shown.)* + +Control whether overlapping text is shown or hidden. + +------------ + + +text-orientation +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Text is not rotated and is displayed upright.)* + +Rotate the text. (only works with text-placement:point). + +------------ + + +text-rotate-displacement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Label center is used for rotation.)* + +Rotates the displacement around the placement origin by the angle given by "orientation". + +------------ + + +text-upright +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``auto`` ``auto-down`` ``left`` ``right`` ``left-only`` ``right-only`` + + +Default Value: auto +*(Text will be positioned upright automatically.)* + +How this label should be placed along lines. By default when more than half of a label's characters are upside down the label is automatically flipped to keep it upright. By changing this parameter you can prevent this "auto-upright" behavior. The "auto-down" value places text in the opposite orientation to "auto". The "left" or "right" settings can be used to force text to always be placed along a line in a given direction and therefore disables flipping if text appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down text rather than trying to flip it. + +------------ + + +text-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` + + +Default Value: point +*(One shield will be placed per geometry.)* + +How this label should be placed. Point placement places one label on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. + +------------ + + +text-placement-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``dummy`` ``simple`` ``list`` + + +Default Value: dummy +*(Alternative placements will not be enabled.)* + +Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. + +------------ + + +text-placements +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(No alternative placements will be used.)* + +If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is ``text-placements: "E,NE,SE,W,NW,SW";``. + +------------ + + +text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` ``reverse`` + + +Default Value: none +*(Transform text instance with specified function. Ignores map scale factor.)* + +Transform the case of the characters. + +------------ + + +text-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` ``adjust`` + + +Default Value: auto +*(TODO.)* + +The text's horizontal alignment from it's centerpoint. If ``placement`` is set to ``line``, then ``adjust`` can be set to auto-fit the text to the length of the path by dynamically calculating ``character-spacing``. + +------------ + + +text-align +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``right`` ``center`` ``auto`` + + +Default Value: auto +*(Auto alignment means that text will be centered by default except when using the ``placement-type`` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the ``text-placements`` directives.)* + +Define how text is justified. + +------------ + + +text-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +text-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +Simplify the geometries used for text placement by the given tolerance. + +------------ + + +text-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +Simplify the geometries used for text placement by the given algorithm. + +------------ + + +text-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out the angles of the geometry used for text placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +text-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +text-halo-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +text-font-feature-settings +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(Default set of typographic features recommended by OpenType specification. Ligatures are turned off by default when ``character-spacing`` is greater than zero.)* + +Comma separated list of OpenType typographic features. The syntax and semantics conforms to ``font-feature-settings`` from W3C CSS. + +------------ + + +text-largest-bbox-only +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + +**Status: experimental** + + + + + +Default Value: true +*(For multipolygons only polygon with largest bbox area is labeled (does not apply to other geometries).)* + +Controls default labeling behavior on multipolygons. The default is true and means that only the polygon with largest bbox is labeled. + +------------ + + + +building +^^^^^^^^ + +building +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a building symbolizer rule or emitting it with default values. + +------------ + + +building-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: The color gray will be used for fill. +*(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)* + +The color of the buildings fill. Note: 0.8 will be used to multiply each color component to auto-generate a darkened wall color. + +------------ + + +building-fill-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of the building as a whole, including all walls. + +------------ + + +building-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Buildings will not have a visual height and will instead look like flat polygons.)* + +The height of the building in pixels. + +------------ + + + +debug +^^^^^ + +debug-mode +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``collision`` ``vertex`` + + +Default Value: collision +*(The otherwise invisible collision boxes will be rendered as squares on the map.)* + +The mode for debug rendering. + +------------ + + + +dot +^^^ + +dot +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a dot symbolizer rule or emitting it with default values. + +------------ + + +dot-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: gray +*(The dot fill color is gray.)* + +The color of the area of the dot. + +------------ + + +dot-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The opacity of the dot.)* + +The overall opacity of the dot. + +------------ + + +dot-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The marker width is 1 pixel.)* + +The width of the dot in pixels. + +------------ + + +dot-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The marker height is 1 pixels.)* + +The height of the dot in pixels. + +------------ + + +dot-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current layer on top of other layers.)* + +Composite operation. This defines how this layer should behave relative to layers atop or below it. + +------------ + + + + + diff --git a/docs/api/mapnik/3.0.6.rst b/docs/api/mapnik/3.0.6.rst new file mode 100644 index 0000000..ec90fa3 --- /dev/null +++ b/docs/api/mapnik/3.0.6.rst @@ -0,0 +1,3778 @@ +3.0.6 +===== +Style +----- + + + + + +image-filters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``functions`` + + + +Possible values: ``agg-stack-blur`` ``emboss`` ``blur`` ``gray`` ``sobel`` ``edge-detect`` ``x-gradient`` ``y-gradient`` ``invert`` ``sharpen`` ``color-blind-protanope`` ``color-blind-deuteranope`` ``color-blind-tritanope`` ``colorize-alpha`` ``color-to-alpha`` ``scale-hsla`` + +Default Value: none +*(no filters)* + +A list of image filters that will be applied to the active rendering canvas for a given style. The presence of one more ``image-filters`` will trigger a new canvas to be created before starting to render a style and then this canvas will be composited back into the main canvas after rendering all features and after all ``image-filters`` have been applied. See ``direct-image-filters`` if you want to apply a filter directly to the main canvas. + +------------ + + + +image-filters-inflate +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``boolean`` + + + + + +Default Value: false +*(No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary)* + +A property that can be set to true to enable using an inflated image internally for seamless blurring across tiles (requires buffered data). + +------------ + + + +direct-image-filters +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``functions`` + + + +Possible values: ``agg-stack-blur`` ``emboss`` ``blur`` ``gray`` ``sobel`` ``edge-detect`` ``x-gradient`` ``y-gradient`` ``invert`` ``sharpen`` ``color-blind-protanope`` ``color-blind-deuteranope`` ``color-blind-tritanope`` ``colorize-alpha`` ``color-to-alpha`` ``scale-hsla`` + +Default Value: none +*(no filters)* + +A list of image filters to apply to the main canvas (see the ``image-filters`` doc for how they work on a separate canvas). + +------------ + + + +comp-op +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(add the current layer on top of other layers)* + +Composite operation. This defines how this layer should behave relative to layers atop or below it. + +------------ + + + +opacity +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: ``float`` + + + + + +Default Value: 1 +*(No separate buffer will be used and no alpha will be applied to the style after rendering.)* + +An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer). + +------------ + + + +Symbolizers +----------- + + +map +^^^ + +background-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: none +*(Will be rendered transparent.)* + +Map Background color. + +------------ + + +background-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: +*(No background image will be used.)* + +An image that is repeated below all features on a map as a background. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +background-image-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(The background-image will be blended with the background normally (placed on top of any existing background-color).)* + +Set the compositing operation used to blend the image into the background. + +------------ + + +background-image-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The image opacity will not be changed when applied to the map background.)* + +Set the opacity of the image. + +------------ + + +srs +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs +*(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space.)* + +Map spatial reference (proj4 string). + +------------ + + +buffer-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No buffer will be used.)* + +Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". + +------------ + + +maximum-extent +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: -20037508.34,-20037508.34,20037508.34,20037508.34 +*(All data will be clipped to global mercator extent (default is applied in Carto.js).)* + +An extent to be used to limit the bounds used to query all layers during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Map. + +------------ + + +base +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)* + +Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. + +------------ + + +font-directory +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none +*(No map-specific fonts will be registered.)* + +Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). + +------------ + + + +polygon +^^^^^^^ + +polygon +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a polygon symbolizer rule or emitting it with default values. + +------------ + + +polygon-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: rgba(128,128,128,1) +*(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)* + +Fill color to assign to a polygon. + +------------ + + +polygon-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of the polygon. + +------------ + + +polygon-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully antialiased.)* +Range: 0-1 +Level of antialiasing of polygon edges. + +------------ + + +polygon-gamma-method +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``power`` ``linear`` ``none`` ``threshold`` ``multiply`` + + +Default Value: power +*(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)* + +An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. + +------------ + + +polygon-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extend outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +polygon-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +Simplify geometries by the given tolerance. + +------------ + + +polygon-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +Simplify geometries by the given algorithm. + +------------ + + +polygon-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +polygon-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(The geometry will not be transformed.)* + +Transform polygon geometry with specified function. + +------------ + + +polygon-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +line +^^^^ + +line +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a line symbolizer rule or emitting it with default values. + +------------ + + +line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black +*(black and fully opaque (alpha = 1), same as rgb(0,0,0) or rgba(0,0,0,1).)* + +The color of a drawn line. + +------------ + + +line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The line will be rendered 1 pixel wide.)* + +The width of a line in pixels. + +------------ + + +line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of a line. + +------------ + + +line-join +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``miter`` ``miter-revert`` ``round`` ``bevel`` + + +Default Value: miter +*(The line joins will be rendered using a miter look.)* + +The behavior of lines when joining. + +------------ + + +line-cap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``butt`` ``round`` ``square`` + + +Default Value: butt +*(The line endings will be rendered using a butt look.)* + +The display of line endings. + +------------ + + +line-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully antialiased.)* +Range: 0-1 +Level of antialiasing of stroke line. + +------------ + + +line-gamma-method +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``power`` ``linear`` ``none`` ``threshold`` ``multiply`` + + +Default Value: power +*(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)* + +An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. + +------------ + + +line-dasharray +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(The line will be drawn without dashes.)* + +A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. + +------------ + + +line-dash-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``numbers`` + + + + + +Default Value: none +*(The line will be drawn without dashes.)* + +Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled). + +------------ + + +line-miterlimit +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 4 +*(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )'.)* + +The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. + +------------ + + +line-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +line-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +Simplify geometries by the given tolerance. + +------------ + + +line-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +Simplify geometries by the given algorithm. + +------------ + + +line-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +line-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + +**Status: unstable** + + + + + +Default Value: 0 +*(Will not be offset.)* + +Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). + +------------ + + +line-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full +*(The line will be rendered using the highest quality method rather than the fastest.)* + +Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. + +------------ + + +line-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(The geometry will not be transformed.)* + +Transform line geometry with specified function. + +------------ + + +line-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +markers +^^^^^^^ + +marker +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a marker symbolizer rule or emitting it with default values. + +------------ + + +marker-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none +*(An ellipse or circle, if width equals height.)* + +A file that this marker shows at each placement. If no file is given, the marker will show an ellipse. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +marker-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The stroke-opacity and fill-opacity of the marker.)* + +The overall opacity of the marker, if set, overrides both the opacity of the fill and the opacity of the stroke. + +------------ + + +marker-fill-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The fill opacity of the marker. This property will also set the ``fill-opacity`` of elements in an SVG loaded from a file. + +------------ + + +marker-line-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black +*(The marker will be drawn with a black outline.)* + +The color of the stroke around the marker. This property will also set the ``stroke`` of elements in an SVG loaded from a file. + +------------ + + +marker-line-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.5 +*(The marker will be drawn with an outline of .5 pixels wide.)* + +The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. This property will also set the ``stroke-width`` of elements in an SVG loaded from a file. + +------------ + + +marker-line-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque. This property will also set the ``stroke-opacity`` of elements in an SVG loaded from a file.)* + +The opacity of a line. + +------------ + + +marker-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``interior`` ``vertex-first`` ``vertex-last`` + + +Default Value: point +*(Place markers at the center point (centroid) of the geometry.)* + +Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior. The 'vertex-first' and 'vertex-last' options can be used to place markers at the first or last vertex of lines or polygons. + +------------ + + +marker-multi-policy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``each`` ``whole`` ``largest`` + + +Default Value: each +*(If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each.)* + +A special setting to allow the user to control rendering behavior for 'multi-geometries' (when a feature contains multiple geometries). This setting does not apply to markers placed along lines. The 'each' policy is default and means all geometries will get a marker. The 'whole' policy means that the aggregate centroid between all geometries will be used. The 'largest' policy means that only the largest (by bounding box areas) feature will get a rendered marker (this is how text labeling behaves by default). + +------------ + + +marker-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: deprecated** + + +Possible values: ``arrow`` ``ellipse`` + + +Default Value: ellipse +*(The marker shape is an ellipse.)* + +The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width). + +------------ + + +marker-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 +*(The marker width is 10 pixels.)* + +The width of the marker, if using one of the default types. + +------------ + + +marker-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 +*(The marker height is 10 pixels.)* + +The height of the marker, if using one of the default types. + +------------ + + +marker-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: blue +*(The marker fill color is blue.)* + +The color of the area of the marker. This property will also set the ``fill`` of elements in an SVG loaded from a file. + +------------ + + +marker-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow markers to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping markers are shown or hidden. + +------------ + + +marker-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Markers will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)* + +Avoid placing markers that intersect with tile boundaries. + +------------ + + +marker-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache.)* + +Value to control whether the placement of the feature will prevent the placement of other features. + +------------ + + +marker-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 100 +*(In the case of marker-placement:line then draw a marker every 100 pixels along a line.)* + +Space between repeated markers in pixels. If the spacing is less than the marker size or larger than the line segment length then no marker will be placed. Any value less than 1 will be ignored and the default will be used instead. + +------------ + + +marker-max-error +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0.2 +*(N/A: not intended to be changed.)* + +N/A: not intended to be changed. + +------------ + + +marker-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation.)* + +Transform marker instance with specified function. Ignores map scale factor. + +------------ + + +marker-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +marker-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Geometry will not be simplified.)* + +geometries are simplified by the given tolerance. + +------------ + + +marker-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +geometries are simplified by the given algorithm. + +------------ + + +marker-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +marker-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(The geometry will not be transformed.)* + +Transform marker geometry with specified function. + +------------ + + +marker-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Will not be offset.)* + +Offsets a marker from a line a number of pixels parallel to its actual path. Positive values move the marker left, negative values move it right (relative to the directionality of the line). + +------------ + + +marker-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +marker-direction +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``auto`` ``auto-down`` ``left`` ``right`` ``left-only`` ``right-only`` ``up`` ``down`` + + +Default Value: right +*(Markers are oriented to the right in the line direction.)* + +How markers should be placed along lines. With the "auto" setting when marker is upside down the marker is automatically rotated by 180 degrees to keep it upright. The "auto-down" value places marker in the opposite orientation to "auto". The "left" or "right" settings can be used to force marker to always be placed along a line in a given direction and therefore disables rotating if marker appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down markers rather than trying to flip it. The "up" and "down" settings don't adjust marker's orientation to the line direction. + +------------ + + + +shield +^^^^^^ + +shield +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a shield symbolizer rule. + +------------ + + +shield-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(No text label will be rendered with the shield.)* + +Value to use for a shield"s text label. Data columns are specified using brackets like [column_name]. + +------------ + + +shield-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image file to render behind the shield text. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +shield-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: none + + +Font name and style to use for the shield text. + +------------ + + +shield-unlock-image +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)* + +This parameter should be set to true if you are trying to position text beside rather than on top of the shield image. + +------------ + + +shield-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 +*(Font size of 10 will be used to render text.)* + +The size of the shield text in pixels. + +------------ + + +shield-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black +*(The shield text will be rendered black.)* + +The color of the shield text. + +------------ + + +shield-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` + + +Default Value: point +*(One shield will be placed per geometry.)* + +How this shield should be placed. Point placement places one shield on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. + +------------ + + +shield-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Shields will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)* + +Avoid placing shields that intersect with tile boundaries. + +------------ + + +shield-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow shields to overlap with other map elements already placed.)* + +Control whether overlapping shields are shown or hidden. + +------------ + + +shield-margin +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No extra margin will be used to determine if a shield collides with any other text, shield, or marker.)* + +Minimum distance that a shield can be placed from any other text, shield, or marker. + +------------ + + +shield-repeat-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Shields with the same text will be rendered without restriction.)* + +Minimum distance between repeated shields. If set this will prevent shields being rendered nearby each other that contain the same text. Similar to shield-min-distance with the difference that it works the same no matter what placement strategy is used. + +------------ + + +shield-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + +**Status: deprecated** + + + + + +Default Value: 0 +*(Shields with the same text will be rendered without restriction.)* + +Minimum distance to any other collision object. Deprecated: replaced by ``text-margin``. + +------------ + + +shield-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Only one shield per line will attempt to be placed.)* + +Distance the renderer should use to try to place repeated shields on a line. + +------------ + + +shield-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No margin will be used to detect if a shield is nearby a tile boundary.)* + +Minimum distance a shield will be placed from the edge of a tile. This option is similar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. + +------------ + + +shield-label-position-tolerance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: shield-spacing/2.0 +*(If a shield cannot be placed then the renderer will advance by shield-spacing/2.0 to try placement again.)* + +Allows the shield to be displaced from its ideal position by a number of pixels (only works with placement:line). + +------------ + + +shield-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 +*(Text will not be wrapped.)* + +Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. + +------------ + + +shield-wrap-before +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Wrapped lines will be a bit longer than wrap-width.)* + +Wrap text before wrap-width is reached. + +------------ + + +shield-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: " " +*(Lines will be wrapped conforming to the (untailored) Unicode Line Break Algorithm provided by ICU BreakIterator.)* + +Must be a single character. If you set it to other than the space character, Mapnik will wrap strictly on that character without involving any additional rules. + +------------ + + +shield-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: white +*(The shield halo text will be rendered white.)* + +Specifies the color of the halo around the text. + +------------ + + +shield-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo.)* + +Specify the radius of the halo in pixels. + +------------ + + +shield-halo-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full +*(The shield will be rendered using the highest quality method rather than the fastest.)* + +Exposes an alternate text halo rendering method that sacrifices quality for speed. + +------------ + + +shield-halo-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: +*(No transformation.)* + +Transform shield halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. + +------------ + + +shield-halo-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +shield-halo-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque.)* + +A number from 0 to 1 specifying the opacity for the text halo. + +------------ + + +shield-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 +*(The default character spacing of the font will be used.)* + +Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. + +------------ + + +shield-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(The default font spacing will be used.)* + +Vertical spacing between lines of multiline labels (in pixels). + +------------ + + +shield-text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Text will not be displaced.)* + +Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right. + +------------ + + +shield-text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Text will not be displaced.)* + +Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down. + +------------ + + +shield-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Shield will not be displaced.)* + +Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right. + +------------ + + +shield-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Shield will not be displaced.)* + +Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down. + +------------ + + +shield-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of the image used for the shield. + +------------ + + +shield-text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of the text placed on top of the shield. + +------------ + + +shield-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` + + +Default Value: auto +*(TODO.)* + +The shield's horizontal alignment from its centerpoint. + +------------ + + +shield-vertical-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``top`` ``middle`` ``bottom`` ``auto`` + + +Default Value: middle +*(TODO.)* + +The shield's vertical alignment from its centerpoint. + +------------ + + +shield-placement-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``dummy`` ``simple`` ``list`` + + +Default Value: dummy +*(Alternative placements will not be enabled.)* + +Re-position and/or re-size shield to avoid overlaps. "simple" for basic algorithm (using shield-placements string,) "dummy" to turn this feature off. + +------------ + + +shield-placements +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(No alternative placements will be used.)* + +If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is ``shield-placements: "E,NE,SE,W,NW,SW";``. + +------------ + + +shield-text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` ``reverse`` + + +Default Value: none +*(No text transformation will be applied.)* + +Transform the case of the characters. + +------------ + + +shield-justify-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``center`` ``right`` ``auto`` + + +Default Value: auto +*(TODO.)* + +Define how text in a shield's label is justified. + +------------ + + +shield-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation.)* + +Transform shield instance with specified function. Ignores map scale factor. + +------------ + + +shield-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +shield-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +Simplify the geometries used for shield placement by the given tolerance. + +------------ + + +shield-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +Simplify the geometries used for shield placement by the given algorithm. + +------------ + + +shield-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out the angles of the geometry used for shield placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +shield-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +line-pattern +^^^^^^^^^^^^ + +line-pattern +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a line pattern symbolizer rule or emitting it with default values. + +------------ + + +line-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +An image file to be repeated and warped along a line. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +line-pattern-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +line-pattern-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The image is rendered without modifications.)* + +Apply an opacity level to the image used for the pattern. + +------------ + + +line-pattern-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +geometries are simplified by the given tolerance. + +------------ + + +line-pattern-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +geometries are simplified by the given algorithm. + +------------ + + +line-pattern-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +line-pattern-offset +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(The line will not be offset.)* + +Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). + +------------ + + +line-pattern-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(The geometry will not be transformed.)* + +Transform line geometry with specified function and apply pattern to transformed geometry. + +------------ + + +line-pattern-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation.)* + +Transform line pattern instance with specified function. + +------------ + + +line-pattern-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +polygon-pattern +^^^^^^^^^^^^^^^ + +polygon-pattern +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a polygon pattern symbolizer rule or emitting it with default values. + +------------ + + +polygon-pattern-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none + + +Image to use as a repeated pattern fill within a polygon. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +polygon-pattern-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``global`` ``local`` + + +Default Value: global +*(Patterns will be aligned to the map (or tile boundaries) when being repeated across polygons. This is ideal for seamless patterns in tiled rendering.)* + +Specify whether to align pattern fills to the layer's geometry (local) or to the map (global). + +------------ + + +polygon-pattern-gamma +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully antialiased.)* +Range: 0-1 +Level of antialiasing of polygon pattern edges. + +------------ + + +polygon-pattern-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The image is rendered without modifications.)* + +Apply an opacity level to the image used for the pattern. + +------------ + + +polygon-pattern-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +polygon-pattern-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +geometries are simplified by the given tolerance. + +------------ + + +polygon-pattern-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +geometries are simplified by the given algorithm. + +------------ + + +polygon-pattern-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +polygon-pattern-geometry-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(The geometry will not be transformed.)* + +Transform polygon geometry with specified function and apply pattern to transformed geometry. + +------------ + + +polygon-pattern-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation.)* + +Transform polygon pattern instance with specified function. + +------------ + + +polygon-pattern-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +raster +^^^^^^ + +raster +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a raster symbolizer rule or emitting it with default values. + +------------ + + +raster-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of the raster symbolizer on top of other symbolizers. + +------------ + + +raster-filter-factor +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: -1 +*(Allow the datasource to choose appropriate downscaling.)* + +This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. + +------------ + + +raster-scaling +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``near`` ``fast`` ``bilinear`` ``bicubic`` ``spline16`` ``spline36`` ``hanning`` ``hamming`` ``hermite`` ``kaiser`` ``quadric`` ``catrom`` ``gaussian`` ``bessel`` ``mitchell`` ``sinc`` ``lanczos`` ``blackman`` + + +Default Value: near +*(Nearest neighboor resampling will be used to scale the image to the target size of the map.)* + +The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. + +------------ + + +raster-mesh-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 16 +*(Reprojection mesh will be 1/16 of the resolution of the source image.)* + +A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. + +------------ + + +raster-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +raster-colorizer-default-mode +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``discrete`` ``linear`` ``exact`` + + +Default Value: linear +*(A linear interpolation is used to generate colors between the two nearest stops.)* + +This can be either ``discrete``, ``linear`` or ``exact``. If it is not specified then the default is ``linear``. + +------------ + + +raster-colorizer-default-color +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: transparent +*(Pixels that are not colored by the colorizer stops will be transparent.)* + +This can be any color. Sets the color that is applied to all values outside of the range of the colorizer-stops. If not supplied pixels will be fully transparent. + +------------ + + +raster-colorizer-epsilon +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1.1920928955078125e-07 +*(Pixels must very closely match the stop filter otherwise they will not be colored.)* + +This can be any positive floating point value and will be used as a tolerance in floating point comparisions. The higher the value the more likely a stop will match and color data. + +------------ + + +raster-colorizer-stops +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``tags`` + + + + + +Default Value: +*(No colorization will happen without supplying stops.)* + +Assigns raster data values to colors. Stops must be listed in ascending order, and contain at a minimum the value and the associated color. You can also include the color-mode as a third argument, like ``stop(100,#fff,exact)``. + +------------ + + + +point +^^^^^ + +point +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a point symbolizer rule or emitting it with default values. + +------------ + + +point-file +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``uri`` + + + + + +Default Value: none +*(A 4x4 black square will be rendered.)* + +Image file to represent a point. Accepted formats: svg, jpg, png, tiff, and webp. + +------------ + + +point-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow points to overlap with each other - overlapping markers will not be shown.)* + +Control whether overlapping points are shown or hidden. + +------------ + + +point-ignore-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(do not store the bbox of this geometry in the collision detector cache.)* + +Control whether the placement of the feature will prevent the placement of other features. + +------------ + + +point-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque.)* + +A value from 0 to 1 to control the opacity of the point. + +------------ + + +point-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``centroid`` ``interior`` + + +Default Value: centroid +*(The centroid of the geometry will be used to place the point.)* + +Control how this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. + +------------ + + +point-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: none +*(No transformation.)* + +Transform point instance with specified function. Ignores map scale factor. + +------------ + + +point-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + + +text +^^^^ + +text +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``none`` + + +Default Value: + + +Allows omitting a text symbolizer rule. + +------------ + + +text-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: none + + +Value to use for a text label. Data columns are specified using brackets like [column_name]. + +------------ + + +text-face-name +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: none + + +Font name and style to render a label in. + +------------ + + +text-size +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 10 +*(Font size of 10 will be used to render text.)* + +Text size in pixels. + +------------ + + +text-ratio +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 +*(TODO.)* + +Define the amount of text (of the total) present on successive lines when wrapping occurs. + +------------ + + +text-wrap-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 +*(Text will not be wrapped.)* + +Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. + +------------ + + +text-wrap-before +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Wrapped lines will be a bit longer than wrap-width.)* + +Wrap text before wrap-width is reached. + +------------ + + +text-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: " " +*(Lines will be wrapped conforming to the (untailored) Unicode Line Break Algorithm provided by ICU BreakIterator.)* + +Must be a single character. If you set it to other than the space character, Mapnik will wrap strictly on that character without involving any additional rules. + +------------ + + +text-repeat-wrap-character +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + +**Status: unstable** + + + + + +Default Value: false +*(Character will be removed when used to wrap a line.)* + +Keep the character used to wrap a line instead of removing it, and repeat it on the new line. + +------------ + + +text-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``unsigned`` + + + + + +Default Value: 0 +*(Only one label per line will attempt to be placed.)* + +Distance the renderer should use to try to place repeated text labels on a line. + +------------ + + +text-character-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(The default character spacing of the font will be used.)* + +Horizontal spacing adjustment between characters in pixels. This value is ignored when ``horizontal-alignment`` is set to ``adjust``. Typographic ligatures are turned off when this value is greater than zero. + +------------ + + +text-line-spacing +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(The default font spacing will be used.)* + +Vertical spacing adjustment between lines in pixels. + +------------ + + +text-label-position-tolerance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: text-spacing/2.0 +*(If a shield cannot be placed then the renderer will advance by text-spacing/2.0 to try placement again.)* + +Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line). + +------------ + + +text-max-char-angle-delta +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 22.5 +*(The label will not be placed if a character falls on a line with an angle sharper than 22.5 degrees.)* + +The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. + +------------ + + +text-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: black +*(The text will be rendered black.)* + +Specifies the color for the text. + +------------ + + +text-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque.)* + +A number from 0 to 1 specifying the opacity for the text. + +------------ + + +text-halo-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Fully opaque.)* + +A number from 0 to 1 specifying the opacity for the text halo. + +------------ + + +text-halo-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: white +*(The halo will be rendered white.)* + +Specifies the color of the halo around the text. + +------------ + + +text-halo-radius +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(no halo.)* + +Specify the radius of the halo in pixels. + +------------ + + +text-halo-rasterizer +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``full`` ``fast`` + + +Default Value: full +*(The text will be rendered using the highest quality method rather than the fastest.)* + +Exposes an alternate text halo rendering method that sacrifices quality for speed. + +------------ + + +text-halo-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``functions`` + + + +Possible values: ``matrix`` ``translate`` ``scale`` ``rotate`` ``skewX`` ``skewY`` + +Default Value: +*(No transformation.)* + +Transform text halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. + +------------ + + +text-dx +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Text will not be displaced.)* + +Displace text by fixed amount, in pixels, +/- along the X axis. With "dummy" placement-type, a positive value displaces to the right. With "simple" placement-type, it is either left, right or unchanged, depending on the placement selected. Any non-zero value implies "horizontal-alignment" changes to "left" by default. Has no effect with 'line' text-placement-type. + +------------ + + +text-dy +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Text will not be displaced.)* + +Displace text by fixed amount, in pixels, +/- along the Y axis. With "dummy" placement-type, a positive value displaces downwards. With "simple" placement-type, it is either up, down or unchanged, depending on the placement selected. With "line" placement-type, a positive value displaces above the path. + +------------ + + +text-vertical-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``top`` ``middle`` ``bottom`` ``auto`` + + +Default Value: auto +*(Default affected by value of dy; "top" for dy>0, "bottom" for dy<0.)* + +Position of label relative to point position. + +------------ + + +text-avoid-edges +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Text will be potentially placed near tile edges and therefore may look cut off unless the same text label is rendered on each adjacent tile.)* + +Avoid placing labels that intersect with tile boundaries. + +------------ + + +text-margin +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No extra margin will be used to determine if a label collides with any other text, shield, or marker.)* + +Minimum distance that a label can be placed from any other text, shield, or marker. + +------------ + + +text-repeat-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Labels with the same text will be rendered without restriction.)* + +Minimum distance between repeated text. If set this will prevent text labels being rendered nearby each other that contain the same text. Similar to text-min-distance with the difference that it works the same no matter what placement strategy is used. + +------------ + + +text-min-distance +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + +**Status: deprecated** + + + + + +Default Value: 0 +*(Labels with the same text will be rendered without restriction.)* + +Minimum distance to the next label with the same text. Only works for line placement. Deprecated: replaced by ``text-repeat-distance`` and ``text-margin`` + +------------ + + +text-min-padding +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No margin will be used to detect if a text label is nearby a tile boundary.)* + +Minimum distance a text label will be placed from the edge of a tile. This option is similar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. + +------------ + + +text-min-path-length +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(place labels on all geometries no matter how small they are.)* + +Place labels only on polygons and lines with a bounding width longer than this value (in pixels). + +------------ + + +text-allow-overlap +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Do not allow text to overlap with other text - overlapping markers will not be shown.)* + +Control whether overlapping text is shown or hidden. + +------------ + + +text-orientation +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Text is not rotated and is displayed upright.)* + +Rotate the text. (only works with text-placement:point). + +------------ + + +text-rotate-displacement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(Label center is used for rotation.)* + +Rotates the displacement around the placement origin by the angle given by "orientation". + +------------ + + +text-upright +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``auto`` ``auto-down`` ``left`` ``right`` ``left-only`` ``right-only`` + + +Default Value: auto +*(Text will be positioned upright automatically.)* + +How this label should be placed along lines. By default when more than half of a label's characters are upside down the label is automatically flipped to keep it upright. By changing this parameter you can prevent this "auto-upright" behavior. The "auto-down" value places text in the opposite orientation to "auto". The "left" or "right" settings can be used to force text to always be placed along a line in a given direction and therefore disables flipping if text appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down text rather than trying to flip it. + +------------ + + +text-placement +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``point`` ``line`` ``vertex`` ``interior`` + + +Default Value: point +*(One shield will be placed per geometry.)* + +How this label should be placed. Point placement places one label on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. + +------------ + + +text-placement-type +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``dummy`` ``simple`` ``list`` + + +Default Value: dummy +*(Alternative placements will not be enabled.)* + +Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. + +------------ + + +text-placements +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(No alternative placements will be used.)* + +If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is ``text-placements: "E,NE,SE,W,NW,SW";``. + +------------ + + +text-transform +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``none`` ``uppercase`` ``lowercase`` ``capitalize`` ``reverse`` + + +Default Value: none +*(Transform text instance with specified function. Ignores map scale factor.)* + +Transform the case of the characters. + +------------ + + +text-horizontal-alignment +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``middle`` ``right`` ``auto`` ``adjust`` + + +Default Value: auto +*(TODO.)* + +The text's horizontal alignment from it's centerpoint. If ``placement`` is set to ``line``, then ``adjust`` can be set to auto-fit the text to the length of the path by dynamically calculating ``character-spacing``. + +------------ + + +text-align +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``left`` ``right`` ``center`` ``auto`` + + +Default Value: auto +*(Auto alignment means that text will be centered by default except when using the ``placement-type`` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the ``text-placements`` directives.)* + +Define how text is justified. + +------------ + + +text-clip +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + + + + + +Default Value: false +*(The geometry will not be clipped to map bounds before rendering.)* + +Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. + +------------ + + +text-simplify +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(geometry will not be simplified.)* + +Simplify the geometries used for text placement by the given tolerance. + +------------ + + +text-simplify-algorithm +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``radial-distance`` ``zhao-saalfeld`` ``visvalingam-whyatt`` ``douglas-peucker`` + + +Default Value: radial-distance +*(The geometry will be simplified using the radial distance algorithm.)* + +Simplify the geometries used for text placement by the given algorithm. + +------------ + + +text-smooth +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(No smoothing.)* +Range: 0-1 +Smooths out the angles of the geometry used for text placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. + +------------ + + +text-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +text-halo-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current symbolizer on top of other symbolizer.)* + +Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. + +------------ + + +text-font-feature-settings +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``string`` + + + + + +Default Value: +*(Default set of typographic features recommended by OpenType specification. Ligatures are turned off by default when ``character-spacing`` is greater than zero.)* + +Comma separated list of OpenType typographic features. The syntax and semantics conforms to ``font-feature-settings`` from W3C CSS. + +------------ + + +text-largest-bbox-only +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``boolean`` + +**Status: experimental** + + + + + +Default Value: true +*(For multipolygons only polygon with largest bbox area is labeled (does not apply to other geometries).)* + +Controls default labeling behavior on multipolygons. The default is true and means that only the polygon with largest bbox is labeled. + +------------ + + + +building +^^^^^^^^ + +building +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a building symbolizer rule or emitting it with default values. + +------------ + + +building-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: The color gray will be used for fill. +*(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)* + +The color of the buildings fill. Note: 0.8 will be used to multiply each color component to auto-generate a darkened wall color. + +------------ + + +building-fill-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(Color is fully opaque.)* + +The opacity of the building as a whole, including all walls. + +------------ + + +building-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 0 +*(Buildings will not have a visual height and will instead look like flat polygons.)* + +The height of the building in pixels. + +------------ + + + +debug +^^^^^ + +debug-mode +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``collision`` ``vertex`` + + +Default Value: collision +*(The otherwise invisible collision boxes will be rendered as squares on the map.)* + +The mode for debug rendering. + +------------ + + + +dot +^^^ + +dot +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + +**Status: unstable** + + +Possible values: ``auto`` ``none`` + + +Default Value: + + +Allows omitting a dot symbolizer rule or emitting it with default values. + +------------ + + +dot-fill +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``color`` + + + + + +Default Value: gray +*(The dot fill color is gray.)* + +The color of the area of the dot. + +------------ + + +dot-opacity +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The opacity of the dot.)* + +The overall opacity of the dot. + +------------ + + +dot-width +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The marker width is 1 pixel.)* + +The width of the dot in pixels. + +------------ + + +dot-height +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``float`` + + + + + +Default Value: 1 +*(The marker height is 1 pixels.)* + +The height of the dot in pixels. + +------------ + + +dot-comp-op +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: ``keyword`` + + +Possible values: ``clear`` ``src`` ``dst`` ``src-over`` ``dst-over`` ``src-in`` ``dst-in`` ``src-out`` ``dst-out`` ``src-atop`` ``dst-atop`` ``xor`` ``plus`` ``minus`` ``multiply`` ``divide`` ``screen`` ``overlay`` ``darken`` ``lighten`` ``color-dodge`` ``color-burn`` ``linear-dodge`` ``linear-burn`` ``hard-light`` ``soft-light`` ``difference`` ``exclusion`` ``contrast`` ``invert`` ``invert-rgb`` ``grain-merge`` ``grain-extract`` ``hue`` ``saturation`` ``color`` ``value`` + + +Default Value: src-over +*(Add the current layer on top of other layers.)* + +Composite operation. This defines how this layer should behave relative to layers atop or below it. + +------------ + + + + + diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..91db25a --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,157 @@ +# -*- coding: utf-8 -*- +# +# carto documentation build configuration file, created by +# sphinx-quickstart on Sun Feb 5 10:57:37 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + +import sphinx_rtd_theme + + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'carto' +copyright = u'2017, Carto contributors' +author = u'Carto contributors' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'' +# The full version, including alpha/beta/rc tags. +release = u'' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = "sphinx_rtd_theme" + +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'cartodoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'carto.tex', u'carto Documentation', + u'Carto contributors', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'carto', u'carto Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'carto', u'carto Documentation', + author, 'carto', 'One line description of project.', + 'Miscellaneous'), +] diff --git a/docs/generate.js b/docs/generate.js new file mode 100644 index 0000000..5122571 --- /dev/null +++ b/docs/generate.js @@ -0,0 +1,38 @@ +var fs = require('fs'), + path = require('path'), + refs = require('mapnik-reference'), + _ = require('lodash'); + +function tmpl(x) { + return _.template(fs.readFileSync(path.join(__dirname, x), 'utf-8')); +} + +function substituteReSt(str) { + str = str.replace(/\`/g, '``'); + + return str; +} + +var index = tmpl('mapnik_api._'), + table = tmpl('symbolizers._'), + versions = []; + +refs.versions.forEach(function (v) { + var ref = refs.load(v), + output = ''; + + output += v + '\n' + Array(v.length + 1).join('=') + '\n'; + output += table({ + style: ref.style, + symbolizers: ref.symbolizers, + subst: substituteReSt, + _: _ + }); + output += '\n\n'; + + versions.push('.. include:: api/mapnik/' + v + '.rst'); + + fs.writeFileSync(path.join(__dirname, 'api/mapnik/' + v + '.rst'), output); +}); + +fs.writeFileSync(path.join(__dirname, 'mapnik_api.rst'), index({versions: versions.reverse().join('\n')})); diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..9e5dc24 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,19 @@ +######## +CartoCSS +######## + +CartoCSS (short: Carto) is a language for map design. It is similar in syntax to CSS, but builds upon it with specific abilities to +filter map data and by providing things like variables. It targets the `Mapnik renderer <http://mapnik.org>`_ and is able to generate Mapnik XML or +a JSON variant of Mapnik XML. It can run from the command line or in the browser by using a bundler like Browserify. + +Carto is an evolution of the `Cascadenik <https://github.com/mapnik/Cascadenik>`_ idea and language, with an emphasis on speed and flexibility. + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + installation_usage + language_elements + styling_concepts + mml + mapnik_api diff --git a/docs/installation_usage.rst b/docs/installation_usage.rst new file mode 100644 index 0000000..22c506a --- /dev/null +++ b/docs/installation_usage.rst @@ -0,0 +1,275 @@ +******************** +Installation & Usage +******************** + +Installation +============ + +If you are using a map design application like Kosmtik, Mapbox Studio Classic or Tilemill you already have CartoCSS installed +and might be more interested in the language reference. + +Else you can install the *carto* binary with NPM by running:: + + npm install -g carto + +You should consider using a Node.js version manager like `NVM <https://github.com/creationix/nvm>`_. + +Optionally you may also want to install millstone which is required for resolving data in the same way as Mapbox Studio Classic does:: + + npm install -g millstone + + +Having *millstone* installed specifically enables support for localizing external resources (URLs and local files) referenced in your MML file, +and detecting projections (using `node-srs <https://github.com/mapbox/node-srs>`_). + +Usage from the command line +=========================== + +Now that Carto is installed you should have a *carto* command line tool available that can be run on a CartoCSS project:: + + carto project.mml > mapnik.xml + +The following command line options are available: + +-a / --api VERSION + Specify Mapnik API version (e.g. --api 3.0.10) (default: latest Mapnik API version) + +-b / --benchmark + Outputs total compile time + +-f / --file + Outputs to the specified file instead of stdout + +-h / --help + Display help message + +-l / --localize + Use millstone to localize resources when loading an MML (default: off) + +-n / --nosymlink + Use absolute paths instead of symlinking files + +-o / --output + Specify output format, possible values are ``mapnik`` and ``json`` (default: ``mapnik``) + +-ppi RESOLUTION + Pixels per inch used to convert m, mm, cm, in, pt, pc to pixels (default: 90.714) + +-q / --quiet + Do not output any warnings (default: off) + +-v / --version + Display version information + +Usage from JavaScript (Carto API) +================================= + +Alternatively, Carto can be used from JavaScript. While you theoretically could +instantiate almost all of the classes the main outward facing stable interfaces +are the ``Renderer`` and the ``MML`` interface. We start with an example and describe +the details afterwards:: + + // defined variables: + // - input (the name or identifier of the file being parsed) + var carto = require('carto'); + + try { + var data = fs.readFileSync(input, 'utf-8'); + var mml = new carto.MML({}); + mml.load(path.dirname(input), data, function (err, data) { + var output = {}; + + if (!err) { + output = new carto.Renderer({ + filename: input + }).render(data); + } + + if (output.msg) { + output.msg.forEach(function (v) { + if (v.type === 'error') { + console.error(carto.Util.getMessageToPrint(v)); + } + else if (v.type === 'warning') { + console.warn(carto.Util.getMessageToPrint(v)); + } + }); + } + + // output content (if no errors) + if (output.data) { + console.log(output.data); + } + }); + } catch (err) { + // program failures + ... + } + +MML +--- + +The MML interface loads and processes a MML file (see :ref:`mml-file-structure` for details). +You instantiate the class with ``carto.MML``. The constructor takes a options object with +the following possible attributes: + +* ``localize`` *boolean* (same as -l / --localize on the command line) - this uses + `millstone <https://github.com/tilemill-project/millstone>`_ to localize stylesheet resources +* ``nosymlink`` *boolean* (same as -n / --nosymlink on the command line) - for millstone, tells + it to use unmodified paths instead of symlinking files + +By calling ``load(basedir, data, callback)`` the MML file is loaded and processed. +This method does not perform reading from a file, so you have to read the contents +of the file yourself and provide it as string to the method via the ``data`` parameter to the +load function. The ``basedir`` parameter is used to resolve stylesheet references. +When the processing is finished the specified ``callback`` function is called, which +has the following signature:: + + function (err, data) {} + +If an error occurred you find the message within ``err`` and ``data`` is ``null``. +When successful you find the processed MML data structure in ``data`` and ``err`` is ``null``. +The structure within ``data`` is excpected by the ``Renderer`` interface's ``render`` method. + +.. note:: If you want to use Carto within the browser you should not use MML loading via ``carto.MML.load``. + Instead you should supply the JSON of the MML including the Stylesheet strings directly to ``carto.Renderer.render``. + +Renderer +-------- + +The Renderer interface performs the parsing and transformation for rendering from +a MML file string (either self loaded or loaded through the MML interface) or from a MSS +file string (without layers). You instantiate the class with ``carto.Renderer``. +The constructor takes a options object with the following possible attributes: + +* ``benchmark`` *boolean* (similar to -b / --benchmark on the command line) - specifies + if carto should run in benchmarking mode +* ``effects`` *array* - a container for side-effects limited to FontSets +* ``filename`` *string* - name of the input file, used to format errors and warnings +* ``outputFormat`` *string [mapnik|json]* (similar to -o / --output on the command line) + - specifies which format the output should have, either Mapnik XML or JSON similar to Mapnik XML +* ``ppi`` *float* (similar to -ppi on the command line) - Pixels per inch used to convert m, mm, cm, in, pt, pc to pixels +* ``quiet`` *boolean* (similar to -q / --quiet on the command line) - if carto should output + warnings or not +* ``reference`` *class* - carto uses a reference to validate input. You can specify your own + which has to adhere to the specification. (see :ref:`reference`) +* ``validationData`` *object* + + * ``fonts`` *array* - a list of fonts that carto should use to validate if used fonts are valid/present + +* ``version`` *string (semver)* (similar to -a / --api on the command line) - specify which + Mapnik API version carto should use + +``carto.Renderer`` offers two methods for actual rendering. You can either use ``render(data)`` or +``renderMSS(data)``. Both accept a string of either a processed MML file or a MSS style fragment. +The ``render`` method produces a full-featured style output while the ``renderMSS`` outputs only +a style fragment. Both return the following object:: + + { + msg: [], + data: '' + } + +If errors or warnings occurred during rendering you will find them in ``msg`` and ``data`` +will be ``null`` (in case of errors). The actual output is found in ``data`` if no errors +occurred. + +Util +---- + +Carto provides a Util class to assist you with e.g. message formatting. Like in the +example you can call ``getMessageToPrint`` with a received message object to output it +nicely formatted as string. + +.. _reference: + +Using a custom reference +------------------------ + +Carto uses a reference to validate input. This reference specifies which rules and functions +are valid and which types a rule can take. It also describes how rules are transformed for +the output. By default carto uses `mapnik-reference <https://github.com/mapnik/mapnik-reference>`_ +as reference, but you can also use your own. It has to adhere to the following specification:: + + { + versions: [], // array of versions (semver) as strings + latest: '', // latest version (semver) as strings + load: function (version) {} // return data structure for specified version + } + +The data structure returned by ``load`` has to look like this:: + + { + version: '', // version (semver) as string + style: {}, // rules that apply to the style as a whole + layer: {}, // rules that apply to a layer as a whole + symbolizers: {}, // rules that apply to different elements of the renderer, this elements make up the map + colors: {}, // color names and their mapping to RGB values + datasources: {} // possible data sources for the rendering library and their parameters + } + +.. note:: ``datasources`` is not yet used by carto for validation. + +All entries that contain rules are objects where there attributes are named after +a color, symbolizer or rule. ``style`` and ``layer`` have the same inner structure. +Here is an example:: + + { + 'filter-mode': { + type: {}, + doc: '', + 'default-value': '', + 'default-meaning': '' + } + ... + } + +``symbolizer`` first contains the possible symbolizers and then their rules:: + + { + polygon: { + fill: {}, + 'fill-opacity': {} + ... + } + ... + } + +``colors`` maps color names to their RGB values:: + + { + aliceblue: [ 240, 248, 255 ], + antiquewhite: [ 250, 235, 215 ] + ... + } + +``datasources`` is similar to ``symbolizers`` and contains first the possible data sources +and then their possible parameters:: + + { + csv: { + file: {}, + base: {} + ... + } + } + +Rules (all the parts that where specified with ``{}`` with a little preview at ``filter-mode``) +can have several attributes that are evaluated:: + + name: { + css: '', // rule name which is used in CartoCSS + default-meaning: '', // meaning of the default value + default-value: '', // default value of the rule + doc: '', // documentation about the rule + expression: bool, // whether this rule is a expression or not + functions: [], // array of arrays that contain function name and # of params e.g. ["matrix", 6] + range: '', // range of values that are allowed e.g. 0-1 + required: bool, // if this rule is required + status: '[unstable|experimental|deprecated]', // if omitted it means stable + type: '[bbox|boolean|color|float|functions|numbers|string|uri]', // type can also be an array of keywords + } + +.. caution:: Adherence to the specification is not assessed in-depth because that would + be too resource intensive. If you don't adhere to the specification it is quite likely + that you hit runtime errors. diff --git a/docs/language_elements.rst b/docs/language_elements.rst new file mode 100644 index 0000000..d894316 --- /dev/null +++ b/docs/language_elements.rst @@ -0,0 +1,205 @@ +***************** +Language Elements +***************** + +Below is a list of values and an explanation of any expression that can be applied to properties in CartoCSS. + +Color +===== + +CartoCSS accepts a variety of syntaxes for colors - HTML-style hex values, rgb, rgba, hsl, hsla, hsluv, and hsluva. +It also supports the predefined HTML colors names, like `yellow` and `blue`. :: + + #line { + line-color: #ff0; + line-color: #ffff00; + line-color: rgb(255, 255, 0); + line-color: rgba(255, 255, 0, 1); + line-color: hsl(100, 50%, 50%); + line-color: hsla(100, 50%, 50%, 1); + line-color: hsluv(100, 50%, 50%); // same values yield different color than HSL + line-color: hsluva(100, 50%, 50%, 1); + line-color: yellow; + } + +Especially of note is the support for HSL and HSLuv, which can be easier to reason about than RGB. +CartoCSS also includes several color operation functions `borrowed from LessCSS <http://lesscss.org/functions/#color-operations>`_:: + + // lighten and darken colors + lighten(#ace, 10%); + darken(#ace, 10%); + + // saturate and desaturate + saturate(#550000, 10%); + desaturate(#00ff00, 10%); + + // increase or decrease the opacity of a color + fadein(#fafafa, 10%); + fadeout(#fefefe, 14%); + + // spin rotates a color around the color wheel by degrees + spin(#ff00ff, 10); + + // mix generates a color in between two other colors. + mix(#fff, #000, 50%); + + // get color components + hue(#ff00ff); + saturation(#ff00ff); + lightness(#ff00ff); + alpha(hsla(100, 50%, 50%, 0.5)); + +These functions all take arguments which can be color variables, literal colors, or the results of other functions operating on colors. +All the above mentioned functions also come in a *functionp*-variant (e.g. ``lightenp``), which force a given color into HSLuv color space. + +Float +===== + +Float is a fancy way of saying 'number'. In CartoCSS, you specify *just a number* - unlike CSS, there are no units, +but everything is specified in pixels. :: + + #line { + line-width: 2; + } + +It's also possible to do simple math with number values:: + + #line { + line-width: 4 / 2; // division + line-width: 4 + 2; // addition + line-width: 4 - 2; // subtraction + line-width: 4 * 2; // multiplication + line-width: 4 % 2; // modulus + } + +URI +=== + +URI is a fancy way of saying URL. When an argument is a URI, you use the same kind of ``url('place.png')`` +notation that you would with HTML. Quotes around the URL aren't required, but are highly recommended. +URIs can be paths to places on your computer, or on the internet. :: + + #markers { + marker-file: url('marker.png'); + } + +String +====== + +A string is basically just text. In the case of CartoCSS, you're going to put it in quotes. Strings can be anything, +though pay attention to the cases of ``text-name`` and ``shield-name`` - they actually will refer to features, +which you refer to by putting them in brackets, as seen in the example below. :: + + #labels { + text-name: "[MY_FIELD]"; + } + +Boolean +======= + +Boolean means yes or no, so it accepts the values ``true`` or ``false``. :: + + #markers { + marker-allow-overlap: true; + } + +Expressions +=========== + +Expressions are statements that can include fields, numbers, and other types in a really flexible way. +You have run into expressions before, in the realm of 'fields', where you'd specify ``"[FIELD]"``, +but expressions allow you to drop the quotes and also do quick addition, division, multiplication, +and concatenation from within CartoCSS syntax. :: + + #buildings { + building-height: [HEIGHT_FIELD] * 10; + } + +Numbers +======= + +Numbers are comma-separated lists of one or more number in a specific order. +They're used in line dash arrays, in which the numbers specify intervals of line, break, and line again. :: + + #disputedboundary { + line-dasharray: 1, 4, 2; + } + +Percentages +=========== + +In CartoCSS, the percentage symbol, ``%`` universally means ``value/100``. +It's meant to be used with ratio-related properties, like opacity rules. + +.. attention:: You should not use percentages as widths, heights, or other properties - unlike CSS, + percentages are not relative to cascaded classes or page size, they're, as stated, + simply the value divided by one hundred. + +In an example:: + + #world { + // this syntax + polygon-opacity: 50%; + + // is equivalent to + polygon-opacity: 0.5; + } + +Functions +========= + +Functions are comma-separated lists of one or more functions. For instance, transforms use the ``functions`` type +to allow for transforms within CartoCSS, which are optionally chainable. :: + + #point { + point-transform: scale(2, 2); + } + +Mapnik Render-Time Variables +============================ + +Mapnik >= 3.0.0 supports variables of the form ``@var``. These can be used from CartoCSS by specifying them as strings. For example:: + + #layer { + line-width: '@zoom'; + } + +For this to have any effect you have to pass the variables to Mapnik at render time in a hashmap of the form ``variable_name:variable_value``. + +Controlling output of symbolizers and symbolizer attributes +=========================================================== + +You can control symbolizer output by using rules that work on the whole symbolizer. E.g. ``line`` works on the +line symbolizer. By using the keywords ``none`` or ``auto`` you can either suppress the symbolizer or output it with +default values. The keyword ``auto`` does not work on shield and text symbolizers because they have attributes without +default values. Here is an example how this works:: + + #layer { + line: none; + line-width: 2; + [feature = 'redfeature'] { + line-color: red; + } + [feature = 'bluefeature'] { + line-color: blue; + } + } + +Without ``line: none`` carto would output a line symbolizer with default values for all features +other than redfeature and bluefeature, that is a black line with width 1. In contrast, you can +quickly output a symbolizer with default value by using ``auto``:: + + #layer { + [feature = 'quickfeature'] { + marker: auto; + } + } + +This outputs a default markers symbolizer for all quickfeature features. + +You can also control the output of individual symbolizer properties by specifying them with the keyword ``none`` e.g. ``line-color: none``. +They will then be removed from the symbolizer thus using their default value +or not using them at all. This does not work or makes sense for all properties like e.g. not for ``text-face-name`` as it does not have a default value. For an overview over properties +where this works or makes sense see `this list <https://github.com/mapbox/carto/blob/master/test/rendering-mss/issue_214.mss>`_. +In this case the use of ``none`` and ``auto`` is equivalent. In both cases the default +value will be used as Mapnik uses the default value automatically when the property is not present. diff --git a/docs/latest.md b/docs/latest.md deleted file mode 100644 index ad7ed30..0000000 --- a/docs/latest.md +++ /dev/null @@ -1,2226 +0,0 @@ -# Carto documentation - -The following is a list of properties provided in CartoCSS that you can apply to map elements. - -## All elements - -##### image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``color-blind-protanope``color-blind-deuteranope``color-blind-tritanope``colorize-alpha``color-to-alpha``scale-hsla` - -Default Value: none -_(no filters.)_ - -A list of image filters that will be applied to the active rendering canvas for a given style. The presence of one more `image-filters` will trigger a new canvas to be created before starting to render a style and then this canvas will be composited back into the main canvas after rendering all features and after all `image-filters` have been applied. See `direct-image-filters` if you want to apply a filter directly to the main canvas. -* * * - -##### image-filters-inflate `boolean` - - - -Default Value: false -_(No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary.)_ - -A property that can be set to true to enable using an inflated image internally for seamless blurring across tiles (requires buffered data). -* * * - -##### direct-image-filters `functions` - -`agg-stack-blur``emboss``blur``gray``sobel``edge-detect``x-gradient``y-gradient``invert``sharpen``color-blind-protanope``color-blind-deuteranope``color-blind-tritanope``colorize-alpha``color-to-alpha``scale-hsla` - -Default Value: none -_(no filters.)_ - -A list of image filters to apply to the main canvas (see the `image-filters` doc for how they work on a separate canvas). -* * * - -##### comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current layer on top of other layers.)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - -##### opacity `float` - - - -Default Value: 1 -_(No separate buffer will be used and no alpha will be applied to the style after rendering.)_ - -An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer). -* * * - - -## map - -##### background-color `color` - - - -Default Value: none -_(Will be rendered transparent.)_ - -Map Background color. -* * * - -##### background-image `uri` - - - -Default Value: -_(No background image will be used.)_ - -An image that is repeated below all features on a map as a background. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### background-image-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(The background-image will be blended with the background normally (placed on top of any existing background-color).)_ - -Set the compositing operation used to blend the image into the background. -* * * - -##### background-image-opacity `float` - - - -Default Value: 1 -_(The image opacity will not be changed when applied to the map background.)_ - -Set the opacity of the image. -* * * - -##### srs `string` - - - -Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs -_(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space.)_ - -Map spatial reference (proj4 string). -* * * - -##### buffer-size `float` - - - -Default Value: 0 -_(No buffer will be used.)_ - -Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges". -* * * - -##### maximum-extent `string` - - - -Default Value: -20037508.34,-20037508.34,20037508.34,20037508.34 -_(All data will be clipped to global mercator extent (default is applied in Carto.js).)_ - -An extent to be used to limit the bounds used to query all layers during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Map. -* * * - -##### base `string` - - - -Default Value: -_(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)_ - -Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet. -* * * - -##### font-directory `uri` - - - -Default Value: none -_(No map-specific fonts will be registered.)_ - -Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered). -* * * - - -## polygon - -##### polygon-fill `color` - - - -Default Value: The color gray will be used for fill. -_(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)_ - -Fill color to assign to a polygon. -* * * - -##### polygon-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the polygon. -* * * - -##### polygon-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of polygon edges. -* * * - -##### polygon-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. -* * * - -##### polygon-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extend outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### polygon-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify geometries by the given tolerance. -* * * - -##### polygon-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify geometries by the given algorithm. -* * * - -##### polygon-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform polygon geometry with specified function. -* * * - -##### polygon-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line - -##### line-color `color` - - - -Default Value: black -_(black and fully opaque (alpha = 1), same as rgb(0,0,0) or rgba(0,0,0,1).)_ - -The color of a drawn line. -* * * - -##### line-width `float` - - - -Default Value: 1 -_(The line will be rendered 1 pixel wide.)_ - -The width of a line in pixels. -* * * - -##### line-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of a line. -* * * - -##### line-join `keyword` -`miter``miter-revert``round``bevel` - - -Default Value: miter -_(The line joins will be rendered using a miter look.)_ - -The behavior of lines when joining. -* * * - -##### line-cap `keyword` -`butt``round``square` - - -Default Value: butt -_(The line endings will be rendered using a butt look.)_ - -The display of line endings. -* * * - -##### line-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of stroke line. -* * * - -##### line-gamma-method `keyword` -`power``linear``none``threshold``multiply` - - -Default Value: power -_(pow(x,gamma) is used to calculate pixel gamma, which produces slightly smoother line and polygon antialiasing than the 'linear' method, while other methods are usually only used to disable AA.)_ - -An Antigrain Geometry specific rendering hint to control the quality of antialiasing. Under the hood in Mapnik this method is used in combination with the 'gamma' value (which defaults to 1). The methods are in the AGG source at https://github.com/mapnik/mapnik/blob/master/deps/agg/include/agg_gamma_functions. -* * * - -##### line-dasharray `numbers` - - - -Default Value: none -_(The line will be drawn without dashes.)_ - -A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns. -* * * - -##### line-dash-offset `numbers` - - - -Default Value: none -_(The line will be drawn without dashes.)_ - -Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled). -* * * - -##### line-miterlimit `float` - - - -Default Value: 4 -_(Will auto-convert miters to bevel line joins when theta is less than 29 degrees as per the SVG spec: 'miterLength / stroke-width = 1 / sin ( theta / 2 )'.)_ - -The limit on the ratio of the miter length to the stroke-width. Used to automatically convert miter joins to bevel joins for sharp angles to avoid the miter extending beyond the thickness of the stroking path. Normally will not need to be set, but a larger value can sometimes help avoid jaggy artifacts. -* * * - -##### line-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### line-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify geometries by the given tolerance. -* * * - -##### line-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify geometries by the given algorithm. -* * * - -##### line-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-offset `float` - - - -Default Value: 0 -_(Will not be offset.)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The line will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate AGG rendering method that sacrifices some accuracy for speed. -* * * - -##### line-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform line geometry with specified function. -* * * - -##### line-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## markers - -##### marker-file `uri` - - - -Default Value: none -_(An ellipse or circle, if width equals height.)_ - -A file that this marker shows at each placement. If no file is given, the marker will show an ellipse. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### marker-opacity `float` - - - -Default Value: 1 -_(The stroke-opacity and fill-opacity of the marker.)_ - -The overall opacity of the marker, if set, overrides both the opacity of both the fill and stroke. -* * * - -##### marker-fill-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The fill opacity of the marker. -* * * - -##### marker-line-color `color` - - - -Default Value: black -_(The marker will be drawn with a black outline.)_ - -The color of the stroke around the marker. -* * * - -##### marker-line-width `float` - - - -Default Value: 0.5 -_(The marker will be drawn with an outline of .5 pixels wide.)_ - -The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself. -* * * - -##### marker-line-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of a line. -* * * - -##### marker-placement `keyword` -`point``line``interior``vertex-first``vertex-last` - - -Default Value: point -_(Place markers at the center point (centroid) of the geometry.)_ - -Attempt to place markers on a point, in the center of a polygon, or if markers-placement:line, then multiple times along a line. 'interior' placement can be used to ensure that points placed on polygons are forced to be inside the polygon interior. The 'vertex-first' and 'vertex-last' options can be used to place markers at the first or last vertex of lines or polygons. -* * * - -##### marker-multi-policy `keyword` -`each``whole``largest` - - -Default Value: each -_(If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each.)_ - -A special setting to allow the user to control rendering behavior for 'multi-geometries' (when a feature contains multiple geometries). This setting does not apply to markers placed along lines. The 'each' policy is default and means all geometries will get a marker. The 'whole' policy means that the aggregate centroid between all geometries will be used. The 'largest' policy means that only the largest (by bounding box areas) feature will get a rendered marker (this is how text labeling behaves by default). -* * * - -##### marker-type `keyword` -`arrow``ellipse` - - -Default Value: ellipse -_(The marker shape is an ellipse.)_ - -The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width). -* * * - -##### marker-width `float` - - - -Default Value: 10 -_(The marker width is 10 pixels.)_ - -The width of the marker, if using one of the default types. -* * * - -##### marker-height `float` - - - -Default Value: 10 -_(The marker height is 10 pixels.)_ - -The height of the marker, if using one of the default types. -* * * - -##### marker-fill `color` - - - -Default Value: blue -_(The marker fill color is blue.)_ - -The color of the area of the marker. -* * * - -##### marker-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow markers to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping markers are shown or hidden. -* * * - -##### marker-avoid-edges `boolean` - - - -Default Value: false -_(Markers will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)_ - -Avoid placing markers that intersect with tile boundaries. -* * * - -##### marker-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache.)_ - -Value to control whether the placement of the feature will prevent the placement of other features. -* * * - -##### marker-spacing `float` - - - -Default Value: 100 -_(In the case of marker-placement:line then draw a marker every 100 pixels along a line.)_ - -Space between repeated markers in pixels. If the spacing is less than the marker size or larger than the line segment length then no marker will be placed. Any value less than 1 will be ignored and the default will be used instead. -* * * - -##### marker-max-error `float` - - - -Default Value: 0.2 -_(N/A: not intended to be changed.)_ - -N/A: not intended to be changed. -* * * - -##### marker-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform marker instance with specified function. Ignores map scale factor. -* * * - -##### marker-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### marker-simplify `float` - - - -Default Value: 0 -_(Geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### marker-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### marker-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### marker-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform marker geometry with specified function. -* * * - -##### marker-offset `float` - - - -Default Value: 0 -_(Will not be offset.)_ - -Offsets a marker from a line a number of pixels parallel to its actual path. Positive values move the marker left, negative values move it right (relative to the directionality of the line). -* * * - -##### marker-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### marker-direction `keyword` -`auto``auto-down``left``right``left-only``right-only``up``down` - - -Default Value: right -_(Markers are oriented to the right in the line direction.)_ - -How markers should be placed along lines. With the "auto" setting when marker is upside down the marker is automatically rotated by 180 degrees to keep it upright. The "auto-down" value places marker in the opposite orientation to "auto". The "left" or "right" settings can be used to force marker to always be placed along a line in a given direction and therefore disables rotating if marker appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down markers rather than trying to flip it. The "up" and "down" settings don't adjust marker's orientation to the line direction. -* * * - - -## shield - -##### shield-name `string` - - - -Default Value: -_(No text label will be rendered with the shield.)_ - -Value to use for a shield"s text label. Data columns are specified using brackets like [column_name]. -* * * - -##### shield-file `uri` - - - -Default Value: none - - -Image file to render behind the shield text. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### shield-face-name `string` - - - -Default Value: none - - -Font name and style to use for the shield text. -* * * - -##### shield-unlock-image `boolean` - - - -Default Value: false -_(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)_ - -This parameter should be set to true if you are trying to position text beside rather than on top of the shield image. -* * * - -##### shield-size `float` - - - -Default Value: 10 -_(Font size of 10 will be used to render text.)_ - -The size of the shield text in pixels. -* * * - -##### shield-fill `color` - - - -Default Value: black -_(The shield text will be rendered black.)_ - -The color of the shield text. -* * * - -##### shield-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point -_(One shield will be placed per geometry.)_ - -How this shield should be placed. Point placement places one shield on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. -* * * - -##### shield-avoid-edges `boolean` - - - -Default Value: false -_(Shields will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.)_ - -Avoid placing shields that intersect with tile boundaries. -* * * - -##### shield-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow shields to overlap with other map elements already placed.)_ - -Control whether overlapping shields are shown or hidden. -* * * - -##### shield-margin `float` - - - -Default Value: 0 -_(No extra margin will be used to determine if a shield collides with any other text, shield, or marker.)_ - -Minimum distance that a shield can be placed from any other text, shield, or marker. -* * * - -##### shield-repeat-distance `float` - - - -Default Value: 0 -_(Shields with the same text will be rendered without restriction.)_ - -Minimum distance between repeated shields. If set this will prevent shields being rendered nearby each other that contain the same text. Similiar to shield-min-distance with the difference that it works the same no matter what placement strategy is used. -* * * - -##### shield-min-distance `float` - - - -Default Value: 0 -_(Shields with the same text will be rendered without restriction.)_ - -Minimum distance to the next shield with the same text. Only works for line placement. -* * * - -##### shield-spacing `float` - - - -Default Value: 0 -_(Only one shield per line will attempt to be placed.)_ - -Distance the renderer should use to try to place repeated shields on a line. -* * * - -##### shield-min-padding `float` - - - -Default Value: 0 -_(No margin will be used to detect if a shield is nearby a tile boundary.)_ - -Minimum distance a shield will be placed from the edge of a tile. This option is similiar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. -* * * - -##### shield-label-position-tolerance `float` - - - -Default Value: shield-spacing/2.0 -_(If a shield cannot be placed then the renderer will advance by shield-spacing/2.0 to try placement again.)_ - -Allows the shield to be displaced from its ideal position by a number of pixels (only works with placement:line). -* * * - -##### shield-wrap-width `unsigned` - - - -Default Value: 0 -_(Text will not be wrapped.)_ - -Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. -* * * - -##### shield-wrap-before `boolean` - - - -Default Value: false -_(Wrapped lines will be a bit longer than wrap-width.)_ - -Wrap text before wrap-width is reached. -* * * - -##### shield-wrap-character `string` - - - -Default Value: " " -_(Lines will be wrapped when whitespace is encountered.)_ - -Use this character instead of a space to wrap long names. -* * * - -##### shield-halo-fill `color` - - - -Default Value: white -_(The shield halo text will be rendered white.)_ - -Specifies the color of the halo around the text. -* * * - -##### shield-halo-radius `float` - - - -Default Value: 0 -_(no halo.)_ - -Specify the radius of the halo in pixels. -* * * - -##### shield-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The shield will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### shield-halo-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation.)_ - -Transform shield halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. -* * * - -##### shield-halo-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### shield-halo-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text halo. -* * * - -##### shield-character-spacing `unsigned` - - - -Default Value: 0 -_(The default character spacing of the font will be used.)_ - -Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement. -* * * - -##### shield-line-spacing `unsigned` - - - -Default Value: 0 -_(The default font spacing will be used.)_ - -Vertical spacing between lines of multiline labels (in pixels). -* * * - -##### shield-text-dx `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right. -* * * - -##### shield-text-dy `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down. -* * * - -##### shield-dx `float` - - - -Default Value: 0 -_(Shield will not be displaced.)_ - -Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right. -* * * - -##### shield-dy `float` - - - -Default Value: 0 -_(Shield will not be displaced.)_ - -Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down. -* * * - -##### shield-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the image used for the shield. -* * * - -##### shield-text-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the text placed on top of the shield. -* * * - -##### shield-horizontal-alignment `keyword` -`left``middle``right``auto` - - -Default Value: auto -_(TODO.)_ - -The shield's horizontal alignment from its centerpoint. -* * * - -##### shield-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: middle -_(TODO.)_ - -The shield's vertical alignment from its centerpoint. -* * * - -##### shield-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy -_(Alternative placements will not be enabled.)_ - -Re-position and/or re-size shield to avoid overlaps. "simple" for basic algorithm (using shield-placements string,) "dummy" to turn this feature off. -* * * - -##### shield-placements `string` - - - -Default Value: -_(No alternative placements will be used.)_ - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `shield-placements: "E,NE,SE,W,NW,SW";`. -* * * - -##### shield-text-transform `keyword` -`none``uppercase``lowercase``capitalize``reverse` - - -Default Value: none -_(No text transformation will be applied.)_ - -Transform the case of the characters. -* * * - -##### shield-justify-alignment `keyword` -`left``center``right``auto` - - -Default Value: auto -_(TODO.)_ - -Define how text in a shield's label is justified. -* * * - -##### shield-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform shield instance with specified function. Ignores map scale factor. -* * * - -##### shield-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### shield-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify the geometries used for shield placement by the given tolerance. -* * * - -##### shield-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify the geometries used for shield placement by the given algorithm. -* * * - -##### shield-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out the angles of the geometry used for shield placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### shield-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## line-pattern - -##### line-pattern-file `uri` - - - -Default Value: none - - -An image file to be repeated and warped along a line. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### line-pattern-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### line-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications.)_ - -Apply an opacity level to the image used for the pattern. -* * * - -##### line-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### line-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### line-pattern-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### line-pattern-offset `float` - - - -Default Value: 0 -_(The line will not be offset.)_ - -Offsets a line a number of pixels parallel to its actual path. Positive values move the line left, negative values move it right (relative to the directionality of the line). -* * * - -##### line-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform line geometry with specified function and apply pattern to transformed geometry. -* * * - -##### line-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## polygon-pattern - -##### polygon-pattern-file `uri` - - - -Default Value: none - - -Image to use as a repeated pattern fill within a polygon. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### polygon-pattern-alignment `keyword` -`global``local` - - -Default Value: global -_(Patterns will be aligned to the map (or tile boundaries) when being repeated across polygons. This is ideal for seamless patterns in tiled rendering.)_ - -Specify whether to align pattern fills to the layer's geometry (local) or to the map (global). -* * * - -##### polygon-pattern-gamma `float` - - - -Default Value: 1 -_(Fully antialiased.)_ -Range: 0-1 -Level of antialiasing of polygon pattern edges. -* * * - -##### polygon-pattern-opacity `float` - - - -Default Value: 1 -_(The image is rendered without modifications.)_ - -Apply an opacity level to the image used for the pattern. -* * * - -##### polygon-pattern-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### polygon-pattern-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -geometries are simplified by the given tolerance. -* * * - -##### polygon-pattern-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -geometries are simplified by the given algorithm. -* * * - -##### polygon-pattern-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### polygon-pattern-geometry-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(The geometry will not be transformed.)_ - -Transform polygon geometry with specified function and apply pattern to transformed geometry. -* * * - -##### polygon-pattern-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## raster - -##### raster-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the raster symbolizer on top of other symbolizers. -* * * - -##### raster-filter-factor `float` - - - -Default Value: -1 -_(Allow the datasource to choose appropriate downscaling.)_ - -This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed. -* * * - -##### raster-scaling `keyword` -`near``fast``bilinear``bicubic``spline16``spline36``hanning``hamming``hermite``kaiser``quadric``catrom``gaussian``bessel``mitchell``sinc``lanczos``blackman` - - -Default Value: near -_(Nearest neighboor resampling will be used to scale the image to the target size of the map.)_ - -The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality. -* * * - -##### raster-mesh-size `unsigned` - - - -Default Value: 16 -_(Reprojection mesh will be 1/16 of the resolution of the source image.)_ - -A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion. -* * * - -##### raster-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### raster-colorizer-default-mode `keyword` -`discrete``linear``exact` - - -Default Value: linear -_(A linear interpolation is used to generate colors between the two nearest stops.)_ - -This can be either `discrete`, `linear` or `exact`. If it is not specified then the default is `linear`. -* * * - -##### raster-colorizer-default-color `color` - - - -Default Value: transparent -_(Pixels that are not colored by the colorizer stops will be transparent.)_ - -This can be any color. Sets the color that is applied to all values outside of the range of the colorizer-stops. If not supplied pixels will be fully transparent. -* * * - -##### raster-colorizer-epsilon `float` - - - -Default Value: 1.1920928955078125e-07 -_(Pixels must very closely match the stop filter otherwise they will not be colored.)_ - -This can be any positive floating point value and will be used as a tolerance in floating point comparisions. The higher the value the more likely a stop will match and color data. -* * * - -##### raster-colorizer-stops `tags` - - - -Default Value: -_(No colorization will happen without supplying stops.)_ - -Assigns raster data values to colors. Stops must be listed in ascending order, and contain at a minimum the value and the associated color. You can also include the color-mode as a third argument, like `stop(100,#fff,exact)`. -* * * - - -## point - -##### point-file `uri` - - - -Default Value: none -_(A 4x4 black square will be rendered.)_ - -Image file to represent a point. Accepted formats: svg, jpg, png, tiff, and webp. -* * * - -##### point-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow points to overlap with each other - overlapping markers will not be shown.)_ - -Control whether overlapping points are shown or hidden. -* * * - -##### point-ignore-placement `boolean` - - - -Default Value: false -_(do not store the bbox of this geometry in the collision detector cache.)_ - -Control whether the placement of the feature will prevent the placement of other features. -* * * - -##### point-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A value from 0 to 1 to control the opacity of the point. -* * * - -##### point-placement `keyword` -`centroid``interior` - - -Default Value: centroid -_(The centroid of the geometry will be used to place the point.)_ - -Control how this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon. -* * * - -##### point-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: none -_(No transformation.)_ - -Transform point instance with specified function. Ignores map scale factor. -* * * - -##### point-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - - -## text - -##### text-name `string` - - - -Default Value: none - - -Value to use for a text label. Data columns are specified using brackets like [column_name]. -* * * - -##### text-face-name `string` - - - -Default Value: none - - -Font name and style to render a label in. -* * * - -##### text-size `float` - - - -Default Value: 10 -_(Font size of 10 will be used to render text.)_ - -Text size in pixels. -* * * - -##### text-ratio `unsigned` - - - -Default Value: 0 -_(TODO.)_ - -Define the amount of text (of the total) present on successive lines when wrapping occurs. -* * * - -##### text-wrap-width `unsigned` - - - -Default Value: 0 -_(Text will not be wrapped.)_ - -Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap. -* * * - -##### text-wrap-before `boolean` - - - -Default Value: false -_(Wrapped lines will be a bit longer than wrap-width.)_ - -Wrap text before wrap-width is reached. -* * * - -##### text-wrap-character `string` - - - -Default Value: " " -_(Lines will be wrapped when whitespace is encountered.)_ - -Use this character instead of a space to wrap long text. -* * * - -##### text-repeat-wrap-character `boolean` - - - -Default Value: false -_(Character will be removed when used to wrap a line.)_ - -Keep the character used to wrap a line instead of removing it, and repeat it on the new line. -* * * - -##### text-spacing `unsigned` - - - -Default Value: 0 -_(Only one label per line will attempt to be placed.)_ - -Distance the renderer should use to try to place repeated text labels on a line. -* * * - -##### text-character-spacing `float` - - - -Default Value: 0 -_(The default character spacing of the font will be used.)_ - -Horizontal spacing adjustment between characters in pixels. This value is ignored when `horizontal-alignment` is set to `adjust`. Typographic ligatures are turned off when this value is greater than zero. -* * * - -##### text-line-spacing `unsigned` - - - -Default Value: 0 -_(The default font spacing will be used.)_ - -Vertical spacing adjustment between lines in pixels. -* * * - -##### text-label-position-tolerance `float` - - - -Default Value: text-spacing/2.0 -_(If a shield cannot be placed then the renderer will advance by text-spacing/2.0 to try placement again.)_ - -Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line). -* * * - -##### text-max-char-angle-delta `float` - - - -Default Value: 22.5 -_(The label will not be placed if a character falls on a line with an angle sharper than 22.5 degrees.)_ - -The maximum angle change, in degrees, allowed between adjacent characters in a label. This value internally is converted to radians to the default is 22.5*math.pi/180.0. The higher the value the fewer labels will be placed around around sharp corners. -* * * - -##### text-fill `color` - - - -Default Value: black -_(The text will be rendered black.)_ - -Specifies the color for the text. -* * * - -##### text-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text. -* * * - -##### text-halo-opacity `float` - - - -Default Value: 1 -_(Fully opaque.)_ - -A number from 0 to 1 specifying the opacity for the text halo. -* * * - -##### text-halo-fill `color` - - - -Default Value: white -_(The halo will be rendered white.)_ - -Specifies the color of the halo around the text. -* * * - -##### text-halo-radius `float` - - - -Default Value: 0 -_(no halo.)_ - -Specify the radius of the halo in pixels. -* * * - -##### text-halo-rasterizer `keyword` -`full``fast` - - -Default Value: full -_(The text will be rendered using the highest quality method rather than the fastest.)_ - -Exposes an alternate text halo rendering method that sacrifices quality for speed. -* * * - -##### text-halo-transform `functions` - -`matrix``translate``scale``rotate``skewX``skewY` - -Default Value: -_(No transformation.)_ - -Transform text halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor. -* * * - -##### text-dx `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text by fixed amount, in pixels, +/- along the X axis. With "dummy" placement-type, a positive value displaces to the right. With "simple" placement-type, it is either left, right or unchanged, depending on the placement selected. Any non-zero value implies "horizontal-alignment" changes to "left" by default. Has no effect with 'line' text-placement-type. -* * * - -##### text-dy `float` - - - -Default Value: 0 -_(Text will not be displaced.)_ - -Displace text by fixed amount, in pixels, +/- along the Y axis. With "dummy" placement-type, a positive value displaces downwards. With "simple" placement-type, it is either up, down or unchanged, depending on the placement selected. With "line" placement-type, a positive value displaces above the path. -* * * - -##### text-vertical-alignment `keyword` -`top``middle``bottom``auto` - - -Default Value: auto -_(Default affected by value of dy; "top" for dy>0, "bottom" for dy<0.)_ - -Position of label relative to point position. -* * * - -##### text-avoid-edges `boolean` - - - -Default Value: false -_(Text will be potentially placed near tile edges and therefore may look cut off unless the same text label is rendered on each adjacent tile.)_ - -Avoid placing labels that intersect with tile boundaries. -* * * - -##### text-margin `float` - - - -Default Value: 0 -_(No extra margin will be used to determine if a label collides with any other text, shield, or marker.)_ - -Minimum distance that a label can be placed from any other text, shield, or marker. -* * * - -##### text-repeat-distance `float` - - - -Default Value: 0 -_(Labels with the same text will be rendered without restriction.)_ - -Minimum distance between repeated text. If set this will prevent text labels being rendered nearby each other that contain the same text. Similiar to text-min-distance with the difference that it works the same no matter what placement strategy is used. -* * * - -##### text-min-distance `float` - - - -Default Value: 0 -_(Labels with the same text will be rendered without restriction.)_ - -Minimum distance to the next label with the same text. Only works for line placement. Deprecated: replaced by `text-repeat-distance` and `text-margin` -* * * - -##### text-min-padding `float` - - - -Default Value: 0 -_(No margin will be used to detect if a text label is nearby a tile boundary.)_ - -Minimum distance a text label will be placed from the edge of a tile. This option is similiar to shield-avoid-edges:true except that the extra margin is used to discard cases where the shield+margin are not fully inside the tile. -* * * - -##### text-min-path-length `float` - - - -Default Value: 0 -_(place labels on all geometries no matter how small they are.)_ - -Place labels only on polygons and lines with a bounding width longer than this value (in pixels). -* * * - -##### text-allow-overlap `boolean` - - - -Default Value: false -_(Do not allow text to overlap with other text - overlapping markers will not be shown.)_ - -Control whether overlapping text is shown or hidden. -* * * - -##### text-orientation `float` - - - -Default Value: 0 -_(Text is not rotated and is displayed upright.)_ - -Rotate the text. (only works with text-placement:point). -* * * - -##### text-rotate-displacement `boolean` - - - -Default Value: false -_(Label center is used for rotation.)_ - -Rotates the displacement around the placement origin by the angle given by "orientation". -* * * - -##### text-upright `keyword` -`auto``auto-down``left``right``left-only``right-only` - - -Default Value: auto -_(Text will be positioned upright automatically.)_ - -How this label should be placed along lines. By default when more than half of a label's characters are upside down the label is automatically flipped to keep it upright. By changing this parameter you can prevent this "auto-upright" behavior. The "auto-down" value places text in the opposite orientation to "auto". The "left" or "right" settings can be used to force text to always be placed along a line in a given direction and therefore disables flipping if text appears upside down. The "left-only" or "right-only" properties also force a given direction but will discard upside down text rather than trying to flip it. -* * * - -##### text-placement `keyword` -`point``line``vertex``interior` - - -Default Value: point -_(One shield will be placed per geometry.)_ - -How this label should be placed. Point placement places one label on top of a point geometry and at the centroid of a polygon or the middle point of a line, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of a polygon. -* * * - -##### text-placement-type `keyword` -`dummy``simple``list` - - -Default Value: dummy -_(Alternative placements will not be enabled.)_ - -Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off. -* * * - -##### text-placements `string` - - - -Default Value: -_(No alternative placements will be used.)_ - -If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. An example is `text-placements: "E,NE,SE,W,NW,SW";`. -* * * - -##### text-transform `keyword` -`none``uppercase``lowercase``capitalize``reverse` - - -Default Value: none -_(Transform text instance with specified function. Ignores map scale factor.)_ - -Transform the case of the characters. -* * * - -##### text-horizontal-alignment `keyword` -`left``middle``right``auto``adjust` - - -Default Value: auto -_(TODO.)_ - -The text's horizontal alignment from it's centerpoint. If `placement` is set to `line`, then `adjust` can be set to auto-fit the text to the length of the path by dynamically calculating `character-spacing`. -* * * - -##### text-align `keyword` -`left``right``center``auto` - - -Default Value: auto -_(Auto alignment means that text will be centered by default except when using the `placement-type` parameter - in that case either right or left justification will be used automatically depending on where the text could be fit given the `text-placements` directives.)_ - -Define how text is justified. -* * * - -##### text-clip `boolean` - - - -Default Value: false -_(The geometry will not be clipped to map bounds before rendering.)_ - -Turning on clipping can help performance in the case that the boundaries of the geometry extent outside of tile extents. But clipping can result in undesirable rendering artifacts in rare cases. -* * * - -##### text-simplify `float` - - - -Default Value: 0 -_(geometry will not be simplified.)_ - -Simplify the geometries used for text placement by the given tolerance. -* * * - -##### text-simplify-algorithm `keyword` -`radial-distance``zhao-saalfeld``visvalingam-whyatt` - - -Default Value: radial-distance -_(The geometry will be simplified using the radial distance algorithm.)_ - -Simplify the geometries used for text placement by the given algorithm. -* * * - -##### text-smooth `float` - - - -Default Value: 0 -_(No smoothing.)_ -Range: 0-1 -Smooths out the angles of the geometry used for text placement. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries. -* * * - -##### text-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### text-halo-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``screen``overlay``darken``lighten``color-dodge``color-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current symbolizer on top of other symbolizer.)_ - -Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it. -* * * - -##### text-font-feature-settings `string` - - - -Default Value: -_(Default set of typographic features recommended by OpenType specification. Ligatures are turned off by default when `character-spacing` is greater than zero.)_ - -Comma separated list of OpenType typographic features. The syntax and semantics conforms to `font-feature-settings` from W3C CSS. -* * * - -##### text-largest-bbox-only `boolean` - - - -Default Value: true -_(For multipolygons only polygon with largest bbox area is labeled (does not apply to other geometries).)_ - -Controls default labeling behavior on multipolygons. The default is true and means that only the polygon with largest bbox is labeled. -* * * - - -## building - -##### building-fill `color` - - - -Default Value: The color gray will be used for fill. -_(Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).)_ - -The color of the buildings fill. Note: 0.8 will be used to multiply each color component to auto-generate a darkened wall color. -* * * - -##### building-fill-opacity `float` - - - -Default Value: 1 -_(Color is fully opaque.)_ - -The opacity of the building as a whole, including all walls. -* * * - -##### building-height `float` - - - -Default Value: 0 -_(Buildings will not have a visual height and will instead look like flat polygons.)_ - -The height of the building in pixels. -* * * - - -## debug - -##### debug-mode `string` - - - -Default Value: collision -_(The otherwise invisible collision boxes will be rendered as squares on the map.)_ - -The mode for debug rendering. -* * * - - -## dot - -##### dot-fill `color` - - - -Default Value: gray -_(The dot fill color is gray.)_ - -The color of the area of the dot. -* * * - -##### dot-opacity `float` - - - -Default Value: 1 -_(The opacity of the dot.)_ - -The overall opacity of the dot. -* * * - -##### dot-width `float` - - - -Default Value: 1 -_(The marker width is 1 pixel.)_ - -The width of the dot in pixels. -* * * - -##### dot-height `float` - - - -Default Value: 1 -_(The marker height is 1 pixels.)_ - -The height of the dot in pixels. -* * * - -##### dot-comp-op `keyword` -`clear``src``dst``src-over``dst-over``src-in``dst-in``src-out``dst-out``src-atop``dst-atop``xor``plus``minus``multiply``divide``screen``overlay``darken``lighten``color-dodge``color-burn``linear-dodge``linear-burn``hard-light``soft-light``difference``exclusion``contrast``invert``invert-rgb``grain-merge``grain-extract``hue``saturation``color``value` - - -Default Value: src-over -_(Add the current layer on top of other layers.)_ - -Composite operation. This defines how this layer should behave relative to layers atop or below it. -* * * - - - - -### Values - -Below is a list of values and an explanation of any expression that can be applied to properties in CartCSS. - -### Color - -CartoCSS accepts a variety of syntaxes for colors - HTML-style hex values, rgb, rgba, hsl, hsla, husl, and husla. It also supports the predefined HTML colors names, like `yellow` and `blue`. - -``` css -#line { -line-color: #ff0; -line-color: #ffff00; -line-color: rgb(255, 255, 0); -line-color: rgba(255, 255, 0, 1); -line-color: hsl(100, 50%, 50%); -line-color: hsla(100, 50%, 50%, 1); -line-color: husl(100, 50%, 50%); // same values yield different color than HSL -line-color: husla(100, 50%, 50%, 1); -line-color: yellow; -} -``` - -Especially of note is the support for hsl and husl, which can be [easier to reason about than rgb()](http://mothereffinghsl.com/). Carto also includes several color operation functions [borrowed from less](http://lesscss.org/functions/#color-operations): - -``` css -// lighten and darken colors -lighten(#ace, 10%); -darken(#ace, 10%); - -// saturate and desaturate -saturate(#550000, 10%); -desaturate(#00ff00, 10%); - -// increase or decrease the opacity of a color -fadein(#fafafa, 10%); -fadeout(#fefefe, 14%); - -// spin rotates a color around the color wheel by degrees -spin(#ff00ff, 10); - -// mix generates a color in between two other colors. -mix(#fff, #000, 50%); - -// get color components -hue(#ff00ff); -saturation(#ff00ff); -lightness(#ff00ff); -alpha(hsla(100, 50%, 50%, 0.5)); -``` - -These functions all take arguments which can be color variables, literal colors, or the results of other functions operating on colors. All the above mentioned functions also come in -a `functionp`-variant (e.g. `lightenp`), which force a given color into perceptual color space. - -### Float - -Float is a fancy way of saying 'number'. In CartoCSS, you specify _just a number_ - unlike CSS, there are no units, but everything is specified in pixels. - -``` css -#line { -line-width: 2; -} -``` - -It's also possible to do simple math with number values: - -``` css -#line { -line-width: 4 / 2; // division -line-width: 4 + 2; // addition -line-width: 4 - 2; // subtraction -line-width: 4 * 2; // multiplication -line-width: 4 % 2; // modulus -} -``` - -### URI - -URI is a fancy way of saying URL. When an argument is a URI, you use the same kind of `url('place.png')` notation that you would with HTML. Quotes around the URL aren't required, but are highly recommended. URIs can be paths to places on your computer, or on the internet. - -```css -#markers { -marker-file: url('marker.png'); -} -``` - -### String - -A string is basically just text. In the case of CartoCSS, you're going to put it in quotes. Strings can be anything, though pay attention to the cases of `text-name` and `shield-name` - they actually will refer to features, which you refer to by putting them in brackets, as seen in the example below. - -```css -#labels { -text-name: "[MY_FIELD]"; -} -``` - -### Boolean - -Boolean means yes or no, so it accepts the values `true` or `false`. - -```css -#markers { -marker-allow-overlap:true; -} -``` - -### Expressions - -Expressions are statements that can include fields, numbers, and other types in a really flexible way. You have run into expressions before, in the realm of 'fields', where you'd specify `"[FIELD]"`, but expressions allow you to drop the quotes and also do quick addition, division, multiplication, and concatenation from within Carto syntax. - -```css -#buildings { -building-height: [HEIGHT_FIELD] * 10; -} -``` - -### Numbers -Numbers are comma-separated lists of one or more number in a specific order. They're used in line dash arrays, in which the numbers specify intervals of line, break, and line again. - -```css -#disputedboundary { -line-dasharray: 1, 4, 2; -} -``` - -### Percentages -In Carto, the percentage symbol, `%` universally means `value/100`. It's meant to be used with ratio-related properties, like opacity rules. - -_You should not use percentages as widths, heights, or other properties - unlike CSS, percentages are not relative to cascaded classes or page size, they're, as stated, simply the value divided by one hundred._ - -```css -#world { -// this syntax -polygon-opacity: 50%; - -// is equivalent to -polygon-opacity: 0.5; -} -``` - -### Functions - -Functions are comma-separated lists of one or more functions. For instance, transforms use the `functions` type to allow for transforms within Carto, which are optionally chainable. - -```css -#point { -point-transform: scale(2, 2); -} -``` diff --git a/docs/mapnik_api._ b/docs/mapnik_api._ new file mode 100644 index 0000000..17d1345 --- /dev/null +++ b/docs/mapnik_api._ @@ -0,0 +1,10 @@ +************************ +Mapnik API documentation +************************ + +The following is a list of properties provided in CartoCSS that you can apply to map elements +when using the Mapnik renderer. Each API version of Mapnik has its own subsection. Pick the one that +applies to the version you are running. If there is no subsection for your specific version the +next older listed version applies to this version. + +<%= versions %> diff --git a/docs/mapnik_api.rst b/docs/mapnik_api.rst new file mode 100644 index 0000000..88d4468 --- /dev/null +++ b/docs/mapnik_api.rst @@ -0,0 +1,20 @@ +************************ +Mapnik API documentation +************************ + +The following is a list of properties provided in CartoCSS that you can apply to map elements +when using the Mapnik renderer. Each API version of Mapnik has its own subsection. Pick the one that +applies to the version you are running. If there is no subsection for your specific version the +next older listed version applies to this version. + +.. include:: api/mapnik/3.0.20.rst +.. include:: api/mapnik/3.0.6.rst +.. include:: api/mapnik/3.0.3.rst +.. include:: api/mapnik/3.0.0.rst +.. include:: api/mapnik/2.3.0.rst +.. include:: api/mapnik/2.2.0.rst +.. include:: api/mapnik/2.1.1.rst +.. include:: api/mapnik/2.1.0.rst +.. include:: api/mapnik/2.0.2.rst +.. include:: api/mapnik/2.0.1.rst +.. include:: api/mapnik/2.0.0.rst diff --git a/docs/mml.rst b/docs/mml.rst new file mode 100644 index 0000000..2a606dd --- /dev/null +++ b/docs/mml.rst @@ -0,0 +1,470 @@ +.. _mml-file-structure: + +MML File Structure +================== + +The MML file (here: Map Markup Language file) is a +`YAML <https://en.wikipedia.org/wiki/YAML>`_ or `JSON <https://en.wikipedia.org/wiki/JSON>`_ +file containing layer definitions and stylesheet references. It is the central +part of a CartoCSS stylesheet. If you generate Mapnik XML from a stylesheet this is +the file you feed to carto and from which and its references the XML is produced. + +You may wonder whether you should use YAML or JSON. Internally, +JSON is used because it is a language that is easy to understand for machines. +YAML is a superset of JSON and is easier to read and write for humans and is also +less verbose. If you edit a stylesheet collaboratively and use version control +YAML might make it easier to resolve version conflicts. Carto fully understands both +forms. + +.. note:: YAML makes it less tedious to specify repeating properties like database + information for PostGIS datasources or extents by using a language feature called + `anchors or aliases <http://www.yaml.org/spec/1.2/spec.html#id2785586>`_. + +Properties Overview +------------------- + +What follows is an overview over properties a MML file can have. This list is not +complete. There may be other (also undocumented) options that Mapnik understands. +Simple properties are described here in alphabetical order while more complex +ones get their own section. + +center +^^^^^^ +Type: ``Array`` + +Specifies the initial center coordinates and zoom level of the map. Longitude, latitude and +zoom level in that order. Example (WGS84): ``[-1.28398, 47.08997, 17]`` + +bounds +^^^^^^ +Type: ``Array`` + +Defines a bounding box of the map extent. Lower left coordinates (longitude, latitude) +and upper right coordinates (longitude, latitude) in that order. +Example (WGS84): ``[-179, -80, 179, 80]`` + +description +^^^^^^^^^^^ +Type: ``String`` + +A description for the stylesheet (usually a bit longer than the name) + +format +^^^^^^ +Type: ``Keyword`` + +Possible values: ``png, jpeg, tiff, webp`` + +Specifies the output format Mapnik should use. For more details see the `Mapnik wiki +page on Image IO <https://github.com/mapnik/mapnik/wiki/Image-IO>`_. + +Layer +^^^^^ +Lists all layers used in the project (see :ref:`layer-reference`) + +maxzoom +^^^^^^^ +Type: ``Integer`` + +Specifies the maximum zoom level of the map + +metatile +^^^^^^^^ +Type: ``Integer`` + +Specifies the number of tiles that make up one side of a metatile. For example, +if the number is 2 then the metatile is 2 tiles wide and tall and consists of +4 individual tiles. For efficiency reasons Mapnik generates metatiles before +splitting them into individual tiles. + +minzoom +^^^^^^^ +Type: ``Integer`` + +Specifies the minimum zoom level of the map + +name +^^^^ +Type: ``String`` + +A name for the stylesheet + +_properties +^^^^^^^^^^^ +Type: ``Object`` + +This is the same as the ``properties`` property for layers, but on a global level with +a bit different structure. It is used when you do not specify the layers in the MML +itself but only reference them. This is used in vector tile styles where the style +and the data are separate. + +First specifiy the layer name and then below it specify its properties as you would +do in the ``properties`` property of the specific layer. + +scale +^^^^^ +Type: ``Integer`` + +Specifies pixel scaling for the output. For example, a scale of 2 means that there +are two pixels for each map pixel in the output. + +srs +^^^ +Type: ``String`` + +Specifies the projection used by Mapnik using the `PROJ.4 <http://proj4.org/>`_ +format (SRS means `Spatial reference system <https://en.wikipedia.org/wiki/Spatial_reference_system>`_). +The format can be determined by e.g. using `spatialreference.org <http://spatialreference.org/>`_. + +Stylesheet +^^^^^^^^^^ +Lists all styles or style files in the project (see :ref:`stylesheet-reference`) + +.. _layer-reference: + +Layer property +--------------- +Type: ``Array`` + +Beneath this property layer objects are referenced that are the building blocks +of the map style. The order of specification is important as it constitutes +the drawing order of layers used by Mapnik. Layers specified first are drawn first +and those specified later are drawn afterwards. + +Layers have different properties and their data can come from different data sources +such as shape files or relational databases like PostgreSQL/PostGIS. + +A layer object can have the following properties (there may be more that Mapnik +understands, also undocumented ones). + +class +^^^^^ +Type: ``String`` + +One or more classes associated with this layer separated by blanks. In style selectors +a class can be referenced by ``.classname`` if class contains ``classname`` similar to CSS. + +Datasource +^^^^^^^^^^ +Mapnik supports different datasources. Beneath this property you specify the type +of the datasource and additional properties depending on the type. + +Not all possible configuration options for each datasource are listed here. For +further information see the page for the datasource type on the Mapnik Wiki: +e.g. `PostGIS <https://github.com/mapnik/mapnik/wiki/PostGIS>`_, +`PgRaster <https://github.com/mapnik/mapnik/wiki/PgRaster>`_, +`ShapeFile <https://github.com/mapnik/mapnik/wiki/ShapeFile>`_, +`GDAL <https://github.com/mapnik/mapnik/wiki/GDAL>`_, +`OGR <https://github.com/mapnik/mapnik/wiki/OGR>`_, +`OsmPlugin <https://github.com/mapnik/mapnik/wiki/OsmPlugin>`_. + +type +"""" +Type: ``Keyword`` + +Possible values: ``shape, postgis, pgraster, raster, (gdal), (ogr), (osm)`` + +Specifies the format of the data source. Types in parenthesis are *not build +by default* according to the `Mapnik Wiki <https://github.com/mapnik/mapnik/wiki/XMLConfigReference#datasource>`_. + +band (gdal, pgraster) +""""""""""""""""""""" +Type: ``Integer`` + +With this property you can request a specific raster band index (1-based). By +specifying `-1` (gdal) / `0` (pgraster) you request to read all bands. + +dbname (postgis, pgraster) +"""""""""""""""""""""""""" +Type: ``String`` + +Specifies the database name of the PostgreSQL database. + +encoding (ogr, postgis, shape) +"""""""""""""""""""""""""""""" +Type: ``String`` + +Specifies the encoding of the database or shapefile e.g. `utf-8` or `latin1`. + +extent (ogr, postgis, pgraster) +""""""""""""""""""""""""""""""" +Type: ``String`` + +Specifies the maximum extent of the geometries or raster data. +Lower left coordinates (longitude, latitude) and upper right coordinates +(longitude, latitude) in that order. By default this is deduced from the +metadata of the table. + +file (gdal, ogr, osm, raster, shape) +"""""""""""""""""""""""""""""""""""" +Type: ``String`` + +Path and file name. + +geometry_field (postgis) +"""""""""""""""""""""""" +Type: ``String`` + +Specifies the name of the column that contains the geometry. Normally this will +be deduced from the query but sometimes it can be necessary to specify it manually +e.g. when there is more than one column with geometry. + +host (postgis, pgraster) +"""""""""""""""""""""""" +Type: ``String`` + +Specifies the hostname of the PostgreSQL database. + +layer (ogr) +""""""""""" +Type: ``String`` + +The name of the layer to display. + +layer_by_index (ogr) +"""""""""""""""""""" +Type: ``Integer`` + +The index of the layer to display (mandatory if no layer name specified). + +layer_by_sql (ogr) +"""""""""""""""""" +Type: ``String`` + +SQL-Statement to execute against the OGR datasource. + +password (postgis, pgraster) +"""""""""""""""""""""""""""" +Type: ``String`` + +Specifies the password for connecting to the PostgreSQL database. + +port (postgis, pgraster) +"""""""""""""""""""""""" +Type: ``String`` + +Specifies the port of the PostgreSQL database. + +raster_field (pgraster) +""""""""""""""""""""""" +Type: ``String`` + +Specifies the name of the column that contains the raster data. Normally this will +be deduced from the query but sometimes it can be necessary to specify it manually +e.g. when there is more than one column with raster data. + +simplify_geometries (postgis) +""""""""""""""""""""""""""""" +Type: ``Boolean`` + +Specify if input vertices should be automatically reduced or not. + +table (postgis, pgraster) +""""""""""""""""""""""""" +Type: ``String`` + +Either the name of the table to fetch or a sub query `(...) AS queryname`. + +user (postgis, pgraster) +"""""""""""""""""""""""" +Type: ``String`` + +Specifies the username for connecting to the PostgreSQL database. + +extent +^^^^^^ +Type: ``Array`` + +Defines a bounding box of the layer extent. Lower left coordinates (longitude, latitude) +and upper right coordinates (longitude, latitude) in that order. +Example (WGS84): ``[-179, -80, 179, 80]`` + +geometry +^^^^^^^^ +Type: ``Keyword`` + +Possible values: ``linestring, point, polygon, raster`` + +Specifies the geometry type for (the datasource of) this layer. + +id +^^ +Type: ``String`` + +A unique identifier for this layer. In style selectors it can be referenced with +``#layerid`` if the id is ``layerid`` similar to CSS. + +properties +^^^^^^^^^^ +Type: ``Object`` + +This property basically adds any sub-property as attribute to the Mapnik layer. So +available values depend greatly on what Mapnik allows. Here is an (incomplete) list: + +abstract +"""""""" +Type: ``String`` + +A short description of this layer (typically longer than the title). + +group-by +"""""""" +Type: ``String`` + +Enables `grouped rendering <https://github.com/mapnik/mapnik/wiki/Grouped-rendering>`_ +for Mapnik by specifying the field of the datasource that should be used for grouping. +Mapnik then renders all styles of the layer for those features that have the same +value for that field before moving on to other features that have different value. + +maxzoom +""""""" +Type: ``Integer`` + +Specifies the zoom level until which the layer is visible. + +minzoom +""""""" +Type: ``Integer`` + +Specifies the zoom level from which the layer is visible. + +status +"""""" +Type: ``Integer`` + +Specifies if the layer is active or not. 0 means inactive or off, 1 means +active or on. + +title +""""" +Type: ``String`` + +The title of this layer. Probably more verbose than the ID. + +srs +^^^ +Type: ``String`` + +Specifies the projection for this layer using the `PROJ.4 <http://proj4.org/>`_ +format (SRS means `Spatial reference system <https://en.wikipedia.org/wiki/Spatial_reference_system>`_). +The format can be determined by e.g. using `spatialreference.org <http://spatialreference.org/>`_. + +srs-name +^^^^^^^^ +Type: ``String`` + +The name of this SRS. + +.. _stylesheet-reference: + +Stylesheet property +-------------------- + +Type: ``Array`` + +You have two options to specify the styles. Either you reference MSS files +(here: Map Stylesheet files) or you specify style objects directly. + +Referencing style files +^^^^^^^^^^^^^^^^^^^^^^^ +Here you reference the style files used in an array of paths/file names. Carto +understands relative as well as absolute paths. The order of style references is +normally not important, but re-definition of variables can be affected by the order +of the style files referenced. + +Specifying style objects +^^^^^^^^^^^^^^^^^^^^^^^^ +Internally style file references are transformed into style objects anyway, so you +can also specify them directly. This only makes sense if you generate them +programmatically otherwise the notation could become a bit tedious. You specify +an array of style objects. The order of the objects is normally not important, +but re-definition of variables can be affected by the order of the style objects. + +A style object consists of the following properties. + +id +""" +This is the identifier of the style object. When styles are being read from a +style file this is usually the file name. The property is used when generating +errors or warnings so it is advisable to set something recognizable here. + +data +"""" +This contains the actual style in the form of a string. + +Example +------- +Here is a simple MML file example with two layers (one shapefile and one PostGIS +layer) referencing one style file in YAML format. It has been modified from the +MML file of `openstreetmap-carto <https://github.com/gravitystorm/openstreetmap-carto>`_. :: + + scale: 1 + metatile: 2 + name: Example MML file + description: A example MML file to illustrate its options + bounds: &world + - -180 + - -85.05112877980659 + - 180 + - 85.05112877980659 + center: + - 0 + - 0 + - 4 + format: png + minzoom: 0 + maxzoom: 19 + srs: "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over" + + # Various parts to be included later on + _parts: + extents: &extents + extent: *world + srs-name: "900913" + srs: "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over" + osm2pgsql: &osm2pgsql + type: "postgis" + dbname: "gis" + key_field: "" + geometry_field: "way" + extent: "-20037508,-20037508,20037508,20037508" + + Stylesheet: + - style_file.mss + Layer: + - id: world + name: world + geometry: polygon + <<: *extents + Datasource: + file: data/simplified-land-polygons-complete-3857/simplified_land_polygons.shp + type: shape + properties: + maxzoom: 9 + - id: landcover-low-zoom + name: landcover-low-zoom + geometry: polygon + <<: *extents + Datasource: + <<: *osm2pgsql + table: |- + (SELECT + way, name, way_pixels, + COALESCE(wetland, landuse, "natural") AS feature + FROM (SELECT + way, COALESCE(name, '') AS name, + ('landuse_' || (CASE WHEN landuse IN ('forest', 'military') THEN landuse ELSE NULL END)) AS landuse, + ('natural_' || (CASE WHEN "natural" IN ('wood', 'sand', 'scree', 'shingle', 'bare_rock') THEN "natural" ELSE NULL END)) AS "natural", + ('wetland_' || (CASE WHEN "natural" IN ('wetland', 'mud') THEN (CASE WHEN "natural" IN ('mud') THEN "natural" ELSE tags->'wetland' END) ELSE NULL END)) AS wetland, + way_area/NULLIF(!pixel_width!::real*!pixel_height!::real,0) AS way_pixels + FROM planet_osm_polygon + WHERE (landuse IN ('forest', 'military') + OR "natural" IN ('wood', 'wetland', 'mud', 'sand', 'scree', 'shingle', 'bare_rock')) + AND way_area > 0.01*!pixel_width!::real*!pixel_height!::real + AND building IS NULL + ORDER BY COALESCE(layer,0), way_area DESC + ) AS features + ) AS landcover_low_zoom + properties: + minzoom: 7 + maxzoom: 9 diff --git a/docs/styling_concepts.rst b/docs/styling_concepts.rst new file mode 100644 index 0000000..1184665 --- /dev/null +++ b/docs/styling_concepts.rst @@ -0,0 +1,141 @@ +Styling Concepts +================ + +Attachments and Instances +------------------------- + +In CSS, a certain object can only have one instance of a property. A ``<div>`` has a specific border width and color, +rules that match better than others (#id instead of .class) override previous definitions. +CartoCSS acts the same way normally for the sake of familiarity and organization, but Mapnik itself is more powerful. + +Layers in Mapnik can have multiple `borders <https://github.com/mapnik/mapnik/wiki/LineSymbolizer>`_ and multiple copies +of other attributes. This ability is useful in drawing line outlines, like in the case of road borders or 'glow' effects around coasts. +CartoCSS makes this accessible by allowing attachments to styles:: + + #world { + line-color: #fff; + line-width: 3; + } + + #world::outline { + line-color: #000; + line-width: 6; + } + +Attachments are optional. + +While attachments allow creating implicit "layers" with the same data, using **instances** +allows you to create multiple symbolizers in the same style/layer:: + + #roads { + casing/line-width: 6; + casing/line-color: #333; + line-width: 4; + line-color: #666; + } + +This makes Mapnik first draw the line of color #333 with a width of 6, and then immediately afterwards, +it draws the same line again with width 4 and color #666. Contrast that to attachments: +Mapnik would first draw all casings before proceeding to the actual lines. + +Variables & Expressions +----------------------- + +CartoCSS inherits from its basis in `LessCSS <http://lesscss.org/>`_ some new features in CSS. +One can define variables in stylesheets, and use expressions to modify them. :: + + @mybackground: #2B4D2D; + + Map { + background-color: @mybackground + } + + #world { + polygon-fill: @mybackground + #222; + line-color: darken(@mybackground, 10%); + } + +Nested Styles +------------- + +CartoCSS also inherits nesting of rules from LessCSS. :: + + /* Applies to all layers with .land class */ + .land { + line-color: #ccc; + line-width: 0.5; + polygon-fill: #eee; + /* Applies to #lakes.land */ + #lakes { + polygon-fill: #000; + } + } + +This can be a convenient way to group style changes by zoom level:: + + [zoom > 1] { + /* Applies to all layers at zoom > 1 */ + polygon-gamma: 0.3; + #world { + polygon-fill: #323; + } + #lakes { + polygon-fill: #144; + } + } + +FontSets +-------- + +By defining multiple fonts in a ``text-face-name`` definition, you create `FontSets <https://github.com/mapnik/mapnik/wiki/FontSet>`_ +in CartoCSS. These are useful for supporting multiple character sets and fallback fonts for distributed styles. + +This CartoCSS code :: + + #world { + text-name: "[NAME]"; + text-size: 11; + text-face-name: "Georgia Regular", "Arial Italic"; + } + +becomes this XML code :: + + <FontSet name="fontset-0"> + <Font face-name="Georgia Regular"> + <Font face-name="Arial Italic"> + </FontSet> + <Style name="world-text"> + <Rule> + <TextSymbolizer fontset-name="fontset-0" + size="11" + name="[NAME]"> + </Rule> + </Style> + +Filters +------- + +CartoCSS supports a variety of filter styles: + +Numeric comparisons:: + + #world[population > 100] + #world[population < 100] + #world[population >= 100] + #world[population <= 100] + +General comparisons:: + + #world[population = 100] + #world[population != 100] + + +String comparisons:: + + /* a regular expression over name */ + #world[name =~ "A.*"] + +More complex expressions:: + + #world[[population] % 50 = 0] + #world[[population] * 2 < 1000] diff --git a/docs/symbolizers._ b/docs/symbolizers._ new file mode 100644 index 0000000..a9ddede --- /dev/null +++ b/docs/symbolizers._ @@ -0,0 +1,52 @@ +Style +----- + +<% _(style).each(function(rule, name) { %> +<% if (_.has(rule, 'css')) { %> +<%= rule.css.replace(/\s/g, '') %> +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Type: <% if (_.isArray(rule.type)) { %>``keyword``<% } else { %>``<%= rule.type %>`` <% } %> + +<% if (_.has(rule, 'status')) { %>**Status: <%= rule.status %>** + +<% } %> +<% if (_.isArray(rule.type)) { %>Possible values: <% _(rule.type).each(function(type) { %>``<%= type %>`` <% }); %><% } %> +<% if (rule.type === 'functions' && _.isArray(rule.functions)) { %>Possible values: <% _(rule.functions).each(function(type) { %>``<%= type[0] %>`` <% }); %><% } %> + +<% if (typeof rule['default-value'] !== '') { %>Default Value: <%= rule['default-value'] %><% } %> +<% if (rule['default-meaning']) { %>*(<%= subst(rule['default-meaning']) %>)*<% } %> +<% if (typeof rule['range'] !== 'undefined') { %>Range: <%= '' + rule['range'] %><% } %> +<% if (rule.doc) { %><%= subst(rule.doc) %><% } %> + +------------ +<% } %> +<% }); %> + +Symbolizers +----------- + +<% _(symbolizers).each(function(symbolizer, name) { %> +<%= name %> +<%= Array(name.length + 1).join('^') %> +<% _(symbolizer).filter(function(p) { return p.css; }).each(function(p) { %> +<%= p.css.replace(/\s/g, '') %> +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Type: <% if (_.isArray(p.type)) { %>``keyword``<% } else { %>``<%= p.type %>`` <% } %> + +<% if (_.has(p, 'status')) { %>**Status: <%= p.status %>** + +<% } %> +<% if (_.isArray(p.type)) { %>Possible values: <% _(p.type).each(function(type) { %>``<%= type %>`` <% }); %><% } %> +<% if (p.type === 'functions' && _.isArray(p.functions)) { %>Possible values: <% _(p.functions).each(function(type) { %>``<%= type[0] %>`` <% }); %><% } %> + +<% if (typeof p['default-value'] !== '') { %>Default Value: <%= p['default-value'] %><% } %> +<% if (p['default-meaning']) { %>*(<%= subst(p['default-meaning']) %>)*<% } %> +<% if (typeof p['range'] !== 'undefined') { %>Range: <%= '' + p['range'] %><% } %> +<% if (p.doc) { %><%= subst(p.doc) %><% } %> + +------------ + +<% }); %> +<% }); %> diff --git a/lib/carto/functions.js b/lib/carto/functions.js index 66ae3f5..5b17693 100644 --- a/lib/carto/functions.js +++ b/lib/carto/functions.js @@ -1,5 +1,5 @@ var chroma = require('chroma-js'), - husl = require('husl'), + hsluv = require('hsluv'), _ = require('lodash'); (function (tree) { @@ -36,10 +36,19 @@ tree.functions = { color: color, mode: mode, toString: function(env) { - return '\n\t<stop value="' + val.ev(env) + '"' + - (color ? ' color="' + color.ev(env) + '" ' : '') + - (mode ? ' mode="' + mode.ev(env) + '" ' : '') + - '/>'; + var attr = {}; + + _.set(attr, 'value', val.ev(env).toString()); + if (color) { + _.set(attr, 'color', color.ev(env).toString()); + } + if (mode) { + _.set(attr, 'mode', mode.ev(env).toString()); + } + return { + '_name': 'stop', + '_attributes': attr + }; } }; }, @@ -53,10 +62,10 @@ tree.functions = { return new tree.Color(hsl, a, false); }, - husl: function (h, s, l) { - return this.husla(h, s, l, 1.0); + hsluv: function (h, s, l) { + return this.hsluva(h, s, l, 1.0); }, - husla: function (h, s, l, a) { + hsluva: function (h, s, l, a) { var hsl = [h, s, l].map(function (c) { return number(c); }); a = number(a); if (hsl.some(isNaN) || isNaN(a)) return null; @@ -253,7 +262,7 @@ tree.functions = { var normalize = function (x) { return x / 255; }; - mix = husl.fromRGB.apply(this, _.map(rgb, normalize)); + mix = hsluv.rgbToHsluv(_.map(rgb, normalize)); mix[1] = mix[1] / 100; mix[2] = mix[2] / 100; } diff --git a/lib/carto/index.js b/lib/carto/index.js index d108731..3ef97a2 100644 --- a/lib/carto/index.js +++ b/lib/carto/index.js @@ -1,23 +1,17 @@ -var util = require('util'), - fs = require('fs'), - path = require('path'); +var util = require('util'); function getVersion() { - if (parseInt(process.version.split('.')[1], 10) > 4) { - return require('../../package.json').version.split('.'); - } else { - // older node - var package_json = JSON.parse(fs.readFileSync(path.join(__dirname,'../../package.json'))); - return package_json.version.split('.'); - } + return require('../../package.json').version.split('.'); } var carto = { version: getVersion(), Parser: require('./parser').Parser, Renderer: require('./renderer').Renderer, + MML: require('./mml').MML, tree: require('./tree'), + Util: require('./util'), // @TODO writeError: function(ctx, options) { @@ -64,14 +58,33 @@ var carto = { } }; -[ 'call', 'color', 'comment', 'definition', 'dimension', - 'element', 'expression', 'filterset', 'filter', 'field', - 'keyword', 'layer', 'literal', 'operation', 'quoted', 'imagefilter', - 'reference', 'rule', 'ruleset', 'selector', 'style', 'url', 'value', - 'variable', 'zoom', 'invalid', 'fontset' -].forEach(function(n) { - require('./tree/' + n); -}); +require('./tree/call'); +require('./tree/color'); +require('./tree/comment'); +require('./tree/definition'); +require('./tree/dimension'); +require('./tree/element'); +require('./tree/expression'); +require('./tree/filterset'); +require('./tree/filter'); +require('./tree/field'); +require('./tree/keyword'); +require('./tree/layer'); +require('./tree/literal'); +require('./tree/operation'); +require('./tree/quoted'); +require('./tree/imagefilter'); +require('./tree/reference'); +require('./tree/rule'); +require('./tree/ruleset'); +require('./tree/selector'); +require('./tree/style'); +require('./tree/url'); +require('./tree/value'); +require('./tree/variable'); +require('./tree/zoom'); +require('./tree/invalid'); +require('./tree/fontset'); require('./functions'); diff --git a/lib/carto/mml.js b/lib/carto/mml.js new file mode 100644 index 0000000..aab6bc9 --- /dev/null +++ b/lib/carto/mml.js @@ -0,0 +1,95 @@ +var path = require('path'), + fs = require('fs'), + _ = require('lodash'), + yaml = require('js-yaml'), + carto = require('./index'), + util = require('./util'); + +carto.MML = function MML(options) { + this.options = options || {}; +}; + +/** + * Load a MML document. + * + * @param {String} basedir base directory of MML document. + * @param {String} data the MML document. + * @param {Callback} callback function to be called when finished loading. + */ +carto.MML.prototype.load = function load(basedir, data, callback) { + var mml = '', + that = this, + env = {}; + + try { + mml = yaml.safeLoad(data); + } catch (err) { + env = {}; + util.error(env, { + message: 'carto: ' + err.message.replace(/^[A-Z]+, /, '') + }); + return callback(env.msg, null); + } + + if (this.options.localize) { + var millstone; + try { + require.resolve('millstone'); + millstone = require('millstone'); + } catch (err) { + env = {}; + util.error(env, { + message: 'carto: Millstone not found, required if localizing stylesheet resources. ' + err.message.replace(/^[A-Z]+, /, '') + }); + return callback(env.msg, null); + } + millstone.resolve({ + mml: mml, + base: basedir, + cache: path.join(basedir, 'cache'), + nosymlink: this.options.nosymlink + }, function (err, data) { + // force drain the millstone download pool now + // to ensure we can exit without waiting + if (that.options.localize && millstone.drainPool) { + millstone.drainPool(function() {}); + } + env = {}; + util.error(env, err); + return callback(env.msg, data); + }); + } else { + if (_.has(mml, 'Stylesheet') && !_.isNil(mml.Stylesheet)) { + mml.Stylesheet = _.castArray(mml.Stylesheet); + for (var i = 0; i < mml.Stylesheet.length; i++) { + var stylesheet = mml.Stylesheet[i]; + if (typeof stylesheet !== 'string') { + mml.Stylesheet[i] = stylesheet; + continue; + } + var mss, + file = path.resolve(basedir, stylesheet); + try { + mss = fs.readFileSync(file, 'utf-8'); + } catch (err) { + env = {}; + util.error(env, { + message: 'Failed to load file ' + file + '.' + }); + return callback(env.msg, null); + } + mml.Stylesheet[i] = { id: stylesheet, data: mss }; + } + return callback(null, mml); + } + else { + env = {}; + util.error(env, { + message: "Expecting a Stylesheet property containing an (array of) stylesheet object(s) of the form { id: 'x', 'data': 'y' }." + }); + return callback(env.msg, null); + } + } +}; + +module.exports = carto; diff --git a/lib/carto/parser.js b/lib/carto/parser.js index 5708ec8..a77c6cf 100644 --- a/lib/carto/parser.js +++ b/lib/carto/parser.js @@ -1,7 +1,7 @@ var carto = exports, tree = require('./tree'), - _ = require('lodash'), - chroma = require('chroma-js'); + chroma = require('chroma-js'), + util = require('./util'); // Token matching is done with the `$` function, which either takes // a terminal string or regexp, or a non-terminal function to call. @@ -12,18 +12,12 @@ carto.Parser = function Parser(env) { j, // current chunk temp, // temporarily holds a chunk's state, for backtracking memo, // temporarily holds `i`, when backtracking - furthest, // furthest index the parser has gone to chunks, // chunkified input current, // index of current chunk, in `input` parser; var that = this; - // This function is called after all files - // have been imported through `@import`. - - var finish = function() {}; // eslint-disable-line - function save() { temp = chunks[j]; memo = i; @@ -104,35 +98,6 @@ carto.Parser = function Parser(env) { } } - // Make an error object from a passed set of properties. - // Accepted properties: - // - `message`: Text of the error message. - // - `filename`: Filename where the error occurred. - // - `index`: Char. index where the error occurred. - function makeError(err) { - var einput; - - _(err).defaults({ - index: furthest, - filename: env.filename, - message: 'Parse error.', - line: 0, - column: -1 - }).value(); - - if (err.filename && that.env.inputs && that.env.inputs[err.filename]) { - einput = that.env.inputs[err.filename]; - } else { - einput = input; - } - - err.line = (einput.slice(0, err.index).match(/\n/g) || '').length + 1; - for (var n = err.index; n >= 0 && einput.charAt(n) !== '\n'; n--) { - err.column++; - } - return new Error(_.template('<%=filename%>:<%=line%>:<%=column%> <%=message%>')(err)); - } - this.env = env = env || {}; this.env.filename = this.env.filename || null; this.env.inputs = this.env.inputs || {}; @@ -145,7 +110,7 @@ carto.Parser = function Parser(env) { parse: function(str) { var root, error = null; - i = j = current = furthest = 0; + i = j = current = 0; chunks = []; input = str.replace(/\r\n/g, '\n'); if (env.filename) { @@ -198,24 +163,53 @@ carto.Parser = function Parser(env) { } } - /*eslint-disable no-fallthrough */ switch (c) { - case '{': if (! inParam) { level ++; chunk.push(c); break; } - case '}': if (! inParam) { level --; chunk.push(c); chunks[++j] = chunk = []; break; } - case '(': if (! inParam) { inParam = true; chunk.push(c); break; } - case ')': if ( inParam) { inParam = false; chunk.push(c); break; } - default: chunk.push(c); + case '{': + if (!inParam) { + level ++; + } + else { + inParam = false; + } + chunk.push(c); + break; + case '}': + if (!inParam) { + level --; + chunk.push(c); + chunks[++j] = chunk = []; + } + else { + inParam = false; + chunk.push(c); + } + break; + case '(': + if (!inParam) { + inParam = true; + } + else { + inParam = false; + } + chunk.push(c); + break; + case ')': + if (inParam) { + inParam = false; + } + chunk.push(c); + break; + default: + chunk.push(c); } - /*eslint-enable no-fallthrough */ - i++; } if (level !== 0) { error = { index: i - 1, - type: 'Parse', - message: (level > 0) ? "missing closing `}`" : "missing opening `{`" + message: (level > 0) ? "missing closing `}`" : "missing opening `{`", + filename: env.filename }; } @@ -223,7 +217,8 @@ carto.Parser = function Parser(env) { })([[]]); if (error) { - throw makeError(error); + util.error(env, error); + throw new Error('N/A'); } // Start with the primary rule. @@ -237,14 +232,6 @@ carto.Parser = function Parser(env) { // and sorted according to specificitySort root.toList = (function() { return function(env) { - env.error = function(e) { - if (!env.errors) env.errors = new Error(''); - if (env.errors.message) { - env.errors.message += '\n' + makeError(e).message; - } else { - env.errors.message = makeError(e).message; - } - }; env.frames = env.frames || []; @@ -314,7 +301,7 @@ carto.Parser = function Parser(env) { // To fail gracefully, match everything until a semicolon or linebreak. if (chunk) { - return new tree.Invalid(chunk, memo); + return new tree.Invalid(chunk, memo, null, env.filename); } }, @@ -393,7 +380,7 @@ carto.Parser = function Parser(env) { if (!$(')')) return; if (name) { - return new tree.Call(name, args, i); + return new tree.Call(name, args, env.filename, i); } }, // Arguments are comma-separated expressions @@ -428,7 +415,7 @@ carto.Parser = function Parser(env) { value = $(this.entities.quoted) || $(this.entities.variable) || $(/^[\-\w%@$\/.&=:;#+?~]+/) || ''; if (! $(')')) { - return new tree.Invalid(value, memo, 'Missing closing ) in URL.'); + return new tree.Invalid(value, memo, 'Missing closing ) in URL.', env.filename); } else { return new tree.URL((typeof value.value !== 'undefined' || value instanceof tree.Variable) ? @@ -460,8 +447,8 @@ carto.Parser = function Parser(env) { keywordcolor: function() { var rgb = chunks[j].match(/^[a-z]+/); - if (rgb && rgb[0] in tree.Reference.data.colors) { - var data = tree.Reference.data.colors[$(/^[a-z]+/)]; + if (rgb && rgb[0] in that.env.ref.data.colors) { + var data = that.env.ref.data.colors[$(/^[a-z]+/)]; var a = 1; if (data.length > 3) { a = data[3]; @@ -478,7 +465,7 @@ carto.Parser = function Parser(env) { if ((c > 57 || c < 45) || c === 47) return; var value = $(/^(-?\d*\.?\d+(?:[eE][-+]?\d+)?)(\%|\w+)?/); if (value) { - return new tree.Dimension(value[1], value[2], memo); + return new tree.Dimension(value[1], value[2], memo, env.filename); } } }, @@ -548,17 +535,21 @@ carto.Parser = function Parser(env) { } else if (f) { var err = filters.add(f); if (err) { - throw makeError({ + util.error(env, { message: err, - index: i - 1 + index: i - 1, + filename: env.filename }); + throw new Error('N/A'); } conditions++; } else if (attachment) { - throw makeError({ + util.error(env, { message: 'Encountered second attachment name.\n', - index: i - 1 + index: i - 1, + filename: env.filename }); + throw new Error('N/A'); } else { attachment = a; } @@ -577,34 +568,35 @@ carto.Parser = function Parser(env) { var key, op, val; if (! $('[')) return; - /*eslint-disable no-cond-assign */ - if (key = $(/^[a-zA-Z0-9\-_]+/) || + if ((key = $(/^[a-zA-Z0-9\-_]+/) || $(this.entities.quoted) || + $(this.expression) || $(this.entities.variable) || $(this.entities.keyword) || - $(this.entities.field)) { + $(this.entities.field))) { // TODO: remove at 1.0.0 if (key instanceof tree.Quoted) { key = new tree.Field(key.toString()); } if ((op = $(this.entities.comparison)) && - (val = $(this.entities.quoted) || + (val = $(this.expression) || + $(this.entities.quoted) || $(this.entities.variable) || $(this.entities.dimension) || $(this.entities.keyword) || $(this.entities.field))) { if (! $(']')) { - throw makeError({ + util.error(env, { message: 'Missing closing ] of filter.', - index: memo - 1 + index: memo - 1, + filename: env.filename }); + throw new Error('N/A'); } if (!key.is) key = new tree.Field(key); return new tree.Filter(key, op, val, memo, env.filename); } } - - /*eslint-enable no-cond-assign */ }, zoom: function() { @@ -613,7 +605,7 @@ carto.Parser = function Parser(env) { if ($(/^\[\s*zoom/g) && (op = $(this.entities.comparison)) && (val = $(this.entities.variable) || $(this.entities.dimension)) && $(']')) { - return new tree.Zoom(op, val, memo); + return new tree.Zoom(op, val, memo, env.filename); } else { // backtrack restore(); @@ -674,19 +666,15 @@ carto.Parser = function Parser(env) { if (c === '.' || c === '#') { return; } - /*eslint-disable no-cond-assign */ - if (name = $(this.variable) || $(this.property)) { + if ((name = $(this.variable) || $(this.property))) { value = $(this.value); if (value && $(this.end)) { - return new tree.Rule(name, value, memo, env.filename); + return new tree.Rule(env.ref, name, value, memo, env.filename); } else { - furthest = i; restore(); } } - - /*eslint-enable no-cond-assign */ }, font: function() { @@ -746,13 +734,9 @@ carto.Parser = function Parser(env) { var m, a, op, operation; m = $(this.operand); if (m) { - - /*eslint-disable no-cond-assign */ while ((op = ($('/') || $('*') || $('%'))) && (a = $(this.operand))) { - operation = new tree.Operation(op, [operation || m, a], memo); + operation = new tree.Operation(op, [operation || m, a], memo, env.filename); } - - /*eslint-enable no-cond-assign */ return operation || m; } }, @@ -760,14 +744,10 @@ carto.Parser = function Parser(env) { var m, a, op, operation; m = $(this.multiplication); if (m) { - - /*eslint-disable no-cond-assign */ while ((op = $(/^[-+]\s+/) || (input.charAt(i - 1) != ' ' && ($('+') || $('-')))) && (a = $(this.multiplication))) { - operation = new tree.Operation(op, [operation || m, a], memo); + operation = new tree.Operation(op, [operation || m, a], memo, env.filename); } - - /*eslint-enable no-cond-assign */ return operation || m; } }, diff --git a/lib/carto/renderer.js b/lib/carto/renderer.js index 49c4cb8..1e67483 100644 --- a/lib/carto/renderer.js +++ b/lib/carto/renderer.js @@ -1,10 +1,47 @@ -var _ = require('lodash'); -var carto = require('./index'); +var _ = require('lodash'), + carto = require('./index'), + util = require('./util'); -carto.Renderer = function Renderer(env, options) { - this.env = env || {}; +carto.Renderer = function Renderer(options) { + this.env = {}; this.options = options || {}; - this.options.mapnik_version = this.options.mapnik_version || '3.0.0'; + + // load different reference if given + if (_.has(this.options, 'reference') && !_.isNil(this.options.reference)) { + this.ref = new carto.tree.Reference(this.options.reference); + } + else { + this.ref = new carto.tree.Reference(); + } + + this.options.version = this.options.version || this.ref.getLatest(); + this.options.outputFormat = this.options.outputFormat || 'mapnik'; + + this.env.ref = this.ref; + if (_.has(this.options, 'quiet') && _.isBoolean(this.options.quiet)) { + this.env.quiet = this.options.quiet; + _.unset(this.options.quiet); + } + if (_.has(this.options, 'benchmark') && _.isBoolean(this.options.benchmark)) { + this.env.benchmark = this.options.benchmark; + _.unset(this.options.benchmark); + } + if (_.has(this.options, 'validationData')) { + this.env.validation_data = this.options.validationData; + _.unset(this.options.validationData); + } + if (_.has(this.options, 'ppi')) { + this.env.ppi = this.options.ppi; + _.unset(this.options.ppi); + } + if (_.has(this.options, 'effects')) { + this.env.effects = this.options.effects; + _.unset(this.options.effects); + } + if (_.has(this.options, 'filename')) { + this.env.filename = this.options.filename; + _.unset(this.options.filename); + } }; /** @@ -19,44 +56,99 @@ carto.Renderer.prototype.renderMSS = function render(data) { var env = _(this.env).defaults({ benchmark: false, validation_data: false, - effects: [] + effects: [], + quiet: false, }).value(); - carto.tree.Reference.setVersion(this.options.mapnik_version); + try { + this.ref.setVersion(this.options.version); + } + catch (err) { + util.error(env, { + message: err.message + }); + return { + msg: env.msg, + data: null + }; + } + + // check if given reference is compliant with expectations + if (!this.ref.compliant) { + util.error(env, { + message: 'Could not use the given reference, because it does not adhere to the specification. See the documentation for details.' + }); + return { + msg: env.msg, + data: null + }; + } var output = []; var styles = []; - if (env.benchmark) console.time('Parsing MSS'); - var parser = (carto.Parser(env)).parse(data); - if (env.benchmark) console.timeEnd('Parsing MSS'); - - if (env.benchmark) console.time('Rule generation'); - var rule_list = parser.toList(env); - if (env.benchmark) console.timeEnd('Rule generation'); - - if (env.benchmark) console.time('Rule inheritance'); - var rules = inheritDefinitions(rule_list, env); - if (env.benchmark) console.timeEnd('Rule inheritance'); - - if (env.benchmark) console.time('Style sort'); - var sorted = sortStyles(rules,env); - if (env.benchmark) console.timeEnd('Style sort'); - - if (env.benchmark) console.time('Total Style generation'); - for (var k = 0, rule, style_name; k < sorted.length; k++) { - rule = sorted[k]; - style_name = 'style' + (rule.attachment !== '__default__' ? '-' + rule.attachment : ''); - styles.push(style_name); - var bench_name = '\tStyle "'+style_name+'" (#'+k+') toXML'; - if (env.benchmark) console.time(bench_name); - // env.effects can be modified by this call - output.push(carto.tree.StyleXML(style_name, rule.attachment, rule, env)); - if (env.benchmark) console.timeEnd(bench_name); + try { + + if (env.benchmark) console.time('Parsing MSS'); + var parser = (carto.Parser(env)).parse(data); + if (env.benchmark) console.timeEnd('Parsing MSS'); + + if (env.benchmark) console.time('Rule generation'); + var rule_list = parser.toList(env); + if (env.benchmark) console.timeEnd('Rule generation'); + + if (env.benchmark) console.time('Rule inheritance'); + var rules = inheritDefinitions(rule_list, env); + if (env.benchmark) console.timeEnd('Rule inheritance'); + + if (env.benchmark) console.time('Style sort'); + var sorted = sortStyles(rules); + if (env.benchmark) console.timeEnd('Style sort'); + + if (env.benchmark) console.time('Total Style generation'); + for (var k = 0, rule, style_name; k < sorted.length; k++) { + rule = sorted[k]; + style_name = 'style' + (rule.attachment !== '__default__' ? '-' + rule.attachment : ''); + styles.push(style_name); + var bench_name = '\tStyle "'+style_name+'" (#'+k+') toXML'; + if (env.benchmark) console.time(bench_name); + // env.effects can be modified by this call + output.push(carto.tree.StyleObject(style_name, rule.attachment, rule, env)); + if (env.benchmark) console.timeEnd(bench_name); + } + if (env.benchmark) console.timeEnd('Total Style generation'); + + if (!util.hasErrors(env.msg)) { + switch (this.options.outputFormat) { + case 'json': + output = JSON.stringify(output, null, 2); + break; + case 'mapnik': + default: + output = util.jsonToXML(output); + break; + } + } + else { + output = null; + } + + return { + msg: env.msg, + data: output + }; + } + catch (err) { + // do not swallow program errors + if (err.message !== 'N/A') { + throw err; + } + + return { + msg: env.msg, + data: null + }; } - if (env.benchmark) console.timeEnd('Total Style generation'); - if (env.errors) throw env.errors; - return output.join('\n'); }; /** @@ -72,153 +164,303 @@ carto.Renderer.prototype.render = function render(m) { benchmark: false, validation_data: false, effects: [], - ppi: 90.714 + ppi: 90.714, + quiet: false }).value(); - carto.tree.Reference.setVersion(this.options.mapnik_version); + try { + this.ref.setVersion(this.options.version); + } + catch (err) { + util.error(env, { + message: err.message + }); + return { + msg: env.msg, + data: null + }; + } + + // check if given reference is compliant with expectations + if (!this.ref.compliant) { + util.error(env, { + message: 'Could not use the given reference, because it does not adhere to the specification. See the documentation for details.' + }); + return { + msg: env.msg, + data: null + }; + } var output = []; var definitions = []; - // Transform stylesheets into definitions. - if (_.has(m, 'Stylesheet') && !_.isNil(m.Stylesheet)) { - m.Stylesheet = _.castArray(m.Stylesheet); - definitions = _(m.Stylesheet).chain() - .map(function(s) { - if (_.isString(s) || !_.has(s, 'id') || !_.has(s, 'data') || _.isNil(s.id) || _.isNil(s.data)) { - var e = new Error("Expecting a stylesheet object of the form { id: 'x', 'data': 'y' } for the Stylesheet property.\n"); - e.stack = null; // do not show stack trace - throw e; - } - // Passing the environment from stylesheet to stylesheet, - // allows frames and effects to be maintained. - env = _(env).extend({filename:s.id}).value(); - - var time = +new Date(), - root = (carto.Parser(env)).parse(s.data); - if (env.benchmark) - console.warn('Parsing time: ' + (new Date() - time) + 'ms'); - return root.toList(env); - }) - .flatten() - .value(); - } - - function appliesTo(name, classIndex) { + function appliesTo(name, classIndex, zoom) { return function(definition) { - return definition.appliesTo(l.name, classIndex); + return definition.appliesTo(name, classIndex, zoom); }; } - // Iterate through layers and create styles custom-built - // for each of them, and apply those styles to the layers. - var styles, l, classIndex, rules, sorted, matching; - for (var i = 0; i < m.Layer.length; i++) { - l = m.Layer[i]; - styles = []; - - if (definitions.length > 0) { - classIndex = {}; - - if (env.benchmark) console.warn('processing layer: ' + l.id); - // Classes are given as space-separated alphanumeric strings. - var classes = (l['class'] || '').split(/\s+/g); - for (var j = 0; j < classes.length; j++) { - classIndex[classes[j]] = true; + try { + // Transform stylesheets into definitions. + if (_.has(m, 'Stylesheet') && !_.isNil(m.Stylesheet)) { + m.Stylesheet = _.castArray(m.Stylesheet); + + + definitions = _(m.Stylesheet).chain() + .map(function(s) { + if (_.isString(s) || !_.has(s, 'id') || !_.has(s, 'data') || _.isNil(s.id) || _.isNil(s.data)) { + util.error(env, { + message: "Expecting a stylesheet object of the form { id: 'x', 'data': 'y' } for the Stylesheet property." + }); + throw new Error('N/A'); + } + // Passing the environment from stylesheet to stylesheet, + // allows frames and effects to be maintained. + env = _(env).extend({filename:s.id}).value(); + + var time = +new Date(), + root = (carto.Parser(env)).parse(s.data); + if (env.benchmark) + console.warn('Parsing time: ' + (new Date() - time) + 'ms'); + return root.toList(env); + }) + .flatten() + .value(); + } + + // Iterate through layers and create styles custom-built + // for each of them, and apply those styles to the layers. + var styles, l, classIndex, rules, sorted, matching; + for (var i = 0; i < m.Layer.length; i++) { + l = m.Layer[i]; + styles = []; + + if (_.has(l, 'id')) { + l.layerId = l.id; + } + else { + util.error(env, { + message: 'The id attribute is required for layers.' + }); + + return { + msg: env.msg, + data: null + }; } - matching = definitions.filter(appliesTo(l.name, classIndex)); - rules = inheritDefinitions(matching, env); - sorted = sortStyles(rules, env); - for (var k = 0, rule, style_name; k < sorted.length; k++) { - rule = foldStyle(sorted[k]); - style_name = l.name + (rule.attachment !== '__default__' ? '-' + rule.attachment : ''); + if (definitions.length > 0) { + classIndex = {}; - // env.effects can be modified by this call - var styleXML = carto.tree.StyleXML(style_name, rule.attachment, rule, env); + if (env.benchmark) console.warn('processing layer: ' + l.id); + // Classes are given as space-separated alphanumeric strings. + var classes = (l['class'] || '').split(/\s+/g); + for (var j = 0; j < classes.length; j++) { + classIndex[classes[j]] = true; + } + // compile zoom range if given + var zoom = 0, + min = 0, + max = Infinity, + minOrMaxZoom = false; + + if (_.has(l, 'properties')) { + if (_.has(l.properties, 'minzoom') && l.properties.minzoom > 0) { + min = l.properties.minzoom; + minOrMaxZoom = true; + } + if (_.has(l.properties, 'maxzoom') && l.properties.maxzoom <= carto.tree.Zoom.maxZoom) { + max = l.properties.maxzoom; + minOrMaxZoom = true; + } + } + + if (minOrMaxZoom) { + for (var z = 0; z <= carto.tree.Zoom.maxZoom; z++) { + if (z >= min && z <= max) { + zoom |= (1 << z); + } + } + matching = definitions.filter(appliesTo(l.layerId, classIndex, zoom)); + } + else { + matching = definitions.filter(appliesTo(l.layerId, classIndex)); + } + + rules = inheritDefinitions(matching, env); + sorted = sortStyles(rules); + + if (sorted.length == 0) { + util.warning(env, { + message: 'Layer ' + l.layerId + ' has no styles associated with it.' + }); + } + + for (var k = 0, rule, style_name; k < sorted.length; k++) { + rule = foldStyle(sorted[k]); + style_name = l.layerId + (rule.attachment !== '__default__' ? '-' + rule.attachment : ''); + + // env.effects can be modified by this call + var styleObj = carto.tree.StyleObject(style_name, rule.attachment, rule, env); + + if (Object.keys(styleObj).length) { + output.push(styleObj); + styles.push(style_name); + } + } + } - if (styleXML) { - output.push(styleXML); - styles.push(style_name); + // if there is a global _properties object for this layer take it into account + if (_.has(m, '_properties') && _.has(m._properties, l.layerId)) { + if (!_.has(l, 'properties')) { + l.properties = {}; } + var props = {}; + _.assign(props, m._properties[l.layerId], l.properties); + l.properties = props; } + + output.push(carto.tree.LayerObject(l, styles, this.ref.data['version'])); } - output.push(carto.tree.LayerXML(l, styles)); - } + if (env.effects.length) { + output = _.concat(env.effects.map(function(e) { + return e.toObject(env); + }), output); + } - output.unshift(env.effects.map(function(e) { - return e.toXML(env); - }).join('\n')); - - var map_properties = getMapProperties(m, definitions, env); - - // Exit on errors. - if (env.errors) throw env.errors; - - // Pass TileJSON and other custom parameters through to Mapnik XML. - var parameters = _(m).reduce(function(memo, v, k) { - if (!v && v !== 0) return memo; - - switch (k) { - // Known skippable properties. - case 'srs': - case 'Layer': - case 'Stylesheet': - break; - // Non URL-bound TileJSON properties. - case 'bounds': - case 'center': - case 'minzoom': - case 'maxzoom': - case 'version': - memo.push(' <Parameter name="' + k + '">' + v + '</Parameter>'); - break; - // Properties that require CDATA. - case 'name': - case 'description': - case 'legend': - case 'attribution': - case 'template': - memo.push(' <Parameter name="' + k + '"><![CDATA[' + v + ']]></Parameter>'); - break; - // Mapnik image format. - case 'format': - memo.push(' <Parameter name="' + k + '">' + v + '</Parameter>'); - break; - // Mapnik interactivity settings. - case 'interactivity': - memo.push(' <Parameter name="interactivity_layer">' + v.layer + '</Parameter>'); - memo.push(' <Parameter name="interactivity_fields">' + v.fields + '</Parameter>'); - break; - // Support any additional scalar properties. - default: - if ('string' === typeof v) { - memo.push(' <Parameter name="' + k + '"><![CDATA[' + v + ']]></Parameter>'); - } else if ('number' === typeof v) { - memo.push(' <Parameter name="' + k + '">' + v + '</Parameter>'); - } else if ('boolean' === typeof v) { - memo.push(' <Parameter name="' + k + '">' + v + '</Parameter>'); + var map_properties = getMapProperties(m, definitions, this.ref.data.symbolizers.map, env); + + if (!util.hasErrors(env.msg)) { + + // Pass TileJSON and other custom parameters through to Mapnik XML. + var parameters = _(m).reduce(function(memo, v, k) { + if (!v && v !== 0) return memo; + + switch (k) { + // Known skippable properties. + case 'srs': + case 'Layer': + case 'Stylesheet': + break; + // Non URL-bound TileJSON properties. + case 'bounds': + case 'center': + case 'minzoom': + case 'maxzoom': + case 'version': + case 'name': + case 'description': + case 'legend': + case 'attribution': + case 'template': + case 'format': + memo.push({ + '_name': 'Parameter', + '_attributes': { + 'name': k + }, + '_content': v + }); + break; + case 'interactivity': + memo.push({ + '_name': 'Parameter', + '_attributes': { + 'name': 'interactivity_layer' + }, + '_content': v.layer + }); + memo.push({ + '_name': 'Parameter', + '_attributes': { + 'name': 'interactivity_fields' + }, + '_content': v.fields + }); + break; + // Support any additional scalar properties. + default: + if ('string' === typeof v || 'number' === typeof v || 'boolean' === typeof v) { + memo.push({ + '_name': 'Parameter', + '_attributes': { + 'name': k + }, + '_content': v + }); + } + break; + } + return memo; + }, []); + if (parameters.length) { + output.unshift({ + '_name': 'Parameters', + '_content': parameters + }); } - break; + + // issue warnings for definitions that do not match layers + _.forEach(definitions, function (v) { + if (v.matchCount == 0) { + var selectorName = '', + filename = null, + index = null; + + if (_.isArray(v.elements) && v.elements.length > 0) { + selectorName = v.elements[v.elements.length - 1].value; + } + if (_.isArray(v.rules) && v.rules.length > 0) { + filename = v.rules[0].filename; + index = v.rules[0].index; + } + util.warning(env, { + message: 'Styles do not match layer selector ' + selectorName + '.', + filename: filename, + index: index + }); + } + }); + + output = { + '_name': 'Map', + '_attributes': map_properties, + '_content': output + }; + + switch (this.options.outputFormat) { + case 'json': + output = JSON.stringify(output, null, 2); + break; + case 'mapnik': + default: + output = '<?xml version="1.0" encoding="utf-8"?>\n<!DOCTYPE Map[]>\n' + util.jsonToXML(output); + break; + } + } - return memo; - }, []); - if (parameters.length) output.unshift( - '<Parameters>\n' + - parameters.join('\n') + - '\n</Parameters>\n' - ); - - var properties = _(map_properties).map(function(v) { return ' ' + v; }).join(''); - - output.unshift( - '<?xml version="1.0" ' + - 'encoding="utf-8"?>\n' + - '<!DOCTYPE Map[]>\n' + - '<Map' + properties +'>\n'); - output.push('</Map>'); - return output.join('\n'); + else { + output = null; + } + + return { + msg: env.msg, + data: output + }; + } + catch (err) { + // do not swallow program errors + if (err.message !== 'N/A') { + throw err; + } + + return { + msg: env.msg, + data: null + }; + } }; /** @@ -228,7 +470,7 @@ carto.Renderer.prototype.render = function render(m) { * @param {Object} byFilter an object/dictionary of existing filters. This is * actually keyed `attachment->filter` */ -function addRules(current, definition, byFilter, env) { // eslint-disable-line +function addRules(current, definition, byFilter) { var newFilters = definition.filters, newRules = definition.rules, updatedFilters, clone, previous; @@ -323,7 +565,7 @@ function inheritDefinitions(definitions, env) { for (var j = i + 1; j < definitions.length; j++) { if (definitions[j].attachment === attachment) { // Only inherit rules from the same attachment. - current = addRules(current, definitions[j], byFilter[attachment], env); + current = addRules(current, definitions[j], byFilter[attachment]); } } @@ -343,7 +585,7 @@ function inheritDefinitions(definitions, env) { // This sorts a slice of the styles, so it returns a sorted // array but does not change the input. function sortStylesIndex(a, b) { return b.index - a.index; } -function sortStyles(styles, env) { // eslint-disable-line +function sortStyles(styles) { for (var i = 0; i < styles.length; i++) { var style = styles[i]; style.index = Infinity; @@ -369,8 +611,9 @@ function sortStyles(styles, env) { // eslint-disable-line function foldStyle(style) { for (var i = 0; i < style.length; i++) { for (var j = style.length - 1; j > i; j--) { - if (style[j].filters.cloneWith(style[i].filters) === null) + if (style[j].filters.cloneWith(style[i].filters) === null) { style.splice(j, 1); + } } } return style; @@ -385,15 +628,15 @@ function foldStyle(style) { * * @param {Object} m the mml object. * @param {Array} definitions the output of toList. + * @param {Array} symbolizers map symbolizers * @param {Object} env * @return {String} rendered properties. */ -function getMapProperties(m, definitions, env) { +function getMapProperties(m, definitions, symbolizers, env) { var rules = {}; - var symbolizers = carto.tree.Reference.data.symbolizers.map; _(m).each(function(value, key) { - if (key in symbolizers) rules[key] = key + '="' + value + '"'; + if (key in symbolizers) rules[key] = value; }); definitions.filter(function(r) { @@ -402,12 +645,12 @@ function getMapProperties(m, definitions, env) { for (var i = 0; i < r.rules.length; i++) { var key = r.rules[i].name; if (!(key in symbolizers)) { - env.error({ + util.error(env, { message: 'Rule ' + key + ' not allowed for Map.', index: r.rules[i].index }); } - rules[key] = r.rules[i].ev(env).toXML(env); + rules[key] = r.rules[i].ev(env).toObject(env)[key]; } }); return rules; diff --git a/lib/carto/tree/call.js b/lib/carto/tree/call.js index 253a882..38c34fd 100644 --- a/lib/carto/tree/call.js +++ b/lib/carto/tree/call.js @@ -1,8 +1,11 @@ (function(tree) { -var _ = require('lodash'); -tree.Call = function Call(name, args, index) { +var _ = require('lodash'), + util = require('../util'); + +tree.Call = function Call(name, args, filename, index) { this.name = name; this.args = args; + this.filename = filename; this.index = index; }; @@ -32,21 +35,19 @@ tree.Call.prototype = { if (tree.functions[this.name].length <= args.length) { var val = tree.functions[this.name].apply(tree.functions, args); if (val === null) { - env.error({ + util.error(env, { message: 'incorrect arguments given to ' + this.name + '()', index: this.index, - type: 'runtime', filename: this.filename }); return { is: 'undefined', value: 'undefined' }; } return val; } else { - env.error({ + util.error(env, { message: 'incorrect number of arguments for ' + this.name + '(). ' + tree.functions[this.name].length + ' expected.', index: this.index, - type: 'runtime', filename: this.filename }); return { @@ -55,21 +56,20 @@ tree.Call.prototype = { }; } } else { - var fn = tree.Reference.mapnikFunctions[this.name]; + var fn = env.ref.functions[this.name]; if (fn === undefined) { - var functions = _.toPairs(tree.Reference.mapnikFunctions); + var functions = _.toPairs(env.ref.functions); // cheap closest, needs improvement. var name = this.name; var mean = functions.map(function(f) { - return [f[0], tree.Reference.editDistance(name, f[0]), f[1]]; + return [f[0], env.ref.editDistance(name, f[0]), f[1]]; }).sort(function(a, b) { return a[1] - b[1]; }); - env.error({ + util.error(env, { message: 'unknown function ' + this.name + '(), did you mean ' + mean[0][0] + '(' + mean[0][2] + ')', index: this.index, - type: 'runtime', filename: this.filename }); return { @@ -81,11 +81,10 @@ tree.Call.prototype = { !(Array.isArray(fn) && _.includes(fn, args.length)) && // support variable-arg functions like `colorize-alpha` fn !== -1) { - env.error({ + util.error(env, { message: 'function ' + this.name + '() takes ' + fn + ' arguments and was given ' + args.length, index: this.index, - type: 'runtime', filename: this.filename }); return { @@ -100,7 +99,7 @@ tree.Call.prototype = { } }, - toString: function(env, format) { // eslint-disable-line + toString: function() { if (this.args.length) { return this.name + '(' + this.args.join(',') + ')'; } else { diff --git a/lib/carto/tree/color.js b/lib/carto/tree/color.js index 633c4fe..8165a35 100644 --- a/lib/carto/tree/color.js +++ b/lib/carto/tree/color.js @@ -1,5 +1,5 @@ var chroma = require('chroma-js'), - husl = require('husl'), + hsluv = require('hsluv'), _ = require('lodash'); (function(tree) { @@ -42,7 +42,7 @@ tree.Color.prototype = { if (this.hsl !== null) { if (this.alpha < 1.0) { if (this.perceptual) { - return 'rgba(' + husl.toRGB(this.hsl[0], this.hsl[1] * 100, this.hsl[2] * 100).map(function(c) { + return 'rgba(' + hsluv.hsluvToRgb([this.hsl[0], this.hsl[1] * 100, this.hsl[2] * 100]).map(function(c) { return Math.round(c * 255); }).concat(this.round(this.alpha, 2)).join(', ') + ')'; } @@ -53,7 +53,7 @@ tree.Color.prototype = { } } else { if (this.perceptual) { - return husl.toHex(this.hsl[0], this.hsl[1] * 100, this.hsl[2] * 100); + return hsluv.hsluvToHex([this.hsl[0], this.hsl[1] * 100, this.hsl[2] * 100]); } else { return chroma.hsl(this.hsl[0], this.hsl[1], this.hsl[2]).hex(); @@ -75,8 +75,8 @@ tree.Color.prototype = { // transition via RGB, because HSL values cannot be directly // transformed into HUSL values easily var rgb = chroma.hsl(this.hsl[0], this.hsl[1], this.hsl[2]).rgb(); - var huslc = husl.fromRGB(rgb[0] / 255, rgb[1] / 255, rgb[2] / 255); - return new tree.Color([huslc[0], huslc[1] / 100, huslc[2] / 100], this.alpha, true); + var hsluvc = hsluv.rgbToHsluv([rgb[0] / 255, rgb[1] / 255, rgb[2] / 255]); + return new tree.Color([hsluvc[0], hsluvc[1] / 100, hsluvc[2] / 100], this.alpha, true); } }, @@ -87,7 +87,7 @@ tree.Color.prototype = { else { // transition via RGB, because HUSL values cannot be directly // transformed into HSL values easily - var rgb = husl.toRGB(this.hsl[0], this.hsl[1], this.hsl[2]).rgb(); + var rgb = hsluv.hsluvToRgb([this.hsl[0], this.hsl[1], this.hsl[2]]).rgb(); var hsl = chroma(rgb[0] * 255, rgb[1] * 255, rgb[2] * 255).hsl(); return new tree.Color([hsl[0], hsl[1], hsl[2]], this.alpha, false); } @@ -129,7 +129,7 @@ tree.Color.prototype = { var normalize = function (x) { return x / 255; }; - result = husl.fromRGB.apply(this, _.map(result, normalize)); + result = hsluv.rgbToHsluv(_.map(result, normalize)); result[1] = result[1] / 100; result[2] = result[2] / 100; } diff --git a/lib/carto/tree/comment.js b/lib/carto/tree/comment.js index 3b2a70e..de5b39e 100644 --- a/lib/carto/tree/comment.js +++ b/lib/carto/tree/comment.js @@ -6,7 +6,7 @@ tree.Comment = function Comment(value, silent) { }; tree.Comment.prototype = { - toString: function(env) { // eslint-disable-line + toString: function() { return '<!--' + this.value + '-->'; }, 'ev': function() { return this; } diff --git a/lib/carto/tree/definition.js b/lib/carto/tree/definition.js index 2283c18..a845bae 100644 --- a/lib/carto/tree/definition.js +++ b/lib/carto/tree/definition.js @@ -1,6 +1,7 @@ (function(tree) { var assert = require('assert'), - _ = require('lodash'); + _ = require('lodash'), + util = require('../util'); // A definition is the combination of a selector and rules, like // #foo { @@ -8,7 +9,7 @@ var assert = require('assert'), // } // // The selector can have filters -tree.Definition = function Definition(selector, rules) { +tree.Definition = function Definition(env, selector, rules) { this.elements = selector.elements; assert.ok(selector.filters instanceof tree.Filterset); this.rules = rules; @@ -22,6 +23,14 @@ tree.Definition = function Definition(selector, rules) { this.zoom = selector.zoom; this.attachment = selector.attachment || '__default__'; this.specificity = selector.specificity(); + this.matchCount = 0; + this.ref = env.ref; + + // special handling for Map selector + if (_.isArray(this.elements) && this.elements.length > 0 && + this.elements[0].value === 'Map') { + this.matchCount = 1; + } }; tree.Definition.prototype.toString = function() { @@ -39,15 +48,18 @@ tree.Definition.prototype.clone = function(filters) { clone.ruleIndex = _.clone(this.ruleIndex); clone.filters = filters ? filters : this.filters.clone(); clone.attachment = this.attachment; + clone.ref = this.ref; return clone; }; tree.Definition.prototype.addRules = function(rules) { var added = 0; - // Add only unique rules. for (var i = 0; i < rules.length; i++) { - if (!this.ruleIndex[rules[i].id]) { + // only add rule if not for whole symbolizer (default) + // and if unique + if (this.ref.selectorName(rules[i].name) !== 'default' && + !this.ruleIndex[rules[i].id]) { this.rules.push(rules[i]); this.ruleIndex[rules[i].id] = true; added++; @@ -57,17 +69,21 @@ tree.Definition.prototype.addRules = function(rules) { return added; }; -// Determine whether this selector matches a given id -// and array of classes, by determining whether +// Determine whether this selector matches a given id, +// array of classes and zoom range, by determining whether // all elements it contains match. -tree.Definition.prototype.appliesTo = function(id, classes) { - for (var i = 0, l = this.elements.length; i < l; i++) { - var elem = this.elements[i]; - if (!(elem.wildcard || - (elem.type === 'class' && classes[elem.clean]) || - (elem.type === 'id' && id === elem.clean))) return false; +tree.Definition.prototype.appliesTo = function(id, classes, zoom) { + if (typeof zoom === 'undefined' || (this.zoom & zoom) > 0) { + for (var i = 0, l = this.elements.length; i < l; i++) { + var elem = this.elements[i]; + if (!(elem.wildcard || + (elem.type === 'class' && classes[elem.clean]) || + (elem.type === 'id' && id === elem.clean))) return false; + } + this.matchCount++; + return true; } - return true; + return false; }; function symbolizerName(symbolizer) { @@ -82,8 +98,14 @@ function symbolizerList(sym_order) { .map(function(v) { return v[0]; }); } -tree.Definition.prototype.symbolizersToXML = function(env, symbolizers, zoom) { - var xml = zoom.toXML(env).join('') + this.filters.toXML(env); +tree.Definition.prototype.symbolizersToObject = function(env, symbolizers, zoom) { + var ruleContent = [], + filter = this.filters.toObject(env); + + ruleContent = _.concat(ruleContent, zoom.toObject(env)); + if (Object.keys(filter).length) { + ruleContent.push(filter); + } // Sort symbolizers by the index of their first property definition var sym_order = [], indexes = []; @@ -100,6 +122,7 @@ tree.Definition.prototype.symbolizersToXML = function(env, symbolizers, zoom) { var sym_count = 0; for (var i = 0; i < sym_order.length; i++) { + var doNotSerialize = false; var attributes = symbolizers[sym_order[i]]; var symbolizer = sym_order[i].split('/').pop(); @@ -108,49 +131,97 @@ tree.Definition.prototype.symbolizersToXML = function(env, symbolizers, zoom) { if (symbolizer === '*') continue; sym_count++; - var fail = tree.Reference.requiredProperties(symbolizer, attributes); + var fail = env.ref.requiredProperties(symbolizer, attributes); if (fail) { var rule = attributes[Object.keys(attributes).shift()]; - env.error({ + util.error(env, { message: fail, index: rule.index, filename: rule.filename }); } - var name = symbolizerName(symbolizer); + var name = symbolizerName(symbolizer), + symbolizerObject = {}, + symbolizerAttr = []; + + _.set(symbolizerObject, '_name', name); var selfclosing = true, tagcontent; - xml += ' <' + name + ' '; - for (var j in attributes) { - if (symbolizer === 'map') env.error({ + // iterate through attributes sorted by cartocss name + Object.keys(attributes).sort().forEach(function(j) { + if (symbolizer === 'map') util.error(env, { message: 'Map properties are not permitted in other rules', index: attributes[j].index, filename: attributes[j].filename }); - var x = tree.Reference.selector(attributes[j].name); + var x = env.ref.selector(attributes[j].name); if (x && x.serialization && x.serialization === 'content') { selfclosing = false; - tagcontent = attributes[j].ev(env).toXML(env, true); + tagcontent = attributes[j].ev(env).toObject(env, true); } else if (x && x.serialization && x.serialization === 'tag') { selfclosing = false; - tagcontent = attributes[j].ev(env).toXML(env, true); + tagcontent = attributes[j].ev(env).toObject(env, true); } else { - xml += attributes[j].ev(env).toXML(env) + ' '; + var attr = attributes[j].ev(env); + // if we have a rule for the whole symbolizer (default) with keyword none + // don't output the rule + if (env.ref.selectorName(attr.name) === 'default' && + attr.value.value[0].is === 'keyword') { + if (attr.value.value[0].value === 'none') { + doNotSerialize = true; + // still call toObject for validation + attr.toObject(env); + } + else if (attr.value.value[0].value === 'auto') { + // still call toObject for validation + attr.toObject(env); + } + } + + // only output attributes that don't use the keywords none and auto + if (!(attr.value.value[0].is === 'keyword' && + (attr.value.value[0].value === 'none' || attr.value.value[0].value === 'auto'))) { + symbolizerAttr.push(attr.toObject(env)); + } + else { + if (!_.has(x, 'type')) { + symbolizerAttr.push(attr.toObject(env)); + } + else if (x.type === 'string' || x.type === 'uri') { + symbolizerAttr.push(attr.toObject(env)); + } + } } + }); + + if (doNotSerialize) { + continue; } - if (selfclosing) { - xml += '/>\n'; - } else if (typeof tagcontent !== "undefined") { - if (tagcontent.indexOf('<') != -1) { - xml += '>' + tagcontent + '</' + name + '>\n'; - } else { - xml += '><![CDATA[' + tagcontent + ']]></' + name + '>\n'; - } + + if (symbolizerAttr.length) { + var attrObj = {}; + + _.forEach(symbolizerAttr, function (a) { + _.forOwn(a, function (v, k) { + attrObj[k] = v; + }); + }); + _.set(symbolizerObject, '_attributes', attrObj); + } + if (!selfclosing && typeof tagcontent !== 'undefined') { + _.set(symbolizerObject, '_content', tagcontent); + } + + if (Object.keys(symbolizerObject).length) { + ruleContent.push(symbolizerObject); } } - if (!sym_count || !xml) return ''; - return ' <Rule>\n' + xml + ' </Rule>\n'; + if (!sym_count || !ruleContent.length) return {}; + return { + '_name': 'Rule', + '_content': ruleContent + }; }; // Take a zoom range of zooms and 'i', the index of a rule in this.rules, @@ -184,12 +255,15 @@ tree.Definition.prototype.collectSymbolizers = function(zooms, i) { // when using the filter-mode="first", more specific zoom filters will always // end up before broader ranges. The filter-mode will pick those first before // resorting to the zoom range with the hole and stop processing further rules. -tree.Definition.prototype.toXML = function(env, existing) { +tree.Definition.prototype.toObject = function(env, existing) { var filter = this.filters.toString(); if (!(filter in existing)) existing[filter] = tree.Zoom.all; - var available = tree.Zoom.all, xml = '', symbolizers, + var available = tree.Zoom.all, + objects = [], + symbolizers, zooms = { available: tree.Zoom.all }; + for (var i = 0; i < this.rules.length && available; i++) { zooms.rule = this.rules[i].zoom; if (!(existing[filter] & zooms.rule)) continue; @@ -200,8 +274,8 @@ tree.Definition.prototype.toXML = function(env, existing) { symbolizers = this.collectSymbolizers(zooms, i); if (symbolizers) { if (!(existing[filter] & zooms.current)) continue; - xml += this.symbolizersToXML(env, symbolizers, - (new tree.Zoom()).setZoom(existing[filter] & zooms.current)); + objects.push(this.symbolizersToObject(env, symbolizers, + (new tree.Zoom()).setZoom(existing[filter] & zooms.current))); existing[filter] &= ~zooms.current; } } @@ -209,7 +283,8 @@ tree.Definition.prototype.toXML = function(env, existing) { while (zooms.current); } - return xml; + if (objects.length == 1) return objects[0]; + return objects; }; })(require('../tree')); diff --git a/lib/carto/tree/dimension.js b/lib/carto/tree/dimension.js index dad8ebb..4d1e707 100644 --- a/lib/carto/tree/dimension.js +++ b/lib/carto/tree/dimension.js @@ -1,12 +1,14 @@ (function(tree) { var _ = require('lodash'), - chroma = require('chroma-js'); + chroma = require('chroma-js'), + util = require('../util'); // // A number with a unit // -tree.Dimension = function Dimension(value, unit, index) { +tree.Dimension = function Dimension(value, unit, index, filename) { this.value = parseFloat(value); this.unit = unit || null; + this.filename = filename; this.index = index; }; @@ -24,9 +26,10 @@ tree.Dimension.prototype = { }, ev: function (env) { if (this.unit && !_.includes(this.all_units, this.unit)) { - env.error({ + util.error(env, { message: "Invalid unit: '" + this.unit + "'", - index: this.index + index: this.index, + filename: this.filename }); return { is: 'undefined', value: 'undefined' }; } @@ -34,9 +37,10 @@ tree.Dimension.prototype = { // normalize units which are not px or % if (this.unit && _.includes(this.physical_units, this.unit)) { if (!env.ppi) { - env.error({ + util.error(env, { message: "ppi is not set, so metric units can't be used", - index: this.index + index: this.index, + filename: this.filename }); return { is: 'undefined', value: 'undefined' }; } @@ -60,9 +64,10 @@ tree.Dimension.prototype = { }, operate: function(env, op, other) { if (this.unit === '%' && other.unit !== '%') { - env.error({ + util.error(env, { message: 'If two operands differ, the first must not be %', - index: this.index + index: this.index, + filename: this.filename }); return { is: 'undefined', @@ -72,9 +77,10 @@ tree.Dimension.prototype = { if (this.unit !== '%' && other.unit === '%') { if (op === '*' || op === '/' || op === '%') { - env.error({ + util.error(env, { message: 'Percent values can only be added or subtracted from other values', - index: this.index + index: this.index, + filename: this.filename }); return { is: 'undefined', @@ -84,12 +90,12 @@ tree.Dimension.prototype = { return new tree.Dimension(tree.operate(op, this.value, this.value * other.value * 0.01), - this.unit); + this.unit, this.index, this.filename); } //here the operands are either the same (% or undefined or px), or one is undefined and the other is px return new tree.Dimension(tree.operate(op, this.value, other.value), - this.unit || other.unit); + this.unit || other.unit, this.index, this.filename); } }; diff --git a/lib/carto/tree/expression.js b/lib/carto/tree/expression.js index 6060914..dfe1da0 100644 --- a/lib/carto/tree/expression.js +++ b/lib/carto/tree/expression.js @@ -1,5 +1,7 @@ (function(tree) { +var _ = require('lodash'); + tree.Expression = function Expression(value) { this.value = value; }; @@ -17,9 +19,20 @@ tree.Expression.prototype = { }, toString: function(env) { - return this.value.map(function(e) { - return e.toString(env); - }).join(' '); + var containsObj = false, + mappedVal = this.value.map(function(e) { + var result = e.toString(env); + + if (_.isObject(result)) { + containsObj = true; + } + return result; + }); + + if (containsObj) { + return mappedVal; + } + return mappedVal.join(' '); } }; diff --git a/lib/carto/tree/filter.js b/lib/carto/tree/filter.js index 97f1d4e..3f94476 100644 --- a/lib/carto/tree/filter.js +++ b/lib/carto/tree/filter.js @@ -1,5 +1,7 @@ (function(tree) { +var util = require('../util'); + tree.Filter = function Filter(key, op, val, index, filename) { this.key = key; this.op = op; @@ -10,14 +12,14 @@ tree.Filter = function Filter(key, op, val, index, filename) { this.id = this.key + this.op + this.val; }; -// xmlsafe, numeric, suffix +// xmlsafe (removed), numeric, suffix var ops = { - '<': [' < ', 'numeric'], - '>': [' > ', 'numeric'], + '<': [' < ', 'numeric'], + '>': [' > ', 'numeric'], '=': [' = ', 'both'], '!=': [' != ', 'both'], - '<=': [' <= ', 'numeric'], - '>=': [' >= ', 'numeric'], + '<=': [' <= ', 'numeric'], + '>=': [' >= ', 'numeric'], '=~': ['.match(', 'string', ')'] }; @@ -27,17 +29,17 @@ tree.Filter.prototype.ev = function(env) { return this; }; -tree.Filter.prototype.toXML = function(env) { - if (tree.Reference.data.filter) { - if (this.key.is === 'keyword' && -1 === tree.Reference.data.filter.value.indexOf(this.key.toString())) { - env.error({ +tree.Filter.prototype.toObject = function(env) { + if (env.ref.data.filter) { + if (this.key.is === 'keyword' && -1 === env.ref.data.filter.value.indexOf(this.key.toString())) { + util.error(env, { message: this.key.toString() + ' is not a valid keyword in a filter expression', index: this.index, filename: this.filename }); } - if (this.val.is === 'keyword' && -1 === tree.Reference.data.filter.value.indexOf(this.val.toString())) { - env.error({ + if (this.val.is === 'keyword' && -1 === env.ref.data.filter.value.indexOf(this.val.toString())) { + util.error(env, { message: this.val.toString() + ' is not a valid keyword in a filter expression', index: this.index, filename: this.filename @@ -51,7 +53,7 @@ tree.Filter.prototype.toXML = function(env) { (ops[this.op][1] == 'numeric' && isNaN(val) && this.val.is !== 'field') || (ops[this.op][1] == 'string' && (val)[0] != "'") ) { - env.error({ + util.error(env, { message: 'Cannot use operator "' + this.op + '" with value ' + this.val, index: this.index, filename: this.filename diff --git a/lib/carto/tree/filterset.js b/lib/carto/tree/filterset.js index cb79390..a72ebc3 100644 --- a/lib/carto/tree/filterset.js +++ b/lib/carto/tree/filterset.js @@ -1,18 +1,22 @@ -var tree = require('../tree'); +var tree = require('../tree'), + util = require('../util'); tree.Filterset = function Filterset() { this.filters = {}; }; -tree.Filterset.prototype.toXML = function(env) { +tree.Filterset.prototype.toObject = function(env) { var filters = []; for (var id in this.filters) { - filters.push('(' + this.filters[id].toXML(env).trim() + ')'); + filters.push('(' + this.filters[id].toObject(env).trim() + ')'); } if (filters.length) { - return ' <Filter>' + filters.join(' and ') + '</Filter>\n'; + return { + '_name': 'Filter', + '_content': filters.join(' and ') + }; } else { - return ''; + return {}; } }; @@ -31,10 +35,12 @@ tree.Filterset.prototype.ev = function(env) { for (var i2 in this.filters) { var err = result.add(this.filters[i2]); if (err) { - var filename = this.filters[i2].filename; - if (filename) - err = filename + ': ' + err; - throw new Error(err); + util.error(env, { + message: err, + filename: this.filters[i2].filename, + index: this.filters[i2].index + }); + throw new Error('N/A'); } } this.filters = result.filters; @@ -98,9 +104,12 @@ tree.Filterset.prototype.cloneWith = function(other) { // false tree.Filterset.prototype.addable = function(filter) { var key = filter.key.toString(), - value = filter.val.toString(); + value = filter.val.toString(), + valueIsNull = filter.val.is == 'keyword' && value == 'null'; - if (value.match(/^[+-]?[0-9]+(\.[0-9]*)?$/)) value = parseFloat(value); + if (value.match(/^[+-]?[0-9]+(\.[0-9]*)?([e|E][+-]?[0-9]+)?$/)) { + value = parseFloat(value); + } switch (filter.op) { case '=': @@ -113,10 +122,10 @@ tree.Filterset.prototype.addable = function(filter) { } } if (this.filters[key + '!=' + value] !== undefined) return false; - if (this.filters[key + '>'] !== undefined && this.filters[key + '>'].val >= value) return false; - if (this.filters[key + '<'] !== undefined && this.filters[key + '<'].val <= value) return false; - if (this.filters[key + '>='] !== undefined && this.filters[key + '>='].val > value) return false; - if (this.filters[key + '<='] !== undefined && this.filters[key + '<='].val < value) return false; + if (this.filters[key + '>'] !== undefined && (this.filters[key + '>'].val >= value || valueIsNull)) return false; + if (this.filters[key + '<'] !== undefined && (this.filters[key + '<'].val <= value || valueIsNull)) return false; + if (this.filters[key + '>='] !== undefined && (this.filters[key + '>='].val > value || valueIsNull)) return false; + if (this.filters[key + '<='] !== undefined && (this.filters[key + '<='].val < value || valueIsNull)) return false; return true; case '=~': @@ -125,20 +134,22 @@ tree.Filterset.prototype.addable = function(filter) { case '!=': if (this.filters[key + '='] !== undefined) return (this.filters[key + '='].val == value) ? false : null; if (this.filters[key + '!=' + value] !== undefined) return null; - if (this.filters[key + '>'] !== undefined && this.filters[key + '>'].val >= value) return null; - if (this.filters[key + '<'] !== undefined && this.filters[key + '<'].val <= value) return null; - if (this.filters[key + '>='] !== undefined && this.filters[key + '>='].val > value) return null; - if (this.filters[key + '<='] !== undefined && this.filters[key + '<='].val < value) return null; + if (this.filters[key + '>'] !== undefined && (this.filters[key + '>'].val >= value || valueIsNull)) return null; + if (this.filters[key + '<'] !== undefined && (this.filters[key + '<'].val <= value || valueIsNull)) return null; + if (this.filters[key + '>='] !== undefined && (this.filters[key + '>='].val > value || valueIsNull)) return null; + if (this.filters[key + '<='] !== undefined && (this.filters[key + '<='].val < value || valueIsNull)) return null; return true; case '>': - if (key + '=' in this.filters) { - if (this.filters[key + '='].val <= value) { + if (this.filters[key + '='] !== undefined) { + if (this.filters[key + '='].val <= value || + (this.filters[key + '='].val.is == 'keyword' && this.filters[key + '='].val.toString() == 'null')) { return false; } else { return null; } } + if (this.filters[key + '<'] !== undefined && this.filters[key + '<'].val <= value) return false; if (this.filters[key + '<='] !== undefined && this.filters[key + '<='].val <= value) return false; if (this.filters[key + '>'] !== undefined && this.filters[key + '>'].val >= value) return null; @@ -146,7 +157,15 @@ tree.Filterset.prototype.addable = function(filter) { return true; case '>=': - if (this.filters[key + '=' ] !== undefined) return (this.filters[key + '='].val < value) ? false : null; + if (this.filters[key + '=' ] !== undefined) { + if (this.filters[key + '='].val < value || + (this.filters[key + '='].val.is == 'keyword' && this.filters[key + '='].val.toString() == 'null')) { + return false; + } else { + return null; + } + } + if (this.filters[key + '<' ] !== undefined && this.filters[key + '<'].val <= value) return false; if (this.filters[key + '<='] !== undefined && this.filters[key + '<='].val < value) return false; if (this.filters[key + '>' ] !== undefined && this.filters[key + '>'].val >= value) return null; @@ -154,7 +173,15 @@ tree.Filterset.prototype.addable = function(filter) { return true; case '<': - if (this.filters[key + '=' ] !== undefined) return (this.filters[key + '='].val >= value) ? false : null; + if (this.filters[key + '=' ] !== undefined) { + if (this.filters[key + '='].val >= value || + (this.filters[key + '='].val.is == 'keyword' && this.filters[key + '='].val.toString() == 'null')) { + return false; + } else { + return null; + } + } + if (this.filters[key + '>' ] !== undefined && this.filters[key + '>'].val >= value) return false; if (this.filters[key + '>='] !== undefined && this.filters[key + '>='].val >= value) return false; if (this.filters[key + '<' ] !== undefined && this.filters[key + '<'].val <= value) return null; @@ -162,7 +189,15 @@ tree.Filterset.prototype.addable = function(filter) { return true; case '<=': - if (this.filters[key + '=' ] !== undefined) return (this.filters[key + '='].val > value) ? false : null; + if (this.filters[key + '=' ] !== undefined) { + if (this.filters[key + '='].val > value || + (this.filters[key + '='].val.is == 'keyword' && this.filters[key + '='].val.toString() == 'null')) { + return false; + } else { + return null; + } + } + if (this.filters[key + '>' ] !== undefined && this.filters[key + '>'].val >= value) return false; if (this.filters[key + '>='] !== undefined && this.filters[key + '>='].val > value) return false; if (this.filters[key + '<' ] !== undefined && this.filters[key + '<'].val <= value) return null; @@ -194,7 +229,7 @@ tree.Filterset.prototype.conflict = function(filter) { }; // Only call this function for filters that have been cleared by .addable(). -tree.Filterset.prototype.add = function(filter, env) { // eslint-disable-line +tree.Filterset.prototype.add = function(filter) { var key = filter.key.toString(), op = filter.op, conflict = this.conflict(filter), diff --git a/lib/carto/tree/fontset.js b/lib/carto/tree/fontset.js index d5a454e..6c530a8 100644 --- a/lib/carto/tree/fontset.js +++ b/lib/carto/tree/fontset.js @@ -1,12 +1,25 @@ (function(tree) { +tree._flattenFontArray = function (fonts) { + var result = []; + + for (var i = 0; i < fonts.length; i++) { + if (Array.isArray(fonts[i].value)) { + result = result.concat(tree._flattenFontArray(fonts[i].value)); + } else { + result.push(fonts[i]); + } + } + return result; +} + tree._getFontSet = function(env, fonts) { var fontKey = fonts.join(''); if (env._fontMap && env._fontMap[fontKey]) { return env._fontMap[fontKey]; } - var new_fontset = new tree.FontSet(env, fonts); + var new_fontset = new tree.FontSet(env, tree._flattenFontArray(fonts)); env.effects.push(new_fontset); if (!env._fontMap) env._fontMap = {}; env._fontMap[fontKey] = new_fontset; @@ -18,14 +31,21 @@ tree.FontSet = function FontSet(env, fonts) { this.name = 'fontset-' + env.effects.length; }; -tree.FontSet.prototype.toXML = function(env) { // eslint-disable-line - return '<FontSet name="' + - this.name + - '">\n' + - this.fonts.map(function(f) { - return ' <Font face-name="' + f +'"/>'; - }).join('\n') + - '\n</FontSet>'; +tree.FontSet.prototype.toObject = function() { + return { + '_name': 'FontSet', + '_attributes': { + name: this.name + }, + '_content': this.fonts.map(function (f) { + return { + '_name': 'Font', + '_attributes': { + 'face-name': f.value + } + } + }) + }; }; })(require('../tree')); diff --git a/lib/carto/tree/invalid.js b/lib/carto/tree/invalid.js index 40eea4a..ad37a7f 100644 --- a/lib/carto/tree/invalid.js +++ b/lib/carto/tree/invalid.js @@ -1,19 +1,22 @@ (function (tree) { -tree.Invalid = function Invalid(chunk, index, message) { + +var util = require('../util'); + +tree.Invalid = function Invalid(chunk, index, message, filename) { this.chunk = chunk; this.index = index; - this.type = 'syntax'; this.message = message || "Invalid code: " + this.chunk; + this.filename = filename; }; tree.Invalid.prototype.is = 'invalid'; tree.Invalid.prototype.ev = function(env) { - env.error({ + util.error(env, { chunk: this.chunk, index: this.index, - type: 'syntax', - message: this.message || "Invalid code: " + this.chunk + message: this.message || "Invalid code: " + this.chunk, + filename: this.filename }); return { is: 'undefined' diff --git a/lib/carto/tree/layer.js b/lib/carto/tree/layer.js index 3972051..52132c3 100644 --- a/lib/carto/tree/layer.js +++ b/lib/carto/tree/layer.js @@ -1,53 +1,70 @@ -var semver = require('semver'); +var semver = require('semver'), + _ = require('lodash'); (function(tree) { -tree.LayerXML = function(obj, styles) { - var dsoptions = []; +tree.LayerObject = function(obj, styles, apiVersion) { + var dsOptions = [], + layerAttr = {}, + layerContent = []; + for (var i in obj.Datasource) { - dsoptions.push('<Parameter name="' + i + '"><![CDATA[' + - obj.Datasource[i] + ']]></Parameter>'); + dsOptions.push({ + '_name': 'Parameter', + '_attributes': { + 'name': i + }, + '_content': obj.Datasource[i] + }); } - var apiVersion = tree.Reference.data['version']; - - var prop_string = ''; for (var prop in obj.properties) { if (prop === 'minzoom') { if (semver.gte(apiVersion, '3.0.0')) { - prop_string += ' maximum-scale-denominator="' + _.set(layerAttr, 'maximum-scale-denominator', tree.Zoom.ranges[obj.properties[prop]]); } else { - prop_string += ' maxzoom="' + _.set(layerAttr, 'maxzoom', tree.Zoom.ranges[obj.properties[prop]]); } - prop_string += tree.Zoom.ranges[obj.properties[prop]] + '"\n'; } else if (prop === 'maxzoom') { if (semver.gte(apiVersion, '3.0.0')) { - prop_string += ' minimum-scale-denominator="' + _.set(layerAttr, 'minimum-scale-denominator', tree.Zoom.ranges[obj.properties[prop]+1]); } else { - prop_string += ' minzoom="' + _.set(layerAttr, 'minzoom', tree.Zoom.ranges[obj.properties[prop]+1]); } - prop_string += tree.Zoom.ranges[obj.properties[prop]+1] + '"\n'; } else { - prop_string += ' ' + prop + '="' + obj.properties[prop] + '"\n'; + _.set(layerAttr, prop, obj.properties[prop]); } } - return '<Layer' + - ' name="' + obj.name + '"\n' + - prop_string + - ((typeof obj.status === 'undefined') ? '' : ' status="' + obj.status + '"\n') + - ((typeof obj.srs === 'undefined') ? '' : ' srs="' + obj.srs + '"') + '>\n ' + - styles.reverse().map(function(s) { - return '<StyleName>' + s + '</StyleName>'; - }).join('\n ') + - (dsoptions.length ? - '\n <Datasource>\n ' + - dsoptions.join('\n ') + - '\n </Datasource>\n' - : '') + - ' </Layer>\n'; + _.set(layerAttr, 'name', new tree.Quoted(obj.layerId).toString()); + if (typeof obj.status !== 'undefined') { + _.set(layerAttr, 'status', obj.status); + } + if (typeof obj.srs !== 'undefined') { + _.set(layerAttr, 'srs', obj.srs); + } + + _.forEach(styles.reverse(), function (s) { + layerContent.push({ + '_name': 'StyleName', + '_content': s + }); + }); + + if (dsOptions.length) { + layerContent.push({ + '_name': 'Datasource', + '_content': dsOptions + }); + } + + return { + '_name': 'Layer', + '_attributes': layerAttr, + '_content': layerContent + }; }; })(require('../tree')); diff --git a/lib/carto/tree/operation.js b/lib/carto/tree/operation.js index cfacfb3..473d785 100644 --- a/lib/carto/tree/operation.js +++ b/lib/carto/tree/operation.js @@ -2,10 +2,13 @@ // like 2 + 1. (function(tree) { -tree.Operation = function Operation(op, operands, index) { +var util = require('../util'); + +tree.Operation = function Operation(op, operands, index, filename) { this.op = op.trim(); this.operands = operands; this.index = index; + this.filename = filename; }; tree.Operation.prototype.is = 'operation'; @@ -26,10 +29,11 @@ tree.Operation.prototype.ev = function(env) { if (this.op === '*' || this.op === '+') { temp = b, b = a, a = temp; } else { - env.error({ + util.error(env, { name: "OperationError", message: "Can't substract or divide a color from a number", - index: this.index + index: this.index, + filename: this.filename }); } } @@ -37,10 +41,9 @@ tree.Operation.prototype.ev = function(env) { // Only concatenate plain strings, because this is easily // pre-processed if (a instanceof tree.Quoted && b instanceof tree.Quoted && this.op !== '+') { - env.error({ + util.error(env, { message: "Can't subtract, divide, or multiply strings.", index: this.index, - type: 'runtime', filename: this.filename }); return { @@ -53,10 +56,9 @@ tree.Operation.prototype.ev = function(env) { if (a instanceof tree.Field || b instanceof tree.Field || a instanceof tree.Literal || b instanceof tree.Literal) { if (a.is === 'color' || b.is === 'color') { - env.error({ + util.error(env, { message: "Can't subtract, divide, or multiply colors in expressions.", index: this.index, - type: 'runtime', filename: this.filename }); return { @@ -69,10 +71,9 @@ tree.Operation.prototype.ev = function(env) { } if (a.operate === undefined) { - env.error({ + util.error(env, { message: 'Cannot do math with type ' + a.is + '.', index: this.index, - type: 'runtime', filename: this.filename }); return { @@ -84,6 +85,10 @@ tree.Operation.prototype.ev = function(env) { return a.operate(env, this.op, b); }; +tree.Operation.prototype.toString = function () { + return this.operands[0].toString() + this.op + this.operands[1].toString(); +}; + tree.operate = function(op, a, b) { switch (op) { case '+': return a + b; diff --git a/lib/carto/tree/reference.js b/lib/carto/tree/reference.js index 0bfcacf..2fa03d1 100644 --- a/lib/carto/tree/reference.js +++ b/lib/carto/tree/reference.js @@ -1,72 +1,149 @@ -// Carto pulls in a reference from the `mapnik-reference` -// module. This file builds indexes from that file for its various +// Carto needs a reference to validate input. +// The reference can be either `mapnik-reference` or customly set. +// This file builds indexes from that file for its various // options, and provides validation methods for property: value // combinations. (function(tree) { var _ = require('lodash'), - mapnik_reference = require('mapnik-reference'), - ref = {}; - -ref.setData = function(data) { - ref.data = data; - ref.selector_cache = generateSelectorCache(data); - ref.mapnikFunctions = generateMapnikFunctions(data); - - ref.mapnikFunctions.matrix = [6]; - ref.mapnikFunctions.translate = [1, 2]; - ref.mapnikFunctions.scale = [1, 2]; - ref.mapnikFunctions.rotate = [1, 3]; - ref.mapnikFunctions.skewX = [1]; - ref.mapnikFunctions.skewY = [1]; - - ref.required_cache = generateRequiredProperties(data); + semver = require('semver'); + +tree.Reference = function Reference(ref) { + this.data = null; + this.selector_cache = []; + this.functions = []; + this.required_cache = []; + + if (!_.isNil(ref)) { + if (this.checkCompliance(ref)) { + this.compliant = true; + this.ref = ref; + } + // fall back to Mapnik reference if non-compliant reference was given + else { + this.compliant = false; + this.ref = require('mapnik-reference'); + } + } + // use Mapnik reference if no reference given + else { + this.compliant = true; + this.ref = require('mapnik-reference'); + } }; -ref.setVersion = function(version) { - try { - ref.setData(mapnik_reference.load(version)); +tree.Reference.prototype.checkCompliance = function (ref) { + if (_.has(ref, 'latest') && _.has(ref, 'versions') && + _.isArray(ref.versions) && _.has(ref, 'load') && + _.isFunction(ref.load)) { + var data = ref.load(ref.latest); + if (_.has(data, 'version') && _.isString(data.version) && + _.has(data, 'style') && _.isObject(data.style) && + _.has(data, 'layer') && _.isObject(data.layer) && + _.has(data, 'symbolizers') && _.isObject(data.symbolizers) && + _.has(data, 'colors') && _.isObject(data.colors) && + _.has(data, 'datasources') && _.isObject(data.datasources)) { + + return true; + } } - catch (err) { - var e = new Error('Mapnik version ' + version + ' is not supported'); - e.stack = null; // do not show stack trace - throw e; + + return false; +}; + +tree.Reference.prototype.getLatest = function () { + return this.ref.latest; +}; + +tree.Reference.prototype.setData = function (data) { + this.data = data; + this.selector_cache = generateSelectorCache(data); + this.functions = generateFunctions(data); + + this.functions.matrix = [6]; + this.functions.translate = [1, 2]; + this.functions.scale = [1, 2]; + this.functions.rotate = [1, 3]; + this.functions.skewX = [1]; + this.functions.skewY = [1]; + + this.required_cache = generateRequiredProperties(data); +}; + +tree.Reference.prototype.setVersion = function (version) { + if (semver.valid(version)) { + try { + this.setData(this.ref.load(version)); + } + catch (err) { + var e = new Error('Version ' + version + ' is not supported'); + e.stack = null; // do not show stack trace + throw e; + } + } + else { + var apiErr = new Error('Invalid API version. A valid version is e.g. 3.0.0 or 3.0.10'); + apiErr.stack = null; // do not show stack trace + throw apiErr; } }; -ref.selectorData = function(selector, i) { - if (ref.selector_cache[selector]) return ref.selector_cache[selector][i]; +tree.Reference.prototype.selectorData = function (selector, i) { + if (this.selector_cache[selector]) return this.selector_cache[selector][i]; }; -ref.validSelector = function(selector) { return !!ref.selector_cache[selector]; }; -ref.selectorName = function(selector) { return ref.selectorData(selector, 2); }; -ref.selector = function(selector) { return ref.selectorData(selector, 0); }; -ref.symbolizer = function(selector) { return ref.selectorData(selector, 1); }; +tree.Reference.prototype.validSelector = function (selector) { return !!this.selector_cache[selector]; }; +tree.Reference.prototype.selectorName = function (selector) { return this.selectorData(selector, 3); }; +tree.Reference.prototype.selector = function (selector) { return this.selectorData(selector, 1); }; +tree.Reference.prototype.symbolizer = function (selector) { return this.selectorData(selector, 2); }; function generateSelectorCache(data) { var index = {}; - for (var i in data.symbolizers) { - for (var j in data.symbolizers[i]) { - if (data.symbolizers[i][j].hasOwnProperty('css')) { - index[data.symbolizers[i][j].css] = [data.symbolizers[i][j], i, j]; - } + _.forEach(data.style, function (rule, i) { + if (_.has(rule, 'css')) { + index[rule.css] = ['style', rule, '*', i]; } - } + }); + _.forEach(data.layer, function (rule, i) { + if (_.has(rule, 'css')) { + index[rule.css] = ['layer', rule, '*', i]; + } + }); + _.forEach(data.symbolizers, function (symbolizer, i) { + _.forEach(symbolizer, function (rule, j) { + if (_.has(rule, 'css')) { + index[rule.css] = ['symbolizer', rule, i, j]; + } + }); + }); return index; } -function generateMapnikFunctions(data) { +function generateFunctions(data) { var functions = {}; - for (var i in data.symbolizers) { - for (var j in data.symbolizers[i]) { - if (data.symbolizers[i][j].type === 'functions') { - for (var k = 0; k < data.symbolizers[i][j].functions.length; k++) { - var fn = data.symbolizers[i][j].functions[k]; - functions[fn[0]] = fn[1]; - } - } + _.forEach(data.style, function (rule) { + if (rule.type === 'functions') { + _.forEach(rule.functions, function (func) { + functions[func[0]] = func[1]; + }); } - } + }); + _.forEach(data.layer, function (rule) { + if (rule.type === 'functions') { + _.forEach(rule.functions, function (func) { + functions[func[0]] = func[1]; + }); + } + }); + _.forEach(data.symbolizers, function (symbolizer) { + _.forEach(symbolizer, function (rule) { + if (rule.type === 'functions') { + _.forEach(rule.functions, function (func) { + functions[func[0]] = func[1]; + }); + } + }); + }); return functions; } @@ -83,8 +160,20 @@ function generateRequiredProperties(data) { return cache; } -ref.requiredProperties = function(symbolizer_name, rules) { - var req = ref.required_cache[symbolizer_name]; +tree.Reference.prototype.requiredProperties = function (symbolizer_name, rules) { + var that = this, + doNotSerialize = false; + + _.forEach(rules, function (rule) { + if (that.selectorName(rule.name) === 'default') { + doNotSerialize = true; + } + }); + if (doNotSerialize) { + return null; + } + + var req = this.required_cache[symbolizer_name]; for (var i in req) { if (!(req[i] in rules)) { return 'Property ' + req[i] + ' required for defining ' + @@ -94,7 +183,7 @@ ref.requiredProperties = function(symbolizer_name, rules) { }; // TODO: finish implementation - this is dead code -ref._validateValue = { +tree.Reference.prototype._validateValue = { 'font': function(env, value) { if (env.validation_data && env.validation_data.fonts) { return env.validation_data.fonts.indexOf(value) != -1; @@ -104,12 +193,12 @@ ref._validateValue = { } }; -ref.isFont = function(selector) { - return ref.selector(selector).validate == 'font'; +tree.Reference.prototype.isFont = function (selector) { + return this.selector(selector).validate == 'font'; }; // https://gist.github.com/982927 -ref.editDistance = function(a, b){ +tree.Reference.prototype.editDistance = function (a, b){ if (a.length === 0) return b.length; if (b.length === 0) return a.length; var matrix = []; @@ -129,7 +218,7 @@ ref.editDistance = function(a, b){ return matrix[b.length][a.length]; }; -function validateFunctions(value, selector) { +function validateFunctions(ref, value, selector) { if (value.value[0].is === 'string') return true; for (var i in value.value) { for (var j in value.value[i].value) { @@ -147,35 +236,46 @@ function validateFunctions(value, selector) { return true; } -function validateKeyword(value, selector) { +function validateKeyword(ref, value, selector) { if (typeof ref.selector(selector).type === 'object') { return ref.selector(selector).type .indexOf(value.value[0].value) !== -1; } else { // allow unquoted keywords as strings - return ref.selector(selector).type === 'string'; + return ref.selector(selector).type === 'string' || + ref.selector(selector)['default-value'] === value.value[0].value; } } -ref.validValue = function(env, selector, value) { +tree.Reference.prototype.selectorStatus = function (selector) { + var selectorRef = this.selector(selector); + + if (_.has(selectorRef, 'status')) { + return selectorRef.status; + } + + return 'stable'; +}; + +tree.Reference.prototype.validValue = function (env, selector, value) { var i; // TODO: handle in reusable way - if (!ref.selector(selector)) { + if (!this.selector(selector)) { return false; } else if (value.value[0].is == 'keyword') { - return validateKeyword(value, selector); + return validateKeyword(this, value, selector); } else if (value.value[0].is == 'undefined') { // caught earlier in the chain - ignore here so that // error is not overridden return true; - } else if (ref.selector(selector).type == 'numbers') { + } else if (this.selector(selector).type == 'numbers') { for (i in value.value) { if (value.value[i].is !== 'float') { return false; } } return true; - } else if (ref.selector(selector).type == 'tags') { + } else if (this.selector(selector).type == 'tags') { if (!value.value) return false; if (!value.value[0].value) { return value.value[0].is === 'tag'; @@ -184,35 +284,31 @@ ref.validValue = function(env, selector, value) { if (value.value[0].value[i].is !== 'tag') return false; } return true; - } else if (ref.selector(selector).type == 'functions') { + } else if (this.selector(selector).type == 'functions') { // For backwards compatibility, you can specify a string for `functions`-compatible // values, though they will not be validated. - return validateFunctions(value, selector); - } else if (ref.selector(selector).type === 'unsigned') { + return validateFunctions(this.ref, value, selector); + } else if (this.selector(selector).type === 'unsigned') { if (value.value[0].is === 'float') { value.value[0].round(); return true; } else { return false; } - } else if ((ref.selector(selector).expression)) { + } else if ((this.selector(selector).expression)) { return true; } else { - if (ref.selector(selector).validate) { - var valid = false; + if (this.selector(selector).validate) { for (i = 0; i < value.value.length; i++) { - if (ref.selector(selector).type == value.value[i].is && - ref._validateValue[ref.selector(selector).validate](env, value.value[i].value)) { + if (this.selector(selector).type == value.value[i].is && + this._validateValue[this.selector(selector).validate](env, value.value[i].value)) { return true; } } - return valid; + return false; } else { - return ref.selector(selector).type == value.value[0].is; + return this.selector(selector).type == value.value[0].is; } } }; - -tree.Reference = ref; - })(require('../tree')); diff --git a/lib/carto/tree/rule.js b/lib/carto/tree/rule.js index c72e05f..3824eb9 100644 --- a/lib/carto/tree/rule.js +++ b/lib/carto/tree/rule.js @@ -1,15 +1,19 @@ (function(tree) { + +var util = require('../util'), + _ = require('lodash'); + // a rule is a single property and value combination, or variable // name and value combination, like // polygon-opacity: 1.0; or @opacity: 1.0; -tree.Rule = function Rule(name, value, index, filename) { +tree.Rule = function Rule(ref, name, value, index, filename) { var parts = name.split('/'); this.name = parts.pop(); this.instance = parts.length ? parts[0] : '__default__'; this.value = (value instanceof tree.Value) ? value : new tree.Value([value]); this.index = index; - this.symbolizer = tree.Reference.symbolizer(this.name); + this.symbolizer = ref.symbolizer(this.name); this.filename = filename; this.variable = (name.charAt(0) === '@'); }; @@ -36,82 +40,131 @@ tree.Rule.prototype.toString = function() { return '[' + tree.Zoom.toString(this.zoom) + '] ' + this.name + ': ' + this.value; }; -function getMean(name) { - return Object.keys(tree.Reference.selector_cache).map(function(f) { - return [f, tree.Reference.editDistance(name, f)]; - }).sort(function(a, b) { return a[1] - b[1]; }); -} +tree.Rule.prototype.validate = function (env) { + var valid = true; -// second argument, if true, outputs the value of this -// rule without the usual attribute="content" wrapping. Right -// now this is just for the TextSymbolizer, but applies to other -// properties in reference.json which specify serialization=content -tree.Rule.prototype.toXML = function(env, content, sep, format) { // eslint-disable-line - if (!tree.Reference.validSelector(this.name)) { - var mean = getMean(this.name); - var mean_message = ''; - if (mean[0][1] < 3) { - mean_message = '. Did you mean ' + mean[0][0] + '?'; + if (!env.ref.validSelector(this.name)) { + var mean = getMean(this.name, env.ref); + var mean_message = '.'; + if (!_.isNil(mean) && !_.isEmpty(mean)) { + if (mean[0][1] < 3) { + mean_message = '. Did you mean ' + mean[0][0] + '?'; + } } - return env.error({ + valid = false; + util.error(env, { message: "Unrecognized rule: " + this.name + mean_message, index: this.index, - type: 'syntax', filename: this.filename }); } + else { + var selectorStatus = env.ref.selectorStatus(this.name); + if (selectorStatus !== 'stable') { + if (selectorStatus === 'deprecated') { + util.warning(env, { + message: this.name + ' is deprecated. It may be removed in the future.', + filename: this.filename, + index: this.index + }); + } + else if (selectorStatus === 'unstable') { + util.warning(env, { + message: this.name + ' is unstable. It may change in the future.', + filename: this.filename, + index: this.index + }); + } + else if (selectorStatus === 'experimental') { + util.warning(env, { + message: this.name + ' is experimental. It may change, be renamed or removed in the future.', + filename: this.filename, + index: this.index + }); + } + } - if ((this.value instanceof tree.Value) && - !tree.Reference.validValue(env, this.name, this.value)) { - if (!tree.Reference.selector(this.name)) { - return env.error({ - message: 'Unrecognized property: ' + - this.name, - index: this.index, - type: 'syntax', - filename: this.filename - }); - } else { - var typename; - if (tree.Reference.selector(this.name).validate) { - typename = tree.Reference.selector(this.name).validate; - } else if (typeof tree.Reference.selector(this.name).type === 'object') { - typename = 'keyword (options: ' + tree.Reference.selector(this.name).type.join(', ') + ')'; + if ((this.value instanceof tree.Value) && + !env.ref.validValue(env, this.name, this.value)) { + if (!env.ref.selector(this.name)) { + valid = false; + util.error(env, { + message: 'Unrecognized property: ' + + this.name, + index: this.index, + filename: this.filename + }); } else { - typename = tree.Reference.selector(this.name).type; + var typename; + if (env.ref.selector(this.name).validate) { + typename = env.ref.selector(this.name).validate; + } else if (typeof env.ref.selector(this.name).type === 'object') { + typename = 'keyword (options: ' + env.ref.selector(this.name).type.join(', ') + ')'; + } else { + typename = env.ref.selector(this.name).type; + } + + if (typename !== 'font' || + (typename === 'font' && this.value.value[0].is !== 'string')) { + valid = false; + util.error(env, { + message: 'Invalid value for ' + + this.name + + ', the type ' + typename + + ' is expected. ' + this.value + + ' (of type ' + this.value.value[0].is + ') was given.', + index: this.index, + filename: this.filename + }); + } + else { + valid = false; + util.error(env, { + message: 'The font \'' + + this.value + + '\' (specified as text-face-name) is not a known font on your system,' + + ' please provide an existing font face name.', + index: this.index, + filename: this.filename + }); + } } - return env.error({ - message: 'Invalid value for ' + - this.name + - ', the type ' + typename + - ' is expected. ' + this.value + - ' (of type ' + this.value.value[0].is + ') ' + - ' was given.', - index: this.index, - type: 'syntax', - filename: this.filename - }); } } - if (this.variable) { - return ''; - } else if (tree.Reference.isFont(this.name) && this.value.value.length > 1) { - var f = tree._getFontSet(env, this.value.value); - return 'fontset-name="' + f.name + '"'; - } else if (content) { - return this.value.toString(env, this.name, sep); - } else { - return tree.Reference.selectorName(this.name) + - '="' + - this.value.toString(env, this.name) + - '"'; + return valid; +} + +function getMean(name, ref) { + return Object.keys(ref.selector_cache).map(function(f) { + return [f, ref.editDistance(name, f)]; + }).sort(function(a, b) { return a[1] - b[1]; }); +} + +// second argument, if true, outputs the value of this +// rule without the usual attribute="content" wrapping. Right +// now this is just for the TextSymbolizer, but applies to other +// properties in reference.json which specify serialization=content +tree.Rule.prototype.toObject = function(env, content, sep) { + if (this.validate(env)) { + if (this.variable) { + return {}; + } else if (env.ref.isFont(this.name) && this.value.value.length > 1) { + var f = tree._getFontSet(env, this.value.value); + return _.set({}, 'fontset-name', f.name); + } else if (content) { + return this.value.toString(env, this.name, sep); + } else { + return _.set({}, env.ref.selectorName(this.name), this.value.toString(env, this.name)); + } } + + return {}; }; // TODO: Rule ev chain should add fontsets to env.frames tree.Rule.prototype.ev = function(context) { - return new tree.Rule(this.name, + return new tree.Rule(context.ref, this.name, this.value.ev(context), this.index, this.filename); diff --git a/lib/carto/tree/ruleset.js b/lib/carto/tree/ruleset.js index 5851ca4..654ebab 100644 --- a/lib/carto/tree/ruleset.js +++ b/lib/carto/tree/ruleset.js @@ -1,5 +1,7 @@ (function(tree) { +var util = require('../util'); + tree.Ruleset = function Ruleset(selectors, rules) { this.selectors = selectors; this.rules = rules; @@ -155,7 +157,7 @@ tree.Ruleset.prototype = { } else if (rule instanceof tree.Rule) { rules.push(rule); } else if (rule instanceof tree.Invalid) { - env.error(rule); + util.error(env, rule); } } @@ -167,7 +169,7 @@ tree.Ruleset.prototype = { if (index !== false) { selectors[i].index = index; } - result.push(new tree.Definition(selectors[i], rules.slice())); + result.push(new tree.Definition(env, selectors[i], rules.slice())); } return result; diff --git a/lib/carto/tree/style.js b/lib/carto/tree/style.js index 0d8e66e..ce110dd 100644 --- a/lib/carto/tree/style.js +++ b/lib/carto/tree/style.js @@ -2,23 +2,32 @@ var _ = require('lodash'); // Given a style's name, attachment, definitions, and an environment object, -// return a stringified style for Mapnik -tree.StyleXML = function(name, attachment, definitions, env) { +// return a style object resembling Mapnik XML +tree.StyleObject = function(name, attachment, definitions, env) { var existing = {}; var image_filters = [], image_filters_inflate = [], direct_image_filters = [], comp_op = [], opacity = []; for (var i = 0; i < definitions.length; i++) { for (var j = 0; j < definitions[i].rules.length; j++) { - if (definitions[i].rules[j].name === 'image-filters') { + var isNone = false; + + if (_.has(definitions[i].rules[j].value.value[0], 'value') && + _.has(definitions[i].rules[j].value.value[0].value[0], 'is') && + definitions[i].rules[j].value.value[0].value[0].is === 'keyword' && + definitions[i].rules[j].value.value[0].value[0].value === 'none') { + isNone = true; + } + + if (definitions[i].rules[j].name === 'image-filters' && !isNone) { image_filters.push(definitions[i].rules[j]); } if (definitions[i].rules[j].name === 'image-filters-inflate') { image_filters_inflate.push(definitions[i].rules[j]); } - if (definitions[i].rules[j].name === 'direct-image-filters') { + if (definitions[i].rules[j].name === 'direct-image-filters' && !isNone) { direct_image_filters.push(definitions[i].rules[j]); } - if (definitions[i].rules[j].name === 'comp-op') { + if (definitions[i].rules[j].name === 'comp-op' && !isNone) { comp_op.push(definitions[i].rules[j]); } if (definitions[i].rules[j].name === 'opacity') { @@ -27,42 +36,61 @@ tree.StyleXML = function(name, attachment, definitions, env) { } } - var rules = definitions.map(function(definition) { - return definition.toXML(env, existing); + var styleContent = definitions.map(function(definition) { + return definition.toObject(env, existing); + }).filter(function (definition) { + // filter empty + if (_.isArray(definition) && !definition.length) { + return false; + } + else if (!Object.keys(definition).length) { + return false; + } + return true; }); - var attrs_xml = ''; + var styleAttrs = {}; if (image_filters.length) { - attrs_xml += ' image-filters="' + _.chain(image_filters) + _.set(styleAttrs, 'image-filters', _.chain(image_filters) // prevent identical filters from being duplicated in the style .uniq(function(i) { return i.id; }).map(function(f) { - return f.ev(env).toXML(env, true, ',', 'image-filter'); - }).value().join(',') + '"'; + return f.ev(env).toObject(env, true, ',', 'image-filter'); + }).value().join(',')); } if (image_filters_inflate.length) { - attrs_xml += ' image-filters-inflate="' + image_filters_inflate[0].value.ev(env).toString() + '"'; + _.set(styleAttrs, 'image-filters-inflate', image_filters_inflate[0].value.ev(env).toString()); } if (direct_image_filters.length) { - attrs_xml += ' direct-image-filters="' + _.chain(direct_image_filters) + _.set(styleAttrs, 'direct-image-filters', _.chain(direct_image_filters) // prevent identical filters from being duplicated in the style .uniq(function(i) { return i.id; }).map(function(f) { - return f.ev(env).toXML(env, true, ',', 'direct-image-filter'); - }).value().join(',') + '"'; + return f.ev(env).toObject(env, true, ',', 'direct-image-filter'); + }).value().join(',')); } if (comp_op.length && comp_op[0].value.ev(env).value != 'src-over') { - attrs_xml += ' comp-op="' + comp_op[0].value.ev(env).toString() + '"'; + _.set(styleAttrs, 'comp-op', comp_op[0].value.ev(env).toString()); } if (opacity.length && opacity[0].value.ev(env).value != 1) { - attrs_xml += ' opacity="' + opacity[0].value.ev(env).toString() + '"'; + _.set(styleAttrs, 'opacity', opacity[0].value.ev(env).toString()); + } + + if (!Object.keys(styleAttrs).length && !styleContent.length) { + return {}; + } + + _.set(styleAttrs, 'name', new tree.Quoted(name).toString()); + _.set(styleAttrs, 'filter-mode', 'first'); + + return { + '_name': 'Style', + '_attributes': styleAttrs, + '_content': styleContent } - var rule_string = rules.join(''); - if (!attrs_xml && !rule_string) return ''; - return '<Style name="' + name + '" filter-mode="first"' + attrs_xml + '>\n' + rule_string + '</Style>'; }; })(require('../tree')); diff --git a/lib/carto/tree/value.js b/lib/carto/tree/value.js index 5fb0a39..4ecbbfe 100644 --- a/lib/carto/tree/value.js +++ b/lib/carto/tree/value.js @@ -1,5 +1,7 @@ (function(tree) { +var _ = require('lodash'); + tree.Value = function Value(value) { this.value = value; }; @@ -16,9 +18,20 @@ tree.Value.prototype = { } }, toString: function(env, selector, sep, format) { - return this.value.map(function(e) { - return e.toString(env, format); - }).join(sep || ', '); + var containsObj = false, + mappedVal = this.value.map(function(e) { + var result = e.toString(env, format); + + if (_.isObject(result)) { + containsObj = true; + } + return result; + }); + + if (containsObj) { + return _.flatten(mappedVal); + } + return mappedVal.join(sep || ', '); }, clone: function() { var obj = Object.create(tree.Value.prototype); diff --git a/lib/carto/tree/variable.js b/lib/carto/tree/variable.js index 3e3cad0..abacb82 100644 --- a/lib/carto/tree/variable.js +++ b/lib/carto/tree/variable.js @@ -1,5 +1,7 @@ (function(tree) { +var util = require('../util'); + tree.Variable = function Variable(name, index, filename) { this.name = name; this.index = index; @@ -18,12 +20,11 @@ tree.Variable.prototype = { return f.name == this.name; }.bind(this)); if (thisframe.length) { - return thisframe[0].value.ev(env); + return thisframe[thisframe.length - 1].value.ev(env); } else { - env.error({ + util.error(env, { message: 'variable ' + this.name + ' is undefined', index: this.index, - type: 'runtime', filename: this.filename }); return { diff --git a/lib/carto/tree/zoom.js b/lib/carto/tree/zoom.js index dcdc351..50b39c2 100644 --- a/lib/carto/tree/zoom.js +++ b/lib/carto/tree/zoom.js @@ -1,12 +1,14 @@ -var tree = require('../tree'); +var tree = require('../tree'), + util = require('../util'); // Storage for zoom ranges. Only supports continuous ranges, // and stores them as bit-sequences so that they can be combined, // inverted, and compared quickly. -tree.Zoom = function(op, value, index) { +tree.Zoom = function(op, value, index, filename) { this.op = op; this.value = value; this.index = index; + this.filename = filename; }; tree.Zoom.prototype.setZoom = function(zoom) { @@ -21,10 +23,11 @@ tree.Zoom.prototype.ev = function(env) { zoom = 0; if (value > tree.Zoom.maxZoom || value < 0) { - env.error({ + util.error(env, { message: 'Only zoom levels between 0 and ' + tree.Zoom.maxZoom + ' supported.', - index: this.index + index: this.index, + filename: this.filename }); } @@ -54,10 +57,6 @@ tree.Zoom.prototype.ev = function(env) { return this; }; -tree.Zoom.prototype.toString = function() { - return this.zoom; -}; - tree.Zoom.maxZoom = 25; // Covers all zoomlevels from 0 to maxZoom @@ -94,7 +93,7 @@ tree.Zoom.ranges = { }; // Only works for single range zooms. `[XXX....XXXXX.........]` is invalid. -tree.Zoom.prototype.toXML = function() { +tree.Zoom.prototype.toObject = function() { var conditions = []; if (this.zoom != tree.Zoom.all) { var start = null, end = null; @@ -104,10 +103,18 @@ tree.Zoom.prototype.toXML = function() { end = i; } } - if (start > 0) conditions.push(' <MaxScaleDenominator>' + - tree.Zoom.ranges[start] + '</MaxScaleDenominator>\n'); - if (end < tree.Zoom.maxZoom) conditions.push(' <MinScaleDenominator>' + - tree.Zoom.ranges[end + 1] + '</MinScaleDenominator>\n'); + if (start > 0) { + conditions.push({ + '_name': 'MaxScaleDenominator', + '_content': tree.Zoom.ranges[start] + }); + } + if (end < tree.Zoom.maxZoom) { + conditions.push({ + '_name': 'MinScaleDenominator', + '_content': tree.Zoom.ranges[end + 1] + }); + } } return conditions; }; diff --git a/lib/carto/util.js b/lib/carto/util.js new file mode 100644 index 0000000..1f49391 --- /dev/null +++ b/lib/carto/util.js @@ -0,0 +1,178 @@ +var _ = require('lodash'); + +var Util = function () { + this.processMessage = function (env, message) { + if (!env.msg) { + env.msg = []; + } + + if (message.type === 'error' || + (message.type === 'warning' && !env.quiet)) { + if (!_.isNil(message.filename) && !_.isNil(message.index) && + env.inputs && env.inputs[message.filename]) { + _.assign(message, this.getLineColumn(env.inputs[message.filename], message.index)); + _.unset(message.index); + } + + // add to messages collection if it not already exists + if (_.isNil(_.find(env.msg, function (v) { + return message.message === v.message && + message.filename === v.filename && + message.line === v.line && + message.column === v.column && + message.type === v.type; + }))) { + env.msg.push(message); + } + } + }; +}; + +Util.prototype.getLineColumn = function (input, index) { + var lineCol = { + line: 0, + column: -1 + }; + + if (!_.isNil(input) && !_.isNil(index)) { + lineCol.line = (input.slice(0, index).match(/\n/g) || '').length + 1; + for (var n = index; n >= 0 && input.charAt(n) !== '\n'; n--) { + lineCol.column++; + } + } + + return lineCol; +}; + +Util.prototype.hasErrors = function (messages) { + return typeof _.find(messages, ['type', 'error']) !== 'undefined'; +}; + +Util.prototype.getMessagesToPrint = function (messages) { + var messageOutput = '', + that = this; + + _.forEach(messages, function (v) { + messageOutput += that.getMessageToPrint(v) + '\n'; + }); + + return messageOutput.trim(); +}; + +Util.prototype.getMessageToPrint = function (message) { + var messageOutput = ''; + + message.type = message.type.charAt(0).toUpperCase() + message.type.slice(1); + + if (!_.isNil(message.filename)) { + if (message.line >= 0) { + if (message.column >= 0) { + messageOutput = _.template('<%=type%>: <%=filename%>:<%=line%>:<%=column%> <%=message%>')(message); + } + else { + messageOutput = _.template('<%=type%>: <%=filename%>:<%=line%> <%=message%>')(message); + } + } + else { + messageOutput = _.template('<%=type%>: <%=filename%> <%=message%>')(message); + } + } + else { + messageOutput = _.template('<%=type%>: <%=message%>')(message); + } + + return messageOutput; +}; + +Util.prototype.warning = function (env, message) { + _(message).defaults({ + type: 'warning', + message: 'Unspecified warning.', + filename: null, + line: -1, + column: -1 + }).value(); + + this.processMessage(env, message); +}; + +Util.prototype.error = function (env, message) { + _(message).defaults({ + type: 'error', + message: 'Unspecified error.', + filename: null, + line: -1, + column: -1 + }).value(); + + this.processMessage(env, message); +} + +Util.prototype.jsonToXML = function (json, level) { + var that = this, + intendation = ''; + + if (typeof level === 'undefined') { + level = 0; + } + for (var i = 0; i < level; i++) { + intendation += ' '; + } + + if (_.isObject(json) && !_.isArray(json)) { + if (_.has(json, '_name')) { + var output = intendation + '<' + json._name; + + if (_.has(json, '_attributes') && Object.keys(json._attributes).length) { + var attributes = []; + + // output attributes sorted in alphabetical order + Object.keys(json._attributes).sort().forEach(function (v) { + attributes.push(v + '="' + json._attributes[v] + '"'); + }); + output += ' ' + attributes.join(' '); + } + + if (_.has(json, '_content')) { + var content = that.jsonToXML(json._content, level + 1); + + // check if there are subtags + if (content.indexOf('</') == -1 && content.indexOf('/>') == -1) { + output += '>' + content + '</' + json._name + '>\n'; + } + else { + output += '>\n' + content; + output += intendation + '</' + json._name + '>\n'; + } + + } + else { + output += ' />\n'; + } + return output; + } + } + else if (_.isArray(json)) { + if (json.length) { + if (_.isObject(json[0])) { + return json.map(function (o) { + return that.jsonToXML(o, level); + }).join(''); + } + else { + return json.join(','); + } + } + } + else { + if (_.isString(json)) { + return '<![CDATA[' + json + ']]>'; + } + else if (!_.isNil(json)) { + return json.toString(); + } + } + return ''; +}; + +module.exports = new Util(); diff --git a/man/carto.1 b/man/carto.1 index 35f1acf..8281fa9 100644 --- a/man/carto.1 +++ b/man/carto.1 @@ -1,24 +1,52 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.12. -.TH CARTO "1" "March 2013" "carto 0.9.4" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3. +.TH CARTO "1" "July 2017" "carto 0.18.0 (Carto map stylesheet compiler)" "User Commands" .SH NAME -carto \- Carto map stylesheet compiler +carto \- manual page for carto 0.18.0 (Carto map stylesheet compiler) .SH SYNOPSIS -.B carto [OPTION] -\fI<source MML file>\fR -.SH DESCRIPTION -Carto is a stylesheet renderer for Mapnik. It's an evolution of -the Cascadenik idea and language, with an emphasis on speed and -flexibility. +.B carto +\fI\,<source MML file>\/\fR .SH OPTIONS .TP -\fB\-v\fR \fB\-\-version\fR -Parse JSON map manifest +\fB\-h\fR, \fB\-\-help\fR +Display this help message .TP -\fB\-b\fR \fB\-\-benchmark\fR -Outputs total compile time +\fB\-v\fR, \fB\-\-version\fR +Display version information [boolean] .TP -\fB\-n\fR \fB\-\-nosymlink\fR -Use absolute paths instead of symlinking files -.SH REPORTING BUGS -Please report bugs on the GitHub issue tracker: -<\fBhttps://github.com/mapbox/carto/issues\fR> +\fB\-b\fR, \fB\-\-benchmark\fR +Outputs total compile time [boolean] +.TP +\fB\-l\fR, \fB\-\-localize\fR +Use millstone to localize resources when loading an MML +[boolean] [default: false] +.TP +\fB\-n\fR, \fB\-\-nosymlink\fR +Use absolute paths instead of symlinking files [boolean] +.TP +\fB\-a\fR, \fB\-\-api\fR +Specify Mapnik API version +.TP +\fB\-f\fR, \fB\-\-file\fR +Outputs to the given file instead of stdout. +.TP +\fB\-o\fR, \fB\-\-output\fR +Specify output format (mapnik, json) [default: "mapnik"] +.TP +\fB\-q\fR, \fB\-\-quiet\fR +Do not output any warnings [boolean] [default: false] +.TP +\fB\-\-ppi\fR +Pixels per inch used to convert m, mm, cm, in, pt, pc to +pixels [default: 90.714] +.SH "SEE ALSO" +The full documentation for +.B carto +is maintained as a Texinfo manual. If the +.B info +and +.B carto +programs are properly installed at your site, the command +.IP +.B info carto +.PP +should give you access to the complete manual. diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..5544351 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,2309 @@ +{ + "name": "carto", + "version": "1.2.0", + "lockfileVersion": 1, + "requires": true, + "dependencies": { + "abbrev": { + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.0.9.tgz", + "integrity": "sha1-kbR5JYinc4wl813W9jdSovh3YTU=", + "dev": true + }, + "acorn": { + "version": "5.7.3", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-5.7.3.tgz", + "integrity": "sha512-T/zvzYRfbVojPWahDsE5evJdHb3oJoQfFbsrKM7w5Zcs++Tr257tia3BmMP8XYVjp1S9RZXQMh7gao96BlqZOw==", + "dev": true + }, + "acorn-jsx": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-3.0.1.tgz", + "integrity": "sha1-r9+UiPsezvyDSPb7IvRk4ypYs2s=", + "dev": true, + "requires": { + "acorn": "^3.0.4" + }, + "dependencies": { + "acorn": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-3.3.0.tgz", + "integrity": "sha1-ReN/s56No/JbruP/U2niu18iAXo=", + "dev": true + } + } + }, + "ajv": { + "version": "5.5.2", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-5.5.2.tgz", + "integrity": "sha1-c7Xuyj+rZT49P5Qis0GtQiBdyWU=", + "dev": true, + "requires": { + "co": "^4.6.0", + "fast-deep-equal": "^1.0.0", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.3.0" + } + }, + "ajv-keywords": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-2.1.1.tgz", + "integrity": "sha1-YXmX/F9gV2iUxDX5QNgZ4TW4B2I=", + "dev": true + }, + "align-text": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/align-text/-/align-text-0.1.4.tgz", + "integrity": "sha1-DNkKVhCT810KmSVsIrcGlDP60Rc=", + "dev": true, + "requires": { + "kind-of": "^3.0.2", + "longest": "^1.0.1", + "repeat-string": "^1.5.2" + } + }, + "amdefine": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/amdefine/-/amdefine-1.0.1.tgz", + "integrity": "sha1-SlKCrBZHKek2Gbz9OtFR+BfOkfU=", + "dev": true + }, + "ansi-escapes": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-3.2.0.tgz", + "integrity": "sha512-cBhpre4ma+U0T1oM5fXg7Dy1Jw7zzwv7lt/GoCpr+hDQJoYnKVPLL4dCvSEFMmQurOQvSrwT7SL/DAlhBI97RQ==", + "dev": true + }, + "ansi-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-3.0.0.tgz", + "integrity": "sha1-7QMXwyIGT3lGbAKWa922Bas32Zg=" + }, + "ansi-styles": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-2.2.1.tgz", + "integrity": "sha1-tDLdM1i2NM914eRmQ2gkBTPB3b4=", + "dev": true + }, + "argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha1-vNZ5HqWuCXJeF+WtmIE0zUCz2RE=", + "requires": { + "sprintf-js": "~1.0.2" + } + }, + "asn1": { + "version": "0.2.4", + "resolved": "https://registry.npmjs.org/asn1/-/asn1-0.2.4.tgz", + "integrity": "sha512-jxwzQpLQjSmWXgwaCZE9Nz+glAG01yF1QnWgbhGwHI5A6FRIEY6IVqtHhIepHqI7/kyEyQEagBC5mBEFlIYvdg==", + "dev": true, + "requires": { + "safer-buffer": "~2.1.0" + } + }, + "assert-plus": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", + "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=", + "dev": true + }, + "async": { + "version": "1.5.2", + "resolved": "https://registry.npmjs.org/async/-/async-1.5.2.tgz", + "integrity": "sha1-7GphrlZIDAw8skHJVhjiCJL5Zyo=", + "dev": true + }, + "asynckit": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", + "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k=", + "dev": true + }, + "aws-sign2": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/aws-sign2/-/aws-sign2-0.7.0.tgz", + "integrity": "sha1-tG6JCTSpWR8tL2+G1+ap8bP+dqg=", + "dev": true + }, + "aws4": { + "version": "1.8.0", + "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.8.0.tgz", + "integrity": "sha512-ReZxvNHIOv88FlT7rxcXIIC0fPt4KZqZbOlivyWtXLt8ESx84zd3kMC6iK5jVeS2qt+g7ftS7ye4fi06X5rtRQ==", + "dev": true + }, + "babel-code-frame": { + "version": "6.26.0", + "resolved": "https://registry.npmjs.org/babel-code-frame/-/babel-code-frame-6.26.0.tgz", + "integrity": "sha1-Y/1D99weO7fONZR9uP42mj9Yx0s=", + "dev": true, + "requires": { + "chalk": "^1.1.3", + "esutils": "^2.0.2", + "js-tokens": "^3.0.2" + } + }, + "balanced-match": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz", + "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c=", + "dev": true + }, + "bcrypt-pbkdf": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/bcrypt-pbkdf/-/bcrypt-pbkdf-1.0.2.tgz", + "integrity": "sha1-pDAdOJtqQ/m2f/PKEaP2Y342Dp4=", + "dev": true, + "requires": { + "tweetnacl": "^0.14.3" + } + }, + "brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha1-PH/L9SnYcibz0vUrlm/1Jx60Qd0=", + "dev": true, + "requires": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "browser-stdout": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/browser-stdout/-/browser-stdout-1.3.1.tgz", + "integrity": "sha1-uqVZ7hTO1zRSIputcyZGfGH6vWA=", + "dev": true + }, + "buffer-from": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.1.tgz", + "integrity": "sha512-MQcXEUbCKtEo7bhqEs6560Hyd4XaovZlO/k9V3hjVUF/zwW7KBVdSK4gIt/bzwS9MbR5qob+F5jusZsb0YQK2A==", + "dev": true + }, + "caller-path": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/caller-path/-/caller-path-0.1.0.tgz", + "integrity": "sha1-lAhe9jWB7NPaqSREqP6U6CV3dR8=", + "dev": true, + "requires": { + "callsites": "^0.2.0" + } + }, + "callsites": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/callsites/-/callsites-0.2.0.tgz", + "integrity": "sha1-r6uWJikQp/M8GaV3WCXGnzTjUMo=", + "dev": true + }, + "camelcase": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-4.1.0.tgz", + "integrity": "sha1-1UVjW+HjPFQmScaRc+Xeas+uNN0=" + }, + "caseless": { + "version": "0.12.0", + "resolved": "https://registry.npmjs.org/caseless/-/caseless-0.12.0.tgz", + "integrity": "sha1-G2gcIf+EAzyCZUMJBolCDRhxUdw=", + "dev": true + }, + "center-align": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/center-align/-/center-align-0.1.3.tgz", + "integrity": "sha1-qg0yYptu6XIgBBHL1EYckHvCt60=", + "dev": true, + "optional": true, + "requires": { + "align-text": "^0.1.3", + "lazy-cache": "^1.0.3" + } + }, + "chalk": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-1.1.3.tgz", + "integrity": "sha1-qBFcVeSnAv5NFQq9OHKCKn4J/Jg=", + "dev": true, + "requires": { + "ansi-styles": "^2.2.1", + "escape-string-regexp": "^1.0.2", + "has-ansi": "^2.0.0", + "strip-ansi": "^3.0.0", + "supports-color": "^2.0.0" + }, + "dependencies": { + "ansi-regex": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", + "integrity": "sha1-w7M6te42DYbg5ijwRorn7yfWVN8=", + "dev": true + }, + "strip-ansi": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz", + "integrity": "sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8=", + "dev": true, + "requires": { + "ansi-regex": "^2.0.0" + } + } + } + }, + "chardet": { + "version": "0.4.2", + "resolved": "https://registry.npmjs.org/chardet/-/chardet-0.4.2.tgz", + "integrity": "sha1-tUc7M9yXxCTl2Y3IfVXU2KKci/I=", + "dev": true + }, + "chroma-js": { + "version": "1.3.7", + "resolved": "https://registry.npmjs.org/chroma-js/-/chroma-js-1.3.7.tgz", + "integrity": "sha512-ARq0P94NObL8hdQbgc+E33X9OHiNzdHO7epe3nC/KgxNRxkQcFpzNqnGeFjvOY2GxfVhbia686NXD2jByb1o0g==" + }, + "circular-json": { + "version": "0.3.3", + "resolved": "https://registry.npmjs.org/circular-json/-/circular-json-0.3.3.tgz", + "integrity": "sha1-gVyZ6oT2gJUp0vRXkb34JxE1LWY=", + "dev": true + }, + "cli-cursor": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-2.1.0.tgz", + "integrity": "sha1-s12sN2R5+sw+lHR9QdDQ9SOP/LU=", + "dev": true, + "requires": { + "restore-cursor": "^2.0.0" + } + }, + "cli-width": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-2.2.0.tgz", + "integrity": "sha1-/xnt6Kml5XkyQUewwR8PvLq+1jk=", + "dev": true + }, + "cliui": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-4.1.0.tgz", + "integrity": "sha1-NIQi2+gtgAswIu709qwQvy5NG0k=", + "requires": { + "string-width": "^2.1.1", + "strip-ansi": "^4.0.0", + "wrap-ansi": "^2.0.0" + } + }, + "co": { + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/co/-/co-4.6.0.tgz", + "integrity": "sha1-bqa989hTrlTMuOR7+gvz+QMfsYQ=", + "dev": true + }, + "code-point-at": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/code-point-at/-/code-point-at-1.1.0.tgz", + "integrity": "sha1-DQcLTQQ6W+ozovGkDi7bPZpMz3c=" + }, + "color-convert": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", + "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", + "dev": true, + "requires": { + "color-name": "1.1.3" + } + }, + "color-name": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", + "dev": true + }, + "combined-stream": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.7.tgz", + "integrity": "sha512-brWl9y6vOB1xYPZcpZde3N9zDByXTosAeMDo4p1wzo6UMOX4vumB+TP1RZ76sfE6Md68Q0NJSrE/gbezd4Ul+w==", + "dev": true, + "requires": { + "delayed-stream": "~1.0.0" + } + }, + "commander": { + "version": "2.15.1", + "resolved": "https://registry.npmjs.org/commander/-/commander-2.15.1.tgz", + "integrity": "sha1-30boZ9D8Kuxmo0ZitAapzK//Ww8=", + "dev": true + }, + "concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", + "dev": true + }, + "concat-stream": { + "version": "1.6.2", + "resolved": "https://registry.npmjs.org/concat-stream/-/concat-stream-1.6.2.tgz", + "integrity": "sha512-27HBghJxjiZtIk3Ycvn/4kbJk/1uZuJFfuPEns6LaEvpvG1f0hTea8lilrouyo9mVc2GWdcEZ8OLoGmSADlrCw==", + "dev": true, + "requires": { + "buffer-from": "^1.0.0", + "inherits": "^2.0.3", + "readable-stream": "^2.2.2", + "typedarray": "^0.0.6" + } + }, + "core-util-is": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", + "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=", + "dev": true + }, + "coveralls": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/coveralls/-/coveralls-3.0.0.tgz", + "integrity": "sha1-Iu9zAzBTgIDSm4wVHckUav3oipk=", + "dev": true, + "requires": { + "js-yaml": "^3.6.1", + "lcov-parse": "^0.0.10", + "log-driver": "^1.2.5", + "minimist": "^1.2.0", + "request": "^2.79.0" + } + }, + "cross-spawn": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-5.1.0.tgz", + "integrity": "sha1-6L0O/uWPz/b4+UUQoKVUu/ojVEk=", + "requires": { + "lru-cache": "^4.0.1", + "shebang-command": "^1.2.0", + "which": "^1.2.9" + } + }, + "dashdash": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/dashdash/-/dashdash-1.14.1.tgz", + "integrity": "sha1-hTz6D3y+L+1d4gMmuN1YEDX24vA=", + "dev": true, + "requires": { + "assert-plus": "^1.0.0" + } + }, + "debug": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz", + "integrity": "sha1-W7WgZyYotkFJVmuhaBnmFRjGcmE=", + "dev": true, + "requires": { + "ms": "2.0.0" + } + }, + "decamelize": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz", + "integrity": "sha1-9lNNFRSCabIDUue+4m9QH5oZEpA=", + "dev": true, + "optional": true + }, + "deep-is": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.3.tgz", + "integrity": "sha1-s2nW+128E+7PUk+RsHD+7cNXzzQ=", + "dev": true + }, + "delayed-stream": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", + "integrity": "sha1-3zrhmayt+31ECqrgsp4icrJOxhk=", + "dev": true + }, + "diff": { + "version": "3.5.0", + "resolved": "https://registry.npmjs.org/diff/-/diff-3.5.0.tgz", + "integrity": "sha1-gAwN0eCov7yVg1wgKtIg/jF+WhI=", + "dev": true + }, + "doctrine": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", + "integrity": "sha1-XNAfwQFiG0LEzX9dGmYkNxbT850=", + "dev": true, + "requires": { + "esutils": "^2.0.2" + } + }, + "ecc-jsbn": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/ecc-jsbn/-/ecc-jsbn-0.1.2.tgz", + "integrity": "sha1-OoOpBOVDUyh4dMVkt1SThoSamMk=", + "dev": true, + "requires": { + "jsbn": "~0.1.0", + "safer-buffer": "^2.1.0" + } + }, + "escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", + "dev": true + }, + "escodegen": { + "version": "1.8.1", + "resolved": "https://registry.npmjs.org/escodegen/-/escodegen-1.8.1.tgz", + "integrity": "sha1-WltTr0aTEQvrsIZ6o0MN07cKEBg=", + "dev": true, + "requires": { + "esprima": "^2.7.1", + "estraverse": "^1.9.1", + "esutils": "^2.0.2", + "optionator": "^0.8.1", + "source-map": "~0.2.0" + }, + "dependencies": { + "esprima": { + "version": "2.7.3", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-2.7.3.tgz", + "integrity": "sha1-luO3DVd59q1JzQMmc9HDEnZ7pYE=", + "dev": true + } + } + }, + "eslint": { + "version": "4.19.1", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-4.19.1.tgz", + "integrity": "sha512-bT3/1x1EbZB7phzYu7vCr1v3ONuzDtX8WjuM9c0iYxe+cq+pwcKEoQjl7zd3RpC6YOLgnSy3cTN58M2jcoPDIQ==", + "dev": true, + "requires": { + "ajv": "^5.3.0", + "babel-code-frame": "^6.22.0", + "chalk": "^2.1.0", + "concat-stream": "^1.6.0", + "cross-spawn": "^5.1.0", + "debug": "^3.1.0", + "doctrine": "^2.1.0", + "eslint-scope": "^3.7.1", + "eslint-visitor-keys": "^1.0.0", + "espree": "^3.5.4", + "esquery": "^1.0.0", + "esutils": "^2.0.2", + "file-entry-cache": "^2.0.0", + "functional-red-black-tree": "^1.0.1", + "glob": "^7.1.2", + "globals": "^11.0.1", + "ignore": "^3.3.3", + "imurmurhash": "^0.1.4", + "inquirer": "^3.0.6", + "is-resolvable": "^1.0.0", + "js-yaml": "^3.9.1", + "json-stable-stringify-without-jsonify": "^1.0.1", + "levn": "^0.3.0", + "lodash": "^4.17.4", + "minimatch": "^3.0.2", + "mkdirp": "^0.5.1", + "natural-compare": "^1.4.0", + "optionator": "^0.8.2", + "path-is-inside": "^1.0.2", + "pluralize": "^7.0.0", + "progress": "^2.0.0", + "regexpp": "^1.0.1", + "require-uncached": "^1.0.3", + "semver": "^5.3.0", + "strip-ansi": "^4.0.0", + "strip-json-comments": "~2.0.1", + "table": "4.0.2", + "text-table": "~0.2.0" + }, + "dependencies": { + "ansi-styles": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", + "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "dev": true, + "requires": { + "color-convert": "^1.9.0" + } + }, + "chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dev": true, + "requires": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + } + }, + "glob": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.3.tgz", + "integrity": "sha512-vcfuiIxogLV4DlGBHIUOwI0IbrJ8HWPc4MU7HzviGeNho/UJDfi6B5p3sHeWIQ0KGIU0Jpxi5ZHxemQfLkkAwQ==", + "dev": true, + "requires": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + } + }, + "has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", + "dev": true + }, + "supports-color": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", + "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", + "dev": true, + "requires": { + "has-flag": "^3.0.0" + } + } + } + }, + "eslint-scope": { + "version": "3.7.3", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-3.7.3.tgz", + "integrity": "sha512-W+B0SvF4gamyCTmUc+uITPY0989iXVfKvhwtmJocTaYoc/3khEHmEmvfY/Gn9HA9VV75jrQECsHizkNw1b68FA==", + "dev": true, + "requires": { + "esrecurse": "^4.1.0", + "estraverse": "^4.1.1" + }, + "dependencies": { + "estraverse": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.2.0.tgz", + "integrity": "sha1-De4/7TH81GlhjOc0IJn8GvoL2xM=", + "dev": true + } + } + }, + "eslint-visitor-keys": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.0.0.tgz", + "integrity": "sha1-PzGA+y4pEBdxastMnW1bXDSmqB0=", + "dev": true + }, + "espree": { + "version": "3.5.4", + "resolved": "https://registry.npmjs.org/espree/-/espree-3.5.4.tgz", + "integrity": "sha512-yAcIQxtmMiB/jL32dzEp2enBeidsB7xWPLNiw3IIkpVds1P+h7qF9YwJq1yUNzp2OKXgAprs4F61ih66UsoD1A==", + "dev": true, + "requires": { + "acorn": "^5.5.0", + "acorn-jsx": "^3.0.0" + } + }, + "esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha1-E7BM2z5sXRnfkatph6hpVhmwqnE=" + }, + "esquery": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.0.1.tgz", + "integrity": "sha512-SmiyZ5zIWH9VM+SRUReLS5Q8a7GxtRdxEBVZpm98rJM7Sb+A9DVCndXfkeFUd3byderg+EbDkfnevfCwynWaNA==", + "dev": true, + "requires": { + "estraverse": "^4.0.0" + }, + "dependencies": { + "estraverse": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.2.0.tgz", + "integrity": "sha1-De4/7TH81GlhjOc0IJn8GvoL2xM=", + "dev": true + } + } + }, + "esrecurse": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.2.1.tgz", + "integrity": "sha512-64RBB++fIOAXPw3P9cy89qfMlvZEXZkqqJkjqqXIvzP5ezRZjW+lPWjw35UX/3EhUPFYbg5ER4JYgDw4007/DQ==", + "dev": true, + "requires": { + "estraverse": "^4.1.0" + }, + "dependencies": { + "estraverse": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.2.0.tgz", + "integrity": "sha1-De4/7TH81GlhjOc0IJn8GvoL2xM=", + "dev": true + } + } + }, + "estraverse": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-1.9.3.tgz", + "integrity": "sha1-r2fy3JIlgkFZUJJgkaQAXSnJu0Q=", + "dev": true + }, + "esutils": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.2.tgz", + "integrity": "sha1-Cr9PHKpbyx96nYrMbepPqqBLrJs=", + "dev": true + }, + "execa": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/execa/-/execa-0.7.0.tgz", + "integrity": "sha1-lEvs00zEHuMqY6n68nrVpl/Fl3c=", + "requires": { + "cross-spawn": "^5.0.1", + "get-stream": "^3.0.0", + "is-stream": "^1.1.0", + "npm-run-path": "^2.0.0", + "p-finally": "^1.0.0", + "signal-exit": "^3.0.0", + "strip-eof": "^1.0.0" + } + }, + "extend": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", + "integrity": "sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==", + "dev": true + }, + "external-editor": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/external-editor/-/external-editor-2.2.0.tgz", + "integrity": "sha512-bSn6gvGxKt+b7+6TKEv1ZycHleA7aHhRHyAqJyp5pbUFuYYNIzpZnQDk7AsYckyWdEnTeAnay0aCy2aV6iTk9A==", + "dev": true, + "requires": { + "chardet": "^0.4.0", + "iconv-lite": "^0.4.17", + "tmp": "^0.0.33" + } + }, + "extsprintf": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/extsprintf/-/extsprintf-1.3.0.tgz", + "integrity": "sha1-lpGEQOMEGnpBT4xS48V06zw+HgU=", + "dev": true + }, + "fast-deep-equal": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-1.1.0.tgz", + "integrity": "sha1-wFNHeBfIa1HaqFPIHgWbcz0CNhQ=", + "dev": true + }, + "fast-json-stable-stringify": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.0.0.tgz", + "integrity": "sha1-1RQsDK7msRifh9OnYREGT4bIu/I=", + "dev": true + }, + "fast-levenshtein": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", + "integrity": "sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc=", + "dev": true + }, + "figures": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/figures/-/figures-2.0.0.tgz", + "integrity": "sha1-OrGi0qYsi/tDGgyUy3l6L84nyWI=", + "dev": true, + "requires": { + "escape-string-regexp": "^1.0.5" + } + }, + "file-entry-cache": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-2.0.0.tgz", + "integrity": "sha1-w5KZDD5oR4PYOLjISkXYoEhFg2E=", + "dev": true, + "requires": { + "flat-cache": "^1.2.1", + "object-assign": "^4.0.1" + } + }, + "find-up": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", + "integrity": "sha1-SRafHXmTQwZG2mHsxa41XCHJe3M=", + "requires": { + "locate-path": "^3.0.0" + } + }, + "flat-cache": { + "version": "1.3.4", + "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-1.3.4.tgz", + "integrity": "sha512-VwyB3Lkgacfik2vhqR4uv2rvebqmDvFu4jlN/C1RzWoJEo8I7z4Q404oiqYCkq41mni8EzQnm95emU9seckwtg==", + "dev": true, + "requires": { + "circular-json": "^0.3.1", + "graceful-fs": "^4.1.2", + "rimraf": "~2.6.2", + "write": "^0.2.1" + } + }, + "forever-agent": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/forever-agent/-/forever-agent-0.6.1.tgz", + "integrity": "sha1-+8cfDEGt6zf5bFd60e1C2P2sypE=", + "dev": true + }, + "form-data": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.3.3.tgz", + "integrity": "sha512-1lLKB2Mu3aGP1Q/2eCOx0fNbRMe7XdwktwOruhfqqd0rIJWwN4Dh+E3hrPSlDCXnSR7UtZ1N38rVXm+6+MEhJQ==", + "dev": true, + "requires": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.6", + "mime-types": "^2.1.12" + } + }, + "fs.realpath": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", + "dev": true + }, + "functional-red-black-tree": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz", + "integrity": "sha1-GwqzvVU7Kg1jmdKcDj6gslIHgyc=", + "dev": true + }, + "get-caller-file": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-1.0.3.tgz", + "integrity": "sha1-+Xj6TJDR3+f/LWvtoqUV5xO9z0o=" + }, + "get-stream": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-3.0.0.tgz", + "integrity": "sha1-jpQ9E1jcN1VQVOy+LtsFqhdO3hQ=" + }, + "getpass": { + "version": "0.1.7", + "resolved": "https://registry.npmjs.org/getpass/-/getpass-0.1.7.tgz", + "integrity": "sha1-Xv+OPmhNVprkyysSgmBOi6YhSfo=", + "dev": true, + "requires": { + "assert-plus": "^1.0.0" + } + }, + "glob": { + "version": "5.0.15", + "resolved": "https://registry.npmjs.org/glob/-/glob-5.0.15.tgz", + "integrity": "sha1-G8k2ueAvSmA/zCIuz3Yz0wuLk7E=", + "dev": true, + "requires": { + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "2 || 3", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + } + }, + "glob-all": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/glob-all/-/glob-all-3.1.0.tgz", + "integrity": "sha1-iRPd+17hrHgSZWJBsD1SF8ZLAqs=", + "dev": true, + "requires": { + "glob": "^7.0.5", + "yargs": "~1.2.6" + }, + "dependencies": { + "glob": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.3.tgz", + "integrity": "sha512-vcfuiIxogLV4DlGBHIUOwI0IbrJ8HWPc4MU7HzviGeNho/UJDfi6B5p3sHeWIQ0KGIU0Jpxi5ZHxemQfLkkAwQ==", + "dev": true, + "requires": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + } + }, + "minimist": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-0.1.0.tgz", + "integrity": "sha1-md9lelJXTCHJBXSX33QnkLK0wN4=", + "dev": true + }, + "yargs": { + "version": "1.2.6", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-1.2.6.tgz", + "integrity": "sha1-nHtKgv1dWVsr8Xq23MQxNUMv40s=", + "dev": true, + "requires": { + "minimist": "^0.1.0" + } + } + } + }, + "globals": { + "version": "11.10.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-11.10.0.tgz", + "integrity": "sha512-0GZF1RiPKU97IHUO5TORo9w1PwrH/NBPl+fS7oMLdaTRiYmYbwK4NWoZWrAdd0/abG9R2BU+OiwyQpTpE6pdfQ==", + "dev": true + }, + "graceful-fs": { + "version": "4.1.15", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.1.15.tgz", + "integrity": "sha512-6uHUhOPEBgQ24HM+r6b/QwWfZq+yiFcipKFrOFiBEnWdy5sdzYoi+pJeQaPI5qOLRFqWmAXUPQNsielzdLoecA==", + "dev": true + }, + "growl": { + "version": "1.10.5", + "resolved": "https://registry.npmjs.org/growl/-/growl-1.10.5.tgz", + "integrity": "sha1-8nNdwig2dPpnR4sQGBBZNVw2nl4=", + "dev": true + }, + "handlebars": { + "version": "4.0.11", + "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.0.11.tgz", + "integrity": "sha1-Ywo13+ApS8KB7a5v/F0yn8eYLcw=", + "dev": true, + "requires": { + "async": "^1.4.0", + "optimist": "^0.6.1", + "source-map": "^0.4.4", + "uglify-js": "^2.6" + }, + "dependencies": { + "source-map": { + "version": "0.4.4", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.4.4.tgz", + "integrity": "sha1-66T12pwNyZneaAMti092FzZSA2s=", + "dev": true, + "requires": { + "amdefine": ">=0.0.4" + } + } + } + }, + "har-schema": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/har-schema/-/har-schema-2.0.0.tgz", + "integrity": "sha1-qUwiJOvKwEeCoNkDVSHyRzW37JI=", + "dev": true + }, + "har-validator": { + "version": "5.1.3", + "resolved": "https://registry.npmjs.org/har-validator/-/har-validator-5.1.3.tgz", + "integrity": "sha512-sNvOCzEQNr/qrvJgc3UG/kD4QtlHycrzwS+6mfTrrSq97BvaYcPZZI1ZSqGSPR73Cxn4LKTD4PttRwfU7jWq5g==", + "dev": true, + "requires": { + "ajv": "^6.5.5", + "har-schema": "^2.0.0" + }, + "dependencies": { + "ajv": { + "version": "6.7.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.7.0.tgz", + "integrity": "sha512-RZXPviBTtfmtka9n9sy1N5M5b82CbxWIR6HIis4s3WQTXDJamc/0gpCWNGz6EWdWp4DOfjzJfhz/AS9zVPjjWg==", + "dev": true, + "requires": { + "fast-deep-equal": "^2.0.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + } + }, + "fast-deep-equal": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-2.0.1.tgz", + "integrity": "sha1-ewUhjd+WZ79/Nwv3/bLLFf3Qqkk=", + "dev": true + }, + "json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true + } + } + }, + "has-ansi": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/has-ansi/-/has-ansi-2.0.0.tgz", + "integrity": "sha1-NPUEnOHs3ysGSa8+8k5F7TVBbZE=", + "dev": true, + "requires": { + "ansi-regex": "^2.0.0" + }, + "dependencies": { + "ansi-regex": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", + "integrity": "sha1-w7M6te42DYbg5ijwRorn7yfWVN8=", + "dev": true + } + } + }, + "has-flag": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-1.0.0.tgz", + "integrity": "sha1-nZ55MWXOAXoA8AQYxD+UKnsdEfo=", + "dev": true + }, + "he": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/he/-/he-1.1.1.tgz", + "integrity": "sha1-k0EP0hsAlzUVH4howvJx80J+I/0=", + "dev": true + }, + "hsluv": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/hsluv/-/hsluv-0.0.2.tgz", + "integrity": "sha1-j9asiY9AhsD+t6FG1TiwESK1HBo=" + }, + "http-signature": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/http-signature/-/http-signature-1.2.0.tgz", + "integrity": "sha1-muzZJRFHcvPZW2WmCruPfBj7rOE=", + "dev": true, + "requires": { + "assert-plus": "^1.0.0", + "jsprim": "^1.2.2", + "sshpk": "^1.7.0" + } + }, + "iconv-lite": { + "version": "0.4.24", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", + "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", + "dev": true, + "requires": { + "safer-buffer": ">= 2.1.2 < 3" + } + }, + "ignore": { + "version": "3.3.10", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-3.3.10.tgz", + "integrity": "sha512-Pgs951kaMm5GXP7MOvxERINe3gsaVjUWFm+UZPSq9xYriQAksyhg0csnS0KXSNRD5NmNdapXEpjxG49+AKh/ug==", + "dev": true + }, + "imurmurhash": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", + "integrity": "sha1-khi5srkoojixPcT7a21XbyMUU+o=", + "dev": true + }, + "inflight": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", + "dev": true, + "requires": { + "once": "^1.3.0", + "wrappy": "1" + } + }, + "inherits": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz", + "integrity": "sha1-Yzwsg+PaQqUC9SRmAiSA9CCCYd4=", + "dev": true + }, + "inquirer": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/inquirer/-/inquirer-3.3.0.tgz", + "integrity": "sha512-h+xtnyk4EwKvFWHrUYsWErEVR+igKtLdchu+o0Z1RL7VU/jVMFbYir2bp6bAj8efFNxWqHX0dIss6fJQ+/+qeQ==", + "dev": true, + "requires": { + "ansi-escapes": "^3.0.0", + "chalk": "^2.0.0", + "cli-cursor": "^2.1.0", + "cli-width": "^2.0.0", + "external-editor": "^2.0.4", + "figures": "^2.0.0", + "lodash": "^4.3.0", + "mute-stream": "0.0.7", + "run-async": "^2.2.0", + "rx-lite": "^4.0.8", + "rx-lite-aggregates": "^4.0.8", + "string-width": "^2.1.0", + "strip-ansi": "^4.0.0", + "through": "^2.3.6" + }, + "dependencies": { + "ansi-styles": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", + "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "dev": true, + "requires": { + "color-convert": "^1.9.0" + } + }, + "chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dev": true, + "requires": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + } + }, + "has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", + "dev": true + }, + "supports-color": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", + "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", + "dev": true, + "requires": { + "has-flag": "^3.0.0" + } + } + } + }, + "invert-kv": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/invert-kv/-/invert-kv-1.0.0.tgz", + "integrity": "sha1-EEqOSqym09jNFXqO+L+rLXo//bY=" + }, + "is-buffer": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-1.1.6.tgz", + "integrity": "sha1-76ouqdqg16suoTqXsritUf776L4=", + "dev": true + }, + "is-fullwidth-code-point": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", + "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=" + }, + "is-promise": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/is-promise/-/is-promise-2.1.0.tgz", + "integrity": "sha1-eaKp7OfwlugPNtKy87wWwf9L8/o=", + "dev": true + }, + "is-resolvable": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/is-resolvable/-/is-resolvable-1.1.0.tgz", + "integrity": "sha512-qgDYXFSR5WvEfuS5dMj6oTMEbrrSaM0CrFk2Yiq/gXnBvD9pMa2jGXxyhGLfvhZpuMZe18CJpFxAt3CRs42NMg==", + "dev": true + }, + "is-stream": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-1.1.0.tgz", + "integrity": "sha1-EtSj3U5o4Lec6428hBc66A2RykQ=" + }, + "is-typedarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", + "integrity": "sha1-5HnICFjfDBsR3dppQPlgEfzaSpo=", + "dev": true + }, + "isarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", + "integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE=", + "dev": true + }, + "isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=" + }, + "isstream": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/isstream/-/isstream-0.1.2.tgz", + "integrity": "sha1-R+Y/evVa+m+S4VAOaQ64uFKcCZo=", + "dev": true + }, + "istanbul": { + "version": "0.4.5", + "resolved": "https://registry.npmjs.org/istanbul/-/istanbul-0.4.5.tgz", + "integrity": "sha1-ZcfXPUxNqE1POsMQuRj7C4Azczs=", + "dev": true, + "requires": { + "abbrev": "1.0.x", + "async": "1.x", + "escodegen": "1.8.x", + "esprima": "2.7.x", + "glob": "^5.0.15", + "handlebars": "^4.0.1", + "js-yaml": "3.x", + "mkdirp": "0.5.x", + "nopt": "3.x", + "once": "1.x", + "resolve": "1.1.x", + "supports-color": "^3.1.0", + "which": "^1.1.1", + "wordwrap": "^1.0.0" + }, + "dependencies": { + "esprima": { + "version": "2.7.3", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-2.7.3.tgz", + "integrity": "sha1-luO3DVd59q1JzQMmc9HDEnZ7pYE=", + "dev": true + }, + "supports-color": { + "version": "3.2.3", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-3.2.3.tgz", + "integrity": "sha1-ZawFBLOVQXHYpklGsq48u4pfVPY=", + "dev": true, + "requires": { + "has-flag": "^1.0.0" + } + } + } + }, + "js-tokens": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-3.0.2.tgz", + "integrity": "sha1-mGbfOVECEw449/mWvOtlRDIJwls=", + "dev": true + }, + "js-yaml": { + "version": "3.12.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.12.0.tgz", + "integrity": "sha1-6u1lbsg0TxD1J8a/obbiJE3hZ9E=", + "requires": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + } + }, + "jsbn": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/jsbn/-/jsbn-0.1.1.tgz", + "integrity": "sha1-peZUwuWi3rXyAdls77yoDA7y9RM=", + "dev": true + }, + "json-schema": { + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/json-schema/-/json-schema-0.2.3.tgz", + "integrity": "sha1-tIDIkuWaLwWVTOcnvT8qTogvnhM=", + "dev": true + }, + "json-schema-traverse": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.3.1.tgz", + "integrity": "sha1-NJptRMU6Ud6JtAgFxdXlm0F9M0A=", + "dev": true + }, + "json-stable-stringify-without-jsonify": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", + "integrity": "sha1-nbe1lJatPzz+8wp1FC0tkwrXJlE=", + "dev": true + }, + "json-stringify-safe": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/json-stringify-safe/-/json-stringify-safe-5.0.1.tgz", + "integrity": "sha1-Epai1Y/UXxmg9s4B1lcB4sc1tus=", + "dev": true + }, + "jsprim": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/jsprim/-/jsprim-1.4.1.tgz", + "integrity": "sha1-MT5mvB5cwG5Di8G3SZwuXFastqI=", + "dev": true, + "requires": { + "assert-plus": "1.0.0", + "extsprintf": "1.3.0", + "json-schema": "0.2.3", + "verror": "1.10.0" + } + }, + "kind-of": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz", + "integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=", + "dev": true, + "requires": { + "is-buffer": "^1.1.5" + } + }, + "lazy-cache": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/lazy-cache/-/lazy-cache-1.0.4.tgz", + "integrity": "sha1-odePw6UEdMuAhF07O24dpJpEbo4=", + "dev": true, + "optional": true + }, + "lcid": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/lcid/-/lcid-1.0.0.tgz", + "integrity": "sha1-MIrMr6C8SDo4Z7S28rlQYlHRuDU=", + "requires": { + "invert-kv": "^1.0.0" + } + }, + "lcov-parse": { + "version": "0.0.10", + "resolved": "https://registry.npmjs.org/lcov-parse/-/lcov-parse-0.0.10.tgz", + "integrity": "sha1-GwuP+ayceIklBYK3C3ExXZ2m2aM=", + "dev": true + }, + "levn": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/levn/-/levn-0.3.0.tgz", + "integrity": "sha1-OwmSTt+fCDwEkP3UwLxEIeBHZO4=", + "dev": true, + "requires": { + "prelude-ls": "~1.1.2", + "type-check": "~0.3.2" + } + }, + "locate-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", + "integrity": "sha1-2+w7OrdZdYBxtY/ln8QYca8hQA4=", + "requires": { + "p-locate": "^3.0.0", + "path-exists": "^3.0.0" + } + }, + "lodash": { + "version": "4.17.10", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.10.tgz", + "integrity": "sha1-G3eTz3JZ6jj7NmHU04syYK+K5Oc=" + }, + "log-driver": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/log-driver/-/log-driver-1.2.7.tgz", + "integrity": "sha1-Y7lQIfBwL+36LJuwok53l9cYcdg=", + "dev": true + }, + "longest": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/longest/-/longest-1.0.1.tgz", + "integrity": "sha1-MKCy2jj3N3DoKUoNIuZiXtd9AJc=", + "dev": true + }, + "lru-cache": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-4.1.1.tgz", + "integrity": "sha1-Yi4y6CSItJJ5EUpPns9F581rulU=", + "requires": { + "pseudomap": "^1.0.2", + "yallist": "^2.1.2" + } + }, + "mapnik-reference": { + "version": "8.10.0", + "resolved": "https://registry.npmjs.org/mapnik-reference/-/mapnik-reference-8.10.0.tgz", + "integrity": "sha512-BuvyCeE9Glf6YmMtTy+s4BhJAwFNygwcwKVJ4gRN4gJLQmDASmotNCwf9A3sw2JO/ynfYLFXpCpOCms2L77Nbg==", + "requires": { + "lodash": "^4.11.0", + "semver": "^5.1.0" + } + }, + "mem": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/mem/-/mem-1.1.0.tgz", + "integrity": "sha1-Xt1StIXKHZAP5kiVUFOZoN+kX3Y=", + "requires": { + "mimic-fn": "^1.0.0" + } + }, + "mime-db": { + "version": "1.37.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.37.0.tgz", + "integrity": "sha512-R3C4db6bgQhlIhPU48fUtdVmKnflq+hRdad7IyKhtFj06VPNVdk2RhiYL3UjQIlso8L+YxAtFkobT0VK+S/ybg==", + "dev": true + }, + "mime-types": { + "version": "2.1.21", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.21.tgz", + "integrity": "sha512-3iL6DbwpyLzjR3xHSFNFeb9Nz/M8WDkX33t1GFQnFOllWk8pOrh/LSrB5OXlnlW5P9LH73X6loW/eogc+F5lJg==", + "dev": true, + "requires": { + "mime-db": "~1.37.0" + } + }, + "mimic-fn": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-1.2.0.tgz", + "integrity": "sha1-ggyGo5M0ZA6ZUWkovQP8qIBX0CI=" + }, + "minimatch": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", + "integrity": "sha1-UWbihkV/AzBgZL5Ul+jbsMPTIIM=", + "dev": true, + "requires": { + "brace-expansion": "^1.1.7" + } + }, + "minimist": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.0.tgz", + "integrity": "sha1-o1AIsg9BOD7sH7kU9M1d95omQoQ=", + "dev": true + }, + "mkdirp": { + "version": "0.5.1", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.1.tgz", + "integrity": "sha1-MAV0OOrGz3+MR2fzhkjWaX11yQM=", + "dev": true, + "requires": { + "minimist": "0.0.8" + }, + "dependencies": { + "minimist": { + "version": "0.0.8", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-0.0.8.tgz", + "integrity": "sha1-hX/Kv8M5fSYluCKCYuhqp6ARsF0=", + "dev": true + } + } + }, + "mocha": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/mocha/-/mocha-5.2.0.tgz", + "integrity": "sha1-bYrlCPWRZ/lA8rWzxKYSrlDJCuY=", + "dev": true, + "requires": { + "browser-stdout": "1.3.1", + "commander": "2.15.1", + "debug": "3.1.0", + "diff": "3.5.0", + "escape-string-regexp": "1.0.5", + "glob": "7.1.2", + "growl": "1.10.5", + "he": "1.1.1", + "minimatch": "3.0.4", + "mkdirp": "0.5.1", + "supports-color": "5.4.0" + }, + "dependencies": { + "glob": { + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.2.tgz", + "integrity": "sha1-wZyd+aAocC1nhhI4SmVSQExjbRU=", + "dev": true, + "requires": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + } + }, + "has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", + "dev": true + }, + "supports-color": { + "version": "5.4.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.4.0.tgz", + "integrity": "sha1-HGszdALCE3YF7+GfEP7DkPb6q1Q=", + "dev": true, + "requires": { + "has-flag": "^3.0.0" + } + } + } + }, + "mocha-eslint": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/mocha-eslint/-/mocha-eslint-4.1.0.tgz", + "integrity": "sha512-y+TIaoozAiuksnsr/7GVw7F2nAqotrZ06SHIw8wMR6PVWipXre5Hz59bsqLX1n2Lqu2YDebUX1A4qF/rtmWsYQ==", + "dev": true, + "requires": { + "chalk": "^1.1.0", + "eslint": "^4.2.0", + "glob-all": "^3.0.1", + "replaceall": "^0.1.6" + } + }, + "ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=", + "dev": true + }, + "mute-stream": { + "version": "0.0.7", + "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-0.0.7.tgz", + "integrity": "sha1-MHXOk7whuPq0PhvE2n6BFe0ee6s=", + "dev": true + }, + "natural-compare": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", + "integrity": "sha1-Sr6/7tdUHywnrPspvbvRXI1bpPc=", + "dev": true + }, + "nopt": { + "version": "3.0.6", + "resolved": "https://registry.npmjs.org/nopt/-/nopt-3.0.6.tgz", + "integrity": "sha1-xkZdvwirzU2zWTF/eaxopkayj/k=", + "dev": true, + "requires": { + "abbrev": "1" + } + }, + "npm-run-path": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-2.0.2.tgz", + "integrity": "sha1-NakjLfo11wZ7TLLd8jV7GHFTbF8=", + "requires": { + "path-key": "^2.0.0" + } + }, + "number-is-nan": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/number-is-nan/-/number-is-nan-1.0.1.tgz", + "integrity": "sha1-CXtgK1NCKlIsGvuHkDGDNpQaAR0=" + }, + "oauth-sign": { + "version": "0.9.0", + "resolved": "https://registry.npmjs.org/oauth-sign/-/oauth-sign-0.9.0.tgz", + "integrity": "sha512-fexhUFFPTGV8ybAtSIGbV6gOkSv8UtRbDBnAyLQw4QPKkgNlsH2ByPGtMUqdWkos6YCRmAqViwgZrJc/mRDzZQ==", + "dev": true + }, + "object-assign": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", + "integrity": "sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=", + "dev": true + }, + "once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", + "dev": true, + "requires": { + "wrappy": "1" + } + }, + "onetime": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/onetime/-/onetime-2.0.1.tgz", + "integrity": "sha1-BnQoIw/WdEOyeUsiu6UotoZ5YtQ=", + "dev": true, + "requires": { + "mimic-fn": "^1.0.0" + } + }, + "optimist": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/optimist/-/optimist-0.6.1.tgz", + "integrity": "sha1-2j6nRob6IaGaERwybpDrFaAZZoY=", + "dev": true, + "requires": { + "minimist": "~0.0.1", + "wordwrap": "~0.0.2" + }, + "dependencies": { + "minimist": { + "version": "0.0.10", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-0.0.10.tgz", + "integrity": "sha1-3j+YVD2/lggr5IrRoMfNqDYwHc8=", + "dev": true + }, + "wordwrap": { + "version": "0.0.3", + "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-0.0.3.tgz", + "integrity": "sha1-o9XabNXAvAAI03I0u68b7WMFkQc=", + "dev": true + } + } + }, + "optionator": { + "version": "0.8.2", + "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.8.2.tgz", + "integrity": "sha1-NkxeQJ0/TWMB1sC0wFu6UBgK62Q=", + "dev": true, + "requires": { + "deep-is": "~0.1.3", + "fast-levenshtein": "~2.0.4", + "levn": "~0.3.0", + "prelude-ls": "~1.1.2", + "type-check": "~0.3.2", + "wordwrap": "~1.0.0" + } + }, + "os-locale": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/os-locale/-/os-locale-2.1.0.tgz", + "integrity": "sha1-QrwpAKa1uL0XN2yOiCtlr8zyS/I=", + "requires": { + "execa": "^0.7.0", + "lcid": "^1.0.0", + "mem": "^1.1.0" + } + }, + "os-tmpdir": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/os-tmpdir/-/os-tmpdir-1.0.2.tgz", + "integrity": "sha1-u+Z0BseaqFxc/sdm/lc0VV36EnQ=", + "dev": true + }, + "p-finally": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/p-finally/-/p-finally-1.0.0.tgz", + "integrity": "sha1-P7z7FbiZpEEjs0ttzBi3JDNqLK4=" + }, + "p-limit": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.0.0.tgz", + "integrity": "sha1-5iTtVO6MRgp3izyfNnBJb/ileuw=", + "requires": { + "p-try": "^2.0.0" + } + }, + "p-locate": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", + "integrity": "sha1-Mi1poFwCZLJZl9n0DNiokasAZKQ=", + "requires": { + "p-limit": "^2.0.0" + } + }, + "p-try": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.0.0.tgz", + "integrity": "sha1-hQgLuHxkaI+keZb+j3376CEXYLE=" + }, + "path-exists": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", + "integrity": "sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=" + }, + "path-is-absolute": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", + "dev": true + }, + "path-is-inside": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/path-is-inside/-/path-is-inside-1.0.2.tgz", + "integrity": "sha1-NlQX3t5EQw0cEa9hAn+s8HS9/FM=", + "dev": true + }, + "path-key": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-2.0.1.tgz", + "integrity": "sha1-QRyttXTFoUDTpLGRDUDYDMn0C0A=" + }, + "performance-now": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/performance-now/-/performance-now-2.1.0.tgz", + "integrity": "sha1-Ywn04OX6kT7BxpMHrjZLSzd8nns=", + "dev": true + }, + "pluralize": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/pluralize/-/pluralize-7.0.0.tgz", + "integrity": "sha1-KYuJ34uTsCIdv0Ia0rGx6iP8Z3c=", + "dev": true + }, + "prelude-ls": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.1.2.tgz", + "integrity": "sha1-IZMqVJ9eUv/ZqCf1cOBL5iqX2lQ=", + "dev": true + }, + "process-nextick-args": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.0.tgz", + "integrity": "sha512-MtEC1TqN0EU5nephaJ4rAtThHtC86dNN9qCuEhtshvpVBkAW5ZO7BASN9REnF9eoXGcRub+pFuKEpOHE+HbEMw==", + "dev": true + }, + "progress": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz", + "integrity": "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==", + "dev": true + }, + "pseudomap": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/pseudomap/-/pseudomap-1.0.2.tgz", + "integrity": "sha1-8FKijacOYYkX7wqKw0wa5aaChrM=" + }, + "psl": { + "version": "1.1.31", + "resolved": "https://registry.npmjs.org/psl/-/psl-1.1.31.tgz", + "integrity": "sha512-/6pt4+C+T+wZUieKR620OpzN/LlnNKuWjy1iFLQ/UG35JqHlR/89MP1d96dUfkf6Dne3TuLQzOYEYshJ+Hx8mw==", + "dev": true + }, + "punycode": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", + "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==", + "dev": true + }, + "qs": { + "version": "6.5.2", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.5.2.tgz", + "integrity": "sha512-N5ZAX4/LxJmF+7wN74pUD6qAh9/wnvdQcjq9TZjevvXzSUo7bfmw91saqMjzGS2xq91/odN2dW/WOl7qQHNDGA==", + "dev": true + }, + "readable-stream": { + "version": "2.3.6", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.6.tgz", + "integrity": "sha512-tQtKA9WIAhBF3+VLAseyMqZeBjW0AHJoxOtYqSUZNJxauErmLbVm2FW1y+J/YA9dUrAC39ITejlZWhVIwawkKw==", + "dev": true, + "requires": { + "core-util-is": "~1.0.0", + "inherits": "~2.0.3", + "isarray": "~1.0.0", + "process-nextick-args": "~2.0.0", + "safe-buffer": "~5.1.1", + "string_decoder": "~1.1.1", + "util-deprecate": "~1.0.1" + } + }, + "regexpp": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/regexpp/-/regexpp-1.1.0.tgz", + "integrity": "sha512-LOPw8FpgdQF9etWMaAfG/WRthIdXJGYp4mJ2Jgn/2lpkbod9jPn0t9UqN7AxBOKNfzRbYyVfgc7Vk4t/MpnXgw==", + "dev": true + }, + "repeat-string": { + "version": "1.6.1", + "resolved": "https://registry.npmjs.org/repeat-string/-/repeat-string-1.6.1.tgz", + "integrity": "sha1-jcrkcOHIirwtYA//Sndihtp15jc=", + "dev": true + }, + "replaceall": { + "version": "0.1.6", + "resolved": "https://registry.npmjs.org/replaceall/-/replaceall-0.1.6.tgz", + "integrity": "sha1-gdgax663LX9cSUKt8ml6MiBojY4=", + "dev": true + }, + "request": { + "version": "2.88.0", + "resolved": "https://registry.npmjs.org/request/-/request-2.88.0.tgz", + "integrity": "sha512-NAqBSrijGLZdM0WZNsInLJpkJokL72XYjUpnB0iwsRgxh7dB6COrHnTBNwN0E+lHDAJzu7kLAkDeY08z2/A0hg==", + "dev": true, + "requires": { + "aws-sign2": "~0.7.0", + "aws4": "^1.8.0", + "caseless": "~0.12.0", + "combined-stream": "~1.0.6", + "extend": "~3.0.2", + "forever-agent": "~0.6.1", + "form-data": "~2.3.2", + "har-validator": "~5.1.0", + "http-signature": "~1.2.0", + "is-typedarray": "~1.0.0", + "isstream": "~0.1.2", + "json-stringify-safe": "~5.0.1", + "mime-types": "~2.1.19", + "oauth-sign": "~0.9.0", + "performance-now": "^2.1.0", + "qs": "~6.5.2", + "safe-buffer": "^5.1.2", + "tough-cookie": "~2.4.3", + "tunnel-agent": "^0.6.0", + "uuid": "^3.3.2" + }, + "dependencies": { + "safe-buffer": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", + "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", + "dev": true + } + } + }, + "require-directory": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", + "integrity": "sha1-jGStX9MNqxyXbiNE/+f3kqam30I=" + }, + "require-main-filename": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/require-main-filename/-/require-main-filename-1.0.1.tgz", + "integrity": "sha1-l/cXtp1IeE9fUmpsWqj/3aBVpNE=" + }, + "require-uncached": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/require-uncached/-/require-uncached-1.0.3.tgz", + "integrity": "sha1-Tg1W1slmL9MeQwEcS5WqSZVUIdM=", + "dev": true, + "requires": { + "caller-path": "^0.1.0", + "resolve-from": "^1.0.0" + } + }, + "resolve": { + "version": "1.1.7", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.1.7.tgz", + "integrity": "sha1-IDEU2CrSxe2ejgQRs5ModeiJ6Xs=", + "dev": true + }, + "resolve-from": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-1.0.1.tgz", + "integrity": "sha1-Jsv+k10a7uq7Kbw/5a6wHpPUQiY=", + "dev": true + }, + "restore-cursor": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-2.0.0.tgz", + "integrity": "sha1-n37ih/gv0ybU/RYpI9YhKe7g368=", + "dev": true, + "requires": { + "onetime": "^2.0.0", + "signal-exit": "^3.0.2" + } + }, + "right-align": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/right-align/-/right-align-0.1.3.tgz", + "integrity": "sha1-YTObci/mo1FWiSENJOFMlhSGE+8=", + "dev": true, + "optional": true, + "requires": { + "align-text": "^0.1.1" + } + }, + "rimraf": { + "version": "2.6.3", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.6.3.tgz", + "integrity": "sha512-mwqeW5XsA2qAejG46gYdENaxXjx9onRNCfn7L0duuP4hCuTIi/QO7PDK07KJfp1d+izWPrzEJDcSqBa0OZQriA==", + "dev": true, + "requires": { + "glob": "^7.1.3" + }, + "dependencies": { + "glob": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.3.tgz", + "integrity": "sha512-vcfuiIxogLV4DlGBHIUOwI0IbrJ8HWPc4MU7HzviGeNho/UJDfi6B5p3sHeWIQ0KGIU0Jpxi5ZHxemQfLkkAwQ==", + "dev": true, + "requires": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + } + } + } + }, + "run-async": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/run-async/-/run-async-2.3.0.tgz", + "integrity": "sha1-A3GrSuC91yDUFm19/aZP96RFpsA=", + "dev": true, + "requires": { + "is-promise": "^2.1.0" + } + }, + "rx-lite": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/rx-lite/-/rx-lite-4.0.8.tgz", + "integrity": "sha1-Cx4Rr4vESDbwSmQH6S2kJGe3lEQ=", + "dev": true + }, + "rx-lite-aggregates": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/rx-lite-aggregates/-/rx-lite-aggregates-4.0.8.tgz", + "integrity": "sha1-dTuHqJoRyVRnxKwWJsTvxOBcZ74=", + "dev": true, + "requires": { + "rx-lite": "*" + } + }, + "safe-buffer": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.1.tgz", + "integrity": "sha1-iTMSr2myEj3vcfV4iQAWce6yyFM=", + "dev": true + }, + "safer-buffer": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", + "dev": true + }, + "sax": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/sax/-/sax-1.2.4.tgz", + "integrity": "sha1-KBYjTiN4vdxOU1T6tcqold9xANk=", + "dev": true + }, + "semver": { + "version": "5.6.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-5.6.0.tgz", + "integrity": "sha512-RS9R6R35NYgQn++fkDWaOmqGoj4Ek9gGs+DPxNUZKuwE183xjJroKvyo1IzVFeXvUrvmALy6FWD5xrdJT25gMg==" + }, + "set-blocking": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/set-blocking/-/set-blocking-2.0.0.tgz", + "integrity": "sha1-BF+XgtARrppoA93TgrJDkrPYkPc=" + }, + "shebang-command": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-1.2.0.tgz", + "integrity": "sha1-RKrGW2lbAzmJaMOfNj/uXer98eo=", + "requires": { + "shebang-regex": "^1.0.0" + } + }, + "shebang-regex": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-1.0.0.tgz", + "integrity": "sha1-2kL0l0DAtC2yypcoVxyxkMmO/qM=" + }, + "signal-exit": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.2.tgz", + "integrity": "sha1-tf3AjxKH6hF4Yo5BXiUTK3NkbG0=" + }, + "slice-ansi": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-1.0.0.tgz", + "integrity": "sha512-POqxBK6Lb3q6s047D/XsDVNPnF9Dl8JSaqe9h9lURl0OdNqy/ujDrOiIHtsqXMGbWWTIomRzAMaTyawAU//Reg==", + "dev": true, + "requires": { + "is-fullwidth-code-point": "^2.0.0" + } + }, + "source-map": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.2.0.tgz", + "integrity": "sha1-2rc/vPwrqBm03gO9b26qSBZLP50=", + "dev": true, + "optional": true, + "requires": { + "amdefine": ">=0.0.4" + } + }, + "sprintf-js": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", + "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=" + }, + "sshpk": { + "version": "1.16.1", + "resolved": "https://registry.npmjs.org/sshpk/-/sshpk-1.16.1.tgz", + "integrity": "sha512-HXXqVUq7+pcKeLqqZj6mHFUMvXtOJt1uoUx09pFW6011inTMxqI8BA8PM95myrIyyKwdnzjdFjLiE6KBPVtJIg==", + "dev": true, + "requires": { + "asn1": "~0.2.3", + "assert-plus": "^1.0.0", + "bcrypt-pbkdf": "^1.0.0", + "dashdash": "^1.12.0", + "ecc-jsbn": "~0.1.1", + "getpass": "^0.1.1", + "jsbn": "~0.1.0", + "safer-buffer": "^2.0.2", + "tweetnacl": "~0.14.0" + } + }, + "string-width": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-2.1.1.tgz", + "integrity": "sha1-q5Pyeo3BPSjKyBXEYhQ6bZASrp4=", + "requires": { + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^4.0.0" + } + }, + "string_decoder": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", + "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", + "dev": true, + "requires": { + "safe-buffer": "~5.1.0" + } + }, + "strip-ansi": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-4.0.0.tgz", + "integrity": "sha1-qEeQIusaw2iocTibY1JixQXuNo8=", + "requires": { + "ansi-regex": "^3.0.0" + } + }, + "strip-eof": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/strip-eof/-/strip-eof-1.0.0.tgz", + "integrity": "sha1-u0P/VZim6wXYm1n80SnJgzE2Br8=" + }, + "strip-json-comments": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", + "integrity": "sha1-PFMZQukIwml8DsNEhYwobHygpgo=", + "dev": true + }, + "supports-color": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-2.0.0.tgz", + "integrity": "sha1-U10EXOa2Nj+kARcIRimZXp3zJMc=", + "dev": true + }, + "table": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/table/-/table-4.0.2.tgz", + "integrity": "sha512-UUkEAPdSGxtRpiV9ozJ5cMTtYiqz7Ni1OGqLXRCynrvzdtR1p+cfOWe2RJLwvUG8hNanaSRjecIqwOjqeatDsA==", + "dev": true, + "requires": { + "ajv": "^5.2.3", + "ajv-keywords": "^2.1.0", + "chalk": "^2.1.0", + "lodash": "^4.17.4", + "slice-ansi": "1.0.0", + "string-width": "^2.1.1" + }, + "dependencies": { + "ansi-styles": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", + "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "dev": true, + "requires": { + "color-convert": "^1.9.0" + } + }, + "chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dev": true, + "requires": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + } + }, + "has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", + "dev": true + }, + "supports-color": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", + "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", + "dev": true, + "requires": { + "has-flag": "^3.0.0" + } + } + } + }, + "text-table": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", + "integrity": "sha1-f17oI66AUgfACvLfSoTsP8+lcLQ=", + "dev": true + }, + "through": { + "version": "2.3.8", + "resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz", + "integrity": "sha1-DdTJ/6q8NXlgsbckEV1+Doai4fU=", + "dev": true + }, + "tmp": { + "version": "0.0.33", + "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.0.33.tgz", + "integrity": "sha1-bTQzWIl2jSGyvNoKonfO07G/rfk=", + "dev": true, + "requires": { + "os-tmpdir": "~1.0.2" + } + }, + "tough-cookie": { + "version": "2.4.3", + "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-2.4.3.tgz", + "integrity": "sha512-Q5srk/4vDM54WJsJio3XNn6K2sCG+CQ8G5Wz6bZhRZoAe/+TxjWB/GlFAnYEbkYVlON9FMk/fE3h2RLpPXo4lQ==", + "dev": true, + "requires": { + "psl": "^1.1.24", + "punycode": "^1.4.1" + }, + "dependencies": { + "punycode": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-1.4.1.tgz", + "integrity": "sha1-wNWmOycYgArY4esPpSachN1BhF4=", + "dev": true + } + } + }, + "tunnel-agent": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/tunnel-agent/-/tunnel-agent-0.6.0.tgz", + "integrity": "sha1-J6XeoGs2sEoKmWZ3SykIaPD8QP0=", + "dev": true, + "requires": { + "safe-buffer": "^5.0.1" + } + }, + "tweetnacl": { + "version": "0.14.5", + "resolved": "https://registry.npmjs.org/tweetnacl/-/tweetnacl-0.14.5.tgz", + "integrity": "sha1-WuaBd/GS1EViadEIr6k/+HQ/T2Q=", + "dev": true + }, + "type-check": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.3.2.tgz", + "integrity": "sha1-WITKtRLPHTVeP7eE8wgEsrUg23I=", + "dev": true, + "requires": { + "prelude-ls": "~1.1.2" + } + }, + "typedarray": { + "version": "0.0.6", + "resolved": "https://registry.npmjs.org/typedarray/-/typedarray-0.0.6.tgz", + "integrity": "sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c=", + "dev": true + }, + "uglify-js": { + "version": "2.8.29", + "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-2.8.29.tgz", + "integrity": "sha1-KcVzMUgFe7Th913zW3qcty5qWd0=", + "dev": true, + "optional": true, + "requires": { + "source-map": "~0.5.1", + "uglify-to-browserify": "~1.0.0", + "yargs": "~3.10.0" + }, + "dependencies": { + "camelcase": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-1.2.1.tgz", + "integrity": "sha1-m7UwTS4LVmmLLHWLCKPqqdqlijk=", + "dev": true, + "optional": true + }, + "cliui": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-2.1.0.tgz", + "integrity": "sha1-S0dXYP+AJkx2LDoXGQMukcf+oNE=", + "dev": true, + "optional": true, + "requires": { + "center-align": "^0.1.1", + "right-align": "^0.1.1", + "wordwrap": "0.0.2" + } + }, + "source-map": { + "version": "0.5.7", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.5.7.tgz", + "integrity": "sha1-igOdLRAh0i0eoUyA2OpGi6LvP8w=", + "dev": true, + "optional": true + }, + "wordwrap": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-0.0.2.tgz", + "integrity": "sha1-t5Zpu0LstAn4PVg8rVLKF+qhZD8=", + "dev": true, + "optional": true + }, + "yargs": { + "version": "3.10.0", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-3.10.0.tgz", + "integrity": "sha1-9+572FfdfB0tOMDnTvvWgdFDH9E=", + "dev": true, + "optional": true, + "requires": { + "camelcase": "^1.0.2", + "cliui": "^2.1.0", + "decamelize": "^1.0.0", + "window-size": "0.1.0" + } + } + } + }, + "uglify-to-browserify": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/uglify-to-browserify/-/uglify-to-browserify-1.0.2.tgz", + "integrity": "sha1-bgkk1r2mta/jSeOabWMoUKD4grc=", + "dev": true, + "optional": true + }, + "uri-js": { + "version": "4.2.2", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.2.2.tgz", + "integrity": "sha512-KY9Frmirql91X2Qgjry0Wd4Y+YTdrdZheS8TFwvkbLWf/G5KNJDCh6pKL5OZctEW4+0Baa5idK2ZQuELRwPznQ==", + "dev": true, + "requires": { + "punycode": "^2.1.0" + } + }, + "util-deprecate": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", + "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8=", + "dev": true + }, + "uuid": { + "version": "3.3.2", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.3.2.tgz", + "integrity": "sha512-yXJmeNaw3DnnKAOKJE51sL/ZaYfWJRl1pK9dr19YFCu0ObS231AB1/LbqTKRAQ5kw8A90rA6fr4riOUpTZvQZA==", + "dev": true + }, + "verror": { + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/verror/-/verror-1.10.0.tgz", + "integrity": "sha1-OhBcoXBTr1XW4nDB+CiGguGNpAA=", + "dev": true, + "requires": { + "assert-plus": "^1.0.0", + "core-util-is": "1.0.2", + "extsprintf": "^1.2.0" + } + }, + "which": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/which/-/which-1.3.0.tgz", + "integrity": "sha1-/wS9/AEO5UfXgL7DjhrBwnd9JTo=", + "requires": { + "isexe": "^2.0.0" + } + }, + "which-module": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/which-module/-/which-module-2.0.0.tgz", + "integrity": "sha1-2e8H3Od7mQK4o6j6SzHD4/fm6Ho=" + }, + "window-size": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/window-size/-/window-size-0.1.0.tgz", + "integrity": "sha1-VDjNLqk7IC76Ohn+iIeu58lPnJ0=", + "dev": true, + "optional": true + }, + "wordwrap": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", + "integrity": "sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=", + "dev": true + }, + "wrap-ansi": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-2.1.0.tgz", + "integrity": "sha1-2Pw9KE3QV5T+hJc8rs3Rz4JP3YU=", + "requires": { + "string-width": "^1.0.1", + "strip-ansi": "^3.0.1" + }, + "dependencies": { + "ansi-regex": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-2.1.1.tgz", + "integrity": "sha1-w7M6te42DYbg5ijwRorn7yfWVN8=" + }, + "is-fullwidth-code-point": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz", + "integrity": "sha1-754xOG8DGn8NZDr4L95QxFfvAMs=", + "requires": { + "number-is-nan": "^1.0.0" + } + }, + "string-width": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz", + "integrity": "sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M=", + "requires": { + "code-point-at": "^1.0.0", + "is-fullwidth-code-point": "^1.0.0", + "strip-ansi": "^3.0.0" + } + }, + "strip-ansi": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz", + "integrity": "sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8=", + "requires": { + "ansi-regex": "^2.0.0" + } + } + } + }, + "wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", + "dev": true + }, + "write": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/write/-/write-0.2.1.tgz", + "integrity": "sha1-X8A4KOJkzqP+kUVUdvejxWbLB1c=", + "dev": true, + "requires": { + "mkdirp": "^0.5.1" + } + }, + "xregexp": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/xregexp/-/xregexp-4.0.0.tgz", + "integrity": "sha1-5pgYneSd0qGMxWh7BeF8jkOUMCA=" + }, + "y18n": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.0.tgz", + "integrity": "sha1-le+U+F7MgdAHwmThkKEg8KPIVms=" + }, + "yallist": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-2.1.2.tgz", + "integrity": "sha1-HBH5IY8HYImkfdUS+TxmmaaoHVI=" + }, + "yargs": { + "version": "12.0.1", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-12.0.1.tgz", + "integrity": "sha1-ZDLlYSO7Tnw1YhFUAemDdAYCYcI=", + "requires": { + "cliui": "^4.0.0", + "decamelize": "^2.0.0", + "find-up": "^3.0.0", + "get-caller-file": "^1.0.1", + "os-locale": "^2.0.0", + "require-directory": "^2.1.1", + "require-main-filename": "^1.0.1", + "set-blocking": "^2.0.0", + "string-width": "^2.0.0", + "which-module": "^2.0.0", + "y18n": "^3.2.1 || ^4.0.0", + "yargs-parser": "^10.1.0" + }, + "dependencies": { + "decamelize": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-2.0.0.tgz", + "integrity": "sha1-ZW17vICUxMeI6lPFhAkIycfQY8c=", + "requires": { + "xregexp": "4.0.0" + } + } + } + }, + "yargs-parser": { + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-10.1.0.tgz", + "integrity": "sha1-cgImW4n36eny5XZeD+c1qQXtuqg=", + "requires": { + "camelcase": "^4.1.0" + } + } + } +} diff --git a/package.json b/package.json index efd793f..90fbbd9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "carto", - "version": "0.16.3", + "version": "1.2.0", "description": "Mapnik Stylesheet Compiler", "url": "https://github.com/mapbox/carto", "repository": { @@ -30,27 +30,27 @@ "man": "./man/carto.1", "main": "./lib/carto/index", "engines": { - "node": ">=0.4.x" + "node": ">=0.5.x" }, "dependencies": { - "chroma-js": "~1.1.1", - "husl": "^6.0.1", - "js-yaml": "^3.4.6", - "lodash": "^4.5.1", - "mapnik-reference": "~8.5.3", - "semver": "^5.1.0", - "yargs": "^4.2.0" + "chroma-js": "~1.3.5", + "hsluv": "~0.0.1", + "js-yaml": "~3.12.0", + "lodash": "~4.17.10", + "mapnik-reference": "~8.10.0", + "semver": "~5.6.0", + "yargs": "~12.0.1" }, "devDependencies": { - "coveralls": "~2.11.8", - "istanbul": "~0.4.2", - "mocha": "~2.4.5", - "mocha-eslint": "^2.0.1", - "sax": "~1.1.5" + "coveralls": "~3.0.0", + "istanbul": "~0.4.5", + "mocha": "~5.2.0", + "mocha-eslint": "^4.0.0", + "sax": "~1.2.1" }, "scripts": { - "pretest": "npm install", - "test": "mocha -R spec --timeout 50000", - "coverage": "istanbul cover ./node_modules/.bin/_mocha && coveralls < ./coverage/lcov.info" + "pretest": "npm install && mocha -R spec --timeout 50000 -f jslint", + "test": "mocha -R spec --timeout 50000 -i -f jslint", + "coverage": "istanbul cover ./node_modules/.bin/_mocha -- -R spec --timeout 50000 -i -f jslint && coveralls < ./coverage/lcov.info" } } diff --git a/test/bincarto.test.js b/test/bincarto.test.js index 2fb23f2..59e9552 100644 --- a/test/bincarto.test.js +++ b/test/bincarto.test.js @@ -19,7 +19,7 @@ describe('bin/carto', function() { var api = '1.0.0'; exec(util.format('node %s -a %s %s', bin, api, file), function(err, stdout, stderr) { assert.equal(1, err.code); - assert.equal("Mapnik version 1.0.0 is not supported\n", stderr); + assert.equal("Error: Version 1.0.0 is not supported\n", stderr); done(); }); }); @@ -28,7 +28,7 @@ describe('bin/carto', function() { var api = 'api'; exec(util.format('node %s -a %s %s', bin, api, file), function(err, stdout, stderr) { assert.equal(1, err.code); - assert.equal("carto: invalid Mapnik API version. A valid version is e.g. 3.0.10\n", stderr); + assert.equal("Error: Invalid API version. A valid version is e.g. 3.0.0 or 3.0.10\n", stderr); done(); }); }); @@ -48,7 +48,7 @@ describe('bin/carto', function() { assert.ifError(err); var expected = file.replace(path.extname(file),'')+'.xml'; var expected_data = fs.readFileSync(expected, 'utf8'); - assert.equal(stdout,expected_data + '\n'); + assert.equal(stdout.trim(),expected_data.trim()); done(); }); }); diff --git a/test/eclint.test.js b/test/eclint.test.js index c5cce9f..cbce110 100644 --- a/test/eclint.test.js +++ b/test/eclint.test.js @@ -1,6 +1,6 @@ var lint = require('mocha-eslint'); -describe('JS linting', function() { +describe('jslint', function() { var paths = [ 'bin', 'lib', diff --git a/test/errorhandling.test.js b/test/errorhandling.test.js index 603c514..72f35d7 100644 --- a/test/errorhandling.test.js +++ b/test/errorhandling.test.js @@ -2,34 +2,38 @@ var path = require('path'), assert = require('assert'), fs = require('fs'); -var carto = require('../lib/carto'); -var helper = require('./support/helper'); +var carto = require('../lib/carto'), + helper = require('./support/helper'), + util = require('../lib/carto/util'); describe('Error handling mml+mss', function() { helper.files('errorhandling', 'mml', function(file) { var basename = path.basename(file); it('should handle errors in ' + basename, function(done) { - var mml = helper.mml(file); - try { - new carto.Renderer({ - paths: [ path.dirname(file) ], - data_dir: path.join(__dirname, '../data'), - local_data_dir: path.join(__dirname, 'rendering'), - filename: file - }).render(mml); - // should not get here - assert.ok(false); - done(); - } catch (err) { - if (err.message.indexOf('***') > -1) throw err; - var output = err.message; + helper.mml(file, function (err, mml) { + var output = { + msg: null, + data: null + }; + + if (!err) { + output = new carto.Renderer({ + paths: [ path.dirname(file) ], + data_dir: path.join(__dirname, '../data'), + local_data_dir: path.join(__dirname, 'rendering'), + filename: file + }).render(mml); + } + else { + output.msg = err; + } // @TODO for some reason, fs.readFile includes an additional \n // at the end of read files. Determine why. // fs.writeFileSync(helper.resultFile(file), output); var data = fs.readFileSync(helper.resultFile(file), 'utf8'); - assert.deepEqual(output, data); + assert.deepEqual(util.getMessagesToPrint(output.msg), data); done(); - } + }); }); }); }); @@ -37,33 +41,26 @@ helper.files('errorhandling', 'mml', function(file) { describe('Error handling mss', function() { helper.files('errorhandling', 'mss', function(file) { var basename = path.basename(file); - if (basename == 'multi_stylesheets_a.mss') { + if (basename == 'multi_stylesheets_a.mss' || + basename == 'issue_29.mss') { return; } it('should handle errors in ' + basename, function(done) { var mss = helper.mss(file); - try { - new carto.Renderer({ - paths: [ path.dirname(file) ], - data_dir: path.join(__dirname, '../data'), - local_data_dir: path.join(__dirname, 'rendering'), - // note: we use the basename here so that the expected error result - // will match if the style was loaded from mml - filename: basename - }).renderMSS(mss); - // should not get here - assert.ok(false); - done(); - } catch (err) { - if (err.message.indexOf('***') > -1) throw err; - var output = err.message; - // @TODO for some reason, fs.readFile includes an additional \n - // at the end of read files. Determine why. - // fs.writeFileSync(helper.resultFile(file), output); - var data = fs.readFileSync(helper.resultFile(file), 'utf8'); - assert.deepEqual(output, data); - done(); - } + var output = new carto.Renderer({ + paths: [ path.dirname(file) ], + data_dir: path.join(__dirname, '../data'), + local_data_dir: path.join(__dirname, 'rendering'), + // note: we use the basename here so that the expected error result + // will match if the style was loaded from mml + filename: basename + }).renderMSS(mss); + // @TODO for some reason, fs.readFile includes an additional \n + // at the end of read files. Determine why. + // fs.writeFileSync(helper.resultFile(file), output); + var data = fs.readFileSync(helper.resultFile(file), 'utf8'); + assert.deepEqual(util.getMessagesToPrint(output.msg), data); + done(); }); }); }); diff --git a/test/errorhandling/bad_filter.mml b/test/errorhandling/bad_filter.mml index 123c427..52ea349 100644 --- a/test/errorhandling/bad_filter.mml +++ b/test/errorhandling/bad_filter.mml @@ -1,7 +1,7 @@ { "Layer": [ { - "name": "a" + "id": "a" } ], "Stylesheet": [ diff --git a/test/errorhandling/bad_filter.result b/test/errorhandling/bad_filter.result index 4d035c5..091bc43 100644 --- a/test/errorhandling/bad_filter.result +++ b/test/errorhandling/bad_filter.result @@ -1 +1 @@ -bad_filter.mss: [[CODE]!=@x] added to [CODE]=X produces an invalid filter
\ No newline at end of file +Error: bad_filter.mss:3:10 [[CODE]!=@x] added to [CODE]=X produces an invalid filter
\ No newline at end of file diff --git a/test/errorhandling/bad_op.mml b/test/errorhandling/bad_op.mml index c01f1a3..93632ce 100644 --- a/test/errorhandling/bad_op.mml +++ b/test/errorhandling/bad_op.mml @@ -5,7 +5,6 @@ ], "Layer": [{ "id": "world", - "name": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/errorhandling/bad_op.result b/test/errorhandling/bad_op.result index 017498c..f63dd5d 100644 --- a/test/errorhandling/bad_op.result +++ b/test/errorhandling/bad_op.result @@ -1 +1 @@ -bad_op.mss:2:4 If two operands differ, the first must not be %
\ No newline at end of file +Error: bad_op.mss:2:4 If two operands differ, the first must not be %
\ No newline at end of file diff --git a/test/errorhandling/bad_op_2.mml b/test/errorhandling/bad_op_2.mml index 3f8e503..1acf819 100644 --- a/test/errorhandling/bad_op_2.mml +++ b/test/errorhandling/bad_op_2.mml @@ -5,7 +5,6 @@ ], "Layer": [{ "id": "world", - "name": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/errorhandling/bad_op_2.result b/test/errorhandling/bad_op_2.result index 452c4e0..a06f545 100644 --- a/test/errorhandling/bad_op_2.result +++ b/test/errorhandling/bad_op_2.result @@ -1 +1 @@ -bad_op_2.mss:2:4 Percent values can only be added or subtracted from other values
\ No newline at end of file +Error: bad_op_2.mss:2:4 Percent values can only be added or subtracted from other values
\ No newline at end of file diff --git a/test/errorhandling/color_functions.mml b/test/errorhandling/color_functions.mml index 00d1f78..5440f61 100644 --- a/test/errorhandling/color_functions.mml +++ b/test/errorhandling/color_functions.mml @@ -5,7 +5,6 @@ ], "Layer": [{ "id": "world", - "name": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/errorhandling/color_functions.result b/test/errorhandling/color_functions.result index 8d27065..b9b8085 100644 --- a/test/errorhandling/color_functions.result +++ b/test/errorhandling/color_functions.result @@ -1 +1 @@ -color_functions.mss:3:31 incorrect arguments given to hsl()
\ No newline at end of file +Error: color_functions.mss:3:31 incorrect arguments given to hsl()
\ No newline at end of file diff --git a/test/errorhandling/contradiction.mml b/test/errorhandling/contradiction.mml index d6b4416..8f47e6b 100644 --- a/test/errorhandling/contradiction.mml +++ b/test/errorhandling/contradiction.mml @@ -4,7 +4,7 @@ "contradiction.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/district.geojson", diff --git a/test/errorhandling/contradiction.result b/test/errorhandling/contradiction.result index 8af476b..39f168f 100644 --- a/test/errorhandling/contradiction.result +++ b/test/errorhandling/contradiction.result @@ -1 +1 @@ -contradiction.mss:1:37 [[FeatureCla]=] added to [FeatureCla]!= produces an invalid filter
\ No newline at end of file +Error: contradiction.mss:1:37 [[FeatureCla]=] added to [FeatureCla]!= produces an invalid filter
\ No newline at end of file diff --git a/test/errorhandling/contradiction_2.result b/test/errorhandling/contradiction_2.result index 7269ced..b6e7607 100644 --- a/test/errorhandling/contradiction_2.result +++ b/test/errorhandling/contradiction_2.result @@ -1 +1 @@ -contradiction_2.mss:1:37 [[FeatureCla]!=] added to [FeatureCla]= produces an invalid filter
\ No newline at end of file +Error: contradiction_2.mss:1:37 [[FeatureCla]!=] added to [FeatureCla]= produces an invalid filter
\ No newline at end of file diff --git a/test/errorhandling/function_args.mml b/test/errorhandling/function_args.mml index 63899ff..df092cc 100644 --- a/test/errorhandling/function_args.mml +++ b/test/errorhandling/function_args.mml @@ -5,7 +5,6 @@ ], "Layer": [{ "id": "world", - "name": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/errorhandling/function_args.result b/test/errorhandling/function_args.result index a189b88..2ed5f44 100644 --- a/test/errorhandling/function_args.result +++ b/test/errorhandling/function_args.result @@ -1 +1 @@ -function_args.mss:3:38 unknown function agg-stack-blu(), did you mean agg-stack-blur(2)
\ No newline at end of file +Error: function_args.mss:3:38 unknown function agg-stack-blu(), did you mean agg-stack-blur(2)
\ No newline at end of file diff --git a/test/errorhandling/invalid_attachment.mml b/test/errorhandling/invalid_attachment.mml index 05b0bfe..ca10826 100644 --- a/test/errorhandling/invalid_attachment.mml +++ b/test/errorhandling/invalid_attachment.mml @@ -5,7 +5,6 @@ ], "Layer": [{ "id": "world", - "name": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/errorhandling/invalid_attachment.result b/test/errorhandling/invalid_attachment.result index 2d2bcbc..d9a7f9f 100644 --- a/test/errorhandling/invalid_attachment.result +++ b/test/errorhandling/invalid_attachment.result @@ -1 +1 @@ -invalid_attachment.mss:1:19 Encountered second attachment name. +Error: invalid_attachment.mss:1:19 Encountered second attachment name.
\ No newline at end of file diff --git a/test/errorhandling/invalid_color_in_fn.result b/test/errorhandling/invalid_color_in_fn.result index 8106354..5ae1ef9 100644 --- a/test/errorhandling/invalid_color_in_fn.result +++ b/test/errorhandling/invalid_color_in_fn.result @@ -1 +1 @@ -invalid_color_in_fn.mss:2:34 incorrect arguments given to spin()
\ No newline at end of file +Error: invalid_color_in_fn.mss:2:34 incorrect arguments given to spin()
\ No newline at end of file diff --git a/test/errorhandling/invalid_property.mml b/test/errorhandling/invalid_property.mml index fb70feb..99c7d91 100644 --- a/test/errorhandling/invalid_property.mml +++ b/test/errorhandling/invalid_property.mml @@ -5,7 +5,6 @@ ], "Layer": [{ "id": "world", - "name": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/errorhandling/invalid_property.result b/test/errorhandling/invalid_property.result index d384047..0104058 100644 --- a/test/errorhandling/invalid_property.result +++ b/test/errorhandling/invalid_property.result @@ -1 +1 @@ -invalid_property.mss:3:2 Unrecognized rule: polygonopacity. Did you mean polygon-opacity?
\ No newline at end of file +Error: invalid_property.mss:3:2 Unrecognized rule: polygonopacity. Did you mean polygon-opacity?
\ No newline at end of file diff --git a/test/errorhandling/invalid_value.mml b/test/errorhandling/invalid_value.mml index 7f2ec06..4a97c1e 100644 --- a/test/errorhandling/invalid_value.mml +++ b/test/errorhandling/invalid_value.mml @@ -5,7 +5,6 @@ ], "Layer": [{ "id": "world", - "name": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/errorhandling/invalid_value.result b/test/errorhandling/invalid_value.result index e70d73e..56819fb 100644 --- a/test/errorhandling/invalid_value.result +++ b/test/errorhandling/invalid_value.result @@ -1 +1 @@ -invalid_value.mss:2:2 Invalid value for text-face-name, the type font is expected. 2 (of type float) was given.
\ No newline at end of file +Error: invalid_value.mss:2:2 Invalid value for text-face-name, the type font is expected. 2 (of type float) was given.
\ No newline at end of file diff --git a/test/errorhandling/invaliddimension.mml b/test/errorhandling/invaliddimension.mml index 9c62378..9185d6c 100644 --- a/test/errorhandling/invaliddimension.mml +++ b/test/errorhandling/invaliddimension.mml @@ -5,7 +5,6 @@ ], "Layer": [{ "id": "world", - "name": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/errorhandling/invaliddimension.result b/test/errorhandling/invaliddimension.result index dcf75c2..955ddcb 100644 --- a/test/errorhandling/invaliddimension.result +++ b/test/errorhandling/invaliddimension.result @@ -1 +1 @@ -invaliddimension.mss:2:4 Invalid unit: 'wifflewaffles'
\ No newline at end of file +Error: invaliddimension.mss:2:4 Invalid unit: 'wifflewaffles'
\ No newline at end of file diff --git a/test/errorhandling/issue119.mml b/test/errorhandling/issue119.mml index c42e776..3d51b97 100644 --- a/test/errorhandling/issue119.mml +++ b/test/errorhandling/issue119.mml @@ -4,7 +4,7 @@ "issue119.mss" ], "Layer": [{ - "name": "countries", + "id": "countries", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/errorhandling/issue119.result b/test/errorhandling/issue119.result index 1204e91..e0ec901 100644 --- a/test/errorhandling/issue119.result +++ b/test/errorhandling/issue119.result @@ -1 +1 @@ -issue119.mss:2:2 Map properties are not permitted in other rules
\ No newline at end of file +Error: issue119.mss:2:2 Map properties are not permitted in other rules
\ No newline at end of file diff --git a/test/errorhandling/issue123.mml b/test/errorhandling/issue123.mml index c387bd7..d53b316 100644 --- a/test/errorhandling/issue123.mml +++ b/test/errorhandling/issue123.mml @@ -4,7 +4,7 @@ "issue123.mss" ], "Layer": [{ - "name": "countries", + "id": "countries", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/errorhandling/issue123.result b/test/errorhandling/issue123.result index 875e815..e397688 100644 --- a/test/errorhandling/issue123.result +++ b/test/errorhandling/issue123.result @@ -1 +1 @@ -issue123.mss:3:31 incorrect number of arguments for darken(). 2 expected.
\ No newline at end of file +Error: issue123.mss:3:31 incorrect number of arguments for darken(). 2 expected.
\ No newline at end of file diff --git a/test/errorhandling/issue124.mml b/test/errorhandling/issue124.mml index 6c1b45a..0268a32 100644 --- a/test/errorhandling/issue124.mml +++ b/test/errorhandling/issue124.mml @@ -4,7 +4,7 @@ "issue124.mss" ], "Layer": [{ - "name": "countries", + "id": "countries", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/errorhandling/issue124.result b/test/errorhandling/issue124.result index 3fd8797..be915ba 100644 --- a/test/errorhandling/issue124.result +++ b/test/errorhandling/issue124.result @@ -1 +1 @@ -issue124.mss:6:0 missing closing `}`
\ No newline at end of file +Error: issue124.mss:6:0 missing closing `}`
\ No newline at end of file diff --git a/test/errorhandling/issue165.mml b/test/errorhandling/issue165.mml new file mode 100644 index 0000000..b3db1f8 --- /dev/null +++ b/test/errorhandling/issue165.mml @@ -0,0 +1,12 @@ +{ + "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", + "Stylesheet": [ + ], + "Layer": [{ + "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", + "Datasource": { + "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", + "type": "shape" + } + }] +} diff --git a/test/errorhandling/issue165.result b/test/errorhandling/issue165.result new file mode 100644 index 0000000..a60d63f --- /dev/null +++ b/test/errorhandling/issue165.result @@ -0,0 +1 @@ +Error: The id attribute is required for layers.
\ No newline at end of file diff --git a/test/errorhandling/issue297.mml b/test/errorhandling/issue297.mml index b27064e..b6076c3 100644 --- a/test/errorhandling/issue297.mml +++ b/test/errorhandling/issue297.mml @@ -3,6 +3,6 @@ "issue297.mss" ], "Layer": [{ - "name": "t" + "id": "t" }] } diff --git a/test/errorhandling/issue297.result b/test/errorhandling/issue297.result index c2fe924..c99a299 100644 --- a/test/errorhandling/issue297.result +++ b/test/errorhandling/issue297.result @@ -1 +1 @@ -issue297.mss:3:2 Invalid value for text-face-name, the type font is expected. 2 (of type float) was given.
\ No newline at end of file +Error: issue297.mss:3:2 Invalid value for text-face-name, the type font is expected. 2 (of type float) was given.
\ No newline at end of file diff --git a/test/errorhandling/issue_204_a.result b/test/errorhandling/issue_204_a.result index ca4418e..f2d5cec 100644 --- a/test/errorhandling/issue_204_a.result +++ b/test/errorhandling/issue_204_a.result @@ -1 +1 @@ -issue_204_a.mss:3:1 missing opening `{`
\ No newline at end of file +Error: issue_204_a.mss:3:1 missing opening `{`
\ No newline at end of file diff --git a/test/errorhandling/issue_204_b.result b/test/errorhandling/issue_204_b.result index 1ddd28f..7f1968d 100644 --- a/test/errorhandling/issue_204_b.result +++ b/test/errorhandling/issue_204_b.result @@ -1 +1 @@ -issue_204_b.mss:3:3 missing opening `{`
\ No newline at end of file +Error: issue_204_b.mss:3:3 missing opening `{`
\ No newline at end of file diff --git a/test/errorhandling/issue_204_c.result b/test/errorhandling/issue_204_c.result index 8588127..88a2328 100644 --- a/test/errorhandling/issue_204_c.result +++ b/test/errorhandling/issue_204_c.result @@ -1 +1 @@ -issue_204_c.mss:4:0 missing opening `{`
\ No newline at end of file +Error: issue_204_c.mss:4:0 missing opening `{`
\ No newline at end of file diff --git a/test/errorhandling/issue_218.result b/test/errorhandling/issue_218.result index 2acca5c..7f66466 100644 --- a/test/errorhandling/issue_218.result +++ b/test/errorhandling/issue_218.result @@ -1 +1 @@ -issue_218.mss:5:2 missing opening `{`
\ No newline at end of file +Error: issue_218.mss:5:2 missing opening `{`
\ No newline at end of file diff --git a/test/errorhandling/issue_29.mml b/test/errorhandling/issue_29.mml new file mode 100644 index 0000000..a47cc70 --- /dev/null +++ b/test/errorhandling/issue_29.mml @@ -0,0 +1,12 @@ +{ + "name": "", + "scale": 1, + "Stylesheet": [ + "issue_29.mss" + ], + "Layer": [ + { + "id": "test" + } + ] +} diff --git a/test/errorhandling/issue_29.mss b/test/errorhandling/issue_29.mss new file mode 100644 index 0000000..fbfb21e --- /dev/null +++ b/test/errorhandling/issue_29.mss @@ -0,0 +1,3 @@ +#bla { + marker-fill: black; +} diff --git a/test/errorhandling/issue_29.result b/test/errorhandling/issue_29.result new file mode 100644 index 0000000..52e585a --- /dev/null +++ b/test/errorhandling/issue_29.result @@ -0,0 +1,2 @@ +Warning: Layer test has no styles associated with it. +Warning: issue_29.mss:2:4 Styles do not match layer selector #bla.
\ No newline at end of file diff --git a/test/errorhandling/issue_462.mss b/test/errorhandling/issue_462.mss new file mode 100644 index 0000000..36fe49b --- /dev/null +++ b/test/errorhandling/issue_462.mss @@ -0,0 +1,6 @@ +#test { + shield: auto; + text: auto; + line-pattern: auto; + polygon-pattern: auto; +} diff --git a/test/errorhandling/issue_462.result b/test/errorhandling/issue_462.result new file mode 100644 index 0000000..511a6c0 --- /dev/null +++ b/test/errorhandling/issue_462.result @@ -0,0 +1,8 @@ +Warning: issue_462.mss:2:4 shield is unstable. It may change in the future. +Error: issue_462.mss:2:4 Invalid value for shield, the type keyword (options: none) is expected. auto (of type keyword) was given. +Warning: issue_462.mss:3:4 text is unstable. It may change in the future. +Error: issue_462.mss:3:4 Invalid value for text, the type keyword (options: none) is expected. auto (of type keyword) was given. +Warning: issue_462.mss:4:4 line-pattern is unstable. It may change in the future. +Error: issue_462.mss:4:4 Invalid value for line-pattern, the type keyword (options: none) is expected. auto (of type keyword) was given. +Warning: issue_462.mss:5:4 polygon-pattern is unstable. It may change in the future. +Error: issue_462.mss:5:4 Invalid value for polygon-pattern, the type keyword (options: none) is expected. auto (of type keyword) was given.
\ No newline at end of file diff --git a/test/errorhandling/issue_474.mss b/test/errorhandling/issue_474.mss new file mode 100644 index 0000000..14aa32a --- /dev/null +++ b/test/errorhandling/issue_474.mss @@ -0,0 +1,7 @@ +#test { + marker-type: ellipse; + line-offset: 2; + text-name: [name]; + text-face-name: Arial; + text-largest-bbox-only: true; +} diff --git a/test/errorhandling/issue_474.result b/test/errorhandling/issue_474.result new file mode 100644 index 0000000..9ccd316 --- /dev/null +++ b/test/errorhandling/issue_474.result @@ -0,0 +1,3 @@ +Warning: issue_474.mss:2:4 marker-type is deprecated. It may be removed in the future. +Warning: issue_474.mss:3:4 line-offset is unstable. It may change in the future. +Warning: issue_474.mss:6:4 text-largest-bbox-only is experimental. It may change, be renamed or removed in the future.
\ No newline at end of file diff --git a/test/errorhandling/mapnik_keyword.mml b/test/errorhandling/mapnik_keyword.mml index ede73af..ec9e1fe 100644 --- a/test/errorhandling/mapnik_keyword.mml +++ b/test/errorhandling/mapnik_keyword.mml @@ -4,7 +4,7 @@ "mapnik_keyword.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/errorhandling/mapnik_keyword.result b/test/errorhandling/mapnik_keyword.result index 598985b..30cdefa 100644 --- a/test/errorhandling/mapnik_keyword.result +++ b/test/errorhandling/mapnik_keyword.result @@ -1 +1 @@ -mapnik_keyword.mss:1:6 nul is not a valid keyword in a filter expression
\ No newline at end of file +Error: mapnik_keyword.mss:1:6 nul is not a valid keyword in a filter expression
\ No newline at end of file diff --git a/test/errorhandling/missing_close.mml b/test/errorhandling/missing_close.mml index 4dee5ed..fb79a63 100644 --- a/test/errorhandling/missing_close.mml +++ b/test/errorhandling/missing_close.mml @@ -4,7 +4,7 @@ "missing_close.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/errorhandling/missing_close.result b/test/errorhandling/missing_close.result index 29e63fb..64da572 100644 --- a/test/errorhandling/missing_close.result +++ b/test/errorhandling/missing_close.result @@ -1 +1 @@ -missing_close.mss:1:5 Missing closing ] of filter.
\ No newline at end of file +Error: missing_close.mss:1:5 Missing closing ] of filter.
\ No newline at end of file diff --git a/test/errorhandling/multi_stylesheets.mml b/test/errorhandling/multi_stylesheets.mml index 698a900..867978c 100644 --- a/test/errorhandling/multi_stylesheets.mml +++ b/test/errorhandling/multi_stylesheets.mml @@ -6,7 +6,6 @@ ], "Layer": [{ "id": "world", - "name": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/errorhandling/multi_stylesheets.result b/test/errorhandling/multi_stylesheets.result index 74ff117..678d384 100644 --- a/test/errorhandling/multi_stylesheets.result +++ b/test/errorhandling/multi_stylesheets.result @@ -1 +1 @@ -multi_stylesheets_b.mss:2:2 Unrecognized rule: polygonopacity. Did you mean polygon-opacity?
\ No newline at end of file +Error: multi_stylesheets_b.mss:2:2 Unrecognized rule: polygonopacity. Did you mean polygon-opacity?
\ No newline at end of file diff --git a/test/errorhandling/multi_stylesheets_b.result b/test/errorhandling/multi_stylesheets_b.result index 74ff117..678d384 100644 --- a/test/errorhandling/multi_stylesheets_b.result +++ b/test/errorhandling/multi_stylesheets_b.result @@ -1 +1 @@ -multi_stylesheets_b.mss:2:2 Unrecognized rule: polygonopacity. Did you mean polygon-opacity?
\ No newline at end of file +Error: multi_stylesheets_b.mss:2:2 Unrecognized rule: polygonopacity. Did you mean polygon-opacity?
\ No newline at end of file diff --git a/test/rendering/no_stylesheet.mml b/test/errorhandling/no_stylesheet.mml index 28bc61c..7b79e7a 100644 --- a/test/rendering/no_stylesheet.mml +++ b/test/errorhandling/no_stylesheet.mml @@ -1,7 +1,7 @@ { "Layer": [ { - "name": "a" + "id": "a" } ] } diff --git a/test/errorhandling/no_stylesheet.result b/test/errorhandling/no_stylesheet.result new file mode 100644 index 0000000..4ef899d --- /dev/null +++ b/test/errorhandling/no_stylesheet.result @@ -0,0 +1 @@ +Error: Expecting a Stylesheet property containing an (array of) stylesheet object(s) of the form { id: 'x', 'data': 'y' }.
\ No newline at end of file diff --git a/test/errorhandling/nopound.mml b/test/errorhandling/nopound.mml index 8f63a38..3e34689 100644 --- a/test/errorhandling/nopound.mml +++ b/test/errorhandling/nopound.mml @@ -5,7 +5,6 @@ ], "Layer": [{ "id": "world", - "name": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/errorhandling/nopound.result b/test/errorhandling/nopound.result index eebd7da..973453f 100644 --- a/test/errorhandling/nopound.result +++ b/test/errorhandling/nopound.result @@ -1 +1 @@ -nopound.mss:1:0 Invalid code: world { +Error: nopound.mss:1:0 Invalid code: world {
\ No newline at end of file diff --git a/test/errorhandling/notenoughargs.mml b/test/errorhandling/notenoughargs.mml index fe20067..578fdd5 100644 --- a/test/errorhandling/notenoughargs.mml +++ b/test/errorhandling/notenoughargs.mml @@ -5,7 +5,6 @@ ], "Layer": [{ "id": "world", - "name": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/errorhandling/notenoughargs.result b/test/errorhandling/notenoughargs.result index 5ee5ba2..375fc19 100644 --- a/test/errorhandling/notenoughargs.result +++ b/test/errorhandling/notenoughargs.result @@ -1 +1 @@ -notenoughargs.mss:3:31 incorrect number of arguments for darken(). 2 expected.
\ No newline at end of file +Error: notenoughargs.mss:3:31 incorrect number of arguments for darken(). 2 expected.
\ No newline at end of file diff --git a/test/errorhandling/stylesheet_absolute_file.mml b/test/errorhandling/stylesheet_absolute_file.mml new file mode 100644 index 0000000..a1fec3b --- /dev/null +++ b/test/errorhandling/stylesheet_absolute_file.mml @@ -0,0 +1,5 @@ +{ + "Stylesheet": [ + "/home/test/test.mss" + ] +} diff --git a/test/errorhandling/stylesheet_absolute_file.result b/test/errorhandling/stylesheet_absolute_file.result new file mode 100644 index 0000000..b6f7ad6 --- /dev/null +++ b/test/errorhandling/stylesheet_absolute_file.result @@ -0,0 +1 @@ +Error: Failed to load file /home/test/test.mss.
\ No newline at end of file diff --git a/test/errorhandling/stylesheet_absolute_file_syswin.result b/test/errorhandling/stylesheet_absolute_file_syswin.result new file mode 100644 index 0000000..d244a3e --- /dev/null +++ b/test/errorhandling/stylesheet_absolute_file_syswin.result @@ -0,0 +1 @@ +Error: Failed to load file C:\home\test\test.mss.
\ No newline at end of file diff --git a/test/errorhandling/stylesheet_no_data.mml b/test/errorhandling/stylesheet_no_data.mml index bf8dea4..7df69e2 100644 --- a/test/errorhandling/stylesheet_no_data.mml +++ b/test/errorhandling/stylesheet_no_data.mml @@ -1,7 +1,7 @@ { "Layer": [ { - "name": "a" + "id": "a" } ], "Stylesheet": [{ diff --git a/test/errorhandling/stylesheet_no_data.result b/test/errorhandling/stylesheet_no_data.result index 1f4227d..2a170a2 100644 --- a/test/errorhandling/stylesheet_no_data.result +++ b/test/errorhandling/stylesheet_no_data.result @@ -1 +1 @@ -Expecting a stylesheet object of the form { id: 'x', 'data': 'y' } for the Stylesheet property. +Error: Expecting a stylesheet object of the form { id: 'x', 'data': 'y' } for the Stylesheet property.
\ No newline at end of file diff --git a/test/errorhandling/stylesheet_no_id.mml b/test/errorhandling/stylesheet_no_id.mml index d7f28fc..57ded32 100644 --- a/test/errorhandling/stylesheet_no_id.mml +++ b/test/errorhandling/stylesheet_no_id.mml @@ -1,7 +1,7 @@ { "Layer": [ { - "name": "a" + "id": "a" } ], "Stylesheet": [{ diff --git a/test/errorhandling/stylesheet_no_id.result b/test/errorhandling/stylesheet_no_id.result index 1f4227d..2a170a2 100644 --- a/test/errorhandling/stylesheet_no_id.result +++ b/test/errorhandling/stylesheet_no_id.result @@ -1 +1 @@ -Expecting a stylesheet object of the form { id: 'x', 'data': 'y' } for the Stylesheet property. +Error: Expecting a stylesheet object of the form { id: 'x', 'data': 'y' } for the Stylesheet property.
\ No newline at end of file diff --git a/test/errorhandling/undefined_variable.mml b/test/errorhandling/undefined_variable.mml index 668b6d9..74880a8 100644 --- a/test/errorhandling/undefined_variable.mml +++ b/test/errorhandling/undefined_variable.mml @@ -5,7 +5,6 @@ ], "Layer": [{ "id": "world", - "name": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/errorhandling/undefined_variable.result b/test/errorhandling/undefined_variable.result index 2a6c6cc..70e9e2a 100644 --- a/test/errorhandling/undefined_variable.result +++ b/test/errorhandling/undefined_variable.result @@ -1,3 +1,3 @@ -undefined_variable.mss:2:16 variable @something is undefined -undefined_variable.mss:3:14 variable @something is undefined -undefined_variable.mss:4:22 variable @something is undefined
\ No newline at end of file +Error: undefined_variable.mss:2:16 variable @something is undefined +Error: undefined_variable.mss:3:14 variable @something is undefined +Error: undefined_variable.mss:4:22 variable @something is undefined
\ No newline at end of file diff --git a/test/errorhandling/zoom_as_var.mml b/test/errorhandling/zoom_as_var.mml index c2d964a..6202d59 100644 --- a/test/errorhandling/zoom_as_var.mml +++ b/test/errorhandling/zoom_as_var.mml @@ -5,7 +5,6 @@ ], "Layer": [{ "id": "world", - "name": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/errorhandling/zoom_as_var.result b/test/errorhandling/zoom_as_var.result index b1849cd..b3eb277 100644 --- a/test/errorhandling/zoom_as_var.result +++ b/test/errorhandling/zoom_as_var.result @@ -1 +1 @@ -zoom_as_var.mss:2:2 Cannot do math with type keyword.
\ No newline at end of file +Error: zoom_as_var.mss:2:2 Cannot do math with type keyword.
\ No newline at end of file diff --git a/test/errorhandling/zoommax.mml b/test/errorhandling/zoommax.mml index 5cae361..464abc7 100644 --- a/test/errorhandling/zoommax.mml +++ b/test/errorhandling/zoommax.mml @@ -5,7 +5,6 @@ ], "Layer": [{ "id": "world", - "name": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/errorhandling/zoommax.result b/test/errorhandling/zoommax.result index d9a2d2c..2e8453e 100644 --- a/test/errorhandling/zoommax.result +++ b/test/errorhandling/zoommax.result @@ -1 +1 @@ -zoommax.mss:1:6 Only zoom levels between 0 and 25 supported.
\ No newline at end of file +Error: zoommax.mss:1:6 Only zoom levels between 0 and 25 supported.
\ No newline at end of file diff --git a/test/filter.test.js b/test/filter.test.js index a301ca9..e223bc2 100644 --- a/test/filter.test.js +++ b/test/filter.test.js @@ -6,19 +6,21 @@ require('../lib/carto/tree/filter'); describe('Field', function() { describe('basic functionality', function() { + var ref = new tree.Reference(); + ref.setVersion(ref.getLatest()); it('should be constructed', function() { var f = new tree.Filter(new tree.Field('foo'), '=', new tree.Dimension(1)); assert.ok(f); }); it('can be evaluated', function() { var f = new tree.Filter(new tree.Field('foo'), '=', new tree.Dimension(1)); - f.ev({}); + f.ev({ ref: ref }); assert.ok(f); }); - it('yields xml', function() { + it('yields object', function() { var f = new tree.Filter(new tree.Field('foo'), '=', new tree.Dimension(1)); - f.ev({}); - assert.equal(f.toXML({}), '[foo] = 1'); + f.ev({ ref: ref }); + assert.equal(f.toObject({ ref: ref }), '[foo] = 1'); }); }); }); diff --git a/test/filterset.test.js b/test/filterset.test.js index 9cb4df2..cfdca17 100644 --- a/test/filterset.test.js +++ b/test/filterset.test.js @@ -9,9 +9,9 @@ describe('Filtersets', function() { assert.ok(f); assert.ok(f.filters); }); - it('yields xml', function() { + it('yields object', function() { var f = new tree.Filterset(); - assert.equal(f.toXML({}), ''); + assert.deepEqual(f.toObject({}), {}); }); it('yields a clone', function() { var f = new tree.Filterset(); diff --git a/test/reference.test.js b/test/reference.test.js new file mode 100644 index 0000000..b44a00a --- /dev/null +++ b/test/reference.test.js @@ -0,0 +1,87 @@ +var assert = require('assert'), + _ = require('lodash'); + +var carto = require('../lib/carto'); + +describe('Reference', function() { + it('should accept custom reference adhering to spec', function(done) { + var customRef = { + load: function (wanted) { + return { + version: wanted, + style: {}, + layer: {}, + symbolizers: { + bla: { + width: { + css: 'bla-width', + type: 'float' + } + } + }, + colors: {}, + datasources: {} + }; + }, + latest: '1.5.0', + versions: [ + '1.0.0', + '1.5.0' + ] + }; + var renderer = new carto.Renderer({ + reference: customRef + }), + output = renderer.renderMSS('#test { bla-width: 1; }'); + assert.equal(output.msg, null); + assert.equal(output.data, '<Style filter-mode="first" name="style">\n <Rule>\n <BlaSymbolizer width="1" />\n </Rule>\n</Style>\n'); + done(); + }); + + it('should reject custom reference not adhering to spec', function(done) { + var customRef = { + load: function (wanted) { + return wanted; + }, + latest: '1.5.0', + versions: [ + '1.0.0', + '1.5.0' + ] + }; + var renderer = new carto.Renderer({ + reference: customRef + }), + output = renderer.renderMSS('#test { marker-color: #fff; }'); + assert.ok(!_.isNil(output.msg) && output.msg.length > 0); + assert.equal(output.msg[0].message, 'Could not use the given reference, because it does not adhere to the specification. See the documentation for details.'); + done(); + }); + + it('should error on no rules', function(done) { + var customRef = { + load: function (wanted) { + return { + version: wanted, + style: {}, + layer: {}, + symbolizers: {}, + colors: {}, + datasources: {} + }; + }, + latest: '1.5.0', + versions: [ + '1.0.0', + '1.5.0' + ] + }; + var renderer = new carto.Renderer({ + reference: customRef + }), + output = renderer.renderMSS('#test { marker-width: 1; }'); + assert.ok(!_.isNil(output.msg) && output.msg.length > 0); + assert.equal(output.msg[0].message, 'Unrecognized rule: marker-width.'); + done(); + }); +}); diff --git a/test/rendering-mss.test.js b/test/rendering-mss.test.js index 74ded5e..10dc537 100644 --- a/test/rendering-mss.test.js +++ b/test/rendering-mss.test.js @@ -1,37 +1,46 @@ var path = require('path'), assert = require('assert'), - fs = require('fs'); - -var existsSync = require('fs').existsSync || require('path').existsSync; -var carto = require('../lib/carto'); -var helper = require('./support/helper'); - + fs = require('fs'), + _ = require('lodash'), + existsSync = require('fs').existsSync || require('path').existsSync; +var carto = require('../lib/carto'), + helper = require('./support/helper'), + util = require('../lib/carto/util'); describe('Rendering mss', function() { helper.files('rendering-mss', 'mss', function(file) { - it('should render mss ' + path.basename(file) + ' correctly', function() { - var mss = helper.mss(file); - try { - var output = new carto.Renderer({ + it('should render mss ' + path.basename(file) + ' correctly', function(done) { + var mss = helper.mss(file), + output = new carto.Renderer({ paths: [ path.dirname(file) ], data_dir: path.join(__dirname, '../data'), local_data_dir: path.join(__dirname, 'rendering'), filename: file }).renderMSS(mss); - } catch (err) { - if (Array.isArray(err)){ - err.forEach(carto.writeError); - } else { - throw err; + if (!_.isNil(output.data)) { + var expected = file.replace(path.extname(file),'')+'.xml'; + if (!existsSync(expected)) { + fs.writeFileSync(expected,output); } + var expected_data = fs.readFileSync(expected).toString(); + assert.equal(output.data.trim(),expected_data.trim()); } - var expected = file.replace(path.extname(file),'')+'.xml'; - if (!existsSync(expected)) { - fs.writeFileSync(expected,output); + else { + if (_.has(output, 'msg') && _.isArray(output.msg) && + output.msg.length > 0) { + _.forEach(output.msg, function (v) { + if (v.type === 'error') { + console.error(util.getMessageToPrint(v)); + } + else if (v.type === 'warning') { + console.warn(util.getMessageToPrint(v)); + } + }); + } + assert.ok(false); } - var expected_data = fs.readFileSync(expected).toString(); - assert.equal(output.trim(),expected_data.trim()); + done(); }); }); }); diff --git a/test/rendering-mss/basic_attachment_internal.xml b/test/rendering-mss/basic_attachment_internal.xml index 6abf66d..03e35c7 100644 --- a/test/rendering-mss/basic_attachment_internal.xml +++ b/test/rendering-mss/basic_attachment_internal.xml @@ -1,10 +1,10 @@ -<Style name="style-inline" filter-mode="first"> +<Style filter-mode="first" name="style-inline"> <Rule> <LineSymbolizer stroke="#00ff00" stroke-width="5" /> </Rule> </Style> -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> <LineSymbolizer stroke="#7fff00" stroke-width="10" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/basic_attachment_internal_before.xml b/test/rendering-mss/basic_attachment_internal_before.xml index b14446d..2bbcc88 100644 --- a/test/rendering-mss/basic_attachment_internal_before.xml +++ b/test/rendering-mss/basic_attachment_internal_before.xml @@ -1,10 +1,10 @@ -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> <LineSymbolizer stroke="#da70d6" stroke-width="10" /> </Rule> </Style> -<Style name="style-outline" filter-mode="first"> +<Style filter-mode="first" name="style-outline"> <Rule> <LineSymbolizer stroke="#f0f8ff" stroke-width="5" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/basic_attachment_internal_before_and_after.xml b/test/rendering-mss/basic_attachment_internal_before_and_after.xml index dac38ef..35fcc87 100644 --- a/test/rendering-mss/basic_attachment_internal_before_and_after.xml +++ b/test/rendering-mss/basic_attachment_internal_before_and_after.xml @@ -1,15 +1,15 @@ -<Style name="style-inline" filter-mode="first"> +<Style filter-mode="first" name="style-inline"> <Rule> <LineSymbolizer stroke="#ffe4b5" stroke-width="1" /> </Rule> </Style> -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> <LineSymbolizer stroke="#ff7f50" stroke-width="5" /> </Rule> </Style> -<Style name="style-outline" filter-mode="first"> +<Style filter-mode="first" name="style-outline"> <Rule> <LineSymbolizer stroke="#fa8072" stroke-width="10" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/basic_attachment_internal_double.xml b/test/rendering-mss/basic_attachment_internal_double.xml index d388f73..e43a2c5 100644 --- a/test/rendering-mss/basic_attachment_internal_double.xml +++ b/test/rendering-mss/basic_attachment_internal_double.xml @@ -1,11 +1,10 @@ - -<Style name="style-inline" filter-mode="first"> +<Style filter-mode="first" name="style-inline"> <Rule> <LineSymbolizer stroke="#f5fffa" stroke-width="5" /> </Rule> </Style> -<Style name="style-outline" filter-mode="first"> +<Style filter-mode="first" name="style-outline"> <Rule> <LineSymbolizer stroke="#f5f5f5" stroke-width="10" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/basic_attachment_internal_with_label.xml b/test/rendering-mss/basic_attachment_internal_with_label.xml index 59f75f1..c80a85b 100644 --- a/test/rendering-mss/basic_attachment_internal_with_label.xml +++ b/test/rendering-mss/basic_attachment_internal_with_label.xml @@ -1,10 +1,10 @@ -<Style name="style-label" filter-mode="first"> +<Style filter-mode="first" name="style-label"> <Rule> - <TextSymbolizer face-name="DejaVu Sans Book" fill="#ff6347" allow-overlap="true" ><![CDATA['1']]></TextSymbolizer> + <TextSymbolizer allow-overlap="true" face-name="DejaVu Sans Book" fill="#ff6347"><![CDATA['1']]></TextSymbolizer> </Rule> </Style> -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> - <MarkersSymbolizer width="10" allow-overlap="true" fill="#cd853f" /> + <MarkersSymbolizer allow-overlap="true" fill="#cd853f" width="10" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/basic_attachment_separate.xml b/test/rendering-mss/basic_attachment_separate.xml index 6abf66d..03e35c7 100644 --- a/test/rendering-mss/basic_attachment_separate.xml +++ b/test/rendering-mss/basic_attachment_separate.xml @@ -1,10 +1,10 @@ -<Style name="style-inline" filter-mode="first"> +<Style filter-mode="first" name="style-inline"> <Rule> <LineSymbolizer stroke="#00ff00" stroke-width="5" /> </Rule> </Style> -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> <LineSymbolizer stroke="#7fff00" stroke-width="10" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/basic_attachment_separate_before.xml b/test/rendering-mss/basic_attachment_separate_before.xml index 371b77e..58b4aef 100644 --- a/test/rendering-mss/basic_attachment_separate_before.xml +++ b/test/rendering-mss/basic_attachment_separate_before.xml @@ -1,10 +1,10 @@ -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> <LineSymbolizer stroke="#da70d6" stroke-width="5" /> </Rule> </Style> -<Style name="style-outline" filter-mode="first"> +<Style filter-mode="first" name="style-outline"> <Rule> <LineSymbolizer stroke="#f0f8ff" stroke-width="10" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/basic_attachment_separate_before_and_after.xml b/test/rendering-mss/basic_attachment_separate_before_and_after.xml index dac38ef..35fcc87 100644 --- a/test/rendering-mss/basic_attachment_separate_before_and_after.xml +++ b/test/rendering-mss/basic_attachment_separate_before_and_after.xml @@ -1,15 +1,15 @@ -<Style name="style-inline" filter-mode="first"> +<Style filter-mode="first" name="style-inline"> <Rule> <LineSymbolizer stroke="#ffe4b5" stroke-width="1" /> </Rule> </Style> -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> <LineSymbolizer stroke="#ff7f50" stroke-width="5" /> </Rule> </Style> -<Style name="style-outline" filter-mode="first"> +<Style filter-mode="first" name="style-outline"> <Rule> <LineSymbolizer stroke="#fa8072" stroke-width="10" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/basic_attachment_separate_double.xml b/test/rendering-mss/basic_attachment_separate_double.xml index ad34f64..e43a2c5 100644 --- a/test/rendering-mss/basic_attachment_separate_double.xml +++ b/test/rendering-mss/basic_attachment_separate_double.xml @@ -1,10 +1,10 @@ -<Style name="style-inline" filter-mode="first"> +<Style filter-mode="first" name="style-inline"> <Rule> <LineSymbolizer stroke="#f5fffa" stroke-width="5" /> </Rule> </Style> -<Style name="style-outline" filter-mode="first"> +<Style filter-mode="first" name="style-outline"> <Rule> <LineSymbolizer stroke="#f5f5f5" stroke-width="10" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/basic_attachment_separate_with_label.xml b/test/rendering-mss/basic_attachment_separate_with_label.xml index 59f75f1..c80a85b 100644 --- a/test/rendering-mss/basic_attachment_separate_with_label.xml +++ b/test/rendering-mss/basic_attachment_separate_with_label.xml @@ -1,10 +1,10 @@ -<Style name="style-label" filter-mode="first"> +<Style filter-mode="first" name="style-label"> <Rule> - <TextSymbolizer face-name="DejaVu Sans Book" fill="#ff6347" allow-overlap="true" ><![CDATA['1']]></TextSymbolizer> + <TextSymbolizer allow-overlap="true" face-name="DejaVu Sans Book" fill="#ff6347"><![CDATA['1']]></TextSymbolizer> </Rule> </Style> -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> - <MarkersSymbolizer width="10" allow-overlap="true" fill="#cd853f" /> + <MarkersSymbolizer allow-overlap="true" fill="#cd853f" width="10" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/color_functions.mss b/test/rendering-mss/color_functions.mss index 4fc3908..9e65d11 100644 --- a/test/rendering-mss/color_functions.mss +++ b/test/rendering-mss/color_functions.mss @@ -13,10 +13,10 @@ hsla/line-color: hsla(123, 45%, 67%, 89%); hsla-d/line-color: hsla(123, 45%, 67%, .89); - husl/line-color: husl(123, 45%, 67%); - husl-d/line-color: husl(123, .45, .67); - husla/line-color: husla(123, 45%, 67%, 89%); - husla-d/line-color: husla(123, 45%, 67%, .89); + hsluv/line-color: hsluv(123, 45%, 67%); + hsluv-d/line-color: hsluv(123, .45, .67); + hsluva/line-color: hsluva(123, 45%, 67%, 89%); + hsluva-d/line-color: hsluva(123, 45%, 67%, .89); hsl-darken/line-color: darken(hsl(209, 81%, 64%), 10%); hsl-lighten/line-color: lighten(hsl(209, 81%, 64%), 10%); @@ -27,14 +27,14 @@ hsl-fadeout/line-color: fadeout(hsla(209, 81%, 64%, 80%), 10%); hsl-greyscale/line-color: greyscale(hsl(209, 81%, 64%)); - percept-darken/line-color: darken(husl(209, 81%, 64%), 10%); - percept-lighten/line-color: lighten(husl(209, 81%, 64%), 10%); - percept-saturate/line-color: saturate(husl(209, 81%, 64%), 10%); - percept-desaturate/line-color: desaturate(husl(209, 81%, 64%), 10%); - percept-spin/line-color: spin(husl(209, 81%, 64%), 10); - percept-fadein/line-color: fadein(husla(209, 81%, 64%, 80%), 10%); - percept-fadeout/line-color: fadeout(husla(209, 81%, 64%, 80%), 10%); - percept-greyscale/line-color: greyscale(husl(209, 81%, 64%)); + percept-darken/line-color: darken(hsluv(209, 81%, 64%), 10%); + percept-lighten/line-color: lighten(hsluv(209, 81%, 64%), 10%); + percept-saturate/line-color: saturate(hsluv(209, 81%, 64%), 10%); + percept-desaturate/line-color: desaturate(hsluv(209, 81%, 64%), 10%); + percept-spin/line-color: spin(hsluv(209, 81%, 64%), 10); + percept-fadein/line-color: fadein(hsluva(209, 81%, 64%, 80%), 10%); + percept-fadeout/line-color: fadeout(hsluva(209, 81%, 64%, 80%), 10%); + percept-greyscale/line-color: greyscale(hsluv(209, 81%, 64%)); force-percept-darken/line-color: darkenp(hsl(209, 81%, 64%), 10%); force-percept-lighten/line-color: lightenp(hsl(209, 81%, 64%), 10%); @@ -50,8 +50,8 @@ mix3/line-color: mix(#ff0000, #00ff00, 0%); mix4/line-color: mix(#ff0000, #00ff00, 100%); mix5/line-color: mix(rgba(255, 0, 0, 0.2), rgba(0, 255, 0, 0.8), 20%); - percept-mix/line-color: mix(hsl(109, 81%, 64%), husl(209, 81%, 64%), 20%); - percept-mix2/line-color: mix(husl(109, 81%, 64%), husl(209, 81%, 64%), 20%); + percept-mix/line-color: mix(hsl(109, 81%, 64%), hsluv(209, 81%, 64%), 20%); + percept-mix2/line-color: mix(hsluv(109, 81%, 64%), hsluv(209, 81%, 64%), 20%); multiply/line-color: #f8f4f0 * 0.8; divide/line-color: #f8f4f0 / 1.2; @@ -64,5 +64,5 @@ subtract2/line-color: #f8f4f0 - #83b7eb; components/line-color: hsl(hue(hsl(209, 81%, 64%)), saturation(hsl(209, 81%, 64%)), lightness(hsl(209, 81%, 64%))); - percept-components/line-color: husl(huep(hsl(209, 81%, 64%)), saturationp(hsl(209, 81%, 64%)), lightnessp(hsl(209, 81%, 64%))); + percept-components/line-color: hsluv(huep(hsl(209, 81%, 64%)), saturationp(hsl(209, 81%, 64%)), lightnessp(hsl(209, 81%, 64%))); } diff --git a/test/rendering-mss/color_functions.xml b/test/rendering-mss/color_functions.xml index 034d791..9139e28 100644 --- a/test/rendering-mss/color_functions.xml +++ b/test/rendering-mss/color_functions.xml @@ -1,4 +1,4 @@ -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> <LineSymbolizer stroke="#008000" /> <LineSymbolizer stroke="#bbeedd" /> diff --git a/test/rendering-mss/empty_name.xml b/test/rendering-mss/empty_name.xml index 669849c..6c60a01 100644 --- a/test/rendering-mss/empty_name.xml +++ b/test/rendering-mss/empty_name.xml @@ -1,5 +1,5 @@ -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> - <TextSymbolizer face-name="DejaVu Sans Book" size="10" fill="#d2691e" ><![CDATA[]]></TextSymbolizer> + <TextSymbolizer face-name="DejaVu Sans Book" fill="#d2691e" size="10"><![CDATA[]]></TextSymbolizer> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/image-filters.xml b/test/rendering-mss/image-filters.xml index 532cf81..99c5c12 100644 --- a/test/rendering-mss/image-filters.xml +++ b/test/rendering-mss/image-filters.xml @@ -1,2 +1 @@ -<Style name="style" filter-mode="first" image-filters="invert" image-filters-inflate="true" direct-image-filters="invert"> -</Style>
\ No newline at end of file +<Style direct-image-filters="invert" filter-mode="first" image-filters="invert" image-filters-inflate="true" name="style"></Style> diff --git a/test/rendering-mss/issue_121.mss b/test/rendering-mss/issue_121.mss new file mode 100644 index 0000000..6e4bce1 --- /dev/null +++ b/test/rendering-mss/issue_121.mss @@ -0,0 +1,3 @@ +#data { + [[dem] > [rep]] { marker-fill: #00f;} +} diff --git a/test/rendering-mss/issue_121.xml b/test/rendering-mss/issue_121.xml new file mode 100644 index 0000000..d5d9026 --- /dev/null +++ b/test/rendering-mss/issue_121.xml @@ -0,0 +1,6 @@ +<Style filter-mode="first" name="style"> + <Rule> + <Filter><![CDATA[([dem] > [rep])]]></Filter> + <MarkersSymbolizer fill="#0000ff" /> + </Rule> +</Style> diff --git a/test/rendering-mss/issue_197.xml b/test/rendering-mss/issue_197.xml index 26fdf91..1abfc0a 100644 --- a/test/rendering-mss/issue_197.xml +++ b/test/rendering-mss/issue_197.xml @@ -1,4 +1,4 @@ -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> <MaxScaleDenominator>3000000</MaxScaleDenominator> <MinScaleDenominator>1500000</MinScaleDenominator> diff --git a/test/rendering-mss/issue_214.mss b/test/rendering-mss/issue_214.mss new file mode 100644 index 0000000..3bdf260 --- /dev/null +++ b/test/rendering-mss/issue_214.mss @@ -0,0 +1,83 @@ +#world { + line-dasharray: none; + line-dash-offset: none; + line-geometry-transform: none; + line-join: none; + line-cap: none; + line-gamma-method: none; + line-simplify-algorithm: none; + line-rasterizer: none; + line-comp-op: none; + + point-transform: none; + point-placement: none; + point-comp-op: none; + + line-pattern-file: none; + line-pattern-transform: none; + line-pattern-geometry-transform: none; + line-pattern-simplify-algorithm: none; + line-pattern-comp-op: none; + + polygon-pattern-file: none; + polygon-pattern-transform: none; + polygon-pattern-geometry-transform: none; + polygon-pattern-alignment: none; + polygon-pattern-simplify-algorithm: none; + polygon-pattern-comp-op: none; + + marker-transform: none; + marker-geometry-transform: none; + marker-placement: none; + marker-multi-policy: none; + marker-type: none; + marker-simplify-algorithm: none; + marker-comp-op: none; + marker-direction: none; + + shield-file: none; + shield-face-name: none; + shield-transform: none; + shield-text-transform: none; + shield-placement: none; + shield-halo-rasterizer: none; + shield-halo-comp-op: none; + shield-horizontal-alignment: none; + shield-vertical-alignment: none; + shield-placement-type: none; + shield-justify-alignment: none; + shield-simplify-algorithm: none; + shield-comp-op: none; + + polygon-geometry-transform: none; + polygon-gamma-method: none; + polygon-simplify-algorithm: none; + polygon-comp-op: none; + + image-filters: none; + direct-image-filters: none; + comp-op: none; + + raster-scaling: none; + raster-comp-op: none; + raster-colorizer-default-mode: none; + + text-name: [name]; + text-face-name: 'Arial'; + text-spacing: none; + text-character-spacing: none; + text-line-spacing: none; + text-label-position-tolerance: none; + text-halo-rasterizer: none; + text-vertical-alignment: none; + text-upright: none; + text-placement: none; + text-placement-type: none; + text-horizontal-alignment: none; + text-align: none; + text-simplify-algorithm: none; + text-comp-op: none; + text-halo-comp-op: none; + + dot-comp-op: none; +} diff --git a/test/rendering-mss/issue_214.xml b/test/rendering-mss/issue_214.xml new file mode 100644 index 0000000..1b333b3 --- /dev/null +++ b/test/rendering-mss/issue_214.xml @@ -0,0 +1,14 @@ +<Style filter-mode="first" name="style"> + <Rule> + <LineSymbolizer /> + <PointSymbolizer /> + <LinePatternSymbolizer file="none" /> + <PolygonPatternSymbolizer file="none" /> + <MarkersSymbolizer /> + <ShieldSymbolizer face-name="none" file="none" /> + <PolygonSymbolizer /> + <RasterSymbolizer /> + <TextSymbolizer face-name="Arial"><![CDATA[[name]]]></TextSymbolizer> + <DotSymbolizer /> + </Rule> +</Style> diff --git a/test/rendering-mss/issue_232.mss b/test/rendering-mss/issue_232.mss new file mode 100644 index 0000000..c2fd201 --- /dev/null +++ b/test/rendering-mss/issue_232.mss @@ -0,0 +1,14 @@ +@sans_bold: 'Helvetica Neue', 'Foo Bar'; +#world[zoom>=11][zoom<=22][reflen<=8][type='bicycle'] { + [network='ncn'],[network='rcn'] { + shield-name: "[ref]"; + shield-face-name: @sans_bold; + shield-file: url(img/shield-motorway-1.png); + [network='ncn'] { + [reflen=8] { shield-file: url(img/shield-motorway-8.png); } + } + [network='rcn'] { + [reflen=8] { shield-file: url(img/shield-trunk-8.png); } + } + } +} diff --git a/test/rendering-mss/issue_232.xml b/test/rendering-mss/issue_232.xml new file mode 100644 index 0000000..4fe0c9d --- /dev/null +++ b/test/rendering-mss/issue_232.xml @@ -0,0 +1,26 @@ +<Style filter-mode="first" name="style"> + <Rule> + <MaxScaleDenominator>400000</MaxScaleDenominator> + <MinScaleDenominator>100</MinScaleDenominator> + <Filter><![CDATA[([type] = 'bicycle') and ([network] = 'rcn') and ([reflen] = 8)]]></Filter> + <ShieldSymbolizer file="img/shield-trunk-8.png" fontset-name="fontset-0"><![CDATA[[ref]]]></ShieldSymbolizer> + </Rule> + <Rule> + <MaxScaleDenominator>400000</MaxScaleDenominator> + <MinScaleDenominator>100</MinScaleDenominator> + <Filter><![CDATA[([type] = 'bicycle') and ([network] = 'ncn') and ([reflen] = 8)]]></Filter> + <ShieldSymbolizer file="img/shield-motorway-8.png" fontset-name="fontset-0"><![CDATA[[ref]]]></ShieldSymbolizer> + </Rule> + <Rule> + <MaxScaleDenominator>400000</MaxScaleDenominator> + <MinScaleDenominator>100</MinScaleDenominator> + <Filter><![CDATA[([reflen] <= 8) and ([type] = 'bicycle') and ([network] = 'rcn')]]></Filter> + <ShieldSymbolizer file="img/shield-motorway-1.png" fontset-name="fontset-0"><![CDATA[[ref]]]></ShieldSymbolizer> + </Rule> + <Rule> + <MaxScaleDenominator>400000</MaxScaleDenominator> + <MinScaleDenominator>100</MinScaleDenominator> + <Filter><![CDATA[([reflen] <= 8) and ([type] = 'bicycle') and ([network] = 'ncn')]]></Filter> + <ShieldSymbolizer file="img/shield-motorway-1.png" fontset-name="fontset-0"><![CDATA[[ref]]]></ShieldSymbolizer> + </Rule> +</Style> diff --git a/test/rendering-mss/issue_247_1.xml b/test/rendering-mss/issue_247_1.xml index 4459493..7e21b2d 100644 --- a/test/rendering-mss/issue_247_1.xml +++ b/test/rendering-mss/issue_247_1.xml @@ -1,11 +1,10 @@ - -<Style name="style-inline" filter-mode="first"> +<Style filter-mode="first" name="style-inline"> <Rule> <LineSymbolizer stroke="#000000" stroke-width="1" /> </Rule> </Style> -<Style name="style-outline" filter-mode="first"> +<Style filter-mode="first" name="style-outline"> <Rule> - <LineSymbolizer stroke="#85c5d3" stroke-width="4" stroke-linejoin="round" /> + <LineSymbolizer stroke="#85c5d3" stroke-linejoin="round" stroke-width="4" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/issue_247_2.xml b/test/rendering-mss/issue_247_2.xml index d0d2050..11c9ec9 100644 --- a/test/rendering-mss/issue_247_2.xml +++ b/test/rendering-mss/issue_247_2.xml @@ -1,15 +1,15 @@ -<Style name="style-inline" filter-mode="first"> +<Style filter-mode="first" name="style-inline"> <Rule> <LineSymbolizer stroke="#000000" stroke-width="1" /> </Rule> </Style> -<Style name="style-outline" filter-mode="first"> +<Style filter-mode="first" name="style-outline"> <Rule> - <Filter>([ne_10m_adm] = 'AAA')</Filter> - <LineSymbolizer stroke="#85c5d3" stroke-width="4" stroke-linejoin="round" /> + <Filter><![CDATA[([ne_10m_adm] = 'AAA')]]></Filter> + <LineSymbolizer stroke="#85c5d3" stroke-linejoin="round" stroke-width="4" /> </Rule> <Rule> - <LineSymbolizer stroke="#85c5d3" stroke-width="4" stroke-linejoin="round" /> + <LineSymbolizer stroke="#85c5d3" stroke-linejoin="round" stroke-width="4" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/issue_284.xml b/test/rendering-mss/issue_284.xml index 8603ecc..20fd377 100644 --- a/test/rendering-mss/issue_284.xml +++ b/test/rendering-mss/issue_284.xml @@ -1,28 +1,28 @@ -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> - <Filter>([foo] = 'bar') and ([type] = 'primary')</Filter> - <LineSymbolizer stroke-width="10" stroke="#ff0000" /> + <Filter><![CDATA[([foo] = 'bar') and ([type] = 'primary')]]></Filter> + <LineSymbolizer stroke="#ff0000" stroke-width="10" /> </Rule> <Rule> - <Filter>([foo] = 'bar')</Filter> + <Filter><![CDATA[([foo] = 'bar')]]></Filter> <LineSymbolizer stroke-width="10" /> </Rule> <Rule> - <Filter>([type] = 'primary')</Filter> + <Filter><![CDATA[([type] = 'primary')]]></Filter> <LineSymbolizer stroke="#ff0000" /> </Rule> </Style> -<Style name="style-outline" filter-mode="first"> +<Style filter-mode="first" name="style-outline"> <Rule> - <Filter>([foo] = 'bar') and ([type] = 'primary')</Filter> - <LineSymbolizer stroke-width="10" stroke="#ff0000" /> + <Filter><![CDATA[([foo] = 'bar') and ([type] = 'primary')]]></Filter> + <LineSymbolizer stroke="#ff0000" stroke-width="10" /> </Rule> <Rule> - <Filter>([foo] = 'bar')</Filter> + <Filter><![CDATA[([foo] = 'bar')]]></Filter> <LineSymbolizer stroke-width="10" /> </Rule> <Rule> - <Filter>([type] = 'primary')</Filter> + <Filter><![CDATA[([type] = 'primary')]]></Filter> <LineSymbolizer stroke="#ff0000" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/issue_284_b.xml b/test/rendering-mss/issue_284_b.xml index 2605d0d..58c5cc5 100644 --- a/test/rendering-mss/issue_284_b.xml +++ b/test/rendering-mss/issue_284_b.xml @@ -1,28 +1,28 @@ -<Style name="style-outline" filter-mode="first"> +<Style filter-mode="first" name="style-outline"> <Rule> - <Filter>([foo] = 'bar') and ([type] = 'primary')</Filter> - <LineSymbolizer stroke-width="10" stroke="#ff0000" /> + <Filter><![CDATA[([foo] = 'bar') and ([type] = 'primary')]]></Filter> + <LineSymbolizer stroke="#ff0000" stroke-width="10" /> </Rule> <Rule> - <Filter>([foo] = 'bar')</Filter> + <Filter><![CDATA[([foo] = 'bar')]]></Filter> <LineSymbolizer stroke-width="10" /> </Rule> <Rule> - <Filter>([type] = 'primary')</Filter> + <Filter><![CDATA[([type] = 'primary')]]></Filter> <LineSymbolizer stroke="#ff0000" /> </Rule> </Style> -<Style name="style-inline" filter-mode="first"> +<Style filter-mode="first" name="style-inline"> <Rule> - <Filter>([foo] = 'bar') and ([type] = 'primary')</Filter> - <LineSymbolizer stroke-width="11" stroke="#8b0000" /> + <Filter><![CDATA[([foo] = 'bar') and ([type] = 'primary')]]></Filter> + <LineSymbolizer stroke="#8b0000" stroke-width="11" /> </Rule> <Rule> - <Filter>([foo] = 'bar')</Filter> + <Filter><![CDATA[([foo] = 'bar')]]></Filter> <LineSymbolizer stroke-width="11" /> </Rule> <Rule> - <Filter>([type] = 'primary')</Filter> + <Filter><![CDATA[([type] = 'primary')]]></Filter> <LineSymbolizer stroke="#8b0000" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/issue_284_c.xml b/test/rendering-mss/issue_284_c.xml index 8f2ebf3..615d13c 100644 --- a/test/rendering-mss/issue_284_c.xml +++ b/test/rendering-mss/issue_284_c.xml @@ -1,14 +1,14 @@ -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> - <Filter>([foo] = 'bar') and ([type] = 'primary')</Filter> - <LineSymbolizer stroke-width="10" stroke="#ff0000" /> + <Filter><![CDATA[([foo] = 'bar') and ([type] = 'primary')]]></Filter> + <LineSymbolizer stroke="#ff0000" stroke-width="10" /> </Rule> <Rule> - <Filter>([foo] = 'bar')</Filter> + <Filter><![CDATA[([foo] = 'bar')]]></Filter> <LineSymbolizer stroke-width="10" /> </Rule> <Rule> - <Filter>([type] = 'primary')</Filter> + <Filter><![CDATA[([type] = 'primary')]]></Filter> <LineSymbolizer stroke="#ff0000" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/issue_303.xml b/test/rendering-mss/issue_303.xml index 3eef433..ac36264 100644 --- a/test/rendering-mss/issue_303.xml +++ b/test/rendering-mss/issue_303.xml @@ -1,6 +1,6 @@ -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> - <Filter>([Hello&Goodbye] = 'yes')</Filter> - <TextSymbolizer face-name="El&Font Bubble Regular" ><![CDATA[[name]]]></TextSymbolizer> + <Filter><![CDATA[([Hello&Goodbye] = 'yes')]]></Filter> + <TextSymbolizer face-name="El&Font Bubble Regular"><![CDATA[[name]]]></TextSymbolizer> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/issue_315.mss b/test/rendering-mss/issue_315.mss deleted file mode 100644 index 2593d5c..0000000 --- a/test/rendering-mss/issue_315.mss +++ /dev/null @@ -1,9 +0,0 @@ -#somelayername { - [feature = 'highway_motorway'], - [feature = 'highway_motorway_link'] { - /* code for any motorway */ - [feature = 'highway_motorway_link'] { - /* code specific for links */ - } - } -}
\ No newline at end of file diff --git a/test/rendering-mss/issue_315.xml b/test/rendering-mss/issue_315.xml deleted file mode 100644 index e69de29..0000000 --- a/test/rendering-mss/issue_315.xml +++ /dev/null diff --git a/test/rendering-mss/issue_339.xml b/test/rendering-mss/issue_339.xml index 88ced86..3f4d4b1 100644 --- a/test/rendering-mss/issue_339.xml +++ b/test/rendering-mss/issue_339.xml @@ -1,2 +1 @@ -<Style name="style" filter-mode="first" opacity="0.5"> -</Style>
\ No newline at end of file +<Style filter-mode="first" name="style" opacity="0.5"></Style> diff --git a/test/rendering-mss/issue_370.xml b/test/rendering-mss/issue_370.xml index ef7c573..4da5e84 100644 --- a/test/rendering-mss/issue_370.xml +++ b/test/rendering-mss/issue_370.xml @@ -1,6 +1,6 @@ -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> - <Filter>([way_pixels] < 192000) and ([way_pixels] > 3000)</Filter> + <Filter><![CDATA[([way_pixels] < 192000) and ([way_pixels] > 3000)]]></Filter> <LineSymbolizer stroke-width="1" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/issue_370_b.xml b/test/rendering-mss/issue_370_b.xml index 4c3a29d..3d10672 100644 --- a/test/rendering-mss/issue_370_b.xml +++ b/test/rendering-mss/issue_370_b.xml @@ -1,6 +1,6 @@ -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> - <Filter>([way_pixels] <= 192000) and ([way_pixels] >= 3000)</Filter> + <Filter><![CDATA[([way_pixels] <= 192000) and ([way_pixels] >= 3000)]]></Filter> <LineSymbolizer stroke-width="1" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/issue_377.mss b/test/rendering-mss/issue_377.mss new file mode 100644 index 0000000..0e0e750 --- /dev/null +++ b/test/rendering-mss/issue_377.mss @@ -0,0 +1,3 @@ +[[height] % 50 = 0] { + marker-fill: red; +} diff --git a/test/rendering-mss/issue_377.xml b/test/rendering-mss/issue_377.xml new file mode 100644 index 0000000..bd992d1 --- /dev/null +++ b/test/rendering-mss/issue_377.xml @@ -0,0 +1,6 @@ +<Style filter-mode="first" name="style"> + <Rule> + <Filter><![CDATA[([height]%50 = 0)]]></Filter> + <MarkersSymbolizer fill="#ff0000" /> + </Rule> +</Style> diff --git a/test/rendering-mss/issue_443.xml b/test/rendering-mss/issue_443.xml index 8131285..932310f 100644 --- a/test/rendering-mss/issue_443.xml +++ b/test/rendering-mss/issue_443.xml @@ -1,4 +1,4 @@ -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> <PolygonSymbolizer fill="#8fb7df" /> </Rule> diff --git a/test/rendering-mss/issue_462.mss b/test/rendering-mss/issue_462.mss new file mode 100644 index 0000000..3f50557 --- /dev/null +++ b/test/rendering-mss/issue_462.mss @@ -0,0 +1,10 @@ +#foo { + line: none; + line-width: 2; + [feature = 'bar'] { + line-color: red; + } + [feature = 'baz'] { + line-color: blue; + } +} diff --git a/test/rendering-mss/issue_462.xml b/test/rendering-mss/issue_462.xml new file mode 100644 index 0000000..a57e211 --- /dev/null +++ b/test/rendering-mss/issue_462.xml @@ -0,0 +1,10 @@ +<Style filter-mode="first" name="style"> + <Rule> + <Filter><![CDATA[([feature] = 'baz')]]></Filter> + <LineSymbolizer stroke="#0000ff" stroke-width="2" /> + </Rule> + <Rule> + <Filter><![CDATA[([feature] = 'bar')]]></Filter> + <LineSymbolizer stroke="#ff0000" stroke-width="2" /> + </Rule> +</Style> diff --git a/test/rendering-mss/issue_462a.mss b/test/rendering-mss/issue_462a.mss new file mode 100644 index 0000000..d7c4bc3 --- /dev/null +++ b/test/rendering-mss/issue_462a.mss @@ -0,0 +1,9 @@ +#foo { + line: auto; + [feature = 'bar'] { + line-color: red; + } + [feature = 'baz'] { + line-color: blue; + } +} diff --git a/test/rendering-mss/issue_462a.xml b/test/rendering-mss/issue_462a.xml new file mode 100644 index 0000000..65b321c --- /dev/null +++ b/test/rendering-mss/issue_462a.xml @@ -0,0 +1,13 @@ +<Style filter-mode="first" name="style"> + <Rule> + <Filter><![CDATA[([feature] = 'baz')]]></Filter> + <LineSymbolizer stroke="#0000ff" /> + </Rule> + <Rule> + <Filter><![CDATA[([feature] = 'bar')]]></Filter> + <LineSymbolizer stroke="#ff0000" /> + </Rule> + <Rule> + <LineSymbolizer /> + </Rule> +</Style> diff --git a/test/rendering-mss/issue_462b.mss b/test/rendering-mss/issue_462b.mss new file mode 100644 index 0000000..cb8065d --- /dev/null +++ b/test/rendering-mss/issue_462b.mss @@ -0,0 +1,15 @@ +#foo { + shield: none; + [feature = 'bar'] { + shield-name: "[refs]"; + shield-face-name: "Arial"; + shield-file: url('test.svg'); + shield-fill: red; + } + [feature = 'baz'] { + shield-name: "[refs]"; + shield-face-name: "Arial"; + shield-file: url('test.svg'); + shield-fill: blue; + } +} diff --git a/test/rendering-mss/issue_462b.xml b/test/rendering-mss/issue_462b.xml new file mode 100644 index 0000000..dc8da4b --- /dev/null +++ b/test/rendering-mss/issue_462b.xml @@ -0,0 +1,10 @@ +<Style filter-mode="first" name="style"> + <Rule> + <Filter><![CDATA[([feature] = 'baz')]]></Filter> + <ShieldSymbolizer face-name="Arial" file="test.svg" fill="#0000ff"><![CDATA[[refs]]]></ShieldSymbolizer> + </Rule> + <Rule> + <Filter><![CDATA[([feature] = 'bar')]]></Filter> + <ShieldSymbolizer face-name="Arial" file="test.svg" fill="#ff0000"><![CDATA[[refs]]]></ShieldSymbolizer> + </Rule> +</Style> diff --git a/test/rendering-mss/line-width-zoom.xml b/test/rendering-mss/line-width-zoom.xml index 2e6d083..d744c2d 100644 --- a/test/rendering-mss/line-width-zoom.xml +++ b/test/rendering-mss/line-width-zoom.xml @@ -1,4 +1,4 @@ -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> <LineSymbolizer stroke-width="@zoom" /> </Rule> diff --git a/test/rendering-mss/quoted_attr.xml b/test/rendering-mss/quoted_attr.xml index 4d49616..83c3a95 100644 --- a/test/rendering-mss/quoted_attr.xml +++ b/test/rendering-mss/quoted_attr.xml @@ -1,6 +1,6 @@ -<Style name="style-power" filter-mode="first"> +<Style filter-mode="first" name="style-power"> <Rule> - <Filter>([power] = 'generator') and ([generator:source] = 'wind')</Filter> + <Filter><![CDATA[([power] = 'generator') and ([generator:source] = 'wind')]]></Filter> <MarkersSymbolizer width="0" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/scale-hsla-filter.xml b/test/rendering-mss/scale-hsla-filter.xml index e52c149..7cbc0ea 100644 --- a/test/rendering-mss/scale-hsla-filter.xml +++ b/test/rendering-mss/scale-hsla-filter.xml @@ -1,5 +1,5 @@ -<Style name="style" filter-mode="first" image-filters="scale-hsla(0.5,0.5,0.5,0.5,0.5,0.5,0.5,0.5)" direct-image-filters="scale-hsla(0.5,0.5,0.5,0.5,0.5,0.5,0.5,0.5)"> +<Style direct-image-filters="scale-hsla(0.5,0.5,0.5,0.5,0.5,0.5,0.5,0.5)" filter-mode="first" image-filters="scale-hsla(0.5,0.5,0.5,0.5,0.5,0.5,0.5,0.5)" name="style"> <Rule> <PolygonSymbolizer fill="#ff0000" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/style-level-prop-only.xml b/test/rendering-mss/style-level-prop-only.xml index 88ced86..3f4d4b1 100644 --- a/test/rendering-mss/style-level-prop-only.xml +++ b/test/rendering-mss/style-level-prop-only.xml @@ -1,2 +1 @@ -<Style name="style" filter-mode="first" opacity="0.5"> -</Style>
\ No newline at end of file +<Style filter-mode="first" name="style" opacity="0.5"></Style> diff --git a/test/rendering-mss/style-level-prop-only2.xml b/test/rendering-mss/style-level-prop-only2.xml index 9c08dcd..3fb96a9 100644 --- a/test/rendering-mss/style-level-prop-only2.xml +++ b/test/rendering-mss/style-level-prop-only2.xml @@ -1,2 +1 @@ -<Style name="style" filter-mode="first" comp-op="color-burn"> -</Style>
\ No newline at end of file +<Style comp-op="color-burn" filter-mode="first" name="style"></Style> diff --git a/test/rendering-mss/style-level-prop-only3.xml b/test/rendering-mss/style-level-prop-only3.xml index 56a1f46..ce42551 100644 --- a/test/rendering-mss/style-level-prop-only3.xml +++ b/test/rendering-mss/style-level-prop-only3.xml @@ -1,2 +1 @@ -<Style name="style" filter-mode="first" image-filters="invert"> -</Style>
\ No newline at end of file +<Style filter-mode="first" image-filters="invert" name="style"></Style> diff --git a/test/rendering-mss/text-face-name-escaping.xml b/test/rendering-mss/text-face-name-escaping.xml index 2c1089a..dc97306 100644 --- a/test/rendering-mss/text-face-name-escaping.xml +++ b/test/rendering-mss/text-face-name-escaping.xml @@ -1,5 +1,5 @@ -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> - <TextSymbolizer face-name="El&Font Bubble Regular" ><![CDATA[[name]]]></TextSymbolizer> + <TextSymbolizer face-name="El&Font Bubble Regular"><![CDATA[[name]]]></TextSymbolizer> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/variable-quoting-of-enum.xml b/test/rendering-mss/variable-quoting-of-enum.xml index bc2b811..5570fa5 100644 --- a/test/rendering-mss/variable-quoting-of-enum.xml +++ b/test/rendering-mss/variable-quoting-of-enum.xml @@ -1,4 +1,4 @@ -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> <LineSymbolizer rasterizer="fast" /> </Rule> diff --git a/test/rendering-mss/zoom-like-field-name.xml b/test/rendering-mss/zoom-like-field-name.xml index d47b079..6dd4c2d 100644 --- a/test/rendering-mss/zoom-like-field-name.xml +++ b/test/rendering-mss/zoom-like-field-name.xml @@ -1,6 +1,6 @@ -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> - <Filter>([zoomy] > 2)</Filter> + <Filter><![CDATA[([zoomy] > 2)]]></Filter> <PolygonSymbolizer fill="#ff0000" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering-mss/zoom_space.xml b/test/rendering-mss/zoom_space.xml index 2d88082..98bcbea 100644 --- a/test/rendering-mss/zoom_space.xml +++ b/test/rendering-mss/zoom_space.xml @@ -1,6 +1,6 @@ -<Style name="style" filter-mode="first"> +<Style filter-mode="first" name="style"> <Rule> <MaxScaleDenominator>100000000</MaxScaleDenominator> <PolygonSymbolizer fill="#ff0000" /> </Rule> -</Style>
\ No newline at end of file +</Style> diff --git a/test/rendering.test.js b/test/rendering.test.js index 129b10e..66dd87a 100644 --- a/test/rendering.test.js +++ b/test/rendering.test.js @@ -1,10 +1,12 @@ var path = require('path'), fs = require('fs'), assert = require('assert'), - semver = require('semver'); + semver = require('semver'), + _ = require('lodash'); -var carto = require('../lib/carto'); -var helper = require('./support/helper'); +var carto = require('../lib/carto'), + helper = require('./support/helper'), + util = require('../lib/carto/util'); describe('Rendering', function() { @@ -37,72 +39,64 @@ helper.files('rendering', 'mml', function(file) { } } it('should render ' + path.basename(file) + ' correctly', function(done) { - var mml = helper.mml(file); - try { - var env = { - paths: [ path.dirname(file) ], - data_dir: path.join(__dirname, '../data'), - local_data_dir: path.join(__dirname, 'rendering'), - filename: file - }, - renderer = null; + helper.mml(file, function (err, mml) { + var output = { + msg: null, + data: null + }; + if (!err) { + var env = { + paths: [ path.dirname(file) ], + data_dir: path.join(__dirname, '../data'), + local_data_dir: path.join(__dirname, 'rendering'), + filename: file + }, + renderer = null; - if (api) { - renderer = new carto.Renderer(env, { - mapnik_version: api - }); + if (api) { + env.version = api + } + renderer = new carto.Renderer(env); + output = renderer.render(mml); } else { - renderer = new carto.Renderer(env); + output.msg = err; } - var output = renderer.render(mml); - } catch (err) { - if (Array.isArray(err)){ - err.forEach(carto.writeError); - return done(); - } else { - return done(err); + if (!_.isNil(output.data)) { + var result = helper.resultFile(file); + helper.compareToXMLFile(result, output.data, function(err,expected_json,actual_json) { + var actual = file.replace(path.extname(file),'') + '-actual.json'; + var expected = file.replace(path.extname(file),'') + '-expected.json'; + if (err) { + fs.writeFileSync(actual,JSON.stringify(actual_json,null,4)); + fs.writeFileSync(expected,JSON.stringify(expected_json,null,4)); + throw new Error('failed: xml ' + result + ' in json form does not match expected result:\n' + actual + ' (actual)\n' + expected + ' (expected)'); + } else { + // cleanup any actual renders that no longer fail + try { + fs.unlinkSync(actual); + fs.unlinkSync(expected); + } catch (err) { + // do nothing + } + } + done(); + }, [ + helper.removeAbsoluteImages, + helper.removeAbsoluteDatasources + ]); } - } - var result = helper.resultFile(file); - helper.compareToXMLFile(result, output, function(err,expected_json,actual_json) { - var actual = file.replace(path.extname(file),'') + '-actual.json'; - var expected = file.replace(path.extname(file),'') + '-expected.json'; - if (err) { - // disabled since it can break on large diffs - /* - console.warn( - helper.stylize("Failure", 'red') + ': ' + - helper.stylize(file, 'underline') + - ' differs from expected result.'); - helper.showDifferences(err); - throw ''; - */ - fs.writeFileSync(actual,JSON.stringify(actual_json,null,4)); - fs.writeFileSync(expected,JSON.stringify(expected_json,null,4)); - throw new Error('failed: xml ' + result + ' in json form does not match expected result:\n' + actual + ' (actual)\n' + expected + ' (expected)'); - } else { - // cleanup any actual renders that no longer fail - try { - fs.unlinkSync(actual); - fs.unlinkSync(expected); - } catch (err) { - // do nothing + else { + if (_.has(output, 'msg') && _.isArray(output.msg) && + output.msg.length > 0) { + assert.fail('','', util.getMessagesToPrint(output.msg)); + } + else { + assert.fail('', '', 'Output was nil but no msg property found.'); } + done(); } - done(); - }, [ - helper.removeAbsoluteImages, - helper.removeAbsoluteDatasources - ]); - - // beforeExit(function() { - // if (!completed && renderResult) { - // console.warn(helper.stylize('renderer produced:', 'bold')); - // console.warn(renderResult); - // } - // assert.ok(completed, 'Rendering finished.'); - // }); + }); }); }); }); diff --git a/test/rendering/afghanistan_votes.mml b/test/rendering/afghanistan_votes.mml index f078ff1..d5b437d 100644 --- a/test/rendering/afghanistan_votes.mml +++ b/test/rendering/afghanistan_votes.mml @@ -4,7 +4,7 @@ "afghanistan_votes.mss" ], "Layer": [{ - "name": "data", + "id": "data", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/district.geojson", diff --git a/test/rendering/afghanistan_votes.mss b/test/rendering/afghanistan_votes.mss index 6ad0392..f1eae0d 100644 --- a/test/rendering/afghanistan_votes.mss +++ b/test/rendering/afghanistan_votes.mss @@ -7,9 +7,8 @@ marker-line-width: 0; marker-line-color: #222; marker-line-opacity: 0.8; - marker-type: ellipse; } - + #data[_votes_total_null = 0][votes_total >= 34730.2][votes_total <= 69457.4] { marker-allow-overlap: true; marker-width: 5; @@ -19,10 +18,9 @@ marker-line-width: 0; marker-line-color: #222; marker-line-opacity: .8; - marker-type: ellipse; } - - + + #data[_votes_total_null = 0][votes_total >= 69457.4][votes_total <= 104184.59999999999] { marker-allow-overlap: true; marker-width: 8; @@ -32,10 +30,9 @@ marker-line-width: 0; marker-line-color: #222; marker-line-opacity: .8; - marker-type: ellipse; } - - + + #data[_votes_total_null = 0][votes_total >= 104184.59999999999][votes_total <= 138911.8] { marker-allow-overlap: true; marker-width: 11; @@ -45,10 +42,9 @@ marker-line-width: 0; marker-line-color: #222; marker-line-opacity: .8; - marker-type: ellipse; } - - + + #data[_votes_total_null = 0][votes_total >= 138911.8][votes_total <= 173639] { marker-allow-overlap: true; marker-width: 14; @@ -58,10 +54,9 @@ marker-line-width: 0; marker-line-color: #222; marker-line-opacity: .8; - marker-type: ellipse; } - - + + #data[_votes_total_null = 0][votes_total >= 173639][votes_total <= 208366.2] { marker-allow-overlap: true; marker-width: 17; @@ -71,5 +66,4 @@ marker-line-width: 0; marker-line-color: #222; marker-line-opacity: .8; - marker-type: ellipse; } diff --git a/test/rendering/afghanistan_votes.result b/test/rendering/afghanistan_votes.result index e8959d8..c8d31bc 100644 --- a/test/rendering/afghanistan_votes.result +++ b/test/rendering/afghanistan_votes.result @@ -1,32 +1,30 @@ <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE Map[]> <Map srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over"> - - -<Style name="data" filter-mode="first" > +<Style filter-mode="first" name="data"> <Rule> <Filter>([_votes_total_null] = 0) and ([votes_total] >= 173639) and ([votes_total] <= 208366.2)</Filter> - <MarkersSymbolizer allow-overlap="true" width="17" height="17" fill="#222222" opacity="0.8" stroke-width="0" stroke="#222222" stroke-opacity="0.8" marker-type="ellipse" /> + <MarkersSymbolizer allow-overlap="true" width="17" height="17" fill="#222222" opacity="0.8" stroke-width="0" stroke="#222222" stroke-opacity="0.8" /> </Rule> <Rule> <Filter>([_votes_total_null] = 0) and ([votes_total] >= 138911.8) and ([votes_total] <= 173639)</Filter> - <MarkersSymbolizer allow-overlap="true" width="14" height="14" fill="#222222" opacity="0.8" stroke-width="0" stroke="#222222" stroke-opacity="0.8" marker-type="ellipse" /> + <MarkersSymbolizer allow-overlap="true" width="14" height="14" fill="#222222" opacity="0.8" stroke-width="0" stroke="#222222" stroke-opacity="0.8" /> </Rule> <Rule> <Filter>([_votes_total_null] = 0) and ([votes_total] >= 104184.59999999999) and ([votes_total] <= 138911.8)</Filter> - <MarkersSymbolizer allow-overlap="true" width="11" height="11" fill="#222222" opacity="0.8" stroke-width="0" stroke="#222222" stroke-opacity="0.8" marker-type="ellipse" /> + <MarkersSymbolizer allow-overlap="true" width="11" height="11" fill="#222222" opacity="0.8" stroke-width="0" stroke="#222222" stroke-opacity="0.8" /> </Rule> <Rule> <Filter>([_votes_total_null] = 0) and ([votes_total] >= 69457.4) and ([votes_total] <= 104184.59999999999)</Filter> - <MarkersSymbolizer allow-overlap="true" width="8" height="8" fill="#222222" opacity="0.8" stroke-width="0" stroke="#222222" stroke-opacity="0.8" marker-type="ellipse" /> + <MarkersSymbolizer allow-overlap="true" width="8" height="8" fill="#222222" opacity="0.8" stroke-width="0" stroke="#222222" stroke-opacity="0.8" /> </Rule> <Rule> <Filter>([_votes_total_null] = 0) and ([votes_total] >= 34730.2) and ([votes_total] <= 69457.4)</Filter> - <MarkersSymbolizer allow-overlap="true" width="5" height="5" fill="#222222" opacity="0.8" stroke-width="0" stroke="#222222" stroke-opacity="0.8" marker-type="ellipse" /> + <MarkersSymbolizer allow-overlap="true" width="5" height="5" fill="#222222" opacity="0.8" stroke-width="0" stroke="#222222" stroke-opacity="0.8" /> </Rule> <Rule> <Filter>([_votes_total_null] = 0) and ([votes_total] >= 3) and ([votes_total] <= 34730.2)</Filter> - <MarkersSymbolizer allow-overlap="true" width="2" height="2" fill="#222222" opacity="0.8" stroke-width="0" stroke="#222222" stroke-opacity="0.8" marker-type="ellipse" /> + <MarkersSymbolizer allow-overlap="true" width="2" height="2" fill="#222222" opacity="0.8" stroke-width="0" stroke="#222222" stroke-opacity="0.8" /> </Rule> </Style> <Layer name="data" diff --git a/test/rendering/background_attributes.result b/test/rendering/background_attributes.result index fd5f0a4..a37b50e 100644 --- a/test/rendering/background_attributes.result +++ b/test/rendering/background_attributes.result @@ -1,7 +1,3 @@ <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE Map[]> -<Map srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over" background-color="#ffffff" > - - -</Map> - +<Map background-color="#ffffff" srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over"></Map> diff --git a/test/rendering/buffersize.mml b/test/rendering/buffersize.mml index 8c1d4c6..52995a1 100644 --- a/test/rendering/buffersize.mml +++ b/test/rendering/buffersize.mml @@ -4,7 +4,7 @@ "buffersize.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/buffersize.result b/test/rendering/buffersize.result index 32d30e6..325a7ab 100644 --- a/test/rendering/buffersize.result +++ b/test/rendering/buffersize.result @@ -1,12 +1,11 @@ <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE Map[]> -<Map srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over" buffer-size="256"> - +<Map buffer-size="256" srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over"> <FontSet name="fontset-0"> <Font face-name="Georgia Regular"/> <Font face-name="Arial Italic"/> </FontSet> -<Style name="world" filter-mode="first" > +<Style filter-mode="first" name="world"> <Rule> <TextSymbolizer size="11" fontset-name="fontset-0" ><![CDATA[[NAME]]]></TextSymbolizer> </Rule> diff --git a/test/rendering/building_height.mml b/test/rendering/building_height.mml index 3bdf048..93122eb 100644 --- a/test/rendering/building_height.mml +++ b/test/rendering/building_height.mml @@ -4,7 +4,7 @@ "building_height.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/building_height.result b/test/rendering/building_height.result index 4e492ad..f1da5a5 100644 --- a/test/rendering/building_height.result +++ b/test/rendering/building_height.result @@ -3,7 +3,7 @@ <Map srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over"> -<Style name="world" filter-mode="first" > +<Style filter-mode="first" name="world" > <Rule> <BuildingSymbolizer height="6*[HEIGHT]+2+[NOTHEIGHT]+8" /> </Rule> diff --git a/test/rendering/combined_class.mml b/test/rendering/combined_class.mml index 0a3a3fa..6ba4d7b 100644 --- a/test/rendering/combined_class.mml +++ b/test/rendering/combined_class.mml @@ -5,7 +5,7 @@ ], "Layer": [ { - "name": "just_land", + "id": "just_land", "class": "land", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { @@ -14,7 +14,6 @@ } }, { - "name": "lakes", "id": "lakes", "class": "land", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", diff --git a/test/rendering/combined_class.result b/test/rendering/combined_class.result index 889f07b..f6f6071 100644 --- a/test/rendering/combined_class.result +++ b/test/rendering/combined_class.result @@ -3,7 +3,7 @@ <Map srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over"> -<Style name="just_land" filter-mode="first" > +<Style filter-mode="first" name="just_land" > <Rule> <LineSymbolizer stroke="#cccccc" stroke-width="0.5" /> <PolygonSymbolizer fill="#eeeeee" /> @@ -18,7 +18,7 @@ </Datasource> </Layer> -<Style name="lakes" filter-mode="first" > +<Style filter-mode="first" name="lakes" > <Rule> <LineSymbolizer stroke="#cccccc" stroke-width="0.5" /> <PolygonSymbolizer fill="#000000" /> diff --git a/test/rendering/complex_cascades.mml b/test/rendering/complex_cascades.mml index 89b7515..9f92000 100644 --- a/test/rendering/complex_cascades.mml +++ b/test/rendering/complex_cascades.mml @@ -4,7 +4,7 @@ "complex_cascades.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", @@ -13,7 +13,7 @@ }, { "class": "new", - "name": "countries", + "id": "countries", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/complex_cascades.result b/test/rendering/complex_cascades.result index e65e25c..577f019 100644 --- a/test/rendering/complex_cascades.result +++ b/test/rendering/complex_cascades.result @@ -3,7 +3,7 @@ <Map srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over"> -<Style name="world" filter-mode="first"> +<Style filter-mode="first" name="world"> <Rule> <MaxScaleDenominator>12500000</MaxScaleDenominator> <Filter>([NAME] = 'United States')</Filter> @@ -35,7 +35,7 @@ </Datasource> </Layer> -<Style name="countries" filter-mode="first"> +<Style filter-mode="first" name="countries"> <Rule> <MaxScaleDenominator>12500000</MaxScaleDenominator> <Filter>([NAME] = 'United States')</Filter> diff --git a/test/rendering/complexfontset.mml b/test/rendering/complexfontset.mml index ff4d06a..0107848 100644 --- a/test/rendering/complexfontset.mml +++ b/test/rendering/complexfontset.mml @@ -4,7 +4,7 @@ "complexfontset.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", @@ -13,7 +13,7 @@ }, { "class": "new", - "name": "countries", + "id": "countries", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/complexfontset.result b/test/rendering/complexfontset.result index 68d1869..119cb54 100644 --- a/test/rendering/complexfontset.result +++ b/test/rendering/complexfontset.result @@ -6,7 +6,7 @@ <Font face-name="Georgia Regular"/> <Font face-name="Arial Italic"/> </FontSet> -<Style name="world" filter-mode="first"> +<Style filter-mode="first" name="world"> <Rule> <TextSymbolizer size="11" fontset-name="fontset-0" >[NAME]</TextSymbolizer> </Rule> @@ -20,7 +20,7 @@ </Datasource> </Layer> -<Style name="countries" filter-mode="first"> +<Style filter-mode="first" name="countries"> <Rule> <TextSymbolizer size="11" fontset-name="fontset-0" >[NAME]</TextSymbolizer> </Rule> diff --git a/test/rendering/cross_stylesheet_variable.mml b/test/rendering/cross_stylesheet_variable.mml index 4148ae9..b53bd2a 100644 --- a/test/rendering/cross_stylesheet_variable.mml +++ b/test/rendering/cross_stylesheet_variable.mml @@ -5,7 +5,7 @@ "cross_stylesheet_variable_b.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/cross_stylesheet_variable.result b/test/rendering/cross_stylesheet_variable.result index 4508336..f31943f 100644 --- a/test/rendering/cross_stylesheet_variable.result +++ b/test/rendering/cross_stylesheet_variable.result @@ -3,7 +3,7 @@ <Map srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over" > -<Style name="world" filter-mode="first"> +<Style filter-mode="first" name="world"> <Rule> <PolygonSymbolizer fill="#ff0000"/> </Rule> diff --git a/test/rendering/data_only.mml b/test/rendering/data_only.mml index e9a4879..472964a 100644 --- a/test/rendering/data_only.mml +++ b/test/rendering/data_only.mml @@ -2,7 +2,7 @@ "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Stylesheet": [], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/empty_style.mml b/test/rendering/empty_style.mml index bd595c2..159efce 100644 --- a/test/rendering/empty_style.mml +++ b/test/rendering/empty_style.mml @@ -4,7 +4,7 @@ "empty_style.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/empty_style.result b/test/rendering/empty_style.result index 5a87aa0..13402cc 100644 --- a/test/rendering/empty_style.result +++ b/test/rendering/empty_style.result @@ -3,12 +3,12 @@ <Map srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over"> -<Style name="world-fill" filter-mode="first"> +<Style filter-mode="first" name="world-fill"> <Rule> <LineSymbolizer stroke="#ffffff" /> </Rule> </Style> -<Style name="world-outline" filter-mode="first"> +<Style filter-mode="first" name="world-outline"> <Rule> <LineSymbolizer stroke="#000000" /> </Rule> diff --git a/test/rendering/empty_url.mml b/test/rendering/empty_url.mml index 6c6fa8f..1317e71 100644 --- a/test/rendering/empty_url.mml +++ b/test/rendering/empty_url.mml @@ -4,7 +4,7 @@ "empty_url.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/external_image.mml b/test/rendering/external_image.mml index d0cc13d..84c20f0 100644 --- a/test/rendering/external_image.mml +++ b/test/rendering/external_image.mml @@ -4,7 +4,7 @@ "external_image.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/fadeout.mml b/test/rendering/fadeout.mml index 8bd0d62..da1cdc3 100644 --- a/test/rendering/fadeout.mml +++ b/test/rendering/fadeout.mml @@ -4,7 +4,7 @@ "fadeout.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/field.mml b/test/rendering/field.mml index 0864703..633a86c 100644 --- a/test/rendering/field.mml +++ b/test/rendering/field.mml @@ -4,7 +4,7 @@ "field.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/field_advanced.mml b/test/rendering/field_advanced.mml index 330992a..d74d082 100644 --- a/test/rendering/field_advanced.mml +++ b/test/rendering/field_advanced.mml @@ -4,7 +4,7 @@ "field_advanced.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/filter_comparing_fields.mml b/test/rendering/filter_comparing_fields.mml index d2e1373..f43c1d5 100644 --- a/test/rendering/filter_comparing_fields.mml +++ b/test/rendering/filter_comparing_fields.mml @@ -4,7 +4,7 @@ "filter_comparing_fields.mss" ], "Layer": [{ - "name": "world", + "id": "world", "class": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { diff --git a/test/rendering/filterexp.mml b/test/rendering/filterexp.mml index 28c9176..a940221 100644 --- a/test/rendering/filterexp.mml +++ b/test/rendering/filterexp.mml @@ -4,7 +4,7 @@ "filterexp.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", @@ -12,4 +12,3 @@ } }] } - diff --git a/test/rendering/filterquote.mml b/test/rendering/filterquote.mml index 6565fc3..a67a0ac 100644 --- a/test/rendering/filterquote.mml +++ b/test/rendering/filterquote.mml @@ -4,7 +4,7 @@ "filterquote.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", @@ -12,4 +12,3 @@ } }] } - diff --git a/test/rendering/filters.mml b/test/rendering/filters.mml index 3764b5d..3968ba2 100644 --- a/test/rendering/filters.mml +++ b/test/rendering/filters.mml @@ -4,7 +4,7 @@ "filters.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/filtervariable.mml b/test/rendering/filtervariable.mml index 9719c9b..5d14084 100644 --- a/test/rendering/filtervariable.mml +++ b/test/rendering/filtervariable.mml @@ -4,7 +4,7 @@ "filtervariable.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", @@ -12,4 +12,3 @@ } }] } - diff --git a/test/rendering/filtervariable2.mml b/test/rendering/filtervariable2.mml index 9ec739e..3bda673 100644 --- a/test/rendering/filtervariable2.mml +++ b/test/rendering/filtervariable2.mml @@ -1,7 +1,7 @@ { "Layer": [ { - "name": "a" + "id": "a" } ], "Stylesheet": [ diff --git a/test/rendering/fontset-duplication.mml b/test/rendering/fontset-duplication.mml index c42a650..1e0a601 100644 --- a/test/rendering/fontset-duplication.mml +++ b/test/rendering/fontset-duplication.mml @@ -6,7 +6,6 @@ "Layer":[ { "id":"city", - "name":"city", "srs":"+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "class":"", "Datasource":{ @@ -17,7 +16,6 @@ }, { "id":"country-label", - "name":"country-label", "srs":"+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "class":"", "Datasource":{ diff --git a/test/rendering/gray_function.mml b/test/rendering/gray_function.mml index ac72dbf..38f611b 100644 --- a/test/rendering/gray_function.mml +++ b/test/rendering/gray_function.mml @@ -4,7 +4,7 @@ "gray_function.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/highzooms.mml b/test/rendering/highzooms.mml index 6fbb180..06164e8 100644 --- a/test/rendering/highzooms.mml +++ b/test/rendering/highzooms.mml @@ -4,7 +4,7 @@ "highzooms.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/identity.mml b/test/rendering/identity.mml index d30b9fd..b8de3d2 100644 --- a/test/rendering/identity.mml +++ b/test/rendering/identity.mml @@ -4,7 +4,7 @@ "identity.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/image_filters.mml b/test/rendering/image_filters.mml index d33fb4f..2ba9ed1 100644 --- a/test/rendering/image_filters.mml +++ b/test/rendering/image_filters.mml @@ -4,7 +4,7 @@ "image_filters.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/imagefilter-duplication.mml b/test/rendering/imagefilter-duplication.mml index 6798418..ab2032c 100644 --- a/test/rendering/imagefilter-duplication.mml +++ b/test/rendering/imagefilter-duplication.mml @@ -4,7 +4,7 @@ "imagefilter-duplication.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", @@ -12,4 +12,3 @@ } }] } - diff --git a/test/rendering/instance_names.mml b/test/rendering/instance_names.mml index d894d7e..150abb2 100644 --- a/test/rendering/instance_names.mml +++ b/test/rendering/instance_names.mml @@ -4,7 +4,7 @@ "instance_names.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/issue294.mml b/test/rendering/issue294.mml index 7e8d6c0..14e4cd6 100644 --- a/test/rendering/issue294.mml +++ b/test/rendering/issue294.mml @@ -2,7 +2,7 @@ "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Stylesheet": [], "Layer": [{ - "name": "world", + "id": "world", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", "type": "shape" diff --git a/test/rendering/issue32.mml b/test/rendering/issue32.mml index b04eb3d..0bda48d 100644 --- a/test/rendering/issue32.mml +++ b/test/rendering/issue32.mml @@ -5,7 +5,7 @@ "issue32.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/issue60.mml b/test/rendering/issue60.mml index faf9a71..b7e4f79 100644 --- a/test/rendering/issue60.mml +++ b/test/rendering/issue60.mml @@ -4,7 +4,7 @@ "issue60.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/issue_100_filters.mml b/test/rendering/issue_100_filters.mml index 1247a77..6bd2bea 100644 --- a/test/rendering/issue_100_filters.mml +++ b/test/rendering/issue_100_filters.mml @@ -4,7 +4,7 @@ "issue_100_filters.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/issue_121.mml b/test/rendering/issue_121.mml new file mode 100644 index 0000000..3ccdec6 --- /dev/null +++ b/test/rendering/issue_121.mml @@ -0,0 +1,36 @@ +{ + "bounds": [ + -180, + -85.05112877980659, + 180, + 85.05112877980659 + ], + "center": [ + 0, + 0, + 2 + ], + "format": "png", + "interactivity": false, + "minzoom": 0, + "maxzoom": 22, + "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", + "Stylesheet": [ + "issue_121.mss" + ], + "Layer": [ + { + "id": "filtertest", + "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", + "geometry": "polygon", + "Datasource": { + "file": "http://mapbox-geodata.s3.amazonaws.com/natural-earth-1.4.0/cultural/10m-admin-0-countries.zip", + "type": "shape" + } + } + ], + "scale": 1, + "metatile": 2, + "name": "", + "description": "" +} diff --git a/test/rendering/issue_121.mss b/test/rendering/issue_121.mss new file mode 100644 index 0000000..cdc63a0 --- /dev/null +++ b/test/rendering/issue_121.mss @@ -0,0 +1,11 @@ +#filtertest[[a] > [b]] { + marker-fill: #ff0000; +} + +#filtertest[[a] > [b] * 2] { + marker-fill: #00ff00; +} + +#filtertest[[a] > 10 * 2] { + marker-fill: #0000ff; +} diff --git a/test/rendering/issue_121.result b/test/rendering/issue_121.result new file mode 100644 index 0000000..a81a6c4 --- /dev/null +++ b/test/rendering/issue_121.result @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE Map[]> +<Map srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over"> + +<Parameters> + <Parameter name="bounds">-180,-85.05112877980659,180,85.05112877980659</Parameter> + <Parameter name="center">0,0,2</Parameter> + <Parameter name="format">png</Parameter> + <Parameter name="minzoom">0</Parameter> + <Parameter name="maxzoom">22</Parameter> + <Parameter name="scale">1</Parameter> + <Parameter name="metatile">2</Parameter> +</Parameters> + + +<Style filter-mode="first" name="filtertest"> + <Rule> + <Filter>([a] > 20)</Filter> + <MarkersSymbolizer fill="#0000ff" /> + </Rule> + <Rule> + <Filter>([a] > [b]*2)</Filter> + <MarkersSymbolizer fill="#00ff00" /> + </Rule> + <Rule> + <Filter>([a] > [b])</Filter> + <MarkersSymbolizer fill="#ff0000" /> + </Rule> +</Style> +<Layer name="filtertest" + srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over"> + <StyleName>filtertest</StyleName> + <Datasource> + <Parameter name="file">[absolute path]</Parameter> + <Parameter name="type"><![CDATA[shape]]></Parameter> + </Datasource> + </Layer> + +</Map> diff --git a/test/rendering/issue_239.mml b/test/rendering/issue_239.mml index 05a5dea..1e5b624 100644 --- a/test/rendering/issue_239.mml +++ b/test/rendering/issue_239.mml @@ -22,7 +22,6 @@ "Layer": [ { "id": "countries", - "name": "countries", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "geometry": "polygon", "Datasource": { @@ -35,4 +34,4 @@ "metatile": 2, "name": "", "description": "" -}
\ No newline at end of file +} diff --git a/test/rendering/issue_273.mml b/test/rendering/issue_273.mml new file mode 100644 index 0000000..652962f --- /dev/null +++ b/test/rendering/issue_273.mml @@ -0,0 +1,37 @@ +{ + "bounds": [ + -180, + -85.05112877980659, + 180, + 85.05112877980659 + ], + "center": [ + 0, + 0, + 2 + ], + "format": "png", + "interactivity": false, + "minzoom": 0, + "maxzoom": 22, + "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", + "Stylesheet": [ + "issue_273.mss" + ], + "Layer": [ + { + "id": "countries & states", + "class": "countries-and-states", + "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", + "geometry": "polygon", + "Datasource": { + "file": "http://mapbox-geodata.s3.amazonaws.com/natural-earth-1.4.0/cultural/10m-admin-0-countries.zip", + "type": "shape" + } + } + ], + "scale": 1, + "metatile": 2, + "name": "", + "description": "" +} diff --git a/test/rendering/issue_273.mss b/test/rendering/issue_273.mss new file mode 100644 index 0000000..99f643b --- /dev/null +++ b/test/rendering/issue_273.mss @@ -0,0 +1,5 @@ +.countries-and-states { + line-color: #024; + line-width: 2; + line-join: round; +} diff --git a/test/rendering/issue_273.result b/test/rendering/issue_273.result new file mode 100644 index 0000000..e3b8582 --- /dev/null +++ b/test/rendering/issue_273.result @@ -0,0 +1,30 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE Map[]> +<Map srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over"> + +<Parameters> + <Parameter name="bounds">-180,-85.05112877980659,180,85.05112877980659</Parameter> + <Parameter name="center">0,0,2</Parameter> + <Parameter name="format">png</Parameter> + <Parameter name="minzoom">0</Parameter> + <Parameter name="maxzoom">22</Parameter> + <Parameter name="scale">1</Parameter> + <Parameter name="metatile">2</Parameter> +</Parameters> + + +<Style name="countries & states" filter-mode="first" > + <Rule> + <LineSymbolizer stroke="#002244" stroke-width="2" stroke-linejoin="round" /> + </Rule> +</Style> +<Layer name="countries & states" + srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over"> + <StyleName>countries & states</StyleName> + <Datasource> + <Parameter name="file">[absolute path]</Parameter> + <Parameter name="type"><![CDATA[shape]]></Parameter> + </Datasource> + </Layer> + +</Map> diff --git a/test/rendering/issue_291.mml b/test/rendering/issue_291.mml new file mode 100644 index 0000000..c7a7c44 --- /dev/null +++ b/test/rendering/issue_291.mml @@ -0,0 +1,24 @@ +{ + "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", + "Stylesheet": [ + "issue_291.mss" + ], + "Layer": [{ + "id": "test", + "class": "a", + "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", + "Datasource": { + "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", + "type": "shape" + } + }, + { + "id": "test2", + "class": "a b", + "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", + "Datasource": { + "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", + "type": "shape" + } + }] +} diff --git a/test/rendering/issue_291.mss b/test/rendering/issue_291.mss new file mode 100644 index 0000000..bad2fdc --- /dev/null +++ b/test/rendering/issue_291.mss @@ -0,0 +1,6 @@ +.a { + line-width: 1; + .b { + line-width: 8; + } +} diff --git a/test/rendering/issue_291.result b/test/rendering/issue_291.result new file mode 100644 index 0000000..6cb92b7 --- /dev/null +++ b/test/rendering/issue_291.result @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE Map[]> +<Map srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over" > + + +<Style name="test" filter-mode="first"> + <Rule> + <LineSymbolizer stroke-width="1" /> + </Rule> +</Style> +<Layer + name="test" + srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over"> + <StyleName>test</StyleName> + <Datasource> + <Parameter name="file"><![CDATA[[absolute path]]]></Parameter> + <Parameter name="type"><![CDATA[shape]]></Parameter> + </Datasource> + </Layer> +<Style name="test2" filter-mode="first"> + <Rule> + <LineSymbolizer stroke-width="8" /> + </Rule> +</Style> +<Layer + name="test2" + srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over"> + <StyleName>test2</StyleName> + <Datasource> + <Parameter name="file"><![CDATA[[absolute path]]]></Parameter> + <Parameter name="type"><![CDATA[shape]]></Parameter> + </Datasource> + </Layer> + +</Map> diff --git a/test/rendering/issue_296.mml b/test/rendering/issue_296.mml new file mode 100644 index 0000000..bb28da6 --- /dev/null +++ b/test/rendering/issue_296.mml @@ -0,0 +1,13 @@ +{ + "Stylesheet": [ + "issue_296.mss" + ], + "Layer": [ + { + "id": "world" + }, + { + "id": "sea" + } + ] +} diff --git a/test/rendering/issue_296.mss b/test/rendering/issue_296.mss new file mode 100644 index 0000000..4df03fb --- /dev/null +++ b/test/rendering/issue_296.mss @@ -0,0 +1,11 @@ +#world { + polygon-fill: grey; + [data_column = null] { polygon-fill: red; polygon-opacity: 0.5; } + [data_column >= 100] { polygon-fill: blue; } +} + +#sea { + polygon-fill: grey; + [data_column = null] { polygon-fill: red; } + [data_column >= 100] { polygon-fill: blue; } +} diff --git a/test/rendering/issue_296.result b/test/rendering/issue_296.result new file mode 100644 index 0000000..48b5bbd --- /dev/null +++ b/test/rendering/issue_296.result @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE Map[]> +<Map> +<Style name="world" filter-mode="first" > + <Rule> + <Filter>([data_column] >= 100)</Filter> + <PolygonSymbolizer fill="#0000ff" /> + </Rule> + <Rule> + <Filter>([data_column] = null)</Filter> + <PolygonSymbolizer fill="#ff0000" fill-opacity="0.5" /> + </Rule> + <Rule> + <PolygonSymbolizer fill="#808080" /> + </Rule> +</Style> +<Layer name="world"> + <StyleName>world</StyleName> +</Layer> +<Style name="sea" filter-mode="first" > + <Rule> + <Filter>([data_column] >= 100)</Filter> + <PolygonSymbolizer fill="#0000ff" /> + </Rule> + <Rule> + <Filter>([data_column] = null)</Filter> + <PolygonSymbolizer fill="#ff0000" /> + </Rule> + <Rule> + <PolygonSymbolizer fill="#808080" /> + </Rule> +</Style> +<Layer name="sea"> + <StyleName>sea</StyleName> +</Layer> + +</Map> diff --git a/test/rendering/issue_333.mml b/test/rendering/issue_333.mml new file mode 100644 index 0000000..f4d2b03 --- /dev/null +++ b/test/rendering/issue_333.mml @@ -0,0 +1,10 @@ +{ + "Stylesheet": [ + "issue_333.mss" + ], + "Layer": [ + { + "id": "world" + } + ] +} diff --git a/test/rendering/issue_333.mss b/test/rendering/issue_333.mss new file mode 100644 index 0000000..0b0e004 --- /dev/null +++ b/test/rendering/issue_333.mss @@ -0,0 +1,8 @@ +@fonts-a: "Arial", "Helvetica Neue"; +@fonts-b: "Roboto", @fonts-a; + +#world { + text-face-name: @fonts-b; + text-name: [title]; + text-size: 11; +} diff --git a/test/rendering/issue_333.result b/test/rendering/issue_333.result new file mode 100644 index 0000000..5893fb5 --- /dev/null +++ b/test/rendering/issue_333.result @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE Map[]> +<Map> +<FontSet name="fontset-0"> + <Font face-name="Roboto"/> + <Font face-name="Arial"/> + <Font face-name="Helvetica Neue"/> +</FontSet> +<Style name="world" filter-mode="first" > + <Rule> + <TextSymbolizer fontset-name="fontset-0" size="11" text="[title]" /> + </Rule> +</Style> +<Layer name="world"> + <StyleName>world</StyleName> +</Layer> + +</Map> diff --git a/test/rendering/issue_338.mml b/test/rendering/issue_338.mml new file mode 100644 index 0000000..2a83ec0 --- /dev/null +++ b/test/rendering/issue_338.mml @@ -0,0 +1,10 @@ +{ + "Stylesheet": [ + "issue_338.mss" + ], + "Layer": [ + { + "id": "world" + } + ] +} diff --git a/test/rendering/issue_338.mss b/test/rendering/issue_338.mss new file mode 100644 index 0000000..6852ac5 --- /dev/null +++ b/test/rendering/issue_338.mss @@ -0,0 +1,7 @@ +@var: 'foo'; +@var: 'oof'; + +#world { + text-face-name: 'Arial'; + text-name: @var + 'bar'; +} diff --git a/test/rendering/issue_338.result b/test/rendering/issue_338.result new file mode 100644 index 0000000..d8b7d91 --- /dev/null +++ b/test/rendering/issue_338.result @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE Map[]> +<Map> +<Style name="world" filter-mode="first" > + <Rule> + <TextSymbolizer face-name="Arial" text="oofbar" /> + </Rule> +</Style> +<Layer name="world"> + <StyleName>world</StyleName> +</Layer> + +</Map> diff --git a/test/rendering/issue_348.mml b/test/rendering/issue_348.mml new file mode 100644 index 0000000..2d18db2 --- /dev/null +++ b/test/rendering/issue_348.mml @@ -0,0 +1,9 @@ +{ + "name": "", + "test": null, + "scale": 1, + "Stylesheet": [ + ], + "Layer": [ + ] +} diff --git a/test/rendering/no_stylesheet.result b/test/rendering/issue_348.result index 6b1862d..3ac2f48 100644 --- a/test/rendering/no_stylesheet.result +++ b/test/rendering/issue_348.result @@ -1,10 +1,7 @@ <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE Map[]> <Map> - - -<Layer name="a" -> - </Layer> - +<Parameters> + <Parameter name="scale">1</Parameter> +</Parameters> </Map> diff --git a/test/rendering/issue_394_api2.3.0.mml b/test/rendering/issue_394_api2.3.0.mml index 989349e..cbd6316 100644 --- a/test/rendering/issue_394_api2.3.0.mml +++ b/test/rendering/issue_394_api2.3.0.mml @@ -4,7 +4,7 @@ "issue_394.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/issue_394_api3.0.0.mml b/test/rendering/issue_394_api3.0.0.mml index 989349e..cbd6316 100644 --- a/test/rendering/issue_394_api3.0.0.mml +++ b/test/rendering/issue_394_api3.0.0.mml @@ -4,7 +4,7 @@ "issue_394.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/issue_411.mml b/test/rendering/issue_411.mml new file mode 100644 index 0000000..af1be17 --- /dev/null +++ b/test/rendering/issue_411.mml @@ -0,0 +1,14 @@ +{ + "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", + "Stylesheet": [ + "issue_411.mss" + ], + "Layer": [{ + "id": "test", + "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", + "Datasource": { + "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", + "type": "shape" + } + }] +} diff --git a/test/rendering/issue_411.mss b/test/rendering/issue_411.mss new file mode 100644 index 0000000..5e35c4e --- /dev/null +++ b/test/rendering/issue_411.mss @@ -0,0 +1,17 @@ +#test { + [zoom >= 3][way_pixels > 0.00000010000][way_pixels < 0.00003600000] { + text-name: "[name]"; + text-size: 10; + [zoom >= 4] { + text-size: 11; + } + text-fill: #ff0000; + text-face-name: 'Arial'; + } + [zoom >= 3][render = '1_outline'] { + text-name: "[name]"; + text-size: 12; + text-fill: #ff0000; + text-face-name: 'Arial'; + } +} diff --git a/test/rendering/issue_411.result b/test/rendering/issue_411.result new file mode 100644 index 0000000..1ff9afb --- /dev/null +++ b/test/rendering/issue_411.result @@ -0,0 +1,34 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE Map[]> +<Map srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over" > + + +<Style name="test" filter-mode="first"> + <Rule> + <MaxScaleDenominator>50000000</MaxScaleDenominator> + <Filter>([way_pixels] > 1e-7) and ([way_pixels] < 0.000036)</Filter> + <TextSymbolizer face-name="Arial" size="11" text="[name]" fill="#ff0000"/> + </Rule> + <Rule> + <MaxScaleDenominator>100000000</MaxScaleDenominator> + <MinScaleDenominator>50000000</MinScaleDenominator> + <Filter>([way_pixels] > 1e-7) and ([way_pixels] < 0.000036)</Filter> + <TextSymbolizer face-name="Arial" size="10" text="[name]" fill="#ff0000"/> + </Rule> + <Rule> + <MaxScaleDenominator>100000000</MaxScaleDenominator> + <Filter>([render] = '1_outline')</Filter> + <TextSymbolizer face-name="Arial" size="12" text="[name]" fill="#ff0000"/> + </Rule> +</Style> +<Layer + name="test" + srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over"> + <StyleName>test</StyleName> + <Datasource> + <Parameter name="file"><![CDATA[[absolute path]]]></Parameter> + <Parameter name="type"><![CDATA[shape]]></Parameter> + </Datasource> + </Layer> + +</Map> diff --git a/test/rendering/issue_450.mml b/test/rendering/issue_450.mml new file mode 100644 index 0000000..30b11f2 --- /dev/null +++ b/test/rendering/issue_450.mml @@ -0,0 +1,67 @@ +{ + "_properties": { + "global-properties": { + "group-by": "layer" + }, + "override-properties": { + "group-by": "layer" + } + }, + "bounds": [ + -180, + -85.05112877980659, + 180, + 85.05112877980659 + ], + "center": [ + 0, + 0, + 2 + ], + "format": "png", + "interactivity": false, + "minzoom": 0, + "maxzoom": 22, + "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", + "Stylesheet": [ + ], + "Layer": [ + { + "id": "properties", + "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", + "geometry": "polygon", + "Datasource": { + "file": "http://mapbox-geodata.s3.amazonaws.com/natural-earth-1.4.0/cultural/10m-admin-0-countries.zip", + "type": "shape" + }, + "properties": { + "group-by": "layer" + } + }, + { + "id": "global-properties", + "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", + "geometry": "polygon", + "Datasource": { + "file": "http://mapbox-geodata.s3.amazonaws.com/natural-earth-1.4.0/cultural/10m-admin-0-countries.zip", + "type": "shape" + } + }, + { + "id": "override-properties", + "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", + "geometry": "polygon", + "Datasource": { + "file": "http://mapbox-geodata.s3.amazonaws.com/natural-earth-1.4.0/cultural/10m-admin-0-countries.zip", + "type": "shape" + }, + "properties": { + "group-by": "override" + } + } + ], + "scale": 1, + "metatile": 2, + "name": "", + "description": "" +} diff --git a/test/rendering/issue_450.result b/test/rendering/issue_450.result new file mode 100644 index 0000000..8529d75 --- /dev/null +++ b/test/rendering/issue_450.result @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE Map[]> +<Map srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over"> + +<Parameters> + <Parameter name="bounds">-180,-85.05112877980659,180,85.05112877980659</Parameter> + <Parameter name="center">0,0,2</Parameter> + <Parameter name="format">png</Parameter> + <Parameter name="minzoom">0</Parameter> + <Parameter name="maxzoom">22</Parameter> + <Parameter name="scale">1</Parameter> + <Parameter name="metatile">2</Parameter> +</Parameters> + + +<Layer name="properties" + srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over" + group-by="layer"> + <Datasource> + <Parameter name="file">[absolute path]</Parameter> + <Parameter name="type"><![CDATA[shape]]></Parameter> + </Datasource> + </Layer> +<Layer name="global-properties" + srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over" + group-by="layer"> + <Datasource> + <Parameter name="file">[absolute path]</Parameter> + <Parameter name="type"><![CDATA[shape]]></Parameter> + </Datasource> + </Layer> +<Layer name="override-properties" + srs="+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over" + group-by="override"> + <Datasource> + <Parameter name="file">[absolute path]</Parameter> + <Parameter name="type"><![CDATA[shape]]></Parameter> + </Datasource> + </Layer> + +</Map> diff --git a/test/rendering/issue_469.mml b/test/rendering/issue_469.mml new file mode 100644 index 0000000..c94e8e5 --- /dev/null +++ b/test/rendering/issue_469.mml @@ -0,0 +1,15 @@ +{ + "Stylesheet": [ + "issue_469.mss" + ], + "Layer": [ + { + "properties": { + "minzoom": 4, + "maxzoom": 8 + }, + "id": "place", + "class": "place" + } + ] +} diff --git a/test/rendering/issue_469.mss b/test/rendering/issue_469.mss new file mode 100644 index 0000000..33f8d5f --- /dev/null +++ b/test/rendering/issue_469.mss @@ -0,0 +1,20 @@ +.place { + [type="continent"][zoom <= 2] { + text-name: "[name]"; + text-face-name: "Arial"; + text-size: 12; + } + [type="country"][zoom <= 3] { + text-name: "[name]"; + text-face-name: "Arial"; + text-size: 10; + } + [type="city"][zoom <= 14] { + [zoom >= 4] { + text-name: "[name]"; + text-face-name: "Arial"; + text-size: 10; + } + [zoom >= 9] { text-size: 12; } + } +} diff --git a/test/rendering/issue_469.result b/test/rendering/issue_469.result new file mode 100644 index 0000000..a85d4c8 --- /dev/null +++ b/test/rendering/issue_469.result @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE Map[]> +<Map> +<Style name="place" filter-mode="first"> + <Rule> + <MaxScaleDenominator>50000000</MaxScaleDenominator> + <MinScaleDenominator>25000</MinScaleDenominator> + <Filter>([type] = 'city')</Filter> + <TextSymbolizer face-name="Arial" size="10"><![CDATA[[name]]]></TextSymbolizer> + </Rule> +</Style> +<Layer name="place" + maximum-scale-denominator="50000000" + minimum-scale-denominator="1500000"> + <StyleName>place</StyleName> + </Layer> + +</Map> diff --git a/test/rendering/layer_nodatasource.mml b/test/rendering/layer_nodatasource.mml index 01eadc0..fbdbaef 100644 --- a/test/rendering/layer_nodatasource.mml +++ b/test/rendering/layer_nodatasource.mml @@ -4,7 +4,7 @@ "layer_nodatasource.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over" }] } diff --git a/test/rendering/layer_properties.mml b/test/rendering/layer_properties.mml index 2b5cec1..c7460c1 100644 --- a/test/rendering/layer_properties.mml +++ b/test/rendering/layer_properties.mml @@ -4,7 +4,7 @@ "layer_properties.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "properties": { "cache-features": "true" diff --git a/test/rendering/mapnik_keyword.mml b/test/rendering/mapnik_keyword.mml index ede73af..ec9e1fe 100644 --- a/test/rendering/mapnik_keyword.mml +++ b/test/rendering/mapnik_keyword.mml @@ -4,7 +4,7 @@ "mapnik_keyword.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/modulus.mml b/test/rendering/modulus.mml index 6421796..2ea26d2 100644 --- a/test/rendering/modulus.mml +++ b/test/rendering/modulus.mml @@ -4,7 +4,7 @@ "modulus.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/multiple_symbolizers.mml b/test/rendering/multiple_symbolizers.mml index 4eff697..18e0819 100644 --- a/test/rendering/multiple_symbolizers.mml +++ b/test/rendering/multiple_symbolizers.mml @@ -4,7 +4,7 @@ "multiple_symbolizers.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/nesting_class.mml b/test/rendering/nesting_class.mml index 4fd9d8c..d4839af 100644 --- a/test/rendering/nesting_class.mml +++ b/test/rendering/nesting_class.mml @@ -5,7 +5,7 @@ ], "Layer": [ { - "name": "foo", + "id": "foo", "class": "land", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { @@ -14,7 +14,6 @@ } }, { - "name": "lakes", "id": "lakes", "class": "land", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", diff --git a/test/rendering/nominzoom.mml b/test/rendering/nominzoom.mml index 8d31e59..73c8bac 100644 --- a/test/rendering/nominzoom.mml +++ b/test/rendering/nominzoom.mml @@ -4,7 +4,7 @@ "nominzoom.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/noquote_font.mml b/test/rendering/noquote_font.mml index d76e744..88182eb 100644 --- a/test/rendering/noquote_font.mml +++ b/test/rendering/noquote_font.mml @@ -4,7 +4,7 @@ "noquote_font.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/partial_overrides.mml b/test/rendering/partial_overrides.mml index e4c2d5f..531f18c 100644 --- a/test/rendering/partial_overrides.mml +++ b/test/rendering/partial_overrides.mml @@ -4,7 +4,7 @@ "partial_overrides.mss" ], "Layer": [{ - "name": "world", + "id": "world", "class": "m_0 m_1 m_2 m_3 m_4 m_5 m_6 m_7 m_8 m_9", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { @@ -13,4 +13,3 @@ } }] } - diff --git a/test/rendering/raster-mesh-size.mml b/test/rendering/raster-mesh-size.mml index 876a535..0a23c06 100644 --- a/test/rendering/raster-mesh-size.mml +++ b/test/rendering/raster-mesh-size.mml @@ -4,7 +4,7 @@ "raster-mesh-size.mss" ], "Layer": [{ - "name": "data", + "id": "data", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/nasa_raster/lasvegas_tm5_12jan09_crop_geo_merc.tif", diff --git a/test/rendering/raster.mml b/test/rendering/raster.mml index f942da1..909ec32 100644 --- a/test/rendering/raster.mml +++ b/test/rendering/raster.mml @@ -4,7 +4,7 @@ "raster.mss" ], "Layer": [{ - "name": "data", + "id": "data", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/nasa_raster/lasvegas_tm5_12jan09_crop_geo_merc.tif", diff --git a/test/rendering/raster_colorizer.mml b/test/rendering/raster_colorizer.mml index 1c4dbed..e430368 100644 --- a/test/rendering/raster_colorizer.mml +++ b/test/rendering/raster_colorizer.mml @@ -4,7 +4,7 @@ "raster_colorizer.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/raster_colorizer_comma.mml b/test/rendering/raster_colorizer_comma.mml index 28126f4..d2c1d2a 100644 --- a/test/rendering/raster_colorizer_comma.mml +++ b/test/rendering/raster_colorizer_comma.mml @@ -4,7 +4,7 @@ "raster_colorizer_comma.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/raster_colorizer_onestop.mml b/test/rendering/raster_colorizer_onestop.mml index b99cdd7..81c7c2e 100644 --- a/test/rendering/raster_colorizer_onestop.mml +++ b/test/rendering/raster_colorizer_onestop.mml @@ -4,7 +4,7 @@ "raster_colorizer_onestop.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/rastercolorizer.mml b/test/rendering/rastercolorizer.mml index 719e22a..9840858 100644 --- a/test/rendering/rastercolorizer.mml +++ b/test/rendering/rastercolorizer.mml @@ -4,11 +4,11 @@ "rastercolorizer.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", "type": "shape" } }] -}
\ No newline at end of file +} diff --git a/test/rendering/regex.mml b/test/rendering/regex.mml index 4133c0b..9ca9803 100644 --- a/test/rendering/regex.mml +++ b/test/rendering/regex.mml @@ -4,7 +4,7 @@ "regex.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/regex_nest.mml b/test/rendering/regex_nest.mml index 82eebac..222ee42 100644 --- a/test/rendering/regex_nest.mml +++ b/test/rendering/regex_nest.mml @@ -4,7 +4,7 @@ "regex_nest.mss" ], "Layer": [{ - "name": "railway", + "id": "railway", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/selector_comment.mml b/test/rendering/selector_comment.mml index c6111a6..0ea15f5 100644 --- a/test/rendering/selector_comment.mml +++ b/test/rendering/selector_comment.mml @@ -4,14 +4,14 @@ "selector_comment.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", "type": "shape" } }, { - "name": "countries", + "id": "countries", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/sharedclass.mml b/test/rendering/sharedclass.mml index cb223de..c01ebb6 100644 --- a/test/rendering/sharedclass.mml +++ b/test/rendering/sharedclass.mml @@ -6,7 +6,6 @@ "Layer": [ { "id": "ab", - "name": "ab", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "geometry": "polygon", "Datasource": { @@ -22,10 +21,8 @@ }, "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "id": "bc", - "name": "bc", "class": "b c", "geometry": "polygon" } ] } - diff --git a/test/rendering/simplefontset.mml b/test/rendering/simplefontset.mml index 15715d4..fa5f051 100644 --- a/test/rendering/simplefontset.mml +++ b/test/rendering/simplefontset.mml @@ -4,7 +4,7 @@ "simplefontset.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", @@ -12,4 +12,3 @@ } }] } - diff --git a/test/rendering/simplevariabletest.mml b/test/rendering/simplevariabletest.mml index a5e7ad7..fc76e1b 100644 --- a/test/rendering/simplevariabletest.mml +++ b/test/rendering/simplevariabletest.mml @@ -4,7 +4,7 @@ "simplevariabletest.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", @@ -12,4 +12,3 @@ } }] } - diff --git a/test/rendering/style_fold.mml b/test/rendering/style_fold.mml index dfb09da..15d08c3 100644 --- a/test/rendering/style_fold.mml +++ b/test/rendering/style_fold.mml @@ -1,7 +1,6 @@ { "Layer": [ { - "name": "a", "id": "a" } ], diff --git a/test/rendering/style_level_opacity.mml b/test/rendering/style_level_opacity.mml index 160ebc8..d5b7546 100644 --- a/test/rendering/style_level_opacity.mml +++ b/test/rendering/style_level_opacity.mml @@ -4,7 +4,7 @@ "style_level_opacity.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/support4504.mml b/test/rendering/support4504.mml index fd33922..2ee6d0a 100644 --- a/test/rendering/support4504.mml +++ b/test/rendering/support4504.mml @@ -5,7 +5,7 @@ ], "Layer": [{ "class": "new", - "name": "countries", + "id": "countries", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/symbolizer_order.mml b/test/rendering/symbolizer_order.mml index aa6911f..95d733c 100644 --- a/test/rendering/symbolizer_order.mml +++ b/test/rendering/symbolizer_order.mml @@ -4,7 +4,7 @@ "symbolizer_order.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/text_property_overrides.mml b/test/rendering/text_property_overrides.mml index 9940bed..41e6eb4 100644 --- a/test/rendering/text_property_overrides.mml +++ b/test/rendering/text_property_overrides.mml @@ -4,7 +4,7 @@ "text_property_overrides.mss" ], "Layer": [{ - "name": "world", + "id": "world", "class": "m_0 m_1 m_2 m_3 m_4 m_5 m_6 m_7 m_8 m_9", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { diff --git a/test/rendering/transforms.mml b/test/rendering/transforms.mml index 63b17e0..923ffd3 100644 --- a/test/rendering/transforms.mml +++ b/test/rendering/transforms.mml @@ -4,7 +4,7 @@ "transforms.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/transforms_backwards.mml b/test/rendering/transforms_backwards.mml index b901d36..4ecf2db 100644 --- a/test/rendering/transforms_backwards.mml +++ b/test/rendering/transforms_backwards.mml @@ -4,7 +4,7 @@ "transforms_backwards.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/transforms_field.mml b/test/rendering/transforms_field.mml index 57fdb81..24e3e37 100644 --- a/test/rendering/transforms_field.mml +++ b/test/rendering/transforms_field.mml @@ -4,7 +4,7 @@ "transforms_field.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/transforms_single.mml b/test/rendering/transforms_single.mml index b3eae98..bed15d1 100644 --- a/test/rendering/transforms_single.mml +++ b/test/rendering/transforms_single.mml @@ -4,7 +4,7 @@ "transforms_single.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/units.mml b/test/rendering/units.mml index 0388d24..c39521d 100644 --- a/test/rendering/units.mml +++ b/test/rendering/units.mml @@ -4,7 +4,7 @@ "units.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/unsigned.mml b/test/rendering/unsigned.mml index e63641e..bdf9111 100644 --- a/test/rendering/unsigned.mml +++ b/test/rendering/unsigned.mml @@ -4,7 +4,7 @@ "unsigned.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/var_concat.mml b/test/rendering/var_concat.mml index 3adb899..b62061e 100644 --- a/test/rendering/var_concat.mml +++ b/test/rendering/var_concat.mml @@ -4,7 +4,7 @@ "var_concat.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/weird_comments.mml b/test/rendering/weird_comments.mml index c71a1c9..f5c15c5 100644 --- a/test/rendering/weird_comments.mml +++ b/test/rendering/weird_comments.mml @@ -4,11 +4,11 @@ "weird_comments.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", "type": "shape" } }] -}
\ No newline at end of file +} diff --git a/test/rendering/weird_comments_2.mml b/test/rendering/weird_comments_2.mml index d3acc85..18b3cbf 100644 --- a/test/rendering/weird_comments_2.mml +++ b/test/rendering/weird_comments_2.mml @@ -4,7 +4,7 @@ "weird_comments_2.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/weird_simple_comments.mml b/test/rendering/weird_simple_comments.mml index 6c26b3e..9d109f8 100644 --- a/test/rendering/weird_simple_comments.mml +++ b/test/rendering/weird_simple_comments.mml @@ -4,7 +4,7 @@ "weird_simple_comments.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", diff --git a/test/rendering/zoomlevels.mml b/test/rendering/zoomlevels.mml index 08ac7d4..30c3867 100644 --- a/test/rendering/zoomlevels.mml +++ b/test/rendering/zoomlevels.mml @@ -4,7 +4,7 @@ "zoomlevels.mss" ], "Layer": [{ - "name": "world", + "id": "world", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", @@ -12,7 +12,7 @@ } }, { - "name": "countries", + "id": "countries", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", "Datasource": { "file": "http://tilemill-data.s3.amazonaws.com/test_data/shape_demo.zip", @@ -20,4 +20,3 @@ } }] } - diff --git a/test/rendering/zoomselector.mml b/test/rendering/zoomselector.mml index 1009e54..2386fe4 100644 --- a/test/rendering/zoomselector.mml +++ b/test/rendering/zoomselector.mml @@ -4,7 +4,6 @@ "zoomselector.mss" ], "Layer": [{ - "name": "world", "id": "world", "class": "", "srs": "+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0.0 +k=1.0 +units=m +nadgrids=@null +wktext +no_defs +over", diff --git a/test/specificity.test.js b/test/specificity.test.js index cecb80a..18c7fff 100644 --- a/test/specificity.test.js +++ b/test/specificity.test.js @@ -26,9 +26,12 @@ describe('Specificity', function() { helper.files('specificity', 'mss', function(file) { it('should handle spec correctly in ' + file, function(done) { helper.file(file, function(content) { + var ref = new carto.tree.Reference(); + ref.setVersion(ref.getLatest()); var tree = (new carto.Parser({ paths: [ path.dirname(file) ], - filename: file + filename: file, + ref: ref })).parse(content); var mss = tree.toList({}); diff --git a/test/specificity/classes.result b/test/specificity/classes.result index 7bff522..0e41a46 100644 --- a/test/specificity/classes.result +++ b/test/specificity/classes.result @@ -1,9 +1,9 @@ [ - {"elements":[".foo",".bar",".baz"],"specificity":[0,3,0,29]}, - {"elements":[".foo",".baz"],"specificity":[0,2,0,68]}, - {"elements":[".baz",".foo"],"specificity":[0,2,0,55]}, - {"elements":[".baz",".bar"],"specificity":[0,2,0,0]}, - {"elements":[".baz"],"specificity":[0,1,0,47]}, - {"elements":[".bar"],"specificity":[0,1,0,21]}, - {"elements":[".foo"],"specificity":[0,1,0,13]} -]
\ No newline at end of file + {"elements":[".foo",".bar",".baz"],"specificity":[0,3,0,29],"matchCount": 0}, + {"elements":[".foo",".baz"],"specificity":[0,2,0,68],"matchCount": 0}, + {"elements":[".baz",".foo"],"specificity":[0,2,0,55],"matchCount": 0}, + {"elements":[".baz",".bar"],"specificity":[0,2,0,0],"matchCount": 0}, + {"elements":[".baz"],"specificity":[0,1,0,47],"matchCount": 0}, + {"elements":[".bar"],"specificity":[0,1,0,21],"matchCount": 0}, + {"elements":[".foo"],"specificity":[0,1,0,13],"matchCount": 0} +] diff --git a/test/specificity/demo.result b/test/specificity/demo.result index 0ad3ff7..a36e3ed 100644 --- a/test/specificity/demo.result +++ b/test/specificity/demo.result @@ -1,10 +1,10 @@ [ - {"elements":["#countries",".foo",".bar",".baz"],"specificity":[1,3,0,241]}, - {"elements":["#countries",".countries",".two"],"specificity":[1,2,0,149]}, - {"elements":["#world"],"filters":["[NAME]=United States","[BLUE]=red"],"specificity":[1,0,2,90]}, - {"elements":["#world"],"filters":["[NAME]=United States"],"specificity":[1,0,1,66]}, - {"elements":["#countries"],"specificity":[1,0,0,241]}, - {"elements":["#countries"],"specificity":[1,0,0,194]}, - {"elements":["#world"],"specificity":[1,0,0,194]}, - {"elements":["#world"],"specificity":[1,0,0,11]} + {"elements":["#countries",".foo",".bar",".baz"],"specificity":[1,3,0,241],"matchCount": 0}, + {"elements":["#countries",".countries",".two"],"specificity":[1,2,0,149],"matchCount": 0}, + {"elements":["#world"],"filters":["[NAME]=United States","[BLUE]=red"],"specificity":[1,0,2,90],"matchCount": 0}, + {"elements":["#world"],"filters":["[NAME]=United States"],"specificity":[1,0,1,66],"matchCount": 0}, + {"elements":["#countries"],"specificity":[1,0,0,241],"matchCount": 0}, + {"elements":["#countries"],"specificity":[1,0,0,194],"matchCount": 0}, + {"elements":["#world"],"specificity":[1,0,0,194],"matchCount": 0}, + {"elements":["#world"],"specificity":[1,0,0,11],"matchCount": 0} ] diff --git a/test/specificity/filters_and_ids.result b/test/specificity/filters_and_ids.result index 09b945e..abe3dce 100644 --- a/test/specificity/filters_and_ids.result +++ b/test/specificity/filters_and_ids.result @@ -1,8 +1,8 @@ [ - {"elements":["#world","#countries"],"filters":["[NAME]=United States"],"specificity":[2,0,1,94]}, - {"elements":["#world"],"filters":["[NAME]=United States"],"zoom":"......XXXXXXXXXXXXXXXXXXXX","specificity":[1,0,2,60]}, - {"elements":["#world"],"filters":["[NAME]=United States"],"specificity":[1,0,1,33]}, - {"elements":["#world"],"filters":["[NAME]=Canada"],"specificity":[1,0,1,7]}, - {"elements":[],"zoom":"......XXXXXXXXXXXXXXXXXXXX","specificity":[0,0,1,146]}, - {"elements":[],"filters":["[NAME]=United States"],"specificity":[0,0,1,120]} + {"elements":["#world","#countries"],"filters":["[NAME]=United States"],"specificity":[2,0,1,94],"matchCount": 0}, + {"elements":["#world"],"filters":["[NAME]=United States"],"zoom":"......XXXXXXXXXXXXXXXXXXXX","specificity":[1,0,2,60],"matchCount": 0}, + {"elements":["#world"],"filters":["[NAME]=United States"],"specificity":[1,0,1,33],"matchCount": 0}, + {"elements":["#world"],"filters":["[NAME]=Canada"],"specificity":[1,0,1,7],"matchCount": 0}, + {"elements":[],"zoom":"......XXXXXXXXXXXXXXXXXXXX","specificity":[0,0,1,146],"matchCount": 0}, + {"elements":[],"filters":["[NAME]=United States"],"specificity":[0,0,1,120],"matchCount": 0} ] diff --git a/test/specificity/issue60.result b/test/specificity/issue60.result index fbe2e51..f24f92a 100644 --- a/test/specificity/issue60.result +++ b/test/specificity/issue60.result @@ -1,6 +1,6 @@ [ - {"elements":["#world"],"filters":["[OBJECTID]=12"],"specificity":[1,0,1,131]}, - {"elements":["#world"],"filters":["[NET_INFLOW]>-10000"],"specificity":[1,0,1,83]}, - {"elements":["#world"],"filters":["[NET_INFLOW]>-30000"],"specificity":[1,0,1,35]}, - {"elements":["#world"],"specificity":[1,0,0,0]} + {"elements":["#world"],"filters":["[OBJECTID]=12"],"specificity":[1,0,1,131],"matchCount": 0}, + {"elements":["#world"],"filters":["[NET_INFLOW]>-10000"],"specificity":[1,0,1,83],"matchCount": 0}, + {"elements":["#world"],"filters":["[NET_INFLOW]>-30000"],"specificity":[1,0,1,35],"matchCount": 0}, + {"elements":["#world"],"specificity":[1,0,0,0],"matchCount": 0} ] diff --git a/test/support/.eslintrc.yml b/test/support/.eslintrc.yml new file mode 100644 index 0000000..3f3f80c --- /dev/null +++ b/test/support/.eslintrc.yml @@ -0,0 +1,2 @@ +rules: + no-control-regex: 0 diff --git a/test/support/helper.js b/test/support/helper.js index eeb80c5..3cc0fe1 100644 --- a/test/support/helper.js +++ b/test/support/helper.js @@ -1,11 +1,10 @@ var path = require('path'), + carto = require('../../lib/carto'), fs = require('fs'), assert = require('assert'), crypto = require('crypto'), sax = require('sax'), diff = require('./diff').diff, - yaml = require('js-yaml'), - _ = require('lodash'), constants = ((!process.ENOENT) >= 1) ? require('constants') : { ENOENT: process.ENOENT }; @@ -36,22 +35,10 @@ exports.json = function(file, callback) { }); }; -exports.mml = function(file) { - var mml = yaml.safeLoad(fs.readFileSync(file, 'utf-8')); - if (!_.isNil(mml.Stylesheet)) { - mml.Stylesheet = mml.Stylesheet.map(function(s) { - if (path.extname(s) === '.mss') { - return { - id: s, - data: fs.readFileSync(path.join(path.dirname(file), s), 'utf-8') - }; - } - else { - return s; - } - }); - } - return mml; +exports.mml = function(file, callback) { + var data = fs.readFileSync(file, 'utf-8'); + var mml = new carto.MML(); + mml.load(path.dirname(file), data, callback); }; exports.mss = function(file) { @@ -122,6 +109,12 @@ exports.compareToXMLFile = function(filename, second, callback, processors) { }; exports.resultFile = function(file) { + if (process.platform && process.platform === 'win32') { + var fileWin = path.join(path.dirname(file), path.basename(file).replace(/\.\w+$/, '_syswin.result')); + if (fs.existsSync(fileWin)) { + return fileWin; + } + } return path.join(path.dirname(file), path.basename(file).replace(/\.\w+$/, '.result')); }; |