carto
Version:
Mapnik Stylesheet Compiler
934 lines (863 loc) • 54.7 kB
HTML
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>2.0.1 — carto documentation</title>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="../../genindex.html"/>
<link rel="search" title="Search" href="../../search.html"/>
<link rel="top" title="carto documentation" href="../../index.html"/>
<script src="../../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../../index.html" class="icon icon-home"> carto
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../installation_usage.html">Installation & Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../language_elements.html">Language Elements</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../styling_concepts.html">Styling Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../mapnik_api.html">Mapnik API documentation</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">carto</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html">Docs</a> »</li>
<li>2.0.1</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/api/mapnik/2.0.1.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="id1">
<h1>2.0.1<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h1>
<div class="section" id="map">
<h2>map<a class="headerlink" href="#map" title="Permalink to this headline">¶</a></h2>
<div class="section" id="background-color">
<h3>background-color<a class="headerlink" href="#background-color" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">color</span></code></p>
<p>Default Value: none
<em>(transparent)</em></p>
<p>Map Background color</p>
</div>
<hr class="docutils" />
<div class="section" id="background-image">
<h3>background-image<a class="headerlink" href="#background-image" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">uri</span></code></p>
<p>Default Value:
<em>(transparent)</em></p>
<p>An image that is repeated below all features on a map as a background.</p>
</div>
<hr class="docutils" />
<div class="section" id="srs">
<h3>srs<a class="headerlink" href="#srs" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">string</span></code></p>
<p>Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs
<em>(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)</em></p>
<p>Map spatial reference (proj4 string)</p>
</div>
<hr class="docutils" />
<div class="section" id="buffer-size">
<h3>buffer-size<a class="headerlink" href="#buffer-size" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0
<em>(No buffer will be used)</em></p>
<p>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”.</p>
</div>
<hr class="docutils" />
<div class="section" id="base">
<h3>base<a class="headerlink" href="#base" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">string</span></code></p>
<p>Default Value:
<em>(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.)</em></p>
<p>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.</p>
</div>
<hr class="docutils" />
<div class="section" id="font-directory">
<h3>font-directory<a class="headerlink" href="#font-directory" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">uri</span></code></p>
<p>Default Value: none
<em>(No map-specific fonts will be registered)</em></p>
<p>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).</p>
</div>
</div>
<hr class="docutils" />
<div class="section" id="polygon">
<h2>polygon<a class="headerlink" href="#polygon" title="Permalink to this headline">¶</a></h2>
<div class="section" id="polygon-fill">
<h3>polygon-fill<a class="headerlink" href="#polygon-fill" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">color</span></code></p>
<p>Default Value: rgba(128,128,128,1)
<em>(gray and fully opaque (alpha = 1), same as rgb(128,128,128))</em></p>
<p>Fill color to assign to a polygon</p>
</div>
<hr class="docutils" />
<div class="section" id="polygon-gamma">
<h3>polygon-gamma<a class="headerlink" href="#polygon-gamma" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 1
<em>(fully antialiased)</em>
Range: 0-1
Level of antialiasing of polygon edges</p>
</div>
<hr class="docutils" />
<div class="section" id="polygon-opacity">
<h3>polygon-opacity<a class="headerlink" href="#polygon-opacity" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 1
<em>(opaque)</em></p>
<p>The opacity of the polygon</p>
</div>
<hr class="docutils" />
<div class="section" id="polygon-smooth">
<h3>polygon-smooth<a class="headerlink" href="#polygon-smooth" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0
<em>(no smoothing)</em>
Range: 0-1
Amount of smoothing applied</p>
</div>
</div>
<hr class="docutils" />
<div class="section" id="line">
<h2>line<a class="headerlink" href="#line" title="Permalink to this headline">¶</a></h2>
<div class="section" id="line-color">
<h3>line-color<a class="headerlink" href="#line-color" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">color</span></code></p>
<p>Default Value: rgba(0,0,0,1)
<em>(black and fully opaque (alpha = 1), same as rgb(0,0,0))</em></p>
<p>The color of a drawn line</p>
</div>
<hr class="docutils" />
<div class="section" id="line-width">
<h3>line-width<a class="headerlink" href="#line-width" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 1</p>
<p>The width of a line in pixels</p>
</div>
<hr class="docutils" />
<div class="section" id="line-opacity">
<h3>line-opacity<a class="headerlink" href="#line-opacity" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 1
<em>(opaque)</em></p>
<p>The opacity of a line</p>
</div>
<hr class="docutils" />
<div class="section" id="line-join">
<h3>line-join<a class="headerlink" href="#line-join" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">keyword</span></code></p>
<p>Possible values: <code class="docutils literal"><span class="pre">miter</span></code> <code class="docutils literal"><span class="pre">round</span></code> <code class="docutils literal"><span class="pre">bevel</span></code></p>
<p>Default Value: miter</p>
<p>The behavior of lines when joining</p>
</div>
<hr class="docutils" />
<div class="section" id="line-cap">
<h3>line-cap<a class="headerlink" href="#line-cap" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">keyword</span></code></p>
<p>Possible values: <code class="docutils literal"><span class="pre">butt</span></code> <code class="docutils literal"><span class="pre">round</span></code> <code class="docutils literal"><span class="pre">square</span></code></p>
<p>Default Value: butt</p>
<p>The display of line endings</p>
</div>
<hr class="docutils" />
<div class="section" id="line-gamma">
<h3>line-gamma<a class="headerlink" href="#line-gamma" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 1
<em>(fully antialiased)</em>
Range: 0-1
Level of antialiasing of stroke line</p>
</div>
<hr class="docutils" />
<div class="section" id="line-dasharray">
<h3>line-dasharray<a class="headerlink" href="#line-dasharray" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">numbers</span></code></p>
<p>Default Value: none
<em>(solid line)</em></p>
<p>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.</p>
</div>
<hr class="docutils" />
<div class="section" id="line-dash-offset">
<h3>line-dash-offset<a class="headerlink" href="#line-dash-offset" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">numbers</span></code></p>
<p>Default Value: none
<em>(solid line)</em></p>
<p>valid parameter but not currently used in renderers</p>
</div>
<hr class="docutils" />
<div class="section" id="line-rasterizer">
<h3>line-rasterizer<a class="headerlink" href="#line-rasterizer" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">keyword</span></code></p>
<p>Possible values: <code class="docutils literal"><span class="pre">full</span></code> <code class="docutils literal"><span class="pre">fast</span></code></p>
<p>Default Value: full</p>
<p>Exposes an alternate AGG rendering method that sacrifices some accuracy for speed.</p>
</div>
</div>
<hr class="docutils" />
<div class="section" id="markers">
<h2>markers<a class="headerlink" href="#markers" title="Permalink to this headline">¶</a></h2>
<div class="section" id="marker-file">
<h3>marker-file<a class="headerlink" href="#marker-file" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">uri</span></code></p>
<p>Default Value:
<em>(An ellipse or circle, if width equals height)</em></p>
<p>An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse.</p>
</div>
<hr class="docutils" />
<div class="section" id="marker-opacity">
<h3>marker-opacity<a class="headerlink" href="#marker-opacity" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 1
<em>(opaque)</em></p>
<p>The overall opacity of the marker</p>
</div>
<hr class="docutils" />
<div class="section" id="marker-line-color">
<h3>marker-line-color<a class="headerlink" href="#marker-line-color" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">color</span></code></p>
<p>Default Value: black</p>
<p>The color of the stroke around a marker shape.</p>
</div>
<hr class="docutils" />
<div class="section" id="marker-line-width">
<h3>marker-line-width<a class="headerlink" href="#marker-line-width" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0.5</p>
<p>The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself.</p>
</div>
<hr class="docutils" />
<div class="section" id="marker-line-opacity">
<h3>marker-line-opacity<a class="headerlink" href="#marker-line-opacity" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 1
<em>(opaque)</em></p>
<p>The opacity of a line</p>
</div>
<hr class="docutils" />
<div class="section" id="marker-placement">
<h3>marker-placement<a class="headerlink" href="#marker-placement" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">keyword</span></code></p>
<p>Possible values: <code class="docutils literal"><span class="pre">point</span></code> <code class="docutils literal"><span class="pre">line</span></code></p>
<p>Default Value: line</p>
<p>Attempt to place markers on a point once or on a line repeatedly</p>
</div>
<hr class="docutils" />
<div class="section" id="marker-type">
<h3>marker-type<a class="headerlink" href="#marker-type" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">keyword</span></code></p>
<p>Possible values: <code class="docutils literal"><span class="pre">arrow</span></code> <code class="docutils literal"><span class="pre">ellipse</span></code></p>
<p>Default Value: ellipse</p>
<p>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)</p>
</div>
<hr class="docutils" />
<div class="section" id="marker-width">
<h3>marker-width<a class="headerlink" href="#marker-width" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 10</p>
<p>The width of the marker, if using one of the default types.</p>
</div>
<hr class="docutils" />
<div class="section" id="marker-height">
<h3>marker-height<a class="headerlink" href="#marker-height" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 10</p>
<p>The height of the marker, if using one of the default types.</p>
</div>
<hr class="docutils" />
<div class="section" id="marker-fill">
<h3>marker-fill<a class="headerlink" href="#marker-fill" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">color</span></code></p>
<p>Default Value: blue</p>
<p>The color of the area of the marker.</p>
</div>
<hr class="docutils" />
<div class="section" id="marker-allow-overlap">
<h3>marker-allow-overlap<a class="headerlink" href="#marker-allow-overlap" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">boolean</span></code></p>
<p>Default Value: false
<em>(Do not allow makers to overlap with each other - overlapping markers will not be shown.)</em></p>
<p>Control whether overlapping markers are shown or hidden.</p>
</div>
<hr class="docutils" />
<div class="section" id="marker-ignore-placement">
<h3>marker-ignore-placement<a class="headerlink" href="#marker-ignore-placement" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">boolean</span></code></p>
<p>Default Value: false
<em>(do not store the bbox of this geometry in the collision detector cache)</em></p>
<p>value to control whether the placement of the feature will prevent the placement of other features</p>
</div>
<hr class="docutils" />
<div class="section" id="marker-spacing">
<h3>marker-spacing<a class="headerlink" href="#marker-spacing" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 100</p>
<p>Space between repeated labels</p>
</div>
<hr class="docutils" />
<div class="section" id="marker-max-error">
<h3>marker-max-error<a class="headerlink" href="#marker-max-error" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0.2</p>
<p>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.</p>
</div>
<hr class="docutils" />
<div class="section" id="marker-transform">
<h3>marker-transform<a class="headerlink" href="#marker-transform" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">string</span></code></p>
<p>Default Value:
<em>(no transformation)</em></p>
<p>An SVG transformation definition</p>
</div>
</div>
<hr class="docutils" />
<div class="section" id="shield">
<h2>shield<a class="headerlink" href="#shield" title="Permalink to this headline">¶</a></h2>
<div class="section" id="shield-name">
<h3>shield-name<a class="headerlink" href="#shield-name" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">string</span></code></p>
<p>Default Value:</p>
<p>Value to use for a shield”s text label. Data columns are specified using brackets like [column_name]</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-face-name">
<h3>shield-face-name<a class="headerlink" href="#shield-face-name" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">string</span></code></p>
<p>Default Value:</p>
<p>Font name and style to use for the shield text</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-unlock-image">
<h3>shield-unlock-image<a class="headerlink" href="#shield-unlock-image" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">boolean</span></code></p>
<p>Default Value: false
<em>(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)</em></p>
<p>This parameter should be set to true if you are trying to position text beside rather than on top of the shield image</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-size">
<h3>shield-size<a class="headerlink" href="#shield-size" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 10</p>
<p>The size of the shield text in pixels</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-fill">
<h3>shield-fill<a class="headerlink" href="#shield-fill" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">color</span></code></p>
<p>Default Value: black</p>
<p>The color of the shield text</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-placement">
<h3>shield-placement<a class="headerlink" href="#shield-placement" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">keyword</span></code></p>
<p>Possible values: <code class="docutils literal"><span class="pre">point</span></code> <code class="docutils literal"><span class="pre">line</span></code> <code class="docutils literal"><span class="pre">vertex</span></code> <code class="docutils literal"><span class="pre">interior</span></code></p>
<p>Default Value: point</p>
<p>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.</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-avoid-edges">
<h3>shield-avoid-edges<a class="headerlink" href="#shield-avoid-edges" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">boolean</span></code></p>
<p>Default Value: false</p>
<p>Tell positioning algorithm to avoid labeling near intersection edges.</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-min-distance">
<h3>shield-min-distance<a class="headerlink" href="#shield-min-distance" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>Minimum distance to the next shield symbol, not necessarily the same shield.</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-spacing">
<h3>shield-spacing<a class="headerlink" href="#shield-spacing" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>The spacing between repeated occurrences of the same shield on a line</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-min-padding">
<h3>shield-min-padding<a class="headerlink" href="#shield-min-padding" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>Determines the minimum amount of padding that a shield gets relative to other shields</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-wrap-width">
<h3>shield-wrap-width<a class="headerlink" href="#shield-wrap-width" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>Length before wrapping long names.</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-wrap-character">
<h3>shield-wrap-character<a class="headerlink" href="#shield-wrap-character" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">string</span></code></p>
<p>Default Value:</p>
<p>Use this character instead of a space to wrap long names.</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-halo-fill">
<h3>shield-halo-fill<a class="headerlink" href="#shield-halo-fill" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">color</span></code></p>
<p>Default Value: #FFFFFF
<em>(white)</em></p>
<p>Specifies the color of the halo around the text.</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-halo-radius">
<h3>shield-halo-radius<a class="headerlink" href="#shield-halo-radius" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0
<em>(no halo)</em></p>
<p>Specify the radius of the halo in pixels</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-character-spacing">
<h3>shield-character-spacing<a class="headerlink" href="#shield-character-spacing" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement.</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-line-spacing">
<h3>shield-line-spacing<a class="headerlink" href="#shield-line-spacing" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>Vertical spacing between lines of multiline labels (in pixels)</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-file">
<h3>shield-file<a class="headerlink" href="#shield-file" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">uri</span></code></p>
<p>Default Value: none</p>
<p>Image file to render behind the shield text</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-text-dx">
<h3>shield-text-dx<a class="headerlink" href="#shield-text-dx" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-text-dy">
<h3>shield-text-dy<a class="headerlink" href="#shield-text-dy" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-dx">
<h3>shield-dx<a class="headerlink" href="#shield-dx" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-dy">
<h3>shield-dy<a class="headerlink" href="#shield-dy" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-opacity">
<h3>shield-opacity<a class="headerlink" href="#shield-opacity" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 1</p>
<p>(Default 1.0) - opacity of the image used for the shield</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-text-opacity">
<h3>shield-text-opacity<a class="headerlink" href="#shield-text-opacity" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 1</p>
<p>(Default 1.0) - opacity of the text placed on top of the shield</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-horizontal-alignment">
<h3>shield-horizontal-alignment<a class="headerlink" href="#shield-horizontal-alignment" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">keyword</span></code></p>
<p>Possible values: <code class="docutils literal"><span class="pre">left</span></code> <code class="docutils literal"><span class="pre">middle</span></code> <code class="docutils literal"><span class="pre">right</span></code> <code class="docutils literal"><span class="pre">auto</span></code></p>
<p>Default Value: middle</p>
<p>The shield’s horizontal alignment from its centerpoint</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-text-transform">
<h3>shield-text-transform<a class="headerlink" href="#shield-text-transform" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">keyword</span></code></p>
<p>Possible values: <code class="docutils literal"><span class="pre">none</span></code> <code class="docutils literal"><span class="pre">uppercase</span></code> <code class="docutils literal"><span class="pre">lowercase</span></code> <code class="docutils literal"><span class="pre">capitalize</span></code></p>
<p>Default Value: none</p>
<p>Transform the case of the characters</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-no-text">
<h3>shield-no-text<a class="headerlink" href="#shield-no-text" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">boolean</span></code></p>
<p>Default Value: false</p>
<p>Whether the shield should make room for a text label.</p>
</div>
<hr class="docutils" />
<div class="section" id="shield-justify-alignment">
<h3>shield-justify-alignment<a class="headerlink" href="#shield-justify-alignment" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">string</span></code></p>
<p>Default Value: middle</p>
<p>Define how text in a shield’s label is justified</p>
</div>
</div>
<hr class="docutils" />
<div class="section" id="line-pattern">
<h2>line-pattern<a class="headerlink" href="#line-pattern" title="Permalink to this headline">¶</a></h2>
<div class="section" id="line-pattern-file">
<h3>line-pattern-file<a class="headerlink" href="#line-pattern-file" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">uri</span></code></p>
<p>Default Value: none</p>
<p>An image file to be repeated and warped along a line</p>
</div>
</div>
<hr class="docutils" />
<div class="section" id="polygon-pattern">
<h2>polygon-pattern<a class="headerlink" href="#polygon-pattern" title="Permalink to this headline">¶</a></h2>
<div class="section" id="polygon-pattern-file">
<h3>polygon-pattern-file<a class="headerlink" href="#polygon-pattern-file" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">uri</span></code></p>
<p>Default Value: none</p>
<p>Image to use as a repeated pattern fill within a polygon</p>
</div>
<hr class="docutils" />
<div class="section" id="polygon-pattern-alignment">
<h3>polygon-pattern-alignment<a class="headerlink" href="#polygon-pattern-alignment" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">keyword</span></code></p>
<p>Possible values: <code class="docutils literal"><span class="pre">local</span></code> <code class="docutils literal"><span class="pre">global</span></code></p>
<p>Default Value: local</p>
<p>Specify whether to align pattern fills to the layer or to the map.</p>
</div>
<hr class="docutils" />
<div class="section" id="polygon-pattern-gamma">
<h3>polygon-pattern-gamma<a class="headerlink" href="#polygon-pattern-gamma" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 1
<em>(fully antialiased)</em>
Range: 0-1
Level of antialiasing of polygon pattern edges</p>
</div>
</div>
<hr class="docutils" />
<div class="section" id="raster">
<h2>raster<a class="headerlink" href="#raster" title="Permalink to this headline">¶</a></h2>
<div class="section" id="raster-opacity">
<h3>raster-opacity<a class="headerlink" href="#raster-opacity" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 1
<em>(opaque)</em></p>
<p>The opacity of the raster symbolizer on top of other symbolizers.</p>
</div>
<hr class="docutils" />
<div class="section" id="raster-mode">
<h3>raster-mode<a class="headerlink" href="#raster-mode" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">keyword</span></code></p>
<p>Possible values: <code class="docutils literal"><span class="pre">normal</span></code> <code class="docutils literal"><span class="pre">grain_merge</span></code> <code class="docutils literal"><span class="pre">grain_merge2</span></code> <code class="docutils literal"><span class="pre">multiply</span></code> <code class="docutils literal"><span class="pre">multiply2</span></code> <code class="docutils literal"><span class="pre">divide</span></code> <code class="docutils literal"><span class="pre">divide2</span></code> <code class="docutils literal"><span class="pre">screen</span></code> <code class="docutils literal"><span class="pre">hard_light</span></code></p>
<p>Default Value: normal</p>
<p>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.</p>
</div>
<hr class="docutils" />
<div class="section" id="raster-filter-factor">
<h3>raster-filter-factor<a class="headerlink" href="#raster-filter-factor" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: -1
<em>(Allow the datasource to choose appropriate downscaling.)</em></p>
<p>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.</p>
</div>
<hr class="docutils" />
<div class="section" id="raster-scaling">
<h3>raster-scaling<a class="headerlink" href="#raster-scaling" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">keyword</span></code></p>
<p>Possible values: <code class="docutils literal"><span class="pre">fast</span></code> <code class="docutils literal"><span class="pre">bilinear</span></code> <code class="docutils literal"><span class="pre">bilinear8</span></code> <code class="docutils literal"><span class="pre">bicubic</span></code> <code class="docutils literal"><span class="pre">spline16</span></code> <code class="docutils literal"><span class="pre">gaussian</span></code> <code class="docutils literal"><span class="pre">lanczos</span></code></p>
<p>Default Value: fast</p>
<p>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.</p>
</div>
<hr class="docutils" />
<div class="section" id="raster-mesh-size">
<h3>raster-mesh-size<a class="headerlink" href="#raster-mesh-size" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">integer</span></code></p>
<p>Default Value: 16
<em>(Reprojection mesh will be 1/16 of the resolution of the source image)</em></p>
<p>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.</p>
</div>
</div>
<hr class="docutils" />
<div class="section" id="point">
<h2>point<a class="headerlink" href="#point" title="Permalink to this headline">¶</a></h2>
<div class="section" id="point-file">
<h3>point-file<a class="headerlink" href="#point-file" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">uri</span></code></p>
<p>Default Value: none</p>
<p>Image file to represent a point</p>
</div>
<hr class="docutils" />
<div class="section" id="point-allow-overlap">
<h3>point-allow-overlap<a class="headerlink" href="#point-allow-overlap" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">boolean</span></code></p>
<p>Default Value: false
<em>(Do not allow points to overlap with each other - overlapping markers will not be shown.)</em></p>
<p>Control whether overlapping points are shown or hidden.</p>
</div>
<hr class="docutils" />
<div class="section" id="point-ignore-placement">
<h3>point-ignore-placement<a class="headerlink" href="#point-ignore-placement" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">boolean</span></code></p>
<p>Default Value: false
<em>(do not store the bbox of this geometry in the collision detector cache)</em></p>
<p>value to control whether the placement of the feature will prevent the placement of other features</p>
</div>
<hr class="docutils" />
<div class="section" id="point-opacity">
<h3>point-opacity<a class="headerlink" href="#point-opacity" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 1
<em>(Fully opaque)</em></p>
<p>A value from 0 to 1 to control the opacity of the point</p>
</div>
<hr class="docutils" />
<div class="section" id="point-placement">
<h3>point-placement<a class="headerlink" href="#point-placement" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">keyword</span></code></p>
<p>Possible values: <code class="docutils literal"><span class="pre">centroid</span></code> <code class="docutils literal"><span class="pre">interior</span></code></p>
<p>Default Value: centroid</p>
<p>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.</p>
</div>
<hr class="docutils" />
<div class="section" id="point-transform">
<h3>point-transform<a class="headerlink" href="#point-transform" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">string</span></code></p>
<p>Default Value:
<em>(No transformation)</em></p>
<p>SVG transformation definition</p>
</div>
</div>
<hr class="docutils" />
<div class="section" id="text">
<h2>text<a class="headerlink" href="#text" title="Permalink to this headline">¶</a></h2>
<div class="section" id="text-name">
<h3>text-name<a class="headerlink" href="#text-name" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">string</span></code></p>
<p>Default Value:</p>
<p>Value to use for a text label. Data columns are specified using brackets like [column_name]</p>
</div>
<hr class="docutils" />
<div class="section" id="text-face-name">
<h3>text-face-name<a class="headerlink" href="#text-face-name" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">string</span></code></p>
<p>Default Value:</p>
<p>Font name and style to render a label in</p>
</div>
<hr class="docutils" />
<div class="section" id="text-size">
<h3>text-size<a class="headerlink" href="#text-size" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 10</p>
<p>Text size in pixels</p>
</div>
<hr class="docutils" />
<div class="section" id="text-ratio">
<h3>text-ratio<a class="headerlink" href="#text-ratio" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>Define the amount of text (of the total) present on successive lines when wrapping occurs</p>
</div>
<hr class="docutils" />
<div class="section" id="text-wrap-width">
<h3>text-wrap-width<a class="headerlink" href="#text-wrap-width" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>Length of a chunk of text in characters before wrapping text</p>
</div>
<hr class="docutils" />
<div class="section" id="text-wrap-character">
<h3>text-wrap-character<a class="headerlink" href="#text-wrap-character" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">string</span></code></p>
<p>Default Value:</p>
<p>Use this character instead of a space to wrap long text.</p>
</div>
<hr class="docutils" />
<div class="section" id="text-spacing">
<h3>text-spacing<a class="headerlink" href="#text-spacing" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>Distance between repeated text labels on a line</p>
</div>
<hr class="docutils" />
<div class="section" id="text-character-spacing">
<h3>text-character-spacing<a class="headerlink" href="#text-character-spacing" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>Horizontal spacing adjustment between characters in pixels</p>
</div>
<hr class="docutils" />
<div class="section" id="text-line-spacing">
<h3>text-line-spacing<a class="headerlink" href="#text-line-spacing" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>Vertical spacing adjustment between lines in pixels</p>
</div>
<hr class="docutils" />
<div class="section" id="text-label-position-tolerance">
<h3>text-label-position-tolerance<a class="headerlink" href="#text-label-position-tolerance" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>Allows the label to be displaced from its ideal position by a number of pixels</p>
</div>
<hr class="docutils" />
<div class="section" id="text-max-char-angle-delta">
<h3>text-max-char-angle-delta<a class="headerlink" href="#text-max-char-angle-delta" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: none</p>
<p>If present, the maximum angle change, in degrees, allowed between adjacent characters in a label. This will stop label placement around sharp corners.</p>
</div>
<hr class="docutils" />
<div class="section" id="text-fill">
<h3>text-fill<a class="headerlink" href="#text-fill" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">color</span></code></p>
<p>Default Value: #000000</p>
<p>Specifies the color for the text</p>
</div>
<hr class="docutils" />
<div class="section" id="text-opacity">
<h3>text-opacity<a class="headerlink" href="#text-opacity" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 1
<em>(Fully opaque)</em></p>
<p>A number from 0 to 1 specifying the opacity for the text</p>
</div>
<hr class="docutils" />
<div class="section" id="text-halo-fill">
<h3>text-halo-fill<a class="headerlink" href="#text-halo-fill" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">color</span></code></p>
<p>Default Value: #FFFFFF
<em>(white)</em></p>
<p>Specifies the color of the halo around the text.</p>
</div>
<hr class="docutils" />
<div class="section" id="text-halo-radius">
<h3>text-halo-radius<a class="headerlink" href="#text-halo-radius" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0
<em>(no halo)</em></p>
<p>Specify the radius of the halo in pixels</p>
</div>
<hr class="docutils" />
<div class="section" id="text-dx">
<h3>text-dx<a class="headerlink" href="#text-dx" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right</p>
</div>
<hr class="docutils" />
<div class="section" id="text-dy">
<h3>text-dy<a class="headerlink" href="#text-dy" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down</p>
</div>
<hr class="docutils" />
<div class="section" id="text-vertical-alignment">
<h3>text-vertical-alignment<a class="headerlink" href="#text-vertical-alignment" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">keyword</span></code></p>
<p>Possible values: <code class="docutils literal"><span class="pre">top</span></code> <code class="docutils literal"><span class="pre">middle</span></code> <code class="docutils literal"><span class="pre">bottom</span></code></p>
<p>Default Value: middle
<em>(Default affected by value of dy; “bottom” for dy>0, “top” for dy<0.)</em></p>
<p>Position of label relative to point position.</p>
</div>
<hr class="docutils" />
<div class="section" id="text-avoid-edges">
<h3>text-avoid-edges<a class="headerlink" href="#text-avoid-edges" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">boolean</span></code></p>
<p>Default Value: false</p>
<p>Tell positioning algorithm to avoid labeling near intersection edges.</p>
</div>
<hr class="docutils" />
<div class="section" id="text-min-distance">
<h3>text-min-distance<a class="headerlink" href="#text-min-distance" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>Minimum permitted distance to the next text symbolizer.</p>
</div>
<hr class="docutils" />
<div class="section" id="text-min-padding">
<h3>text-min-padding<a class="headerlink" href="#text-min-padding" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>Determines the minimum amount of padding that a text symbolizer gets relative to other text</p>
</div>
<hr class="docutils" />
<div class="section" id="text-min-path-length">
<h3>text-min-path-length<a class="headerlink" href="#text-min-path-length" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0
<em>(place labels on all paths)</em></p>
<p>Place labels only on paths longer than this value.</p>
</div>
<hr class="docutils" />
<div class="section" id="text-allow-overlap">
<h3>text-allow-overlap<a class="headerlink" href="#text-allow-overlap" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">boolean</span></code></p>
<p>Default Value: false
<em>(Do not allow text to overlap with other text - overlapping markers will not be shown.)</em></p>
<p>Control whether overlapping text is shown or hidden.</p>
</div>
<hr class="docutils" />
<div class="section" id="text-orientation">
<h3>text-orientation<a class="headerlink" href="#text-orientation" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">float</span></code></p>
<p>Default Value: 0</p>
<p>Rotate the text.</p>
</div>
<hr class="docutils" />
<div class="section" id="text-placement">
<h3>text-placement<a class="headerlink" href="#text-placement" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">keyword</span></code></p>
<p>Possible values: <code class="docutils literal"><span class="pre">point</span></code> <code class="docutils literal"><span class="pre">line</span></code> <code class="docutils literal"><span class="pre">vertex</span></code> <code class="docutils literal"><span class="pre">interior</span></code></p>
<p>Default Value: point</p>
<p>Control the style of placement of a point versus the geometry it is attached to.</p>
</div>
<hr class="docutils" />
<div class="section" id="text-placement-type">
<h3>text-placement-type<a class="headerlink" href="#text-placement-type" title="Permalink to this headline">¶</a></h3>
<p>Type: <code class="docutils literal"><span class="pre">keyword</span></code></p>
<p>Possible values: <code class="docutils literal"><span class="pre">dummy</span></code> <code class="docutils literal"><span class="pre">simple</span></code></p>
<p>Default Value: dummy</p>
<p>Re-position and/or re-size text to avoid overlaps. “simple” for basic algorithm (using text-placements string,) “dummy” to turn this feature off.</p>
</div>
<hr class="docutils" />
<div class="section" id="text-placements">
<h3>text-placements<a class="headerlink" href="#text-placements" title="Permalink to