pax_global_header00006660000000000000000000000064134231133110014502gustar00rootroot0000000000000052 comment=47a86a894b04bd08d571bf164e9cef2a983ea806 mapnik-reference-8.10.0/000077500000000000000000000000001342311331100150035ustar00rootroot00000000000000mapnik-reference-8.10.0/.gitignore000066400000000000000000000000331342311331100167670ustar00rootroot00000000000000node_modules npm-debug.log mapnik-reference-8.10.0/.npmignore000066400000000000000000000001311342311331100167750ustar00rootroot00000000000000Makefile .npmignore .travis.yml scripts test node_modules npm-debug.log index.html site/ mapnik-reference-8.10.0/.travis.yml000066400000000000000000000006611342311331100171170ustar00rootroot00000000000000language: cpp os: - osx - linux sudo: false branches: only: - gh-pages - /^.*$/ env: matrix: - NODE_NVM_VERSION="4" - NODE_NVM_VERSION="6" - NODE_NVM_VERSION="7" before_install: - git clone --depth 1 https://github.com/creationix/nvm.git ../.nvm - source ../.nvm/nvm.sh - nvm install $NODE_NVM_VERSION - nvm use $NODE_NVM_VERSION install: - npm install before_script: - make script: - make test mapnik-reference-8.10.0/2.0.0/000077500000000000000000000000001342311331100154405ustar00rootroot00000000000000mapnik-reference-8.10.0/2.0.0/reference.json000066400000000000000000001311061342311331100202730ustar00rootroot00000000000000{ "version": "2.0.0", "style": { "filter-mode": { "type": [ "all", "first" ], "doc": "Control the processing behavior of Rule filters within a Style. If 'all' is used then all Rules are processed sequentially independent of whether any previous filters matched. If 'first' is used then it means processing ends after the first match (a positive filter evaluation) and no further Rules in the Style are processed ('first' is usually the default for CSS implementations on top of Mapnik to simplify translation from CSS to Mapnik XML)", "default-value": "all", "default-meaning": "All Rules in a Style are processed whether they have filters or not and whether or not the filter conditions evaluate to true." } }, "layer" : { "name": { "default-value": "", "type":"string", "required" : true, "default-meaning": "No layer name has been provided", "doc": "The name of a layer. Can be anything you wish and is not strictly validated, but ideally unique in the map" }, "srs": { "default-value": "", "type":"string", "default-meaning": "No srs value is provided and the value will be inherited from the Map's srs", "doc": "The spatial reference system definition for the layer, aka the projection. Can either be a proj4 literal string like '+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs' or, if the proper proj4 epsg/nad/etc identifier files are installed, a string that uses an id like: '+init=epsg:4326'" }, "status": { "default-value": true, "type":"boolean", "default-meaning": "This layer will be marked as active and available for processing", "doc": "A property that can be set to false to disable this layer from being processed" }, "minzoom": { "default-value": 0, "type":"float", "default-meaning": "The layer will be visible at the minimum possible scale", "doc": "The minimum scale denominator that this layer will be visible at. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6" }, "maxzoom": { "default-value": "1.79769e+308", "type":"float", "default-meaning": "The layer will be visible at the maximum possible scale", "doc": "The maximum scale denominator that this layer will be visible at. The default is the numeric limit of the C++ double type, which may vary slightly by system, but is likely a massive number like 1.79769e+308 and ensures that this layer will always be visible unless the value is reduced. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6" }, "queryable": { "default-value": false, "type":"boolean", "default-meaning": "The layer will not be available for the direct querying of data values", "doc": "This property was added for GetFeatureInfo/WMS compatibility and is rarely used. It is off by default meaning that in a WMS context the layer will not be able to be queried unless the property is explicitly set to true" }, "clear-label-cache": { "default-value": false, "type":"boolean", "default-meaning": "The renderer's collision detector cache (used for avoiding duplicate labels and overlapping markers) will not be cleared immediately before processing this layer", "doc": "This property, by default off, can be enabled to allow a user to clear the collision detector cache before a given layer is processed. This may be desirable to ensure that a given layers data shows up on the map even if it normally would not because of collisions with previously rendered labels or markers" } }, "symbolizers" : { "map": { "background-color": { "css": "background-color", "default-value": "none", "default-meaning": "transparent", "type": "color", "doc": "Map Background color" }, "background-image": { "css": "background-image", "type": "uri", "default-value": "", "default-meaning": "transparent", "doc": "An image that is repeated below all features on a map as a background.", "description": "Map Background image" }, "srs": { "css": "srs", "type": "string", "default-value": "+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs", "default-meaning": "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", "doc": "Map spatial reference (proj4 string)" }, "buffer-size": { "css": "buffer-size", "default-value": 0, "type":"float", "default-meaning": "No buffer will be used", "doc": "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": { "css": "", "default-value": "none", "type":"bbox", "default-meaning": "No clipping extent will be used", "doc": "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": { "css": "base", "default-value": "", "default-meaning": "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.", "type": "string", "doc": "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." }, "paths-from-xml": { "css": "", "default-value": true, "default-meaning": "Paths read from XML will be interpreted from the location of the XML", "type": "boolean", "doc": "value to control whether paths in the XML will be interpreted from the location of the XML or from the working directory of the program that calls load_map()" }, "minimum-version": { "css": "", "default-value": "none", "default-meaning": "Mapnik version will not be detected and no error will be thrown about compatibility", "type": "string", "doc": "The minumum Mapnik version (e.g. 0.7.2) needed to use certain functionality in the stylesheet" }, "font-directory": { "css": "font-directory", "type": "uri", "default-value": "none", "default-meaning": "No map-specific fonts will be registered", "doc": "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": { "fill": { "css": "polygon-fill", "type": "color", "default-value": "rgba(128,128,128,1)", "default-meaning": "gray and fully opaque (alpha = 1), same as rgb(128,128,128)", "doc": "Fill color to assign to a polygon" }, "gamma": { "css": "polygon-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of polygon edges" }, "fill-opacity": { "css": "polygon-opacity", "type": "float", "doc": "The opacity of the polygon", "default-value": 1, "default-meaning": "opaque" }, "smooth": { "css": "polygon-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Amount of smoothing applied" } }, "line": { "stroke": { "css": "line-color", "default-value": "rgba(0,0,0,1)", "type": "color", "default-meaning": "black and fully opaque (alpha = 1), same as rgb(0,0,0)", "doc": "The color of a drawn line" }, "stroke-width": { "css": "line-width", "default-value": 1, "type": "float", "doc": "The width of a line in pixels" }, "stroke-opacity": { "css": "line-opacity", "default-value": 1, "type": "float", "default-meaning": "opaque", "doc": "The opacity of a line" }, "stroke-linejoin": { "css": "line-join", "default-value": "miter", "type": [ "miter", "round", "bevel" ], "doc": "The behavior of lines when joining" }, "stroke-linecap": { "css": "line-cap", "default-value": "butt", "type": [ "butt", "round", "square" ], "doc": "The display of line endings" }, "stroke-gamma": { "css": "line-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of stroke line" }, "stroke-dasharray": { "css": "line-dasharray", "type": "numbers", "doc": "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.", "default-value": "none", "default-meaning": "solid line" }, "stroke-dashoffset": { "css": "line-dash-offset", "type": "numbers", "doc": "valid parameter but not currently used in renderers", "default-value": "none", "default-meaning": "solid line" }, "rasterizer": { "css": "line-rasterizer", "type": [ "full", "fast" ], "default-value": "full", "doc": "Exposes an alternate AGG rendering method that sacrifices some accuracy for speed." } }, "markers": { "file": { "css": "marker-file", "doc": "An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse.", "default-value": "", "default-meaning": "An ellipse or circle, if width equals height", "type": "uri" }, "opacity": { "css": "marker-opacity", "doc": "The overall opacity of the marker", "default-value": 1, "default-meaning": "opaque", "type": "float" }, "stroke": { "css": "marker-line-color", "doc": "The color of the stroke around a marker shape.", "default-value": "black", "type": "color" }, "stroke-width": { "css": "marker-line-width", "default-value": 0.5, "doc": "The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself.", "type": "float" }, "stroke-opacity": { "css": "marker-line-opacity", "default-value": 1, "default-meaning": "opaque", "doc": "The opacity of a line", "type": "float" }, "placement": { "css": "marker-placement", "type": [ "point", "line" ], "doc": "Attempt to place markers on a point once or on a line repeatedly", "default-value": "line" }, "marker-type": { "css": "marker-type", "type": [ "arrow", "ellipse" ], "default-value": "ellipse", "doc": "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)" }, "width": { "css": "marker-width", "default-value": 10, "doc": "The width of the marker, if using one of the default types.", "type": "float" }, "height": { "css": "marker-height", "default-value": 10, "doc": "The height of the marker, if using one of the default types.", "type": "float" }, "fill": { "css": "marker-fill", "default-value": "blue", "doc": "The color of the area of the marker.", "type": "color" }, "allow-overlap": { "css": "marker-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping markers are shown or hidden.", "default-meaning": "Do not allow makers to overlap with each other - overlapping markers will not be shown." }, "ignore-placement": { "css": "marker-ignore-placement", "type": "boolean", "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache", "doc": "value to control whether the placement of the feature will prevent the placement of other features" }, "spacing": { "css": "marker-spacing", "doc": "Space between repeated labels", "default-value": 100, "type": "float" }, "max-error": { "css": "marker-max-error", "type": "float", "default-value": 0.2, "doc": "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." }, "transform": { "css": "marker-transform", "doc": "An SVG transformation definition", "default-value": "", "default-meaning": "no transformation", "type": "string" } }, "shield": { "name": { "css": "shield-name", "type": "string", "required": true, "serialization": "content", "default-value": "", "doc": "Value to use for a shield\"s text label. Data columns are specified using brackets like [column_name]" }, "face-name": { "css": "shield-face-name", "type": "string", "validate": "font", "doc": "Font name and style to use for the shield text", "default-value": "", "required": true }, "unlock-image": { "css": "shield-unlock-image", "type": "boolean", "doc": "This parameter should be set to true if you are trying to position text beside rather than on top of the shield image", "default-value": false, "default-meaning": "text alignment relative to the shield image uses the center of the image as the anchor for text positioning." }, "size": { "css": "shield-size", "type": "float", "default-value": 10, "doc": "The size of the shield text in pixels" }, "fill": { "css": "shield-fill", "type": "color", "default-value": "black", "doc": "The color of the shield text" }, "placement": { "css": "shield-placement", "type": [ "point", "line", "vertex", "interior" ], "default-value": "point", "doc": "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." }, "avoid-edges": { "css": "shield-avoid-edges", "doc": "Tell positioning algorithm to avoid labeling near intersection edges.", "type": "boolean", "default-value": false }, "minimum-distance": { "css": "shield-min-distance", "type": "float", "default-value": 0, "doc": "Minimum distance to the next shield symbol, not necessarily the same shield." }, "spacing": { "css": "shield-spacing", "type": "float", "default-value": 0, "doc": "The spacing between repeated occurrences of the same shield on a line" }, "minimum-padding": { "css": "shield-min-padding", "default-value": 0, "doc": "Determines the minimum amount of padding that a shield gets relative to other shields", "type": "float" }, "wrap-width": { "css": "shield-wrap-width", "type": "float", "default-value": 0, "doc": "Length before wrapping long names." }, "wrap-character": { "css": "shield-wrap-character", "type": "string", "default-value": " ", "doc": "Use this character instead of a space to wrap long names." }, "halo-fill": { "css": "shield-halo-fill", "type": "color", "default-value": "#FFFFFF", "default-meaning": "white", "doc": "Specifies the color of the halo around the text." }, "halo-radius": { "css": "shield-halo-radius", "doc": "Specify the radius of the halo in pixels", "default-value": 0, "default-meaning": "no halo", "type": "float" }, "character-spacing": { "css": "shield-character-spacing", "type": "float", "default-value": 0, "doc": "Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement." }, "line-spacing": { "css": "shield-line-spacing", "default-value": 0, "doc": "Vertical spacing between lines of multiline labels (in pixels)", "type": "float" }, "file": { "css": "shield-file", "type": "uri", "default-value": "none", "doc": "Image file to render behind the shield text" }, "dx": { "css": "shield-text-dx", "type": "float", "doc": "Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right", "default-value": 0 }, "dy": { "css": "shield-text-dy", "type": "float", "doc": "Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down", "default-value": 0 }, "shield-dx": { "css": "shield-dx", "type": "float", "doc": "Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right", "default-value": 0 }, "shield-dy": { "css": "shield-dy", "type": "float", "doc": "Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down", "default-value": 0 }, "opacity": { "css": "shield-opacity", "type": "float", "doc": "(Default 1.0) - opacity of the image used for the shield", "default-value": 1 }, "text-opacity": { "css": "shield-text-opacity", "type": "float", "doc": "(Default 1.0) - opacity of the text placed on top of the shield", "default-value": 1 }, "horizontal-alignment": { "css": "shield-horizontal-alignment", "type": [ "left", "middle", "right", "auto" ], "doc": "The shield's horizontal alignment from its centerpoint", "default-value": "middle" }, "text-transform": { "css": "shield-text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize" ], "doc": "Transform the case of the characters", "default-value": "none" }, "no-text": { "css": "shield-no-text", "type": "boolean", "doc": "Whether the shield should make room for a text label.", "default-value": "false" }, "justify-alignment": { "css": "shield-justify-alignment", "type": "string", "doc": "Define how text in a shield's label is justified", "default-value": "middle" } }, "line-pattern": { "file": { "css": "line-pattern-file", "type": "uri", "default-value": "none", "required": true, "doc": "An image file to be repeated and warped along a line" } }, "polygon-pattern": { "file": { "css": "polygon-pattern-file", "type": "uri", "default-value": "none", "required": true, "doc": "Image to use as a repeated pattern fill within a polygon" }, "alignment": { "css": "polygon-pattern-alignment", "type": ["local","global"], "default-value": "local", "doc": "Specify whether to align pattern fills to the layer or to the map." }, "gamma": { "css": "polygon-pattern-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of polygon pattern edges" } }, "raster": { "opacity": { "css": "raster-opacity", "default-value": 1, "default-meaning": "opaque", "type": "float", "doc": "The opacity of the raster symbolizer on top of other symbolizers." }, "mode": { "css": "raster-mode", "default-value": "normal", "type": [ "normal", "grain_merge", "grain_merge2", "multiply", "multiply2", "divide", "divide2", "screen", "hard_light" ], "doc": "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." }, "filter-factor": { "css": "raster-filter-factor", "default-value": -1, "default-meaning": "Allow the datasource to choose appropriate downscaling.", "type": "float", "doc": "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." }, "scaling": { "css": "raster-scaling", "type": [ "fast", "bilinear", "bilinear8", "bicubic", "spline16", "gaussian", "lanczos" ], "default-value": "fast", "doc": "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." }, "mesh-size": { "css": "raster-mesh-size", "default-value": 16, "default-meaning": "Reprojection mesh will be 1/16 of the resolution of the source image", "type": "integer", "doc": "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": { "file": { "css": "point-file", "type": "uri", "required": false, "default-value": "none", "doc": "Image file to represent a point" }, "allow-overlap": { "css": "point-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping points are shown or hidden.", "default-meaning": "Do not allow points to overlap with each other - overlapping markers will not be shown." }, "ignore-placement": { "css": "point-ignore-placement", "type": "boolean", "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache", "doc": "value to control whether the placement of the feature will prevent the placement of other features" }, "opacity": { "css": "point-opacity", "type": "float", "default-value": 1.0, "default-meaning": "Fully opaque", "doc": "A value from 0 to 1 to control the opacity of the point" }, "placement": { "css": "point-placement", "type": [ "centroid", "interior" ], "doc": "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.", "default-value": "centroid" }, "transform": { "css": "point-transform", "type": "string", "default-value": "", "default-meaning": "No transformation", "doc": "SVG transformation definition" } }, "text": { "name": { "css": "text-name", "type": "string", "required": true, "default-value": "", "serialization": "content", "doc": "Value to use for a text label. Data columns are specified using brackets like [column_name]" }, "face-name": { "css": "text-face-name", "type": "string", "validate": "font", "default-value": "", "doc": "Font name and style to render a label in", "required": true }, "size": { "css": "text-size", "type": "float", "default-value": 10, "doc": "Text size in pixels" }, "text-ratio": { "css": "text-ratio", "doc": "Define the amount of text (of the total) present on successive lines when wrapping occurs", "default-value": 0, "type": "float" }, "wrap-width": { "css": "text-wrap-width", "doc": "Length of a chunk of text in characters before wrapping text", "default-value": 0, "type": "float" }, "wrap-character": { "css": "text-wrap-character", "type": "string", "default-value": " ", "doc": "Use this character instead of a space to wrap long text." }, "spacing": { "css": "text-spacing", "type": "float", "default-value": 0, "doc": "Distance between repeated text labels on a line" }, "character-spacing": { "css": "text-character-spacing", "type": "float", "default-value": 0, "doc": "Horizontal spacing adjustment between characters in pixels" }, "line-spacing": { "css": "text-line-spacing", "default-value": 0, "type": "float", "doc": "Vertical spacing adjustment between lines in pixels" }, "label-position-tolerance": { "css": "text-label-position-tolerance", "default-value": 0, "type": "float", "doc": "Allows the label to be displaced from its ideal position by a number of pixels" }, "max-char-angle-delta": { "css": "text-max-char-angle-delta", "type": "float", "default-value": "none", "doc": "If present, the maximum angle change, in degrees, allowed between adjacent characters in a label. This will stop label placement around sharp corners." }, "fill": { "css": "text-fill", "doc": "Specifies the color for the text", "default-value": "#000000", "type": "color" }, "opacity": { "css": "text-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text", "default-value": 1.0, "default-meaning": "Fully opaque", "type": "float" }, "halo-fill": { "css": "text-halo-fill", "type": "color", "default-value": "#FFFFFF", "default-meaning": "white", "doc": "Specifies the color of the halo around the text." }, "halo-radius": { "css": "text-halo-radius", "doc": "Specify the radius of the halo in pixels", "default-value": 0, "default-meaning": "no halo", "type": "float" }, "dx": { "css": "text-dx", "type": "float", "doc": "Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right", "default-value": 0 }, "dy": { "css": "text-dy", "type": "float", "doc": "Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down", "default-value": 0 }, "vertical-alignment": { "css": "text-vertical-alignment", "type": [ "top", "middle", "bottom" ], "doc": "Position of label relative to point position.", "default-value": "middle", "default-meaning": "Default affected by value of dy; \"bottom\" for dy>0, \"top\" for dy<0." }, "avoid-edges": { "css": "text-avoid-edges", "doc": "Tell positioning algorithm to avoid labeling near intersection edges.", "default-value": false, "type": "boolean" }, "minimum-distance": { "css": "text-min-distance", "doc": "Minimum permitted distance to the next text symbolizer.", "default-value": 0, "type": "float" }, "minimum-padding": { "css": "text-min-padding", "doc": "Determines the minimum amount of padding that a text symbolizer gets relative to other text", "default-value": 0, "type": "float" }, "minimum-path-length": { "css": "text-min-path-length", "type": "float", "default-value": 0, "default-meaning": "place labels on all paths", "doc": "Place labels only on paths longer than this value." }, "allow-overlap": { "css": "text-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping text is shown or hidden.", "default-meaning": "Do not allow text to overlap with other text - overlapping markers will not be shown." }, "orientation": { "css": "text-orientation", "type": "float", "default-value": 0, "doc": "Rotate the text." }, "placement": { "css": "text-placement", "type": [ "point", "line", "vertex", "interior" ], "default-value": "point", "doc": "Control the style of placement of a point versus the geometry it is attached to." }, "placement-type": { "css": "text-placement-type", "doc": "Re-position and/or re-size text to avoid overlaps. \"simple\" for basic algorithm (using text-placements string,) \"dummy\" to turn this feature off.", "type": [ "dummy", "simple" ], "default-value": "dummy" }, "placements": { "css": "text-placements", "type": "string", "default-value": "", "doc": "If \"placement-type\" is set to \"simple\", use this \"POSITIONS,[SIZES]\" string. See TextSymbolizer docs for format." }, "text-transform": { "css": "text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize" ], "doc": "Transform the case of the characters", "default-value": "none" }, "horizontal-alignment": { "css": "text-horizontal-alignment", "type": [ "left", "middle", "right", "auto" ], "doc": "The text's horizontal alignment from its centerpoint", "default-value": "middle" }, "justify-alignment": { "css": "text-align", "type": [ "left", "right", "center" ], "doc": "Set the text alignment.", "default-value": "center" } }, "building": { "fill": { "css": "building-fill", "default-value": "#FFFFFF", "doc": "The color of the buildings walls.", "type": "color" }, "fill-opacity": { "css": "building-fill-opacity", "type": "float", "doc": "The opacity of the building as a whole, including all walls.", "default-value": 1 }, "height": { "css": "building-height", "doc": "The height of the building in pixels.", "type": "float", "default-value": 0 } } }, "colors": { "aliceblue": [240, 248, 255], "antiquewhite": [250, 235, 215], "aqua": [0, 255, 255], "aquamarine": [127, 255, 212], "azure": [240, 255, 255], "beige": [245, 245, 220], "bisque": [255, 228, 196], "black": [0, 0, 0], "blanchedalmond": [255,235,205], "blue": [0, 0, 255], "blueviolet": [138, 43, 226], "brown": [165, 42, 42], "burlywood": [222, 184, 135], "cadetblue": [95, 158, 160], "chartreuse": [127, 255, 0], "chocolate": [210, 105, 30], "coral": [255, 127, 80], "cornflowerblue": [100, 149, 237], "cornsilk": [255, 248, 220], "crimson": [220, 20, 60], "cyan": [0, 255, 255], "darkblue": [0, 0, 139], "darkcyan": [0, 139, 139], "darkgoldenrod": [184, 134, 11], "darkgray": [169, 169, 169], "darkgreen": [0, 100, 0], "darkgrey": [169, 169, 169], "darkkhaki": [189, 183, 107], "darkmagenta": [139, 0, 139], "darkolivegreen": [85, 107, 47], "darkorange": [255, 140, 0], "darkorchid": [153, 50, 204], "darkred": [139, 0, 0], "darksalmon": [233, 150, 122], "darkseagreen": [143, 188, 143], "darkslateblue": [72, 61, 139], "darkslategrey": [47, 79, 79], "darkturquoise": [0, 206, 209], "darkviolet": [148, 0, 211], "deeppink": [255, 20, 147], "deepskyblue": [0, 191, 255], "dimgray": [105, 105, 105], "dimgrey": [105, 105, 105], "dodgerblue": [30, 144, 255], "firebrick": [178, 34, 34], "floralwhite": [255, 250, 240], "forestgreen": [34, 139, 34], "fuchsia": [255, 0, 255], "gainsboro": [220, 220, 220], "ghostwhite": [248, 248, 255], "gold": [255, 215, 0], "goldenrod": [218, 165, 32], "gray": [128, 128, 128], "grey": [128, 128, 128], "green": [0, 128, 0], "greenyellow": [173, 255, 47], "honeydew": [240, 255, 240], "hotpink": [255, 105, 180], "indianred": [205, 92, 92], "indigo": [75, 0, 130], "ivory": [255, 255, 240], "khaki": [240, 230, 140], "lavender": [230, 230, 250], "lavenderblush": [255, 240, 245], "lawngreen": [124, 252, 0], "lemonchiffon": [255, 250, 205], "lightblue": [173, 216, 230], "lightcoral": [240, 128, 128], "lightcyan": [224, 255, 255], "lightgoldenrodyellow": [250, 250, 210], "lightgray": [211, 211, 211], "lightgreen": [144, 238, 144], "lightgrey": [211, 211, 211], "lightpink": [255, 182, 193], "lightsalmon": [255, 160, 122], "lightseagreen": [32, 178, 170], "lightskyblue": [135, 206, 250], "lightslategray": [119, 136, 153], "lightslategrey": [119, 136, 153], "lightsteelblue": [176, 196, 222], "lightyellow": [255, 255, 224], "lime": [0, 255, 0], "limegreen": [50, 205, 50], "linen": [250, 240, 230], "magenta": [255, 0, 255], "maroon": [128, 0, 0], "mediumaquamarine": [102, 205, 170], "mediumblue": [0, 0, 205], "mediumorchid": [186, 85, 211], "mediumpurple": [147, 112, 219], "mediumseagreen": [60, 179, 113], "mediumslateblue": [123, 104, 238], "mediumspringgreen": [0, 250, 154], "mediumturquoise": [72, 209, 204], "mediumvioletred": [199, 21, 133], "midnightblue": [25, 25, 112], "mintcream": [245, 255, 250], "mistyrose": [255, 228, 225], "moccasin": [255, 228, 181], "navajowhite": [255, 222, 173], "navy": [0, 0, 128], "oldlace": [253, 245, 230], "olive": [128, 128, 0], "olivedrab": [107, 142, 35], "orange": [255, 165, 0], "orangered": [255, 69, 0], "orchid": [218, 112, 214], "palegoldenrod": [238, 232, 170], "palegreen": [152, 251, 152], "paleturquoise": [175, 238, 238], "palevioletred": [219, 112, 147], "papayawhip": [255, 239, 213], "peachpuff": [255, 218, 185], "peru": [205, 133, 63], "pink": [255, 192, 203], "plum": [221, 160, 221], "powderblue": [176, 224, 230], "purple": [128, 0, 128], "red": [255, 0, 0], "rosybrown": [188, 143, 143], "royalblue": [65, 105, 225], "saddlebrown": [139, 69, 19], "salmon": [250, 128, 114], "sandybrown": [244, 164, 96], "seagreen": [46, 139, 87], "seashell": [255, 245, 238], "sienna": [160, 82, 45], "silver": [192, 192, 192], "skyblue": [135, 206, 235], "slateblue": [106, 90, 205], "slategray": [112, 128, 144], "slategrey": [112, 128, 144], "snow": [255, 250, 250], "springgreen": [0, 255, 127], "steelblue": [70, 130, 180], "tan": [210, 180, 140], "teal": [0, 128, 128], "thistle": [216, 191, 216], "tomato": [255, 99, 71], "turquoise": [64, 224, 208], "violet": [238, 130, 238], "wheat": [245, 222, 179], "white": [255, 255, 255], "whitesmoke": [245, 245, 245], "yellow": [255, 255, 0], "yellowgreen": [154, 205, 50], "transparent": [0, 0, 0, 0] }, "filter": { "value": [ "true", "false", "null" ] } } mapnik-reference-8.10.0/2.0.1/000077500000000000000000000000001342311331100154415ustar00rootroot00000000000000mapnik-reference-8.10.0/2.0.1/reference.json000066400000000000000000001311061342311331100202740ustar00rootroot00000000000000{ "version": "2.0.1", "style": { "filter-mode": { "type": [ "all", "first" ], "doc": "Control the processing behavior of Rule filters within a Style. If 'all' is used then all Rules are processed sequentially independent of whether any previous filters matched. If 'first' is used then it means processing ends after the first match (a positive filter evaluation) and no further Rules in the Style are processed ('first' is usually the default for CSS implementations on top of Mapnik to simplify translation from CSS to Mapnik XML)", "default-value": "all", "default-meaning": "All Rules in a Style are processed whether they have filters or not and whether or not the filter conditions evaluate to true." } }, "layer" : { "name": { "default-value": "", "type":"string", "required" : true, "default-meaning": "No layer name has been provided", "doc": "The name of a layer. Can be anything you wish and is not strictly validated, but ideally unique in the map" }, "srs": { "default-value": "", "type":"string", "default-meaning": "No srs value is provided and the value will be inherited from the Map's srs", "doc": "The spatial reference system definition for the layer, aka the projection. Can either be a proj4 literal string like '+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs' or, if the proper proj4 epsg/nad/etc identifier files are installed, a string that uses an id like: '+init=epsg:4326'" }, "status": { "default-value": true, "type":"boolean", "default-meaning": "This layer will be marked as active and available for processing", "doc": "A property that can be set to false to disable this layer from being processed" }, "minzoom": { "default-value": 0, "type":"float", "default-meaning": "The layer will be visible at the minimum possible scale", "doc": "The minimum scale denominator that this layer will be visible at. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6" }, "maxzoom": { "default-value": "1.79769e+308", "type":"float", "default-meaning": "The layer will be visible at the maximum possible scale", "doc": "The maximum scale denominator that this layer will be visible at. The default is the numeric limit of the C++ double type, which may vary slightly by system, but is likely a massive number like 1.79769e+308 and ensures that this layer will always be visible unless the value is reduced. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6" }, "queryable": { "default-value": false, "type":"boolean", "default-meaning": "The layer will not be available for the direct querying of data values", "doc": "This property was added for GetFeatureInfo/WMS compatibility and is rarely used. It is off by default meaning that in a WMS context the layer will not be able to be queried unless the property is explicitly set to true" }, "clear-label-cache": { "default-value": false, "type":"boolean", "default-meaning": "The renderer's collision detector cache (used for avoiding duplicate labels and overlapping markers) will not be cleared immediately before processing this layer", "doc": "This property, by default off, can be enabled to allow a user to clear the collision detector cache before a given layer is processed. This may be desirable to ensure that a given layers data shows up on the map even if it normally would not because of collisions with previously rendered labels or markers" } }, "symbolizers" : { "map": { "background-color": { "css": "background-color", "default-value": "none", "default-meaning": "transparent", "type": "color", "doc": "Map Background color" }, "background-image": { "css": "background-image", "type": "uri", "default-value": "", "default-meaning": "transparent", "doc": "An image that is repeated below all features on a map as a background.", "description": "Map Background image" }, "srs": { "css": "srs", "type": "string", "default-value": "+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs", "default-meaning": "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", "doc": "Map spatial reference (proj4 string)" }, "buffer-size": { "css": "buffer-size", "default-value": 0, "type":"float", "default-meaning": "No buffer will be used", "doc": "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": { "css": "", "default-value": "none", "type":"bbox", "default-meaning": "No clipping extent will be used", "doc": "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": { "css": "base", "default-value": "", "default-meaning": "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.", "type": "string", "doc": "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." }, "paths-from-xml": { "css": "", "default-value": true, "default-meaning": "Paths read from XML will be interpreted from the location of the XML", "type": "boolean", "doc": "value to control whether paths in the XML will be interpreted from the location of the XML or from the working directory of the program that calls load_map()" }, "minimum-version": { "css": "", "default-value": "none", "default-meaning": "Mapnik version will not be detected and no error will be thrown about compatibility", "type": "string", "doc": "The minumum Mapnik version (e.g. 0.7.2) needed to use certain functionality in the stylesheet" }, "font-directory": { "css": "font-directory", "type": "uri", "default-value": "none", "default-meaning": "No map-specific fonts will be registered", "doc": "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": { "fill": { "css": "polygon-fill", "type": "color", "default-value": "rgba(128,128,128,1)", "default-meaning": "gray and fully opaque (alpha = 1), same as rgb(128,128,128)", "doc": "Fill color to assign to a polygon" }, "gamma": { "css": "polygon-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of polygon edges" }, "fill-opacity": { "css": "polygon-opacity", "type": "float", "doc": "The opacity of the polygon", "default-value": 1, "default-meaning": "opaque" }, "smooth": { "css": "polygon-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Amount of smoothing applied" } }, "line": { "stroke": { "css": "line-color", "default-value": "rgba(0,0,0,1)", "type": "color", "default-meaning": "black and fully opaque (alpha = 1), same as rgb(0,0,0)", "doc": "The color of a drawn line" }, "stroke-width": { "css": "line-width", "default-value": 1, "type": "float", "doc": "The width of a line in pixels" }, "stroke-opacity": { "css": "line-opacity", "default-value": 1, "type": "float", "default-meaning": "opaque", "doc": "The opacity of a line" }, "stroke-linejoin": { "css": "line-join", "default-value": "miter", "type": [ "miter", "round", "bevel" ], "doc": "The behavior of lines when joining" }, "stroke-linecap": { "css": "line-cap", "default-value": "butt", "type": [ "butt", "round", "square" ], "doc": "The display of line endings" }, "stroke-gamma": { "css": "line-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of stroke line" }, "stroke-dasharray": { "css": "line-dasharray", "type": "numbers", "doc": "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.", "default-value": "none", "default-meaning": "solid line" }, "stroke-dashoffset": { "css": "line-dash-offset", "type": "numbers", "doc": "valid parameter but not currently used in renderers", "default-value": "none", "default-meaning": "solid line" }, "rasterizer": { "css": "line-rasterizer", "type": [ "full", "fast" ], "default-value": "full", "doc": "Exposes an alternate AGG rendering method that sacrifices some accuracy for speed." } }, "markers": { "file": { "css": "marker-file", "doc": "An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse.", "default-value": "", "default-meaning": "An ellipse or circle, if width equals height", "type": "uri" }, "opacity": { "css": "marker-opacity", "doc": "The overall opacity of the marker", "default-value": 1, "default-meaning": "opaque", "type": "float" }, "stroke": { "css": "marker-line-color", "doc": "The color of the stroke around a marker shape.", "default-value": "black", "type": "color" }, "stroke-width": { "css": "marker-line-width", "default-value": 0.5, "doc": "The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself.", "type": "float" }, "stroke-opacity": { "css": "marker-line-opacity", "default-value": 1, "default-meaning": "opaque", "doc": "The opacity of a line", "type": "float" }, "placement": { "css": "marker-placement", "type": [ "point", "line" ], "doc": "Attempt to place markers on a point once or on a line repeatedly", "default-value": "line" }, "marker-type": { "css": "marker-type", "type": [ "arrow", "ellipse" ], "default-value": "ellipse", "doc": "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)" }, "width": { "css": "marker-width", "default-value": 10, "doc": "The width of the marker, if using one of the default types.", "type": "float" }, "height": { "css": "marker-height", "default-value": 10, "doc": "The height of the marker, if using one of the default types.", "type": "float" }, "fill": { "css": "marker-fill", "default-value": "blue", "doc": "The color of the area of the marker.", "type": "color" }, "allow-overlap": { "css": "marker-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping markers are shown or hidden.", "default-meaning": "Do not allow makers to overlap with each other - overlapping markers will not be shown." }, "ignore-placement": { "css": "marker-ignore-placement", "type": "boolean", "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache", "doc": "value to control whether the placement of the feature will prevent the placement of other features" }, "spacing": { "css": "marker-spacing", "doc": "Space between repeated labels", "default-value": 100, "type": "float" }, "max-error": { "css": "marker-max-error", "type": "float", "default-value": 0.2, "doc": "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." }, "transform": { "css": "marker-transform", "doc": "An SVG transformation definition", "default-value": "", "default-meaning": "no transformation", "type": "string" } }, "shield": { "name": { "css": "shield-name", "type": "string", "required": true, "serialization": "content", "default-value": "", "doc": "Value to use for a shield\"s text label. Data columns are specified using brackets like [column_name]" }, "face-name": { "css": "shield-face-name", "type": "string", "validate": "font", "doc": "Font name and style to use for the shield text", "default-value": "", "required": true }, "unlock-image": { "css": "shield-unlock-image", "type": "boolean", "doc": "This parameter should be set to true if you are trying to position text beside rather than on top of the shield image", "default-value": false, "default-meaning": "text alignment relative to the shield image uses the center of the image as the anchor for text positioning." }, "size": { "css": "shield-size", "type": "float", "default-value": 10, "doc": "The size of the shield text in pixels" }, "fill": { "css": "shield-fill", "type": "color", "default-value": "black", "doc": "The color of the shield text" }, "placement": { "css": "shield-placement", "type": [ "point", "line", "vertex", "interior" ], "default-value": "point", "doc": "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." }, "avoid-edges": { "css": "shield-avoid-edges", "doc": "Tell positioning algorithm to avoid labeling near intersection edges.", "type": "boolean", "default-value": false }, "minimum-distance": { "css": "shield-min-distance", "type": "float", "default-value": 0, "doc": "Minimum distance to the next shield symbol, not necessarily the same shield." }, "spacing": { "css": "shield-spacing", "type": "float", "default-value": 0, "doc": "The spacing between repeated occurrences of the same shield on a line" }, "minimum-padding": { "css": "shield-min-padding", "default-value": 0, "doc": "Determines the minimum amount of padding that a shield gets relative to other shields", "type": "float" }, "wrap-width": { "css": "shield-wrap-width", "type": "float", "default-value": 0, "doc": "Length before wrapping long names." }, "wrap-character": { "css": "shield-wrap-character", "type": "string", "default-value": " ", "doc": "Use this character instead of a space to wrap long names." }, "halo-fill": { "css": "shield-halo-fill", "type": "color", "default-value": "#FFFFFF", "default-meaning": "white", "doc": "Specifies the color of the halo around the text." }, "halo-radius": { "css": "shield-halo-radius", "doc": "Specify the radius of the halo in pixels", "default-value": 0, "default-meaning": "no halo", "type": "float" }, "character-spacing": { "css": "shield-character-spacing", "type": "float", "default-value": 0, "doc": "Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement." }, "line-spacing": { "css": "shield-line-spacing", "default-value": 0, "doc": "Vertical spacing between lines of multiline labels (in pixels)", "type": "float" }, "file": { "css": "shield-file", "type": "uri", "default-value": "none", "doc": "Image file to render behind the shield text" }, "dx": { "css": "shield-text-dx", "type": "float", "doc": "Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right", "default-value": 0 }, "dy": { "css": "shield-text-dy", "type": "float", "doc": "Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down", "default-value": 0 }, "shield-dx": { "css": "shield-dx", "type": "float", "doc": "Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right", "default-value": 0 }, "shield-dy": { "css": "shield-dy", "type": "float", "doc": "Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down", "default-value": 0 }, "opacity": { "css": "shield-opacity", "type": "float", "doc": "(Default 1.0) - opacity of the image used for the shield", "default-value": 1 }, "text-opacity": { "css": "shield-text-opacity", "type": "float", "doc": "(Default 1.0) - opacity of the text placed on top of the shield", "default-value": 1 }, "horizontal-alignment": { "css": "shield-horizontal-alignment", "type": [ "left", "middle", "right", "auto" ], "doc": "The shield's horizontal alignment from its centerpoint", "default-value": "middle" }, "text-transform": { "css": "shield-text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize" ], "doc": "Transform the case of the characters", "default-value": "none" }, "no-text": { "css": "shield-no-text", "type": "boolean", "doc": "Whether the shield should make room for a text label.", "default-value": "false" }, "justify-alignment": { "css": "shield-justify-alignment", "type": "string", "doc": "Define how text in a shield's label is justified", "default-value": "middle" } }, "line-pattern": { "file": { "css": "line-pattern-file", "type": "uri", "default-value": "none", "required": true, "doc": "An image file to be repeated and warped along a line" } }, "polygon-pattern": { "file": { "css": "polygon-pattern-file", "type": "uri", "default-value": "none", "required": true, "doc": "Image to use as a repeated pattern fill within a polygon" }, "alignment": { "css": "polygon-pattern-alignment", "type": ["local","global"], "default-value": "local", "doc": "Specify whether to align pattern fills to the layer or to the map." }, "gamma": { "css": "polygon-pattern-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of polygon pattern edges" } }, "raster": { "opacity": { "css": "raster-opacity", "default-value": 1, "default-meaning": "opaque", "type": "float", "doc": "The opacity of the raster symbolizer on top of other symbolizers." }, "mode": { "css": "raster-mode", "default-value": "normal", "type": [ "normal", "grain_merge", "grain_merge2", "multiply", "multiply2", "divide", "divide2", "screen", "hard_light" ], "doc": "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." }, "filter-factor": { "css": "raster-filter-factor", "default-value": -1, "default-meaning": "Allow the datasource to choose appropriate downscaling.", "type": "float", "doc": "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." }, "scaling": { "css": "raster-scaling", "type": [ "fast", "bilinear", "bilinear8", "bicubic", "spline16", "gaussian", "lanczos" ], "default-value": "fast", "doc": "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." }, "mesh-size": { "css": "raster-mesh-size", "default-value": 16, "default-meaning": "Reprojection mesh will be 1/16 of the resolution of the source image", "type": "integer", "doc": "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": { "file": { "css": "point-file", "type": "uri", "required": false, "default-value": "none", "doc": "Image file to represent a point" }, "allow-overlap": { "css": "point-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping points are shown or hidden.", "default-meaning": "Do not allow points to overlap with each other - overlapping markers will not be shown." }, "ignore-placement": { "css": "point-ignore-placement", "type": "boolean", "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache", "doc": "value to control whether the placement of the feature will prevent the placement of other features" }, "opacity": { "css": "point-opacity", "type": "float", "default-value": 1.0, "default-meaning": "Fully opaque", "doc": "A value from 0 to 1 to control the opacity of the point" }, "placement": { "css": "point-placement", "type": [ "centroid", "interior" ], "doc": "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.", "default-value": "centroid" }, "transform": { "css": "point-transform", "type": "string", "default-value": "", "default-meaning": "No transformation", "doc": "SVG transformation definition" } }, "text": { "name": { "css": "text-name", "type": "string", "required": true, "default-value": "", "serialization": "content", "doc": "Value to use for a text label. Data columns are specified using brackets like [column_name]" }, "face-name": { "css": "text-face-name", "type": "string", "validate": "font", "default-value": "", "doc": "Font name and style to render a label in", "required": true }, "size": { "css": "text-size", "type": "float", "default-value": 10, "doc": "Text size in pixels" }, "text-ratio": { "css": "text-ratio", "doc": "Define the amount of text (of the total) present on successive lines when wrapping occurs", "default-value": 0, "type": "float" }, "wrap-width": { "css": "text-wrap-width", "doc": "Length of a chunk of text in characters before wrapping text", "default-value": 0, "type": "float" }, "wrap-character": { "css": "text-wrap-character", "type": "string", "default-value": " ", "doc": "Use this character instead of a space to wrap long text." }, "spacing": { "css": "text-spacing", "type": "float", "default-value": 0, "doc": "Distance between repeated text labels on a line" }, "character-spacing": { "css": "text-character-spacing", "type": "float", "default-value": 0, "doc": "Horizontal spacing adjustment between characters in pixels" }, "line-spacing": { "css": "text-line-spacing", "default-value": 0, "type": "float", "doc": "Vertical spacing adjustment between lines in pixels" }, "label-position-tolerance": { "css": "text-label-position-tolerance", "default-value": 0, "type": "float", "doc": "Allows the label to be displaced from its ideal position by a number of pixels" }, "max-char-angle-delta": { "css": "text-max-char-angle-delta", "type": "float", "default-value": "none", "doc": "If present, the maximum angle change, in degrees, allowed between adjacent characters in a label. This will stop label placement around sharp corners." }, "fill": { "css": "text-fill", "doc": "Specifies the color for the text", "default-value": "#000000", "type": "color" }, "opacity": { "css": "text-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text", "default-value": 1.0, "default-meaning": "Fully opaque", "type": "float" }, "halo-fill": { "css": "text-halo-fill", "type": "color", "default-value": "#FFFFFF", "default-meaning": "white", "doc": "Specifies the color of the halo around the text." }, "halo-radius": { "css": "text-halo-radius", "doc": "Specify the radius of the halo in pixels", "default-value": 0, "default-meaning": "no halo", "type": "float" }, "dx": { "css": "text-dx", "type": "float", "doc": "Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right", "default-value": 0 }, "dy": { "css": "text-dy", "type": "float", "doc": "Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down", "default-value": 0 }, "vertical-alignment": { "css": "text-vertical-alignment", "type": [ "top", "middle", "bottom" ], "doc": "Position of label relative to point position.", "default-value": "middle", "default-meaning": "Default affected by value of dy; \"bottom\" for dy>0, \"top\" for dy<0." }, "avoid-edges": { "css": "text-avoid-edges", "doc": "Tell positioning algorithm to avoid labeling near intersection edges.", "default-value": false, "type": "boolean" }, "minimum-distance": { "css": "text-min-distance", "doc": "Minimum permitted distance to the next text symbolizer.", "default-value": 0, "type": "float" }, "minimum-padding": { "css": "text-min-padding", "doc": "Determines the minimum amount of padding that a text symbolizer gets relative to other text", "default-value": 0, "type": "float" }, "minimum-path-length": { "css": "text-min-path-length", "type": "float", "default-value": 0, "default-meaning": "place labels on all paths", "doc": "Place labels only on paths longer than this value." }, "allow-overlap": { "css": "text-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping text is shown or hidden.", "default-meaning": "Do not allow text to overlap with other text - overlapping markers will not be shown." }, "orientation": { "css": "text-orientation", "type": "float", "default-value": 0, "doc": "Rotate the text." }, "placement": { "css": "text-placement", "type": [ "point", "line", "vertex", "interior" ], "default-value": "point", "doc": "Control the style of placement of a point versus the geometry it is attached to." }, "placement-type": { "css": "text-placement-type", "doc": "Re-position and/or re-size text to avoid overlaps. \"simple\" for basic algorithm (using text-placements string,) \"dummy\" to turn this feature off.", "type": [ "dummy", "simple" ], "default-value": "dummy" }, "placements": { "css": "text-placements", "type": "string", "default-value": "", "doc": "If \"placement-type\" is set to \"simple\", use this \"POSITIONS,[SIZES]\" string. See TextSymbolizer docs for format." }, "text-transform": { "css": "text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize" ], "doc": "Transform the case of the characters", "default-value": "none" }, "horizontal-alignment": { "css": "text-horizontal-alignment", "type": [ "left", "middle", "right", "auto" ], "doc": "The text's horizontal alignment from its centerpoint", "default-value": "middle" }, "justify-alignment": { "css": "text-align", "type": [ "left", "right", "center" ], "doc": "Set the text alignment.", "default-value": "center" } }, "building": { "fill": { "css": "building-fill", "default-value": "#FFFFFF", "doc": "The color of the buildings walls.", "type": "color" }, "fill-opacity": { "css": "building-fill-opacity", "type": "float", "doc": "The opacity of the building as a whole, including all walls.", "default-value": 1 }, "height": { "css": "building-height", "doc": "The height of the building in pixels.", "type": "float", "default-value": 0 } } }, "colors": { "aliceblue": [240, 248, 255], "antiquewhite": [250, 235, 215], "aqua": [0, 255, 255], "aquamarine": [127, 255, 212], "azure": [240, 255, 255], "beige": [245, 245, 220], "bisque": [255, 228, 196], "black": [0, 0, 0], "blanchedalmond": [255,235,205], "blue": [0, 0, 255], "blueviolet": [138, 43, 226], "brown": [165, 42, 42], "burlywood": [222, 184, 135], "cadetblue": [95, 158, 160], "chartreuse": [127, 255, 0], "chocolate": [210, 105, 30], "coral": [255, 127, 80], "cornflowerblue": [100, 149, 237], "cornsilk": [255, 248, 220], "crimson": [220, 20, 60], "cyan": [0, 255, 255], "darkblue": [0, 0, 139], "darkcyan": [0, 139, 139], "darkgoldenrod": [184, 134, 11], "darkgray": [169, 169, 169], "darkgreen": [0, 100, 0], "darkgrey": [169, 169, 169], "darkkhaki": [189, 183, 107], "darkmagenta": [139, 0, 139], "darkolivegreen": [85, 107, 47], "darkorange": [255, 140, 0], "darkorchid": [153, 50, 204], "darkred": [139, 0, 0], "darksalmon": [233, 150, 122], "darkseagreen": [143, 188, 143], "darkslateblue": [72, 61, 139], "darkslategrey": [47, 79, 79], "darkturquoise": [0, 206, 209], "darkviolet": [148, 0, 211], "deeppink": [255, 20, 147], "deepskyblue": [0, 191, 255], "dimgray": [105, 105, 105], "dimgrey": [105, 105, 105], "dodgerblue": [30, 144, 255], "firebrick": [178, 34, 34], "floralwhite": [255, 250, 240], "forestgreen": [34, 139, 34], "fuchsia": [255, 0, 255], "gainsboro": [220, 220, 220], "ghostwhite": [248, 248, 255], "gold": [255, 215, 0], "goldenrod": [218, 165, 32], "gray": [128, 128, 128], "grey": [128, 128, 128], "green": [0, 128, 0], "greenyellow": [173, 255, 47], "honeydew": [240, 255, 240], "hotpink": [255, 105, 180], "indianred": [205, 92, 92], "indigo": [75, 0, 130], "ivory": [255, 255, 240], "khaki": [240, 230, 140], "lavender": [230, 230, 250], "lavenderblush": [255, 240, 245], "lawngreen": [124, 252, 0], "lemonchiffon": [255, 250, 205], "lightblue": [173, 216, 230], "lightcoral": [240, 128, 128], "lightcyan": [224, 255, 255], "lightgoldenrodyellow": [250, 250, 210], "lightgray": [211, 211, 211], "lightgreen": [144, 238, 144], "lightgrey": [211, 211, 211], "lightpink": [255, 182, 193], "lightsalmon": [255, 160, 122], "lightseagreen": [32, 178, 170], "lightskyblue": [135, 206, 250], "lightslategray": [119, 136, 153], "lightslategrey": [119, 136, 153], "lightsteelblue": [176, 196, 222], "lightyellow": [255, 255, 224], "lime": [0, 255, 0], "limegreen": [50, 205, 50], "linen": [250, 240, 230], "magenta": [255, 0, 255], "maroon": [128, 0, 0], "mediumaquamarine": [102, 205, 170], "mediumblue": [0, 0, 205], "mediumorchid": [186, 85, 211], "mediumpurple": [147, 112, 219], "mediumseagreen": [60, 179, 113], "mediumslateblue": [123, 104, 238], "mediumspringgreen": [0, 250, 154], "mediumturquoise": [72, 209, 204], "mediumvioletred": [199, 21, 133], "midnightblue": [25, 25, 112], "mintcream": [245, 255, 250], "mistyrose": [255, 228, 225], "moccasin": [255, 228, 181], "navajowhite": [255, 222, 173], "navy": [0, 0, 128], "oldlace": [253, 245, 230], "olive": [128, 128, 0], "olivedrab": [107, 142, 35], "orange": [255, 165, 0], "orangered": [255, 69, 0], "orchid": [218, 112, 214], "palegoldenrod": [238, 232, 170], "palegreen": [152, 251, 152], "paleturquoise": [175, 238, 238], "palevioletred": [219, 112, 147], "papayawhip": [255, 239, 213], "peachpuff": [255, 218, 185], "peru": [205, 133, 63], "pink": [255, 192, 203], "plum": [221, 160, 221], "powderblue": [176, 224, 230], "purple": [128, 0, 128], "red": [255, 0, 0], "rosybrown": [188, 143, 143], "royalblue": [65, 105, 225], "saddlebrown": [139, 69, 19], "salmon": [250, 128, 114], "sandybrown": [244, 164, 96], "seagreen": [46, 139, 87], "seashell": [255, 245, 238], "sienna": [160, 82, 45], "silver": [192, 192, 192], "skyblue": [135, 206, 235], "slateblue": [106, 90, 205], "slategray": [112, 128, 144], "slategrey": [112, 128, 144], "snow": [255, 250, 250], "springgreen": [0, 255, 127], "steelblue": [70, 130, 180], "tan": [210, 180, 140], "teal": [0, 128, 128], "thistle": [216, 191, 216], "tomato": [255, 99, 71], "turquoise": [64, 224, 208], "violet": [238, 130, 238], "wheat": [245, 222, 179], "white": [255, 255, 255], "whitesmoke": [245, 245, 245], "yellow": [255, 255, 0], "yellowgreen": [154, 205, 50], "transparent": [0, 0, 0, 0] }, "filter": { "value": [ "true", "false", "null" ] } } mapnik-reference-8.10.0/2.0.2/000077500000000000000000000000001342311331100154425ustar00rootroot00000000000000mapnik-reference-8.10.0/2.0.2/reference.json000066400000000000000000001311061342311331100202750ustar00rootroot00000000000000{ "version": "2.0.2", "style": { "filter-mode": { "type": [ "all", "first" ], "doc": "Control the processing behavior of Rule filters within a Style. If 'all' is used then all Rules are processed sequentially independent of whether any previous filters matched. If 'first' is used then it means processing ends after the first match (a positive filter evaluation) and no further Rules in the Style are processed ('first' is usually the default for CSS implementations on top of Mapnik to simplify translation from CSS to Mapnik XML)", "default-value": "all", "default-meaning": "All Rules in a Style are processed whether they have filters or not and whether or not the filter conditions evaluate to true." } }, "layer" : { "name": { "default-value": "", "type":"string", "required" : true, "default-meaning": "No layer name has been provided", "doc": "The name of a layer. Can be anything you wish and is not strictly validated, but ideally unique in the map" }, "srs": { "default-value": "", "type":"string", "default-meaning": "No srs value is provided and the value will be inherited from the Map's srs", "doc": "The spatial reference system definition for the layer, aka the projection. Can either be a proj4 literal string like '+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs' or, if the proper proj4 epsg/nad/etc identifier files are installed, a string that uses an id like: '+init=epsg:4326'" }, "status": { "default-value": true, "type":"boolean", "default-meaning": "This layer will be marked as active and available for processing", "doc": "A property that can be set to false to disable this layer from being processed" }, "minzoom": { "default-value": 0, "type":"float", "default-meaning": "The layer will be visible at the minimum possible scale", "doc": "The minimum scale denominator that this layer will be visible at. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6" }, "maxzoom": { "default-value": "1.79769e+308", "type":"float", "default-meaning": "The layer will be visible at the maximum possible scale", "doc": "The maximum scale denominator that this layer will be visible at. The default is the numeric limit of the C++ double type, which may vary slightly by system, but is likely a massive number like 1.79769e+308 and ensures that this layer will always be visible unless the value is reduced. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6" }, "queryable": { "default-value": false, "type":"boolean", "default-meaning": "The layer will not be available for the direct querying of data values", "doc": "This property was added for GetFeatureInfo/WMS compatibility and is rarely used. It is off by default meaning that in a WMS context the layer will not be able to be queried unless the property is explicitly set to true" }, "clear-label-cache": { "default-value": false, "type":"boolean", "default-meaning": "The renderer's collision detector cache (used for avoiding duplicate labels and overlapping markers) will not be cleared immediately before processing this layer", "doc": "This property, by default off, can be enabled to allow a user to clear the collision detector cache before a given layer is processed. This may be desirable to ensure that a given layers data shows up on the map even if it normally would not because of collisions with previously rendered labels or markers" } }, "symbolizers" : { "map": { "background-color": { "css": "background-color", "default-value": "none", "default-meaning": "transparent", "type": "color", "doc": "Map Background color" }, "background-image": { "css": "background-image", "type": "uri", "default-value": "", "default-meaning": "transparent", "doc": "An image that is repeated below all features on a map as a background.", "description": "Map Background image" }, "srs": { "css": "srs", "type": "string", "default-value": "+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs", "default-meaning": "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", "doc": "Map spatial reference (proj4 string)" }, "buffer-size": { "css": "buffer-size", "default-value": 0, "type":"float", "default-meaning": "No buffer will be used", "doc": "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": { "css": "", "default-value": "none", "type":"bbox", "default-meaning": "No clipping extent will be used", "doc": "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": { "css": "base", "default-value": "", "default-meaning": "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.", "type": "string", "doc": "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." }, "paths-from-xml": { "css": "", "default-value": true, "default-meaning": "Paths read from XML will be interpreted from the location of the XML", "type": "boolean", "doc": "value to control whether paths in the XML will be interpreted from the location of the XML or from the working directory of the program that calls load_map()" }, "minimum-version": { "css": "", "default-value": "none", "default-meaning": "Mapnik version will not be detected and no error will be thrown about compatibility", "type": "string", "doc": "The minumum Mapnik version (e.g. 0.7.2) needed to use certain functionality in the stylesheet" }, "font-directory": { "css": "font-directory", "type": "uri", "default-value": "none", "default-meaning": "No map-specific fonts will be registered", "doc": "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": { "fill": { "css": "polygon-fill", "type": "color", "default-value": "rgba(128,128,128,1)", "default-meaning": "gray and fully opaque (alpha = 1), same as rgb(128,128,128)", "doc": "Fill color to assign to a polygon" }, "gamma": { "css": "polygon-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of polygon edges" }, "fill-opacity": { "css": "polygon-opacity", "type": "float", "doc": "The opacity of the polygon", "default-value": 1, "default-meaning": "opaque" }, "smooth": { "css": "polygon-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Amount of smoothing applied" } }, "line": { "stroke": { "css": "line-color", "default-value": "rgba(0,0,0,1)", "type": "color", "default-meaning": "black and fully opaque (alpha = 1), same as rgb(0,0,0)", "doc": "The color of a drawn line" }, "stroke-width": { "css": "line-width", "default-value": 1, "type": "float", "doc": "The width of a line in pixels" }, "stroke-opacity": { "css": "line-opacity", "default-value": 1, "type": "float", "default-meaning": "opaque", "doc": "The opacity of a line" }, "stroke-linejoin": { "css": "line-join", "default-value": "miter", "type": [ "miter", "round", "bevel" ], "doc": "The behavior of lines when joining" }, "stroke-linecap": { "css": "line-cap", "default-value": "butt", "type": [ "butt", "round", "square" ], "doc": "The display of line endings" }, "stroke-gamma": { "css": "line-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of stroke line" }, "stroke-dasharray": { "css": "line-dasharray", "type": "numbers", "doc": "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.", "default-value": "none", "default-meaning": "solid line" }, "stroke-dashoffset": { "css": "line-dash-offset", "type": "numbers", "doc": "valid parameter but not currently used in renderers", "default-value": "none", "default-meaning": "solid line" }, "rasterizer": { "css": "line-rasterizer", "type": [ "full", "fast" ], "default-value": "full", "doc": "Exposes an alternate AGG rendering method that sacrifices some accuracy for speed." } }, "markers": { "file": { "css": "marker-file", "doc": "An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse.", "default-value": "", "default-meaning": "An ellipse or circle, if width equals height", "type": "uri" }, "opacity": { "css": "marker-opacity", "doc": "The overall opacity of the marker", "default-value": 1, "default-meaning": "opaque", "type": "float" }, "stroke": { "css": "marker-line-color", "doc": "The color of the stroke around a marker shape.", "default-value": "black", "type": "color" }, "stroke-width": { "css": "marker-line-width", "default-value": 0.5, "doc": "The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself.", "type": "float" }, "stroke-opacity": { "css": "marker-line-opacity", "default-value": 1, "default-meaning": "opaque", "doc": "The opacity of a line", "type": "float" }, "placement": { "css": "marker-placement", "type": [ "point", "line" ], "doc": "Attempt to place markers on a point once or on a line repeatedly", "default-value": "line" }, "marker-type": { "css": "marker-type", "type": [ "arrow", "ellipse" ], "default-value": "ellipse", "doc": "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)" }, "width": { "css": "marker-width", "default-value": 10, "doc": "The width of the marker, if using one of the default types.", "type": "float" }, "height": { "css": "marker-height", "default-value": 10, "doc": "The height of the marker, if using one of the default types.", "type": "float" }, "fill": { "css": "marker-fill", "default-value": "blue", "doc": "The color of the area of the marker.", "type": "color" }, "allow-overlap": { "css": "marker-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping markers are shown or hidden.", "default-meaning": "Do not allow makers to overlap with each other - overlapping markers will not be shown." }, "ignore-placement": { "css": "marker-ignore-placement", "type": "boolean", "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache", "doc": "value to control whether the placement of the feature will prevent the placement of other features" }, "spacing": { "css": "marker-spacing", "doc": "Space between repeated labels", "default-value": 100, "type": "float" }, "max-error": { "css": "marker-max-error", "type": "float", "default-value": 0.2, "doc": "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." }, "transform": { "css": "marker-transform", "doc": "An SVG transformation definition", "default-value": "", "default-meaning": "no transformation", "type": "string" } }, "shield": { "name": { "css": "shield-name", "type": "string", "required": true, "serialization": "content", "default-value": "", "doc": "Value to use for a shield\"s text label. Data columns are specified using brackets like [column_name]" }, "face-name": { "css": "shield-face-name", "type": "string", "validate": "font", "doc": "Font name and style to use for the shield text", "default-value": "", "required": true }, "unlock-image": { "css": "shield-unlock-image", "type": "boolean", "doc": "This parameter should be set to true if you are trying to position text beside rather than on top of the shield image", "default-value": false, "default-meaning": "text alignment relative to the shield image uses the center of the image as the anchor for text positioning." }, "size": { "css": "shield-size", "type": "float", "default-value": 10, "doc": "The size of the shield text in pixels" }, "fill": { "css": "shield-fill", "type": "color", "default-value": "black", "doc": "The color of the shield text" }, "placement": { "css": "shield-placement", "type": [ "point", "line", "vertex", "interior" ], "default-value": "point", "doc": "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." }, "avoid-edges": { "css": "shield-avoid-edges", "doc": "Tell positioning algorithm to avoid labeling near intersection edges.", "type": "boolean", "default-value": false }, "minimum-distance": { "css": "shield-min-distance", "type": "float", "default-value": 0, "doc": "Minimum distance to the next shield symbol, not necessarily the same shield." }, "spacing": { "css": "shield-spacing", "type": "float", "default-value": 0, "doc": "The spacing between repeated occurrences of the same shield on a line" }, "minimum-padding": { "css": "shield-min-padding", "default-value": 0, "doc": "Determines the minimum amount of padding that a shield gets relative to other shields", "type": "float" }, "wrap-width": { "css": "shield-wrap-width", "type": "float", "default-value": 0, "doc": "Length before wrapping long names." }, "wrap-character": { "css": "shield-wrap-character", "type": "string", "default-value": " ", "doc": "Use this character instead of a space to wrap long names." }, "halo-fill": { "css": "shield-halo-fill", "type": "color", "default-value": "#FFFFFF", "default-meaning": "white", "doc": "Specifies the color of the halo around the text." }, "halo-radius": { "css": "shield-halo-radius", "doc": "Specify the radius of the halo in pixels", "default-value": 0, "default-meaning": "no halo", "type": "float" }, "character-spacing": { "css": "shield-character-spacing", "type": "float", "default-value": 0, "doc": "Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement." }, "line-spacing": { "css": "shield-line-spacing", "default-value": 0, "doc": "Vertical spacing between lines of multiline labels (in pixels)", "type": "float" }, "file": { "css": "shield-file", "type": "uri", "default-value": "none", "doc": "Image file to render behind the shield text" }, "dx": { "css": "shield-text-dx", "type": "float", "doc": "Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right", "default-value": 0 }, "dy": { "css": "shield-text-dy", "type": "float", "doc": "Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down", "default-value": 0 }, "shield-dx": { "css": "shield-dx", "type": "float", "doc": "Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right", "default-value": 0 }, "shield-dy": { "css": "shield-dy", "type": "float", "doc": "Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down", "default-value": 0 }, "opacity": { "css": "shield-opacity", "type": "float", "doc": "(Default 1.0) - opacity of the image used for the shield", "default-value": 1 }, "text-opacity": { "css": "shield-text-opacity", "type": "float", "doc": "(Default 1.0) - opacity of the text placed on top of the shield", "default-value": 1 }, "horizontal-alignment": { "css": "shield-horizontal-alignment", "type": [ "left", "middle", "right", "auto" ], "doc": "The shield's horizontal alignment from its centerpoint", "default-value": "middle" }, "text-transform": { "css": "shield-text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize" ], "doc": "Transform the case of the characters", "default-value": "none" }, "no-text": { "css": "shield-no-text", "type": "boolean", "doc": "Whether the shield should make room for a text label.", "default-value": "false" }, "justify-alignment": { "css": "shield-justify-alignment", "type": "string", "doc": "Define how text in a shield's label is justified", "default-value": "middle" } }, "line-pattern": { "file": { "css": "line-pattern-file", "type": "uri", "default-value": "none", "required": true, "doc": "An image file to be repeated and warped along a line" } }, "polygon-pattern": { "file": { "css": "polygon-pattern-file", "type": "uri", "default-value": "none", "required": true, "doc": "Image to use as a repeated pattern fill within a polygon" }, "alignment": { "css": "polygon-pattern-alignment", "type": ["local","global"], "default-value": "local", "doc": "Specify whether to align pattern fills to the layer or to the map." }, "gamma": { "css": "polygon-pattern-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of polygon pattern edges" } }, "raster": { "opacity": { "css": "raster-opacity", "default-value": 1, "default-meaning": "opaque", "type": "float", "doc": "The opacity of the raster symbolizer on top of other symbolizers." }, "mode": { "css": "raster-mode", "default-value": "normal", "type": [ "normal", "grain_merge", "grain_merge2", "multiply", "multiply2", "divide", "divide2", "screen", "hard_light" ], "doc": "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." }, "filter-factor": { "css": "raster-filter-factor", "default-value": -1, "default-meaning": "Allow the datasource to choose appropriate downscaling.", "type": "float", "doc": "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." }, "scaling": { "css": "raster-scaling", "type": [ "fast", "bilinear", "bilinear8", "bicubic", "spline16", "gaussian", "lanczos" ], "default-value": "fast", "doc": "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." }, "mesh-size": { "css": "raster-mesh-size", "default-value": 16, "default-meaning": "Reprojection mesh will be 1/16 of the resolution of the source image", "type": "integer", "doc": "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": { "file": { "css": "point-file", "type": "uri", "required": false, "default-value": "none", "doc": "Image file to represent a point" }, "allow-overlap": { "css": "point-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping points are shown or hidden.", "default-meaning": "Do not allow points to overlap with each other - overlapping markers will not be shown." }, "ignore-placement": { "css": "point-ignore-placement", "type": "boolean", "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache", "doc": "value to control whether the placement of the feature will prevent the placement of other features" }, "opacity": { "css": "point-opacity", "type": "float", "default-value": 1.0, "default-meaning": "Fully opaque", "doc": "A value from 0 to 1 to control the opacity of the point" }, "placement": { "css": "point-placement", "type": [ "centroid", "interior" ], "doc": "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.", "default-value": "centroid" }, "transform": { "css": "point-transform", "type": "string", "default-value": "", "default-meaning": "No transformation", "doc": "SVG transformation definition" } }, "text": { "name": { "css": "text-name", "type": "string", "required": true, "default-value": "", "serialization": "content", "doc": "Value to use for a text label. Data columns are specified using brackets like [column_name]" }, "face-name": { "css": "text-face-name", "type": "string", "validate": "font", "default-value": "", "doc": "Font name and style to render a label in", "required": true }, "size": { "css": "text-size", "type": "float", "default-value": 10, "doc": "Text size in pixels" }, "text-ratio": { "css": "text-ratio", "doc": "Define the amount of text (of the total) present on successive lines when wrapping occurs", "default-value": 0, "type": "float" }, "wrap-width": { "css": "text-wrap-width", "doc": "Length of a chunk of text in characters before wrapping text", "default-value": 0, "type": "float" }, "wrap-character": { "css": "text-wrap-character", "type": "string", "default-value": " ", "doc": "Use this character instead of a space to wrap long text." }, "spacing": { "css": "text-spacing", "type": "float", "default-value": 0, "doc": "Distance between repeated text labels on a line" }, "character-spacing": { "css": "text-character-spacing", "type": "float", "default-value": 0, "doc": "Horizontal spacing adjustment between characters in pixels" }, "line-spacing": { "css": "text-line-spacing", "default-value": 0, "type": "float", "doc": "Vertical spacing adjustment between lines in pixels" }, "label-position-tolerance": { "css": "text-label-position-tolerance", "default-value": 0, "type": "float", "doc": "Allows the label to be displaced from its ideal position by a number of pixels" }, "max-char-angle-delta": { "css": "text-max-char-angle-delta", "type": "float", "default-value": "none", "doc": "If present, the maximum angle change, in degrees, allowed between adjacent characters in a label. This will stop label placement around sharp corners." }, "fill": { "css": "text-fill", "doc": "Specifies the color for the text", "default-value": "#000000", "type": "color" }, "opacity": { "css": "text-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text", "default-value": 1.0, "default-meaning": "Fully opaque", "type": "float" }, "halo-fill": { "css": "text-halo-fill", "type": "color", "default-value": "#FFFFFF", "default-meaning": "white", "doc": "Specifies the color of the halo around the text." }, "halo-radius": { "css": "text-halo-radius", "doc": "Specify the radius of the halo in pixels", "default-value": 0, "default-meaning": "no halo", "type": "float" }, "dx": { "css": "text-dx", "type": "float", "doc": "Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right", "default-value": 0 }, "dy": { "css": "text-dy", "type": "float", "doc": "Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down", "default-value": 0 }, "vertical-alignment": { "css": "text-vertical-alignment", "type": [ "top", "middle", "bottom" ], "doc": "Position of label relative to point position.", "default-value": "middle", "default-meaning": "Default affected by value of dy; \"bottom\" for dy>0, \"top\" for dy<0." }, "avoid-edges": { "css": "text-avoid-edges", "doc": "Tell positioning algorithm to avoid labeling near intersection edges.", "default-value": false, "type": "boolean" }, "minimum-distance": { "css": "text-min-distance", "doc": "Minimum permitted distance to the next text symbolizer.", "default-value": 0, "type": "float" }, "minimum-padding": { "css": "text-min-padding", "doc": "Determines the minimum amount of padding that a text symbolizer gets relative to other text", "default-value": 0, "type": "float" }, "minimum-path-length": { "css": "text-min-path-length", "type": "float", "default-value": 0, "default-meaning": "place labels on all paths", "doc": "Place labels only on paths longer than this value." }, "allow-overlap": { "css": "text-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping text is shown or hidden.", "default-meaning": "Do not allow text to overlap with other text - overlapping markers will not be shown." }, "orientation": { "css": "text-orientation", "type": "float", "default-value": 0, "doc": "Rotate the text." }, "placement": { "css": "text-placement", "type": [ "point", "line", "vertex", "interior" ], "default-value": "point", "doc": "Control the style of placement of a point versus the geometry it is attached to." }, "placement-type": { "css": "text-placement-type", "doc": "Re-position and/or re-size text to avoid overlaps. \"simple\" for basic algorithm (using text-placements string,) \"dummy\" to turn this feature off.", "type": [ "dummy", "simple" ], "default-value": "dummy" }, "placements": { "css": "text-placements", "type": "string", "default-value": "", "doc": "If \"placement-type\" is set to \"simple\", use this \"POSITIONS,[SIZES]\" string. See TextSymbolizer docs for format." }, "text-transform": { "css": "text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize" ], "doc": "Transform the case of the characters", "default-value": "none" }, "horizontal-alignment": { "css": "text-horizontal-alignment", "type": [ "left", "middle", "right", "auto" ], "doc": "The text's horizontal alignment from its centerpoint", "default-value": "middle" }, "justify-alignment": { "css": "text-align", "type": [ "left", "right", "center" ], "doc": "Set the text alignment.", "default-value": "center" } }, "building": { "fill": { "css": "building-fill", "default-value": "#FFFFFF", "doc": "The color of the buildings walls.", "type": "color" }, "fill-opacity": { "css": "building-fill-opacity", "type": "float", "doc": "The opacity of the building as a whole, including all walls.", "default-value": 1 }, "height": { "css": "building-height", "doc": "The height of the building in pixels.", "type": "float", "default-value": 0 } } }, "colors": { "aliceblue": [240, 248, 255], "antiquewhite": [250, 235, 215], "aqua": [0, 255, 255], "aquamarine": [127, 255, 212], "azure": [240, 255, 255], "beige": [245, 245, 220], "bisque": [255, 228, 196], "black": [0, 0, 0], "blanchedalmond": [255,235,205], "blue": [0, 0, 255], "blueviolet": [138, 43, 226], "brown": [165, 42, 42], "burlywood": [222, 184, 135], "cadetblue": [95, 158, 160], "chartreuse": [127, 255, 0], "chocolate": [210, 105, 30], "coral": [255, 127, 80], "cornflowerblue": [100, 149, 237], "cornsilk": [255, 248, 220], "crimson": [220, 20, 60], "cyan": [0, 255, 255], "darkblue": [0, 0, 139], "darkcyan": [0, 139, 139], "darkgoldenrod": [184, 134, 11], "darkgray": [169, 169, 169], "darkgreen": [0, 100, 0], "darkgrey": [169, 169, 169], "darkkhaki": [189, 183, 107], "darkmagenta": [139, 0, 139], "darkolivegreen": [85, 107, 47], "darkorange": [255, 140, 0], "darkorchid": [153, 50, 204], "darkred": [139, 0, 0], "darksalmon": [233, 150, 122], "darkseagreen": [143, 188, 143], "darkslateblue": [72, 61, 139], "darkslategrey": [47, 79, 79], "darkturquoise": [0, 206, 209], "darkviolet": [148, 0, 211], "deeppink": [255, 20, 147], "deepskyblue": [0, 191, 255], "dimgray": [105, 105, 105], "dimgrey": [105, 105, 105], "dodgerblue": [30, 144, 255], "firebrick": [178, 34, 34], "floralwhite": [255, 250, 240], "forestgreen": [34, 139, 34], "fuchsia": [255, 0, 255], "gainsboro": [220, 220, 220], "ghostwhite": [248, 248, 255], "gold": [255, 215, 0], "goldenrod": [218, 165, 32], "gray": [128, 128, 128], "grey": [128, 128, 128], "green": [0, 128, 0], "greenyellow": [173, 255, 47], "honeydew": [240, 255, 240], "hotpink": [255, 105, 180], "indianred": [205, 92, 92], "indigo": [75, 0, 130], "ivory": [255, 255, 240], "khaki": [240, 230, 140], "lavender": [230, 230, 250], "lavenderblush": [255, 240, 245], "lawngreen": [124, 252, 0], "lemonchiffon": [255, 250, 205], "lightblue": [173, 216, 230], "lightcoral": [240, 128, 128], "lightcyan": [224, 255, 255], "lightgoldenrodyellow": [250, 250, 210], "lightgray": [211, 211, 211], "lightgreen": [144, 238, 144], "lightgrey": [211, 211, 211], "lightpink": [255, 182, 193], "lightsalmon": [255, 160, 122], "lightseagreen": [32, 178, 170], "lightskyblue": [135, 206, 250], "lightslategray": [119, 136, 153], "lightslategrey": [119, 136, 153], "lightsteelblue": [176, 196, 222], "lightyellow": [255, 255, 224], "lime": [0, 255, 0], "limegreen": [50, 205, 50], "linen": [250, 240, 230], "magenta": [255, 0, 255], "maroon": [128, 0, 0], "mediumaquamarine": [102, 205, 170], "mediumblue": [0, 0, 205], "mediumorchid": [186, 85, 211], "mediumpurple": [147, 112, 219], "mediumseagreen": [60, 179, 113], "mediumslateblue": [123, 104, 238], "mediumspringgreen": [0, 250, 154], "mediumturquoise": [72, 209, 204], "mediumvioletred": [199, 21, 133], "midnightblue": [25, 25, 112], "mintcream": [245, 255, 250], "mistyrose": [255, 228, 225], "moccasin": [255, 228, 181], "navajowhite": [255, 222, 173], "navy": [0, 0, 128], "oldlace": [253, 245, 230], "olive": [128, 128, 0], "olivedrab": [107, 142, 35], "orange": [255, 165, 0], "orangered": [255, 69, 0], "orchid": [218, 112, 214], "palegoldenrod": [238, 232, 170], "palegreen": [152, 251, 152], "paleturquoise": [175, 238, 238], "palevioletred": [219, 112, 147], "papayawhip": [255, 239, 213], "peachpuff": [255, 218, 185], "peru": [205, 133, 63], "pink": [255, 192, 203], "plum": [221, 160, 221], "powderblue": [176, 224, 230], "purple": [128, 0, 128], "red": [255, 0, 0], "rosybrown": [188, 143, 143], "royalblue": [65, 105, 225], "saddlebrown": [139, 69, 19], "salmon": [250, 128, 114], "sandybrown": [244, 164, 96], "seagreen": [46, 139, 87], "seashell": [255, 245, 238], "sienna": [160, 82, 45], "silver": [192, 192, 192], "skyblue": [135, 206, 235], "slateblue": [106, 90, 205], "slategray": [112, 128, 144], "slategrey": [112, 128, 144], "snow": [255, 250, 250], "springgreen": [0, 255, 127], "steelblue": [70, 130, 180], "tan": [210, 180, 140], "teal": [0, 128, 128], "thistle": [216, 191, 216], "tomato": [255, 99, 71], "turquoise": [64, 224, 208], "violet": [238, 130, 238], "wheat": [245, 222, 179], "white": [255, 255, 255], "whitesmoke": [245, 245, 245], "yellow": [255, 255, 0], "yellowgreen": [154, 205, 50], "transparent": [0, 0, 0, 0] }, "filter": { "value": [ "true", "false", "null" ] } } mapnik-reference-8.10.0/2.1.0/000077500000000000000000000000001342311331100154415ustar00rootroot00000000000000mapnik-reference-8.10.0/2.1.0/reference.json000066400000000000000000002234471342311331100203060ustar00rootroot00000000000000{ "version": "2.1.0", "style": { "filter-mode": { "type": [ "all", "first" ], "doc": "Control the processing behavior of Rule filters within a Style. If 'all' is used then all Rules are processed sequentially independent of whether any previous filters matched. If 'first' is used then it means processing ends after the first match (a positive filter evaluation) and no further Rules in the Style are processed ('first' is usually the default for CSS implementations on top of Mapnik to simplify translation from CSS to Mapnik XML)", "default-value": "all", "default-meaning": "All Rules in a Style are processed whether they have filters or not and whether or not the filter conditions evaluate to true." }, "image-filters": { "css": "image-filters", "default-value": "none", "default-meaning": "no filters", "type": "functions", "functions": [ ["agg-stack-blur", 2], ["emboss", 0], ["blur", 0], ["gray", 0], ["sobel", 0], ["edge-detect", 0], ["x-gradient", 0], ["y-gradient", 0], ["invert", 0], ["sharpen", 0] ], "doc": "A list of image filters." }, "comp-op": { "css": "comp-op", "default-value": "src-over", "default-meaning": "add the current layer on top of other layers", "doc": "Composite operation. This defines how this layer should behave relative to layers atop or below it.", "type": ["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" ] }, "opacity": { "css": "opacity", "type": "float", "doc": "An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer)", "default-value": 1, "default-meaning": "no separate buffer will be used and no alpha will be applied to the style after rendering" } }, "layer" : { "name": { "default-value": "", "type":"string", "required" : true, "default-meaning": "No layer name has been provided", "doc": "The name of a layer. Can be anything you wish and is not strictly validated, but ideally unique in the map" }, "srs": { "default-value": "", "type":"string", "default-meaning": "No srs value is provided and the value will be inherited from the Map's srs", "doc": "The spatial reference system definition for the layer, aka the projection. Can either be a proj4 literal string like '+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs' or, if the proper proj4 epsg/nad/etc identifier files are installed, a string that uses an id like: '+init=epsg:4326'" }, "status": { "default-value": true, "type":"boolean", "default-meaning": "This layer will be marked as active and available for processing", "doc": "A property that can be set to false to disable this layer from being processed" }, "minzoom": { "default-value": 0, "type":"float", "default-meaning": "The layer will be visible at the minimum possible scale", "doc": "The minimum scale denominator that this layer will be visible at. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6" }, "maxzoom": { "default-value": "1.79769e+308", "type":"float", "default-meaning": "The layer will be visible at the maximum possible scale", "doc": "The maximum scale denominator that this layer will be visible at. The default is the numeric limit of the C++ double type, which may vary slightly by system, but is likely a massive number like 1.79769e+308 and ensures that this layer will always be visible unless the value is reduced. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6" }, "queryable": { "default-value": false, "type":"boolean", "default-meaning": "The layer will not be available for the direct querying of data values", "doc": "This property was added for GetFeatureInfo/WMS compatibility and is rarely used. It is off by default meaning that in a WMS context the layer will not be able to be queried unless the property is explicitly set to true" }, "clear-label-cache": { "default-value": false, "type":"boolean", "default-meaning": "The renderer's collision detector cache (used for avoiding duplicate labels and overlapping markers) will not be cleared immediately before processing this layer", "doc": "This property, by default off, can be enabled to allow a user to clear the collision detector cache before a given layer is processed. This may be desirable to ensure that a given layers data shows up on the map even if it normally would not because of collisions with previously rendered labels or markers" }, "group-by": { "default-value": "", "type":"string", "default-meaning": "No special layer grouping will be used during rendering", "doc": "https://github.com/mapnik/mapnik/wiki/Grouped-rendering" }, "buffer-size": { "default-value": 0, "type":"float", "default-meaning": "No buffer will be used", "doc": "Extra tolerance around the Layer extent (in pixels) used to when querying and (potentially) clipping the layer data during rendering" }, "maximum-extent": { "default-value": "none", "type":"bbox", "default-meaning": "No clipping extent will be used", "doc": "An extent to be used to limit the bounds used to query this specific layer data during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Layer." } }, "symbolizers" : { "map": { "background-color": { "css": "background-color", "default-value": "none", "default-meaning": "transparent", "type": "color", "doc": "Map Background color" }, "background-image": { "css": "background-image", "type": "uri", "default-value": "", "default-meaning": "transparent", "doc": "An image that is repeated below all features on a map as a background.", "description": "Map Background image" }, "srs": { "css": "srs", "type": "string", "default-value": "+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs", "default-meaning": "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", "doc": "Map spatial reference (proj4 string)" }, "buffer-size": { "css": "buffer-size", "default-value": 0, "type":"float", "default-meaning": "No buffer will be used", "doc": "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": { "css": "", "default-value": "none", "type":"bbox", "default-meaning": "No clipping extent will be used", "doc": "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": { "css": "base", "default-value": "", "default-meaning": "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.", "type": "string", "doc": "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." }, "paths-from-xml": { "css": "", "default-value": true, "default-meaning": "Paths read from XML will be interpreted from the location of the XML", "type": "boolean", "doc": "value to control whether paths in the XML will be interpreted from the location of the XML or from the working directory of the program that calls load_map()" }, "minimum-version": { "css": "", "default-value": "none", "default-meaning": "Mapnik version will not be detected and no error will be thrown about compatibility", "type": "string", "doc": "The minumum Mapnik version (e.g. 0.7.2) needed to use certain functionality in the stylesheet" }, "font-directory": { "css": "font-directory", "type": "uri", "default-value": "none", "default-meaning": "No map-specific fonts will be registered", "doc": "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": { "fill": { "css": "polygon-fill", "type": "color", "default-value": "rgba(128,128,128,1)", "default-meaning": "gray and fully opaque (alpha = 1), same as rgb(128,128,128)", "doc": "Fill color to assign to a polygon" }, "fill-opacity": { "css": "polygon-opacity", "type": "float", "doc": "The opacity of the polygon", "default-value": 1, "default-meaning": "opaque" }, "gamma": { "css": "polygon-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of polygon edges" }, "gamma-method": { "css": "polygon-gamma-method", "type": [ "power", "linear", "none", "threshold", "multiply" ], "default-value": "power", "default-meaning": "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", "doc": "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" }, "clip": { "css": "polygon-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "smooth": { "css": "polygon-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "polygon-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "geometry will not be transformed", "doc": "Allows transformation functions to be applied to the geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "polygon-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "line": { "stroke": { "css": "line-color", "default-value": "rgba(0,0,0,1)", "type": "color", "default-meaning": "black and fully opaque (alpha = 1), same as rgb(0,0,0)", "doc": "The color of a drawn line" }, "stroke-width": { "css": "line-width", "default-value": 1, "type": "float", "doc": "The width of a line in pixels" }, "stroke-opacity": { "css": "line-opacity", "default-value": 1, "type": "float", "default-meaning": "opaque", "doc": "The opacity of a line" }, "stroke-linejoin": { "css": "line-join", "default-value": "miter", "type": [ "miter", "round", "bevel" ], "doc": "The behavior of lines when joining" }, "stroke-linecap": { "css": "line-cap", "default-value": "butt", "type": [ "butt", "round", "square" ], "doc": "The display of line endings" }, "stroke-gamma": { "css": "line-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of stroke line" }, "stroke-gamma-method": { "css": "line-gamma-method", "type": [ "power", "linear", "none", "threshold", "multiply" ], "default-value": "power", "default-meaning": "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", "doc": "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" }, "stroke-dasharray": { "css": "line-dasharray", "type": "numbers", "doc": "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.", "default-value": "none", "default-meaning": "solid line" }, "stroke-dashoffset": { "css": "line-dash-offset", "type": "numbers", "doc": "valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled)", "default-value": "none", "default-meaning": "solid line" }, "stroke-miterlimit": { "css": "line-miterlimit", "type": "float", "doc": "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.", "default-value": 4.0, "default-meaning": "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 )'" }, "clip": { "css": "line-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "smooth": { "css": "line-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "offset": { "css": "line-offset", "type": "float", "default-value": 0, "default-meaning": "no offset", "doc": "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)." }, "rasterizer": { "css": "line-rasterizer", "type": [ "full", "fast" ], "default-value": "full", "doc": "Exposes an alternate AGG rendering method that sacrifices some accuracy for speed." }, "geometry-transform": { "css": "line-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "geometry will not be transformed", "doc": "Allows transformation functions to be applied to the geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "line-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "markers": { "file": { "css": "marker-file", "doc": "An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse.", "default-value": "", "default-meaning": "An ellipse or circle, if width equals height", "type": "uri" }, "opacity": { "css": "marker-opacity", "doc": "The overall opacity of the marker, if set, overrides both the opacity of the fill and the opacity of the stroke.", "default-value": 1, "default-meaning": "The stroke-opacity and fill-opacity will be used", "type": "float" }, "fill-opacity": { "css": "marker-fill-opacity", "doc": "The fill opacity of the marker", "default-value": 1, "default-meaning": "opaque", "type": "float" }, "stroke": { "css": "marker-line-color", "doc": "The color of the stroke around a marker shape.", "default-value": "black", "type": "color" }, "stroke-width": { "css": "marker-line-width", "default-value": 0.5, "doc": "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.", "type": "float" }, "stroke-opacity": { "css": "marker-line-opacity", "default-value": 1, "default-meaning": "opaque", "doc": "The opacity of a line", "type": "float" }, "placement": { "css": "marker-placement", "type": [ "point", "line", "interior" ], "default-value": "point", "default-meaning": "Place markers at the center point (centroid) of the geometry", "doc": "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": { "css": "marker-type", "type": [ "arrow", "ellipse" ], "default-value": "ellipse", "doc": "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)" }, "width": { "css": "marker-width", "default-value": 10, "doc": "The width of the marker, if using one of the default types.", "type": "float", "expression":true }, "height": { "css": "marker-height", "default-value": 10, "doc": "The height of the marker, if using one of the default types.", "type": "float", "expression":true }, "fill": { "css": "marker-fill", "default-value": "blue", "doc": "The color of the area of the marker.", "type": "color" }, "allow-overlap": { "css": "marker-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping markers are shown or hidden.", "default-meaning": "Do not allow makers to overlap with each other - overlapping markers will not be shown." }, "ignore-placement": { "css": "marker-ignore-placement", "type": "boolean", "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache", "doc": "value to control whether the placement of the feature will prevent the placement of other features" }, "spacing": { "css": "marker-spacing", "doc": "Space between repeated labels", "default-value": 100, "type": "float" }, "max-error": { "css": "marker-max-error", "type": "float", "default-value": 0.2, "doc": "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." }, "transform": { "css": "marker-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "", "default-meaning": "No transformation", "doc": "SVG transformation definition" }, "clip": { "css": "marker-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "smooth": { "css": "marker-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "marker-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "geometry will not be transformed", "doc": "Allows transformation functions to be applied to the geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "marker-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "shield": { "name": { "css": "shield-name", "type": "string", "expression":true, "serialization": "content", "default-value": "", "doc": "Value to use for a shield\"s text label. Data columns are specified using brackets like [column_name]" }, "file": { "css": "shield-file", "required": true, "type": "uri", "default-value": "none", "doc": "Image file to render behind the shield text" }, "face-name": { "css": "shield-face-name", "type": "string", "validate": "font", "doc": "Font name and style to use for the shield text", "default-value": "", "required": true }, "unlock-image": { "css": "shield-unlock-image", "type": "boolean", "doc": "This parameter should be set to true if you are trying to position text beside rather than on top of the shield image", "default-value": false, "default-meaning": "text alignment relative to the shield image uses the center of the image as the anchor for text positioning." }, "size": { "css": "shield-size", "type": "float", "default-value": 10, "doc": "The size of the shield text in pixels" }, "fill": { "css": "shield-fill", "type": "color", "default-value": "black", "doc": "The color of the shield text" }, "placement": { "css": "shield-placement", "type": [ "point", "line", "vertex", "interior" ], "default-value": "point", "doc": "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." }, "avoid-edges": { "css": "shield-avoid-edges", "doc": "Tell positioning algorithm to avoid labeling near intersection edges.", "type": "boolean", "default-value": false }, "allow-overlap": { "css": "shield-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping shields are shown or hidden.", "default-meaning": "Do not allow shields to overlap with other map elements already placed." }, "minimum-distance": { "css": "shield-min-distance", "type": "float", "default-value": 0, "doc": "Minimum distance to the next shield symbol, not necessarily the same shield." }, "spacing": { "css": "shield-spacing", "type": "float", "default-value": 0, "doc": "The spacing between repeated occurrences of the same shield on a line" }, "minimum-padding": { "css": "shield-min-padding", "default-value": 0, "doc": "Determines the minimum amount of padding that a shield gets relative to other shields", "type": "float" }, "wrap-width": { "css": "shield-wrap-width", "type": "unsigned", "default-value": 0, "doc": "Length of a chunk of text in characters before wrapping text" }, "wrap-before": { "css": "shield-wrap-before", "type": "boolean", "default-value": false, "doc": "Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width." }, "wrap-character": { "css": "shield-wrap-character", "type": "string", "default-value": " ", "doc": "Use this character instead of a space to wrap long names." }, "halo-fill": { "css": "shield-halo-fill", "type": "color", "default-value": "#FFFFFF", "default-meaning": "white", "doc": "Specifies the color of the halo around the text." }, "halo-radius": { "css": "shield-halo-radius", "doc": "Specify the radius of the halo in pixels", "default-value": 0, "default-meaning": "no halo", "type": "float" }, "character-spacing": { "css": "shield-character-spacing", "type": "unsigned", "default-value": 0, "doc": "Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement." }, "line-spacing": { "css": "shield-line-spacing", "default-value": 0, "doc": "Vertical spacing between lines of multiline labels (in pixels)", "type": "float" }, "dx": { "css": "shield-text-dx", "type": "float", "doc": "Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right", "default-value": 0 }, "dy": { "css": "shield-text-dy", "type": "float", "doc": "Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down", "default-value": 0 }, "shield-dx": { "css": "shield-dx", "type": "float", "doc": "Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right", "default-value": 0 }, "shield-dy": { "css": "shield-dy", "type": "float", "doc": "Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down", "default-value": 0 }, "opacity": { "css": "shield-opacity", "type": "float", "doc": "(Default 1.0) - opacity of the image used for the shield", "default-value": 1 }, "text-opacity": { "css": "shield-text-opacity", "type": "float", "doc": "(Default 1.0) - opacity of the text placed on top of the shield", "default-value": 1 }, "horizontal-alignment": { "css": "shield-horizontal-alignment", "type": [ "left", "middle", "right", "auto" ], "doc": "The shield's horizontal alignment from its centerpoint", "default-value": "auto" }, "vertical-alignment": { "css": "shield-vertical-alignment", "type": [ "top", "middle", "bottom", "auto" ], "doc": "The shield's vertical alignment from its centerpoint", "default-value": "middle" }, "text-transform": { "css": "shield-text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize" ], "doc": "Transform the case of the characters", "default-value": "none" }, "justify-alignment": { "css": "shield-justify-alignment", "type": [ "left", "center", "right", "auto" ], "doc": "Define how text in a shield's label is justified", "default-value": "auto" }, "clip": { "css": "shield-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "comp-op": { "css": "shield-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "line-pattern": { "file": { "css": "line-pattern-file", "type": "uri", "default-value": "none", "required": true, "doc": "An image file to be repeated and warped along a line" }, "clip": { "css": "line-pattern-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "smooth": { "css": "line-pattern-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "line-pattern-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "geometry will not be transformed", "doc": "Allows transformation functions to be applied to the geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "line-pattern-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "polygon-pattern": { "file": { "css": "polygon-pattern-file", "type": "uri", "default-value": "none", "required": true, "doc": "Image to use as a repeated pattern fill within a polygon" }, "alignment": { "css": "polygon-pattern-alignment", "type": [ "local", "global" ], "default-value": "local", "doc": "Specify whether to align pattern fills to the layer or to the map." }, "gamma": { "css": "polygon-pattern-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of polygon pattern edges" }, "opacity": { "css": "polygon-pattern-opacity", "type": "float", "doc": "(Default 1.0) - Apply an opacity level to the image used for the pattern", "default-value": 1, "default-meaning": "The image is rendered without modifications" }, "clip": { "css": "polygon-pattern-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "smooth": { "css": "polygon-pattern-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "polygon-pattern-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "geometry will not be transformed", "doc": "Allows transformation functions to be applied to the geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "polygon-pattern-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "raster": { "opacity": { "css": "raster-opacity", "default-value": 1, "default-meaning": "opaque", "type": "float", "doc": "The opacity of the raster symbolizer on top of other symbolizers." }, "filter-factor": { "css": "raster-filter-factor", "default-value": -1, "default-meaning": "Allow the datasource to choose appropriate downscaling.", "type": "float", "doc": "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." }, "scaling": { "css": "raster-scaling", "type": [ "near", "fast", "bilinear", "bilinear8", "bicubic", "spline16", "spline36", "hanning", "hamming", "hermite", "kaiser", "quadric", "catrom", "gaussian", "bessel", "mitchell", "sinc", "lanczos", "blackman" ], "default-value": "near", "doc": "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." }, "mesh-size": { "css": "raster-mesh-size", "default-value": 16, "default-meaning": "Reprojection mesh will be 1/16 of the resolution of the source image", "type": "unsigned", "doc": "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." }, "comp-op": { "css": "raster-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "point": { "file": { "css": "point-file", "type": "uri", "required": false, "default-value": "none", "doc": "Image file to represent a point" }, "allow-overlap": { "css": "point-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping points are shown or hidden.", "default-meaning": "Do not allow points to overlap with each other - overlapping markers will not be shown." }, "ignore-placement": { "css": "point-ignore-placement", "type": "boolean", "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache", "doc": "value to control whether the placement of the feature will prevent the placement of other features" }, "opacity": { "css": "point-opacity", "type": "float", "default-value": 1.0, "default-meaning": "Fully opaque", "doc": "A value from 0 to 1 to control the opacity of the point" }, "placement": { "css": "point-placement", "type": [ "centroid", "interior" ], "doc": "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.", "default-value": "centroid" }, "transform": { "css": "point-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "", "default-meaning": "No transformation", "doc": "SVG transformation definition" }, "comp-op": { "css": "point-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "text": { "name": { "css": "text-name", "type": "string", "expression":true, "required": true, "default-value": "", "serialization": "content", "doc": "Value to use for a text label. Data columns are specified using brackets like [column_name]" }, "face-name": { "css": "text-face-name", "type": "string", "validate": "font", "default-value": "", "doc": "Font name and style to render a label in", "required": true }, "size": { "css": "text-size", "type": "float", "default-value": 10, "doc": "Text size in pixels" }, "text-ratio": { "css": "text-ratio", "doc": "Define the amount of text (of the total) present on successive lines when wrapping occurs", "default-value": 0, "type": "unsigned" }, "wrap-width": { "css": "text-wrap-width", "doc": "Length of a chunk of text in characters before wrapping text", "default-value": 0, "type": "unsigned" }, "wrap-before": { "css": "text-wrap-before", "type": "boolean", "default-value": false, "doc": "Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width." }, "wrap-character": { "css": "text-wrap-character", "type": "string", "default-value": " ", "doc": "Use this character instead of a space to wrap long text." }, "spacing": { "css": "text-spacing", "type": "unsigned", "default-value": 0, "doc": "Distance between repeated text labels on a line (aka. label-spacing)" }, "character-spacing": { "css": "text-character-spacing", "type": "float", "default-value": 0, "doc": "Horizontal spacing adjustment between characters in pixels" }, "line-spacing": { "css": "text-line-spacing", "default-value": 0, "type": "float", "doc": "Vertical spacing adjustment between lines in pixels" }, "label-position-tolerance": { "css": "text-label-position-tolerance", "default-value": 0, "type": "unsigned", "doc": "Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line)" }, "max-char-angle-delta": { "css": "text-max-char-angle-delta", "type": "float", "default-value": "22.5", "doc": "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." }, "fill": { "css": "text-fill", "doc": "Specifies the color for the text", "default-value": "#000000", "type": "color" }, "opacity": { "css": "text-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text", "default-value": 1.0, "default-meaning": "Fully opaque", "type": "float" }, "halo-fill": { "css": "text-halo-fill", "type": "color", "default-value": "#FFFFFF", "default-meaning": "white", "doc": "Specifies the color of the halo around the text." }, "halo-radius": { "css": "text-halo-radius", "doc": "Specify the radius of the halo in pixels", "default-value": 0, "default-meaning": "no halo", "type": "float" }, "dx": { "css": "text-dx", "type": "float", "doc": "Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right", "default-value": 0 }, "dy": { "css": "text-dy", "type": "float", "doc": "Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down", "default-value": 0 }, "vertical-alignment": { "css": "text-vertical-alignment", "type": [ "top", "middle", "bottom", "auto" ], "doc": "Position of label relative to point position.", "default-value": "auto", "default-meaning": "Default affected by value of dy; \"bottom\" for dy>0, \"top\" for dy<0." }, "avoid-edges": { "css": "text-avoid-edges", "doc": "Tell positioning algorithm to avoid labeling near intersection edges.", "default-value": false, "type": "boolean" }, "minimum-distance": { "css": "text-min-distance", "doc": "Minimum permitted distance to the next text symbolizer.", "default-value": 0, "type": "float" }, "minimum-padding": { "css": "text-min-padding", "doc": "Determines the minimum amount of padding that a text symbolizer gets relative to other text", "default-value": 0, "type": "float" }, "minimum-path-length": { "css": "text-min-path-length", "type": "float", "default-value": 0, "default-meaning": "place labels on all paths", "doc": "Place labels only on paths longer than this value." }, "allow-overlap": { "css": "text-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping text is shown or hidden.", "default-meaning": "Do not allow text to overlap with other text - overlapping markers will not be shown." }, "orientation": { "css": "text-orientation", "type": "float", "expression":true, "default-value": 0, "doc": "Rotate the text." }, "placement": { "css": "text-placement", "type": [ "point", "line", "vertex", "interior" ], "default-value": "point", "doc": "Control the style of placement of a point versus the geometry it is attached to." }, "placement-type": { "css": "text-placement-type", "doc": "Re-position and/or re-size text to avoid overlaps. \"simple\" for basic algorithm (using text-placements string,) \"dummy\" to turn this feature off.", "type": [ "dummy", "simple", "list" ], "default-value": "dummy" }, "placements": { "css": "text-placements", "type": "string", "default-value": "", "doc": "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": { "css": "text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize" ], "doc": "Transform the case of the characters", "default-value": "none" }, "horizontal-alignment": { "css": "text-horizontal-alignment", "type": [ "left", "middle", "right", "auto" ], "doc": "The text's horizontal alignment from its centerpoint", "default-value": "auto" }, "justify-alignment": { "css": "text-align", "type": [ "left", "right", "center", "auto" ], "doc": "Define how text is justified", "default-value": "auto", "default-meaning": "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" }, "clip": { "css": "text-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "comp-op": { "css": "text-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "building": { "fill": { "css": "building-fill", "default-value": "#FFFFFF", "doc": "The color of the buildings walls.", "type": "color" }, "fill-opacity": { "css": "building-fill-opacity", "type": "float", "doc": "The opacity of the building as a whole, including all walls.", "default-value": 1 }, "height": { "css": "building-height", "doc": "The height of the building in pixels.", "type": "float", "expression":true, "default-value": 0 } } }, "colors": { "aliceblue": [240, 248, 255], "antiquewhite": [250, 235, 215], "aqua": [0, 255, 255], "aquamarine": [127, 255, 212], "azure": [240, 255, 255], "beige": [245, 245, 220], "bisque": [255, 228, 196], "black": [0, 0, 0], "blanchedalmond": [255,235,205], "blue": [0, 0, 255], "blueviolet": [138, 43, 226], "brown": [165, 42, 42], "burlywood": [222, 184, 135], "cadetblue": [95, 158, 160], "chartreuse": [127, 255, 0], "chocolate": [210, 105, 30], "coral": [255, 127, 80], "cornflowerblue": [100, 149, 237], "cornsilk": [255, 248, 220], "crimson": [220, 20, 60], "cyan": [0, 255, 255], "darkblue": [0, 0, 139], "darkcyan": [0, 139, 139], "darkgoldenrod": [184, 134, 11], "darkgray": [169, 169, 169], "darkgreen": [0, 100, 0], "darkgrey": [169, 169, 169], "darkkhaki": [189, 183, 107], "darkmagenta": [139, 0, 139], "darkolivegreen": [85, 107, 47], "darkorange": [255, 140, 0], "darkorchid": [153, 50, 204], "darkred": [139, 0, 0], "darksalmon": [233, 150, 122], "darkseagreen": [143, 188, 143], "darkslateblue": [72, 61, 139], "darkslategrey": [47, 79, 79], "darkturquoise": [0, 206, 209], "darkviolet": [148, 0, 211], "deeppink": [255, 20, 147], "deepskyblue": [0, 191, 255], "dimgray": [105, 105, 105], "dimgrey": [105, 105, 105], "dodgerblue": [30, 144, 255], "firebrick": [178, 34, 34], "floralwhite": [255, 250, 240], "forestgreen": [34, 139, 34], "fuchsia": [255, 0, 255], "gainsboro": [220, 220, 220], "ghostwhite": [248, 248, 255], "gold": [255, 215, 0], "goldenrod": [218, 165, 32], "gray": [128, 128, 128], "grey": [128, 128, 128], "green": [0, 128, 0], "greenyellow": [173, 255, 47], "honeydew": [240, 255, 240], "hotpink": [255, 105, 180], "indianred": [205, 92, 92], "indigo": [75, 0, 130], "ivory": [255, 255, 240], "khaki": [240, 230, 140], "lavender": [230, 230, 250], "lavenderblush": [255, 240, 245], "lawngreen": [124, 252, 0], "lemonchiffon": [255, 250, 205], "lightblue": [173, 216, 230], "lightcoral": [240, 128, 128], "lightcyan": [224, 255, 255], "lightgoldenrodyellow": [250, 250, 210], "lightgray": [211, 211, 211], "lightgreen": [144, 238, 144], "lightgrey": [211, 211, 211], "lightpink": [255, 182, 193], "lightsalmon": [255, 160, 122], "lightseagreen": [32, 178, 170], "lightskyblue": [135, 206, 250], "lightslategray": [119, 136, 153], "lightslategrey": [119, 136, 153], "lightsteelblue": [176, 196, 222], "lightyellow": [255, 255, 224], "lime": [0, 255, 0], "limegreen": [50, 205, 50], "linen": [250, 240, 230], "magenta": [255, 0, 255], "maroon": [128, 0, 0], "mediumaquamarine": [102, 205, 170], "mediumblue": [0, 0, 205], "mediumorchid": [186, 85, 211], "mediumpurple": [147, 112, 219], "mediumseagreen": [60, 179, 113], "mediumslateblue": [123, 104, 238], "mediumspringgreen": [0, 250, 154], "mediumturquoise": [72, 209, 204], "mediumvioletred": [199, 21, 133], "midnightblue": [25, 25, 112], "mintcream": [245, 255, 250], "mistyrose": [255, 228, 225], "moccasin": [255, 228, 181], "navajowhite": [255, 222, 173], "navy": [0, 0, 128], "oldlace": [253, 245, 230], "olive": [128, 128, 0], "olivedrab": [107, 142, 35], "orange": [255, 165, 0], "orangered": [255, 69, 0], "orchid": [218, 112, 214], "palegoldenrod": [238, 232, 170], "palegreen": [152, 251, 152], "paleturquoise": [175, 238, 238], "palevioletred": [219, 112, 147], "papayawhip": [255, 239, 213], "peachpuff": [255, 218, 185], "peru": [205, 133, 63], "pink": [255, 192, 203], "plum": [221, 160, 221], "powderblue": [176, 224, 230], "purple": [128, 0, 128], "red": [255, 0, 0], "rosybrown": [188, 143, 143], "royalblue": [65, 105, 225], "saddlebrown": [139, 69, 19], "salmon": [250, 128, 114], "sandybrown": [244, 164, 96], "seagreen": [46, 139, 87], "seashell": [255, 245, 238], "sienna": [160, 82, 45], "silver": [192, 192, 192], "skyblue": [135, 206, 235], "slateblue": [106, 90, 205], "slategray": [112, 128, 144], "slategrey": [112, 128, 144], "snow": [255, 250, 250], "springgreen": [0, 255, 127], "steelblue": [70, 130, 180], "tan": [210, 180, 140], "teal": [0, 128, 128], "thistle": [216, 191, 216], "tomato": [255, 99, 71], "turquoise": [64, 224, 208], "violet": [238, 130, 238], "wheat": [245, 222, 179], "white": [255, 255, 255], "whitesmoke": [245, 245, 245], "yellow": [255, 255, 0], "yellowgreen": [154, 205, 50], "transparent": [0, 0, 0, 0] }, "filter": { "value": [ "true", "false", "null", "point", "linestring", "polygon", "collection" ] } } mapnik-reference-8.10.0/2.1.1/000077500000000000000000000000001342311331100154425ustar00rootroot00000000000000mapnik-reference-8.10.0/2.1.1/reference.json000066400000000000000000002250771342311331100203100ustar00rootroot00000000000000{ "version": "2.1.1", "style": { "filter-mode": { "type": [ "all", "first" ], "doc": "Control the processing behavior of Rule filters within a Style. If 'all' is used then all Rules are processed sequentially independent of whether any previous filters matched. If 'first' is used then it means processing ends after the first match (a positive filter evaluation) and no further Rules in the Style are processed ('first' is usually the default for CSS implementations on top of Mapnik to simplify translation from CSS to Mapnik XML)", "default-value": "all", "default-meaning": "All Rules in a Style are processed whether they have filters or not and whether or not the filter conditions evaluate to true." }, "image-filters": { "css": "image-filters", "default-value": "none", "default-meaning": "no filters", "type": "functions", "functions": [ ["agg-stack-blur", 2], ["emboss", 0], ["blur", 0], ["gray", 0], ["sobel", 0], ["edge-detect", 0], ["x-gradient", 0], ["y-gradient", 0], ["invert", 0], ["sharpen", 0] ], "doc": "A list of image filters." }, "comp-op": { "css": "comp-op", "default-value": "src-over", "default-meaning": "add the current layer on top of other layers", "doc": "Composite operation. This defines how this layer should behave relative to layers atop or below it.", "type": ["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" ] }, "opacity": { "css": "opacity", "type": "float", "doc": "An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer)", "default-value": 1, "default-meaning": "no separate buffer will be used and no alpha will be applied to the style after rendering" } }, "layer" : { "name": { "default-value": "", "type":"string", "required" : true, "default-meaning": "No layer name has been provided", "doc": "The name of a layer. Can be anything you wish and is not strictly validated, but ideally unique in the map" }, "srs": { "default-value": "", "type":"string", "default-meaning": "No srs value is provided and the value will be inherited from the Map's srs", "doc": "The spatial reference system definition for the layer, aka the projection. Can either be a proj4 literal string like '+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs' or, if the proper proj4 epsg/nad/etc identifier files are installed, a string that uses an id like: '+init=epsg:4326'" }, "status": { "default-value": true, "type":"boolean", "default-meaning": "This layer will be marked as active and available for processing", "doc": "A property that can be set to false to disable this layer from being processed" }, "minzoom": { "default-value": 0, "type":"float", "default-meaning": "The layer will be visible at the minimum possible scale", "doc": "The minimum scale denominator that this layer will be visible at. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6" }, "maxzoom": { "default-value": "1.79769e+308", "type":"float", "default-meaning": "The layer will be visible at the maximum possible scale", "doc": "The maximum scale denominator that this layer will be visible at. The default is the numeric limit of the C++ double type, which may vary slightly by system, but is likely a massive number like 1.79769e+308 and ensures that this layer will always be visible unless the value is reduced. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6" }, "queryable": { "default-value": false, "type":"boolean", "default-meaning": "The layer will not be available for the direct querying of data values", "doc": "This property was added for GetFeatureInfo/WMS compatibility and is rarely used. It is off by default meaning that in a WMS context the layer will not be able to be queried unless the property is explicitly set to true" }, "clear-label-cache": { "default-value": false, "type":"boolean", "default-meaning": "The renderer's collision detector cache (used for avoiding duplicate labels and overlapping markers) will not be cleared immediately before processing this layer", "doc": "This property, by default off, can be enabled to allow a user to clear the collision detector cache before a given layer is processed. This may be desirable to ensure that a given layers data shows up on the map even if it normally would not because of collisions with previously rendered labels or markers" }, "group-by": { "default-value": "", "type":"string", "default-meaning": "No special layer grouping will be used during rendering", "doc": "https://github.com/mapnik/mapnik/wiki/Grouped-rendering" }, "buffer-size": { "default-value": 0, "type":"float", "default-meaning": "No buffer will be used", "doc": "Extra tolerance around the Layer extent (in pixels) used to when querying and (potentially) clipping the layer data during rendering" }, "maximum-extent": { "default-value": "none", "type":"bbox", "default-meaning": "No clipping extent will be used", "doc": "An extent to be used to limit the bounds used to query this specific layer data during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Layer." } }, "symbolizers" : { "map": { "background-color": { "css": "background-color", "default-value": "none", "default-meaning": "transparent", "type": "color", "doc": "Map Background color" }, "background-image": { "css": "background-image", "type": "uri", "default-value": "", "default-meaning": "transparent", "doc": "An image that is repeated below all features on a map as a background.", "description": "Map Background image" }, "srs": { "css": "srs", "type": "string", "default-value": "+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs", "default-meaning": "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", "doc": "Map spatial reference (proj4 string)" }, "buffer-size": { "css": "buffer-size", "default-value": 0, "type":"float", "default-meaning": "No buffer will be used", "doc": "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": { "css": "", "default-value": "none", "type":"bbox", "default-meaning": "No clipping extent will be used", "doc": "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": { "css": "base", "default-value": "", "default-meaning": "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.", "type": "string", "doc": "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." }, "paths-from-xml": { "css": "", "default-value": true, "default-meaning": "Paths read from XML will be interpreted from the location of the XML", "type": "boolean", "doc": "value to control whether paths in the XML will be interpreted from the location of the XML or from the working directory of the program that calls load_map()" }, "minimum-version": { "css": "", "default-value": "none", "default-meaning": "Mapnik version will not be detected and no error will be thrown about compatibility", "type": "string", "doc": "The minumum Mapnik version (e.g. 0.7.2) needed to use certain functionality in the stylesheet" }, "font-directory": { "css": "font-directory", "type": "uri", "default-value": "none", "default-meaning": "No map-specific fonts will be registered", "doc": "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": { "fill": { "css": "polygon-fill", "type": "color", "default-value": "rgba(128,128,128,1)", "default-meaning": "gray and fully opaque (alpha = 1), same as rgb(128,128,128)", "doc": "Fill color to assign to a polygon" }, "fill-opacity": { "css": "polygon-opacity", "type": "float", "doc": "The opacity of the polygon", "default-value": 1, "default-meaning": "opaque" }, "gamma": { "css": "polygon-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of polygon edges" }, "gamma-method": { "css": "polygon-gamma-method", "type": [ "power", "linear", "none", "threshold", "multiply" ], "default-value": "power", "default-meaning": "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", "doc": "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" }, "clip": { "css": "polygon-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "smooth": { "css": "polygon-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "polygon-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "geometry will not be transformed", "doc": "Allows transformation functions to be applied to the geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "polygon-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "line": { "stroke": { "css": "line-color", "default-value": "rgba(0,0,0,1)", "type": "color", "default-meaning": "black and fully opaque (alpha = 1), same as rgb(0,0,0)", "doc": "The color of a drawn line" }, "stroke-width": { "css": "line-width", "default-value": 1, "type": "float", "doc": "The width of a line in pixels" }, "stroke-opacity": { "css": "line-opacity", "default-value": 1, "type": "float", "default-meaning": "opaque", "doc": "The opacity of a line" }, "stroke-linejoin": { "css": "line-join", "default-value": "miter", "type": [ "miter", "round", "bevel" ], "doc": "The behavior of lines when joining" }, "stroke-linecap": { "css": "line-cap", "default-value": "butt", "type": [ "butt", "round", "square" ], "doc": "The display of line endings" }, "stroke-gamma": { "css": "line-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of stroke line" }, "stroke-gamma-method": { "css": "line-gamma-method", "type": [ "power", "linear", "none", "threshold", "multiply" ], "default-value": "power", "default-meaning": "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", "doc": "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" }, "stroke-dasharray": { "css": "line-dasharray", "type": "numbers", "doc": "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.", "default-value": "none", "default-meaning": "solid line" }, "stroke-dashoffset": { "css": "line-dash-offset", "type": "numbers", "doc": "valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled)", "default-value": "none", "default-meaning": "solid line" }, "stroke-miterlimit": { "css": "line-miterlimit", "type": "float", "doc": "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.", "default-value": 4.0, "default-meaning": "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 )'" }, "clip": { "css": "line-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "smooth": { "css": "line-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "offset": { "css": "line-offset", "type": "float", "default-value": 0, "default-meaning": "no offset", "doc": "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)." }, "rasterizer": { "css": "line-rasterizer", "type": [ "full", "fast" ], "default-value": "full", "doc": "Exposes an alternate AGG rendering method that sacrifices some accuracy for speed." }, "geometry-transform": { "css": "line-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "geometry will not be transformed", "doc": "Allows transformation functions to be applied to the geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "line-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "markers": { "file": { "css": "marker-file", "doc": "An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse.", "default-value": "", "default-meaning": "An ellipse or circle, if width equals height", "type": "uri" }, "opacity": { "css": "marker-opacity", "doc": "The overall opacity of the marker, if set, overrides both the opacity of the fill and the opacity of the stroke.", "default-value": 1, "default-meaning": "The stroke-opacity and fill-opacity will be used", "type": "float" }, "fill-opacity": { "css": "marker-fill-opacity", "doc": "The fill opacity of the marker", "default-value": 1, "default-meaning": "opaque", "type": "float" }, "stroke": { "css": "marker-line-color", "doc": "The color of the stroke around a marker shape.", "default-value": "black", "type": "color" }, "stroke-width": { "css": "marker-line-width", "default-value": 0.5, "doc": "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.", "type": "float" }, "stroke-opacity": { "css": "marker-line-opacity", "default-value": 1, "default-meaning": "opaque", "doc": "The opacity of a line", "type": "float" }, "placement": { "css": "marker-placement", "type": [ "point", "line", "interior" ], "default-value": "point", "default-meaning": "Place markers at the center point (centroid) of the geometry", "doc": "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" }, "multi-policy": { "css": "marker-multi-policy", "type": [ "each", "whole", "largest" ], "default-value": "each", "default-meaning": "If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each", "doc": "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": { "css": "marker-type", "type": [ "arrow", "ellipse" ], "default-value": "ellipse", "doc": "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)" }, "width": { "css": "marker-width", "default-value": 10, "doc": "The width of the marker, if using one of the default types.", "type": "expression" }, "height": { "css": "marker-height", "default-value": 10, "doc": "The height of the marker, if using one of the default types.", "type": "expression" }, "fill": { "css": "marker-fill", "default-value": "blue", "doc": "The color of the area of the marker.", "type": "color" }, "allow-overlap": { "css": "marker-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping markers are shown or hidden.", "default-meaning": "Do not allow makers to overlap with each other - overlapping markers will not be shown." }, "ignore-placement": { "css": "marker-ignore-placement", "type": "boolean", "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache", "doc": "value to control whether the placement of the feature will prevent the placement of other features" }, "spacing": { "css": "marker-spacing", "doc": "Space between repeated labels", "default-value": 100, "type": "float" }, "max-error": { "css": "marker-max-error", "type": "float", "default-value": 0.2, "doc": "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." }, "transform": { "css": "marker-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "", "default-meaning": "No transformation", "doc": "SVG transformation definition" }, "clip": { "css": "marker-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "smooth": { "css": "marker-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "marker-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "geometry will not be transformed", "doc": "Allows transformation functions to be applied to the geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "marker-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "shield": { "name": { "css": "shield-name", "type": "expression", "serialization": "content", "default-value": "", "doc": "Value to use for a shield\"s text label. Data columns are specified using brackets like [column_name]" }, "file": { "css": "shield-file", "required": true, "type": "uri", "default-value": "none", "doc": "Image file to render behind the shield text" }, "face-name": { "css": "shield-face-name", "type": "string", "validate": "font", "doc": "Font name and style to use for the shield text", "default-value": "", "required": true }, "unlock-image": { "css": "shield-unlock-image", "type": "boolean", "doc": "This parameter should be set to true if you are trying to position text beside rather than on top of the shield image", "default-value": false, "default-meaning": "text alignment relative to the shield image uses the center of the image as the anchor for text positioning." }, "size": { "css": "shield-size", "type": "float", "default-value": 10, "doc": "The size of the shield text in pixels" }, "fill": { "css": "shield-fill", "type": "color", "default-value": "black", "doc": "The color of the shield text" }, "placement": { "css": "shield-placement", "type": [ "point", "line", "vertex", "interior" ], "default-value": "point", "doc": "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." }, "avoid-edges": { "css": "shield-avoid-edges", "doc": "Tell positioning algorithm to avoid labeling near intersection edges.", "type": "boolean", "default-value": false }, "allow-overlap": { "css": "shield-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping shields are shown or hidden.", "default-meaning": "Do not allow shields to overlap with other map elements already placed." }, "minimum-distance": { "css": "shield-min-distance", "type": "float", "default-value": 0, "doc": "Minimum distance to the next shield symbol, not necessarily the same shield." }, "spacing": { "css": "shield-spacing", "type": "float", "default-value": 0, "doc": "The spacing between repeated occurrences of the same shield on a line" }, "minimum-padding": { "css": "shield-min-padding", "default-value": 0, "doc": "Determines the minimum amount of padding that a shield gets relative to other shields", "type": "float" }, "wrap-width": { "css": "shield-wrap-width", "type": "unsigned", "default-value": 0, "doc": "Length of a chunk of text in characters before wrapping text" }, "wrap-before": { "css": "shield-wrap-before", "type": "boolean", "default-value": false, "doc": "Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width." }, "wrap-character": { "css": "shield-wrap-character", "type": "string", "default-value": " ", "doc": "Use this character instead of a space to wrap long names." }, "halo-fill": { "css": "shield-halo-fill", "type": "color", "default-value": "#FFFFFF", "default-meaning": "white", "doc": "Specifies the color of the halo around the text." }, "halo-radius": { "css": "shield-halo-radius", "doc": "Specify the radius of the halo in pixels", "default-value": 0, "default-meaning": "no halo", "type": "float" }, "character-spacing": { "css": "shield-character-spacing", "type": "unsigned", "default-value": 0, "doc": "Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement." }, "line-spacing": { "css": "shield-line-spacing", "default-value": 0, "doc": "Vertical spacing between lines of multiline labels (in pixels)", "type": "float" }, "dx": { "css": "shield-text-dx", "type": "float", "doc": "Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right", "default-value": 0 }, "dy": { "css": "shield-text-dy", "type": "float", "doc": "Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down", "default-value": 0 }, "shield-dx": { "css": "shield-dx", "type": "float", "doc": "Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right", "default-value": 0 }, "shield-dy": { "css": "shield-dy", "type": "float", "doc": "Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down", "default-value": 0 }, "opacity": { "css": "shield-opacity", "type": "float", "doc": "(Default 1.0) - opacity of the image used for the shield", "default-value": 1 }, "text-opacity": { "css": "shield-text-opacity", "type": "float", "doc": "(Default 1.0) - opacity of the text placed on top of the shield", "default-value": 1 }, "horizontal-alignment": { "css": "shield-horizontal-alignment", "type": [ "left", "middle", "right", "auto" ], "doc": "The shield's horizontal alignment from its centerpoint", "default-value": "auto" }, "vertical-alignment": { "css": "shield-vertical-alignment", "type": [ "top", "middle", "bottom", "auto" ], "doc": "The shield's vertical alignment from its centerpoint", "default-value": "middle" }, "text-transform": { "css": "shield-text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize" ], "doc": "Transform the case of the characters", "default-value": "none" }, "justify-alignment": { "css": "shield-justify-alignment", "type": [ "left", "center", "right", "auto" ], "doc": "Define how text in a shield's label is justified", "default-value": "auto" }, "clip": { "css": "shield-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "comp-op": { "css": "shield-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "line-pattern": { "file": { "css": "line-pattern-file", "type": "uri", "default-value": "none", "required": true, "doc": "An image file to be repeated and warped along a line" }, "clip": { "css": "line-pattern-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "smooth": { "css": "line-pattern-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "line-pattern-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "geometry will not be transformed", "doc": "Allows transformation functions to be applied to the geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "line-pattern-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "polygon-pattern": { "file": { "css": "polygon-pattern-file", "type": "uri", "default-value": "none", "required": true, "doc": "Image to use as a repeated pattern fill within a polygon" }, "alignment": { "css": "polygon-pattern-alignment", "type": [ "local", "global" ], "default-value": "local", "doc": "Specify whether to align pattern fills to the layer or to the map." }, "gamma": { "css": "polygon-pattern-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of polygon pattern edges" }, "opacity": { "css": "polygon-pattern-opacity", "type": "float", "doc": "(Default 1.0) - Apply an opacity level to the image used for the pattern", "default-value": 1, "default-meaning": "The image is rendered without modifications" }, "clip": { "css": "polygon-pattern-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "smooth": { "css": "polygon-pattern-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "polygon-pattern-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "geometry will not be transformed", "doc": "Allows transformation functions to be applied to the geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "polygon-pattern-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "raster": { "opacity": { "css": "raster-opacity", "default-value": 1, "default-meaning": "opaque", "type": "float", "doc": "The opacity of the raster symbolizer on top of other symbolizers." }, "filter-factor": { "css": "raster-filter-factor", "default-value": -1, "default-meaning": "Allow the datasource to choose appropriate downscaling.", "type": "float", "doc": "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." }, "scaling": { "css": "raster-scaling", "type": [ "near", "fast", "bilinear", "bilinear8", "bicubic", "spline16", "spline36", "hanning", "hamming", "hermite", "kaiser", "quadric", "catrom", "gaussian", "bessel", "mitchell", "sinc", "lanczos", "blackman" ], "default-value": "near", "doc": "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." }, "mesh-size": { "css": "raster-mesh-size", "default-value": 16, "default-meaning": "Reprojection mesh will be 1/16 of the resolution of the source image", "type": "unsigned", "doc": "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." }, "comp-op": { "css": "raster-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "point": { "file": { "css": "point-file", "type": "uri", "required": false, "default-value": "none", "doc": "Image file to represent a point" }, "allow-overlap": { "css": "point-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping points are shown or hidden.", "default-meaning": "Do not allow points to overlap with each other - overlapping markers will not be shown." }, "ignore-placement": { "css": "point-ignore-placement", "type": "boolean", "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache", "doc": "value to control whether the placement of the feature will prevent the placement of other features" }, "opacity": { "css": "point-opacity", "type": "float", "default-value": 1.0, "default-meaning": "Fully opaque", "doc": "A value from 0 to 1 to control the opacity of the point" }, "placement": { "css": "point-placement", "type": [ "centroid", "interior" ], "doc": "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.", "default-value": "centroid" }, "transform": { "css": "point-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "", "default-meaning": "No transformation", "doc": "SVG transformation definition" }, "comp-op": { "css": "point-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "text": { "name": { "css": "text-name", "type": "expression", "required": true, "default-value": "", "serialization": "content", "doc": "Value to use for a text label. Data columns are specified using brackets like [column_name]" }, "face-name": { "css": "text-face-name", "type": "string", "validate": "font", "default-value": "", "doc": "Font name and style to render a label in", "required": true }, "size": { "css": "text-size", "type": "float", "default-value": 10, "doc": "Text size in pixels" }, "text-ratio": { "css": "text-ratio", "doc": "Define the amount of text (of the total) present on successive lines when wrapping occurs", "default-value": 0, "type": "unsigned" }, "wrap-width": { "css": "text-wrap-width", "doc": "Length of a chunk of text in characters before wrapping text", "default-value": 0, "type": "unsigned" }, "wrap-before": { "css": "text-wrap-before", "type": "boolean", "default-value": false, "doc": "Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width." }, "wrap-character": { "css": "text-wrap-character", "type": "string", "default-value": " ", "doc": "Use this character instead of a space to wrap long text." }, "spacing": { "css": "text-spacing", "type": "unsigned", "default-value": 0, "doc": "Distance between repeated text labels on a line (aka. label-spacing)" }, "character-spacing": { "css": "text-character-spacing", "type": "float", "default-value": 0, "doc": "Horizontal spacing adjustment between characters in pixels" }, "line-spacing": { "css": "text-line-spacing", "default-value": 0, "type": "float", "doc": "Vertical spacing adjustment between lines in pixels" }, "label-position-tolerance": { "css": "text-label-position-tolerance", "default-value": 0, "type": "unsigned", "doc": "Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line)" }, "max-char-angle-delta": { "css": "text-max-char-angle-delta", "type": "float", "default-value": "22.5", "doc": "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." }, "fill": { "css": "text-fill", "doc": "Specifies the color for the text", "default-value": "#000000", "type": "color" }, "opacity": { "css": "text-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text", "default-value": 1.0, "default-meaning": "Fully opaque", "type": "float" }, "halo-fill": { "css": "text-halo-fill", "type": "color", "default-value": "#FFFFFF", "default-meaning": "white", "doc": "Specifies the color of the halo around the text." }, "halo-radius": { "css": "text-halo-radius", "doc": "Specify the radius of the halo in pixels", "default-value": 0, "default-meaning": "no halo", "type": "float" }, "dx": { "css": "text-dx", "type": "float", "doc": "Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right", "default-value": 0 }, "dy": { "css": "text-dy", "type": "float", "doc": "Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down", "default-value": 0 }, "vertical-alignment": { "css": "text-vertical-alignment", "type": [ "top", "middle", "bottom", "auto" ], "doc": "Position of label relative to point position.", "default-value": "auto", "default-meaning": "Default affected by value of dy; \"bottom\" for dy>0, \"top\" for dy<0." }, "avoid-edges": { "css": "text-avoid-edges", "doc": "Tell positioning algorithm to avoid labeling near intersection edges.", "default-value": false, "type": "boolean" }, "minimum-distance": { "css": "text-min-distance", "doc": "Minimum permitted distance to the next text symbolizer.", "default-value": 0, "type": "float" }, "minimum-padding": { "css": "text-min-padding", "doc": "Determines the minimum amount of padding that a text symbolizer gets relative to other text", "default-value": 0, "type": "float" }, "minimum-path-length": { "css": "text-min-path-length", "type": "float", "default-value": 0, "default-meaning": "place labels on all paths", "doc": "Place labels only on paths longer than this value." }, "allow-overlap": { "css": "text-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping text is shown or hidden.", "default-meaning": "Do not allow text to overlap with other text - overlapping markers will not be shown." }, "orientation": { "css": "text-orientation", "type": "expression", "default-value": 0, "doc": "Rotate the text." }, "placement": { "css": "text-placement", "type": [ "point", "line", "vertex", "interior" ], "default-value": "point", "doc": "Control the style of placement of a point versus the geometry it is attached to." }, "placement-type": { "css": "text-placement-type", "doc": "Re-position and/or re-size text to avoid overlaps. \"simple\" for basic algorithm (using text-placements string,) \"dummy\" to turn this feature off.", "type": [ "dummy", "simple", "list" ], "default-value": "dummy" }, "placements": { "css": "text-placements", "type": "string", "default-value": "", "doc": "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": { "css": "text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize" ], "doc": "Transform the case of the characters", "default-value": "none" }, "horizontal-alignment": { "css": "text-horizontal-alignment", "type": [ "left", "middle", "right", "auto" ], "doc": "The text's horizontal alignment from its centerpoint", "default-value": "auto" }, "justify-alignment": { "css": "text-align", "type": [ "left", "right", "center", "auto" ], "doc": "Define how text is justified", "default-value": "auto", "default-meaning": "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" }, "clip": { "css": "text-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "comp-op": { "css": "text-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "building": { "fill": { "css": "building-fill", "default-value": "#FFFFFF", "doc": "The color of the buildings walls.", "type": "color" }, "fill-opacity": { "css": "building-fill-opacity", "type": "float", "doc": "The opacity of the building as a whole, including all walls.", "default-value": 1 }, "height": { "css": "building-height", "doc": "The height of the building in pixels.", "type": "expression", "default-value": 0 } } }, "colors": { "aliceblue": [240, 248, 255], "antiquewhite": [250, 235, 215], "aqua": [0, 255, 255], "aquamarine": [127, 255, 212], "azure": [240, 255, 255], "beige": [245, 245, 220], "bisque": [255, 228, 196], "black": [0, 0, 0], "blanchedalmond": [255,235,205], "blue": [0, 0, 255], "blueviolet": [138, 43, 226], "brown": [165, 42, 42], "burlywood": [222, 184, 135], "cadetblue": [95, 158, 160], "chartreuse": [127, 255, 0], "chocolate": [210, 105, 30], "coral": [255, 127, 80], "cornflowerblue": [100, 149, 237], "cornsilk": [255, 248, 220], "crimson": [220, 20, 60], "cyan": [0, 255, 255], "darkblue": [0, 0, 139], "darkcyan": [0, 139, 139], "darkgoldenrod": [184, 134, 11], "darkgray": [169, 169, 169], "darkgreen": [0, 100, 0], "darkgrey": [169, 169, 169], "darkkhaki": [189, 183, 107], "darkmagenta": [139, 0, 139], "darkolivegreen": [85, 107, 47], "darkorange": [255, 140, 0], "darkorchid": [153, 50, 204], "darkred": [139, 0, 0], "darksalmon": [233, 150, 122], "darkseagreen": [143, 188, 143], "darkslateblue": [72, 61, 139], "darkslategrey": [47, 79, 79], "darkturquoise": [0, 206, 209], "darkviolet": [148, 0, 211], "deeppink": [255, 20, 147], "deepskyblue": [0, 191, 255], "dimgray": [105, 105, 105], "dimgrey": [105, 105, 105], "dodgerblue": [30, 144, 255], "firebrick": [178, 34, 34], "floralwhite": [255, 250, 240], "forestgreen": [34, 139, 34], "fuchsia": [255, 0, 255], "gainsboro": [220, 220, 220], "ghostwhite": [248, 248, 255], "gold": [255, 215, 0], "goldenrod": [218, 165, 32], "gray": [128, 128, 128], "grey": [128, 128, 128], "green": [0, 128, 0], "greenyellow": [173, 255, 47], "honeydew": [240, 255, 240], "hotpink": [255, 105, 180], "indianred": [205, 92, 92], "indigo": [75, 0, 130], "ivory": [255, 255, 240], "khaki": [240, 230, 140], "lavender": [230, 230, 250], "lavenderblush": [255, 240, 245], "lawngreen": [124, 252, 0], "lemonchiffon": [255, 250, 205], "lightblue": [173, 216, 230], "lightcoral": [240, 128, 128], "lightcyan": [224, 255, 255], "lightgoldenrodyellow": [250, 250, 210], "lightgray": [211, 211, 211], "lightgreen": [144, 238, 144], "lightgrey": [211, 211, 211], "lightpink": [255, 182, 193], "lightsalmon": [255, 160, 122], "lightseagreen": [32, 178, 170], "lightskyblue": [135, 206, 250], "lightslategray": [119, 136, 153], "lightslategrey": [119, 136, 153], "lightsteelblue": [176, 196, 222], "lightyellow": [255, 255, 224], "lime": [0, 255, 0], "limegreen": [50, 205, 50], "linen": [250, 240, 230], "magenta": [255, 0, 255], "maroon": [128, 0, 0], "mediumaquamarine": [102, 205, 170], "mediumblue": [0, 0, 205], "mediumorchid": [186, 85, 211], "mediumpurple": [147, 112, 219], "mediumseagreen": [60, 179, 113], "mediumslateblue": [123, 104, 238], "mediumspringgreen": [0, 250, 154], "mediumturquoise": [72, 209, 204], "mediumvioletred": [199, 21, 133], "midnightblue": [25, 25, 112], "mintcream": [245, 255, 250], "mistyrose": [255, 228, 225], "moccasin": [255, 228, 181], "navajowhite": [255, 222, 173], "navy": [0, 0, 128], "oldlace": [253, 245, 230], "olive": [128, 128, 0], "olivedrab": [107, 142, 35], "orange": [255, 165, 0], "orangered": [255, 69, 0], "orchid": [218, 112, 214], "palegoldenrod": [238, 232, 170], "palegreen": [152, 251, 152], "paleturquoise": [175, 238, 238], "palevioletred": [219, 112, 147], "papayawhip": [255, 239, 213], "peachpuff": [255, 218, 185], "peru": [205, 133, 63], "pink": [255, 192, 203], "plum": [221, 160, 221], "powderblue": [176, 224, 230], "purple": [128, 0, 128], "red": [255, 0, 0], "rosybrown": [188, 143, 143], "royalblue": [65, 105, 225], "saddlebrown": [139, 69, 19], "salmon": [250, 128, 114], "sandybrown": [244, 164, 96], "seagreen": [46, 139, 87], "seashell": [255, 245, 238], "sienna": [160, 82, 45], "silver": [192, 192, 192], "skyblue": [135, 206, 235], "slateblue": [106, 90, 205], "slategray": [112, 128, 144], "slategrey": [112, 128, 144], "snow": [255, 250, 250], "springgreen": [0, 255, 127], "steelblue": [70, 130, 180], "tan": [210, 180, 140], "teal": [0, 128, 128], "thistle": [216, 191, 216], "tomato": [255, 99, 71], "turquoise": [64, 224, 208], "violet": [238, 130, 238], "wheat": [245, 222, 179], "white": [255, 255, 255], "whitesmoke": [245, 245, 245], "yellow": [255, 255, 0], "yellowgreen": [154, 205, 50], "transparent": [0, 0, 0, 0] }, "filter": { "value": [ "true", "false", "null", "point", "linestring", "polygon", "collection" ] } } mapnik-reference-8.10.0/2.2.0/000077500000000000000000000000001342311331100154425ustar00rootroot00000000000000mapnik-reference-8.10.0/2.2.0/reference.json000066400000000000000000002536161342311331100203100ustar00rootroot00000000000000{ "version": "2.2.0", "style": { "filter-mode": { "type": [ "all", "first" ], "doc": "Control the processing behavior of Rule filters within a Style. If 'all' is used then all Rules are processed sequentially independent of whether any previous filters matched. If 'first' is used then it means processing ends after the first match (a positive filter evaluation) and no further Rules in the Style are processed ('first' is usually the default for CSS implementations on top of Mapnik to simplify translation from CSS to Mapnik XML)", "default-value": "all", "default-meaning": "All Rules in a Style are processed whether they have filters or not and whether or not the filter conditions evaluate to true." }, "image-filters": { "css": "image-filters", "default-value": "none", "default-meaning": "no filters", "type": "functions", "functions": [ ["agg-stack-blur", 2], ["emboss", 0], ["blur", 0], ["gray", 0], ["sobel", 0], ["edge-detect", 0], ["x-gradient", 0], ["y-gradient", 0], ["invert", 0], ["sharpen", 0], ["colorize-alpha", -1] ], "doc": "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": { "css": "direct-image-filters", "default-value": "none", "default-meaning": "no filters", "type": "functions", "functions": [ ["agg-stack-blur", 2], ["emboss", 0], ["blur", 0], ["gray", 0], ["sobel", 0], ["edge-detect", 0], ["x-gradient", 0], ["y-gradient", 0], ["invert", 0], ["sharpen", 0], ["colorize-alpha", -1] ], "doc": "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": { "css": "comp-op", "default-value": "src-over", "default-meaning": "add the current layer on top of other layers", "doc": "Composite operation. This defines how this layer should behave relative to layers atop or below it.", "type": ["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" ] }, "opacity": { "css": "opacity", "type": "float", "doc": "An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer)", "default-value": 1, "default-meaning": "no separate buffer will be used and no alpha will be applied to the style after rendering" } }, "layer" : { "name": { "default-value": "", "type":"string", "required" : true, "default-meaning": "No layer name has been provided", "doc": "The name of a layer. Can be anything you wish and is not strictly validated, but ideally unique in the map" }, "srs": { "default-value": "", "type":"string", "default-meaning": "No srs value is provided and the value will be inherited from the Map's srs", "doc": "The spatial reference system definition for the layer, aka the projection. Can either be a proj4 literal string like '+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs' or, if the proper proj4 epsg/nad/etc identifier files are installed, a string that uses an id like: '+init=epsg:4326'" }, "status": { "default-value": true, "type":"boolean", "default-meaning": "This layer will be marked as active and available for processing", "doc": "A property that can be set to false to disable this layer from being processed" }, "minzoom": { "default-value": 0, "type":"float", "default-meaning": "The layer will be visible at the minimum possible scale", "doc": "The minimum scale denominator that this layer will be visible at. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6" }, "maxzoom": { "default-value": "1.79769e+308", "type":"float", "default-meaning": "The layer will be visible at the maximum possible scale", "doc": "The maximum scale denominator that this layer will be visible at. The default is the numeric limit of the C++ double type, which may vary slightly by system, but is likely a massive number like 1.79769e+308 and ensures that this layer will always be visible unless the value is reduced. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6" }, "queryable": { "default-value": false, "type":"boolean", "default-meaning": "The layer will not be available for the direct querying of data values", "doc": "This property was added for GetFeatureInfo/WMS compatibility and is rarely used. It is off by default meaning that in a WMS context the layer will not be able to be queried unless the property is explicitly set to true" }, "clear-label-cache": { "default-value": false, "type":"boolean", "default-meaning": "The renderer's collision detector cache (used for avoiding duplicate labels and overlapping markers) will not be cleared immediately before processing this layer", "doc": "This property, by default off, can be enabled to allow a user to clear the collision detector cache before a given layer is processed. This may be desirable to ensure that a given layers data shows up on the map even if it normally would not because of collisions with previously rendered labels or markers" }, "group-by": { "default-value": "", "type":"string", "default-meaning": "No special layer grouping will be used during rendering", "doc": "https://github.com/mapnik/mapnik/wiki/Grouped-rendering" }, "buffer-size": { "default-value": 0, "type":"float", "default-meaning": "No custom buffer will be used for the layer and rather the Map buffer-size will be used", "doc": "Extra tolerance around the Layer extent (in pixels) used when querying the layer data during rendering. If set this will override the Map buffer-size" }, "maximum-extent": { "default-value": "none", "type":"bbox", "default-meaning": "No clipping extent will be used", "doc": "An extent to be used to limit the bounds used to query this specific layer data during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Layer." } }, "symbolizers" : { "map": { "background-color": { "css": "background-color", "default-value": "none", "default-meaning": "transparent", "type": "color", "doc": "Map Background color" }, "background-image": { "css": "background-image", "type": "uri", "default-value": "", "default-meaning": "transparent", "doc": "An image that is repeated below all features on a map as a background." }, "srs": { "css": "srs", "type": "string", "default-value": "+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs", "default-meaning": "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", "doc": "Map spatial reference (proj4 string)" }, "buffer-size": { "css": "buffer-size", "default-value": 0, "type":"float", "default-meaning": "No buffer will be used", "doc": "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": { "css": "", "default-value": "none", "type":"bbox", "default-meaning": "No clipping extent will be used", "doc": "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": { "css": "base", "default-value": "", "default-meaning": "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.", "type": "string", "doc": "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." }, "paths-from-xml": { "css": "", "default-value": true, "default-meaning": "Paths read from XML will be interpreted from the location of the XML", "type": "boolean", "doc": "value to control whether paths in the XML will be interpreted from the location of the XML or from the working directory of the program that calls load_map()" }, "minimum-version": { "css": "", "default-value": "none", "default-meaning": "Mapnik version will not be detected and no error will be thrown about compatibility", "type": "string", "doc": "The minumum Mapnik version (e.g. 0.7.2) needed to use certain functionality in the stylesheet" }, "font-directory": { "css": "font-directory", "type": "uri", "default-value": "none", "default-meaning": "No map-specific fonts will be registered", "doc": "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": { "default": { "css": "polygon", "type": [ "auto", "none" ], "doc": "Allows omitting a polygon symbolizer rule or emitting it with default values.", "status": "unstable" }, "fill": { "css": "polygon-fill", "type": "color", "default-value": "rgba(128,128,128,1)", "default-meaning": "gray and fully opaque (alpha = 1), same as rgb(128,128,128)", "doc": "Fill color to assign to a polygon" }, "fill-opacity": { "css": "polygon-opacity", "type": "float", "doc": "The opacity of the polygon", "default-value": 1, "default-meaning": "opaque" }, "gamma": { "css": "polygon-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of polygon edges" }, "gamma-method": { "css": "polygon-gamma-method", "type": [ "power", "linear", "none", "threshold", "multiply" ], "default-value": "power", "default-meaning": "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", "doc": "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" }, "clip": { "css": "polygon-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "simplify": { "css": "polygon-simplify", "type": "float", "default-value": 0.0, "default-meaning": "geometry will not be simplified", "doc": "geometries are simplified by the given tolerance" }, "simplify-algorithm": { "css": "polygon-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt" ], "default-value": "radial-distance", "default-meaning": "geometry will not be simplified using the radial distance algorithm", "doc": "geometries are simplified by the given algorithm" }, "smooth": { "css": "polygon-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "polygon-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "geometry will not be transformed", "doc": "Allows transformation functions to be applied to the geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "polygon-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "line": { "default": { "css": "line", "type": [ "auto", "none" ], "doc": "Allows omitting a line symbolizer rule or emitting it with default values.", "status": "unstable" }, "stroke": { "css": "line-color", "default-value": "rgba(0,0,0,1)", "type": "color", "default-meaning": "black and fully opaque (alpha = 1), same as rgb(0,0,0)", "doc": "The color of a drawn line" }, "stroke-width": { "css": "line-width", "default-value": 1, "type": "float", "doc": "The width of a line in pixels" }, "stroke-opacity": { "css": "line-opacity", "default-value": 1, "type": "float", "default-meaning": "opaque", "doc": "The opacity of a line" }, "stroke-linejoin": { "css": "line-join", "default-value": "miter", "type": [ "miter", "round", "bevel" ], "doc": "The behavior of lines when joining" }, "stroke-linecap": { "css": "line-cap", "default-value": "butt", "type": [ "butt", "round", "square" ], "doc": "The display of line endings" }, "stroke-gamma": { "css": "line-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of stroke line" }, "stroke-gamma-method": { "css": "line-gamma-method", "type": [ "power", "linear", "none", "threshold", "multiply" ], "default-value": "power", "default-meaning": "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", "doc": "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" }, "stroke-dasharray": { "css": "line-dasharray", "type": "numbers", "doc": "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.", "default-value": "none", "default-meaning": "solid line" }, "stroke-dashoffset": { "css": "line-dash-offset", "type": "numbers", "doc": "valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled)", "default-value": "none", "default-meaning": "solid line" }, "stroke-miterlimit": { "css": "line-miterlimit", "type": "float", "doc": "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.", "default-value": 4.0, "default-meaning": "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 )'" }, "clip": { "css": "line-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "simplify": { "css": "line-simplify", "type": "float", "default-value": 0.0, "default-meaning": "geometry will not be simplified", "doc": "geometries are simplified by the given tolerance" }, "simplify-algorithm": { "css": "line-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt" ], "default-value": "radial-distance", "default-meaning": "geometry will not be simplified using the radial distance algorithm", "doc": "geometries are simplified by the given algorithm" }, "smooth": { "css": "line-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "offset": { "css": "line-offset", "type": "float", "default-value": 0, "default-meaning": "no offset", "doc": "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)." }, "rasterizer": { "css": "line-rasterizer", "type": [ "full", "fast" ], "default-value": "full", "doc": "Exposes an alternate AGG rendering method that sacrifices some accuracy for speed." }, "geometry-transform": { "css": "line-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "geometry will not be transformed", "doc": "Allows transformation functions to be applied to the geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "line-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "markers": { "default": { "css": "marker", "type": [ "auto", "none" ], "doc": "Allows omitting a marker symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "marker-file", "doc": "An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse.", "default-value": "", "default-meaning": "An ellipse or circle, if width equals height", "type": "uri" }, "opacity": { "css": "marker-opacity", "doc": "The overall opacity of the marker, overrides both the opacity of the fill and the opacity of the stroke.", "default-value": 1, "default-meaning": "The stroke-opacity and fill-opacity will be used", "type": "float" }, "fill-opacity": { "css": "marker-fill-opacity", "doc": "The fill opacity of the marker", "default-value": 1, "default-meaning": "opaque", "type": "float" }, "stroke": { "css": "marker-line-color", "doc": "The color of the stroke around a marker shape.", "default-value": "black", "type": "color" }, "stroke-width": { "css": "marker-line-width", "default-value": 0.5, "doc": "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.", "type": "float" }, "stroke-opacity": { "css": "marker-line-opacity", "default-value": 1, "default-meaning": "opaque", "doc": "The opacity of a line", "type": "float" }, "placement": { "css": "marker-placement", "type": [ "point", "line", "interior" ], "default-value": "point", "default-meaning": "Place markers at the center point (centroid) of the geometry", "doc": "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" }, "multi-policy": { "css": "marker-multi-policy", "type": [ "each", "whole", "largest" ], "default-value": "each", "default-meaning": "If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each", "doc": "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": { "css": "marker-type", "type": [ "arrow", "ellipse" ], "default-value": "ellipse", "doc": "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)" }, "width": { "css": "marker-width", "default-value": 10, "doc": "The width of the marker, if using one of the default types.", "type": "float", "expression":true }, "height": { "css": "marker-height", "default-value": 10, "doc": "The height of the marker, if using one of the default types.", "type": "float", "expression":true }, "fill": { "css": "marker-fill", "default-value": "blue", "doc": "The color of the area of the marker.", "type": "color" }, "allow-overlap": { "css": "marker-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping markers are shown or hidden.", "default-meaning": "Do not allow makers to overlap with each other - overlapping markers will not be shown." }, "ignore-placement": { "css": "marker-ignore-placement", "type": "boolean", "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache", "doc": "value to control whether the placement of the feature will prevent the placement of other features" }, "spacing": { "css": "marker-spacing", "doc": "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", "default-value": 100, "type": "float" }, "max-error": { "css": "marker-max-error", "type": "float", "default-value": 0.2, "doc": "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." }, "transform": { "css": "marker-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "", "default-meaning": "No transformation", "doc": "SVG transformation definition" }, "clip": { "css": "marker-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "smooth": { "css": "marker-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "marker-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "geometry will not be transformed", "doc": "Allows transformation functions to be applied to the geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "marker-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "shield": { "default": { "css": "shield", "type": [ "none" ], "doc": "Allows omitting a shield symbolizer.", "status": "unstable" }, "name": { "css": "shield-name", "type": "string", "expression":true, "serialization": "content", "default-value": "", "doc": "Value to use for a shield\"s text label. Data columns are specified using brackets like [column_name]" }, "file": { "css": "shield-file", "required": true, "type": "uri", "default-value": "none", "doc": "Image file to render behind the shield text" }, "face-name": { "css": "shield-face-name", "type": "string", "validate": "font", "doc": "Font name and style to use for the shield text", "default-value": "", "required": true }, "unlock-image": { "css": "shield-unlock-image", "type": "boolean", "doc": "This parameter should be set to true if you are trying to position text beside rather than on top of the shield image", "default-value": false, "default-meaning": "text alignment relative to the shield image uses the center of the image as the anchor for text positioning." }, "size": { "css": "shield-size", "type": "float", "default-value": 10, "doc": "The size of the shield text in pixels" }, "fill": { "css": "shield-fill", "type": "color", "default-value": "black", "doc": "The color of the shield text" }, "placement": { "css": "shield-placement", "type": [ "point", "line", "vertex", "interior" ], "default-value": "point", "doc": "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." }, "avoid-edges": { "css": "shield-avoid-edges", "doc": "Avoid placing shields that intersect with tile boundaries.", "type": "boolean", "default-value": false }, "allow-overlap": { "css": "shield-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping shields are shown or hidden.", "default-meaning": "Do not allow shields to overlap with other map elements already placed." }, "minimum-distance": { "css": "shield-min-distance", "type": "float", "default-value": 0, "doc": "Minimum distance to the next shield symbol, not necessarily the same shield." }, "spacing": { "css": "shield-spacing", "type": "float", "default-value": 0, "doc": "The spacing between repeated occurrences of the same shield on a line" }, "minimum-padding": { "css": "shield-min-padding", "default-value": 0, "doc": "Minimum distance a shield will be placed from the edge of a metatile.", "type": "float" }, "wrap-width": { "css": "shield-wrap-width", "type": "unsigned", "default-value": 0, "doc": "Length of a chunk of text in characters before wrapping text" }, "wrap-before": { "css": "shield-wrap-before", "type": "boolean", "default-value": false, "doc": "Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width." }, "wrap-character": { "css": "shield-wrap-character", "type": "string", "default-value": " ", "doc": "Use this character instead of a space to wrap long names." }, "halo-fill": { "css": "shield-halo-fill", "type": "color", "default-value": "#FFFFFF", "default-meaning": "white", "doc": "Specifies the color of the halo around the text." }, "halo-radius": { "css": "shield-halo-radius", "doc": "Specify the radius of the halo in pixels", "default-value": 0, "default-meaning": "no halo", "type": "float" }, "character-spacing": { "css": "shield-character-spacing", "type": "unsigned", "default-value": 0, "doc": "Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement." }, "line-spacing": { "css": "shield-line-spacing", "default-value": 0, "doc": "Vertical spacing between lines of multiline labels (in pixels)", "type": "float" }, "dx": { "css": "shield-text-dx", "type": "float", "doc": "Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right", "default-value": 0 }, "dy": { "css": "shield-text-dy", "type": "float", "doc": "Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down", "default-value": 0 }, "shield-dx": { "css": "shield-dx", "type": "float", "doc": "Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right", "default-value": 0 }, "shield-dy": { "css": "shield-dy", "type": "float", "doc": "Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down", "default-value": 0 }, "opacity": { "css": "shield-opacity", "type": "float", "doc": "The opacity of the image used for the shield", "default-value": 1 }, "text-opacity": { "css": "shield-text-opacity", "type": "float", "doc": "The opacity of the text placed on top of the shield", "default-value": 1 }, "horizontal-alignment": { "css": "shield-horizontal-alignment", "type": [ "left", "middle", "right", "auto" ], "doc": "The shield's horizontal alignment from its centerpoint", "default-value": "auto" }, "vertical-alignment": { "css": "shield-vertical-alignment", "type": [ "top", "middle", "bottom", "auto" ], "doc": "The shield's vertical alignment from its centerpoint", "default-value": "middle" }, "placement-type": { "css": "shield-placement-type", "doc": "Re-position and/or re-size shield to avoid overlaps. \"simple\" for basic algorithm (using shield-placements string,) \"dummy\" to turn this feature off.", "type": [ "dummy", "simple" ], "default-value": "dummy" }, "placements": { "css": "shield-placements", "type": "string", "default-value": "", "doc": "If \"placement-type\" is set to \"simple\", use this \"POSITIONS,[SIZES]\" string. An example is `shield-placements: \"E,NE,SE,W,NW,SW\";` " }, "text-transform": { "css": "shield-text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize" ], "doc": "Transform the case of the characters", "default-value": "none" }, "justify-alignment": { "css": "shield-justify-alignment", "type": [ "left", "center", "right", "auto" ], "doc": "Define how text in a shield's label is justified", "default-value": "auto" }, "transform": { "css": "shield-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "", "default-meaning": "No transformation", "doc": "SVG transformation definition" }, "clip": { "css": "shield-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "comp-op": { "css": "shield-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "line-pattern": { "default": { "css": "line-pattern", "type": [ "none" ], "doc": "Allows omitting a line pattern symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "line-pattern-file", "type": "uri", "default-value": "none", "required": true, "doc": "An image file to be repeated and warped along a line" }, "clip": { "css": "line-pattern-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "simplify": { "css": "line-pattern-simplify", "type": "float", "default-value": 0.0, "default-meaning": "geometry will not be simplified", "doc": "geometries are simplified by the given tolerance" }, "simplify-algorithm": { "css": "line-pattern-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt" ], "default-value": "radial-distance", "default-meaning": "geometry will not be simplified using the radial distance algorithm", "doc": "geometries are simplified by the given algorithm" }, "smooth": { "css": "line-pattern-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "line-pattern-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "geometry will not be transformed", "doc": "Allows transformation functions to be applied to the geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "line-pattern-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "polygon-pattern": { "default": { "css": "polygon-pattern", "type": [ "none" ], "doc": "Allows omitting a polygon pattern symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "polygon-pattern-file", "type": "uri", "default-value": "none", "required": true, "doc": "Image to use as a repeated pattern fill within a polygon" }, "alignment": { "css": "polygon-pattern-alignment", "type": [ "local", "global" ], "default-value": "local", "doc": "Specify whether to align pattern fills to the layer or to the map." }, "gamma": { "css": "polygon-pattern-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of polygon pattern edges" }, "opacity": { "css": "polygon-pattern-opacity", "type": "float", "doc": "Apply an opacity level to the image used for the pattern", "default-value": 1, "default-meaning": "The image is rendered without modifications" }, "clip": { "css": "polygon-pattern-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "simplify": { "css": "polygon-pattern-simplify", "type": "float", "default-value": 0.0, "default-meaning": "geometry will not be simplified", "doc": "geometries are simplified by the given tolerance" }, "simplify-algorithm": { "css": "polygon-pattern-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt" ], "default-value": "radial-distance", "default-meaning": "geometry will not be simplified using the radial distance algorithm", "doc": "geometries are simplified by the given algorithm" }, "smooth": { "css": "polygon-pattern-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "polygon-pattern-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "geometry will not be transformed", "doc": "Allows transformation functions to be applied to the geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "polygon-pattern-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "raster": { "default": { "css": "raster", "type": [ "auto", "none" ], "doc": "Allows omitting a raster symbolizer rule or emitting it with default values.", "status": "unstable" }, "opacity": { "css": "raster-opacity", "default-value": 1, "default-meaning": "opaque", "type": "float", "doc": "The opacity of the raster symbolizer on top of other symbolizers." }, "filter-factor": { "css": "raster-filter-factor", "default-value": -1, "default-meaning": "Allow the datasource to choose appropriate downscaling.", "type": "float", "doc": "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." }, "scaling": { "css": "raster-scaling", "type": [ "near", "fast", "bilinear", "bilinear8", "bicubic", "spline16", "spline36", "hanning", "hamming", "hermite", "kaiser", "quadric", "catrom", "gaussian", "bessel", "mitchell", "sinc", "lanczos", "blackman" ], "default-value": "near", "doc": "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." }, "mesh-size": { "css": "raster-mesh-size", "default-value": 16, "default-meaning": "Reprojection mesh will be 1/16 of the resolution of the source image", "type": "unsigned", "doc": "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." }, "comp-op": { "css": "raster-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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-mode": { "css": "raster-colorizer-default-mode", "type": [ "discrete", "linear", "exact" ], "doc": "This can be either `discrete`, `linear` or `exact`. If it is not specified then the default is `linear`.", "default-value": "linear", "default-meaning": "A linear interpolation is used to generate colors between the two nearest stops." }, "default-color": { "css": "raster-colorizer-default-color", "type": "color", "doc": "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", "default-value": "transparent", "default-meaning": "Pixels that are not colored by the colorizer stops will be transparent" }, "epsilon": { "css": "raster-colorizer-epsilon", "type": "float", "doc": "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.", "default-value": "1.1920928955078125e-07", "default-meaning": "Pixels must very closely match the stop filter otherwise they will not be colored." }, "stop": { "css": "raster-colorizer-stops", "type": "tags", "serialization": "tag", "tagname": "tagname", "doc": "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)`.", "default-value": "", "default-meaning": "No colorization will happen without supplying stops." } }, "point": { "default": { "css": "point", "type": [ "auto", "none" ], "doc": "Allows omitting a point symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "point-file", "type": "uri", "required": false, "default-value": "none", "doc": "Image file to represent a point" }, "allow-overlap": { "css": "point-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping points are shown or hidden.", "default-meaning": "Do not allow points to overlap with each other - overlapping markers will not be shown." }, "ignore-placement": { "css": "point-ignore-placement", "type": "boolean", "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache", "doc": "value to control whether the placement of the feature will prevent the placement of other features" }, "opacity": { "css": "point-opacity", "type": "float", "default-value": 1.0, "default-meaning": "Fully opaque", "doc": "A value from 0 to 1 to control the opacity of the point" }, "placement": { "css": "point-placement", "type": [ "centroid", "interior" ], "doc": "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.", "default-value": "centroid" }, "transform": { "css": "point-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "", "default-meaning": "No transformation", "doc": "SVG transformation definition" }, "comp-op": { "css": "point-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "text": { "default": { "css": "text", "type": [ "none" ], "doc": "Allows omitting a text symbolizer rule.", "status": "unstable" }, "name": { "css": "text-name", "type": "string", "expression":true, "required": true, "default-value": "", "serialization": "content", "doc": "Value to use for a text label. Data columns are specified using brackets like [column_name]" }, "face-name": { "css": "text-face-name", "type": "string", "validate": "font", "default-value": "", "doc": "Font name and style to render a label in", "required": true }, "size": { "css": "text-size", "type": "float", "default-value": 10, "doc": "Text size in pixels" }, "text-ratio": { "css": "text-ratio", "doc": "Define the amount of text (of the total) present on successive lines when wrapping occurs", "default-value": 0, "type": "unsigned" }, "wrap-width": { "css": "text-wrap-width", "doc": "Length of a chunk of text in characters before wrapping text", "default-value": 0, "type": "unsigned" }, "wrap-before": { "css": "text-wrap-before", "type": "boolean", "default-value": false, "doc": "Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width." }, "wrap-character": { "css": "text-wrap-character", "type": "string", "default-value": " ", "doc": "Use this character instead of a space to wrap long text." }, "spacing": { "css": "text-spacing", "type": "unsigned", "default-value": 0, "doc": "Distance between repeated text labels on a line (aka. label-spacing)" }, "character-spacing": { "css": "text-character-spacing", "type": "float", "default-value": 0, "doc": "Horizontal spacing adjustment between characters in pixels" }, "line-spacing": { "css": "text-line-spacing", "default-value": 0, "type": "float", "doc": "Vertical spacing adjustment between lines in pixels" }, "label-position-tolerance": { "css": "text-label-position-tolerance", "default-value": 0, "type": "unsigned", "doc": "Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line)" }, "max-char-angle-delta": { "css": "text-max-char-angle-delta", "type": "float", "default-value": "22.5", "doc": "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." }, "fill": { "css": "text-fill", "doc": "Specifies the color for the text", "default-value": "#000000", "type": "color" }, "opacity": { "css": "text-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text", "default-value": 1.0, "default-meaning": "Fully opaque", "type": "float" }, "halo-fill": { "css": "text-halo-fill", "type": "color", "default-value": "#FFFFFF", "default-meaning": "white", "doc": "Specifies the color of the halo around the text." }, "halo-radius": { "css": "text-halo-radius", "doc": "Specify the radius of the halo in pixels", "default-value": 0, "default-meaning": "no halo", "type": "float" }, "halo-rasterizer": { "css": "text-halo-rasterizer", "type": [ "full", "fast" ], "default-value": "full", "doc": "Exposes an alternate text halo rendering method that sacrifices quality for speed." }, "dx": { "css": "text-dx", "type": "float", "doc": "Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right", "default-value": 0 }, "dy": { "css": "text-dy", "type": "float", "doc": "Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down", "default-value": 0 }, "vertical-alignment": { "css": "text-vertical-alignment", "type": [ "top", "middle", "bottom", "auto" ], "doc": "Position of label relative to point position.", "default-value": "auto", "default-meaning": "Default affected by value of dy; \"bottom\" for dy>0, \"top\" for dy<0." }, "avoid-edges": { "css": "text-avoid-edges", "doc": "Avoid placing labels that intersect with tile boundaries.", "default-value": false, "type": "boolean" }, "minimum-distance": { "css": "text-min-distance", "doc": "Minimum permitted distance to the next text symbolizer.", "default-value": 0, "type": "float" }, "minimum-padding": { "css": "text-min-padding", "doc": "Minimum distance a text label will be placed from the edge of a metatile.", "default-value": 0, "type": "float" }, "minimum-path-length": { "css": "text-min-path-length", "type": "float", "default-value": 0, "default-meaning": "place labels on all paths", "doc": "Place labels only on paths longer than this value." }, "allow-overlap": { "css": "text-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping text is shown or hidden.", "default-meaning": "Do not allow text to overlap with other text - overlapping markers will not be shown." }, "orientation": { "css": "text-orientation", "type": "float", "expression":true, "default-value": 0, "doc": "Rotate the text." }, "placement": { "css": "text-placement", "type": [ "point", "line", "vertex", "interior" ], "default-value": "point", "doc": "Control the style of placement of a point versus the geometry it is attached to." }, "placement-type": { "css": "text-placement-type", "doc": "Re-position and/or re-size text to avoid overlaps. \"simple\" for basic algorithm (using text-placements string,) \"dummy\" to turn this feature off.", "type": [ "dummy", "simple" ], "default-value": "dummy" }, "placements": { "css": "text-placements", "type": "string", "default-value": "", "doc": "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": { "css": "text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize" ], "doc": "Transform the case of the characters", "default-value": "none" }, "horizontal-alignment": { "css": "text-horizontal-alignment", "type": [ "left", "middle", "right", "auto" ], "doc": "The text's horizontal alignment from its centerpoint", "default-value": "auto" }, "justify-alignment": { "css": "text-align", "type": [ "left", "right", "center", "auto" ], "doc": "Define how text is justified", "default-value": "auto", "default-meaning": "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" }, "clip": { "css": "text-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "comp-op": { "css": "text-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "building": { "default": { "css": "building", "type": [ "auto", "none" ], "doc": "Allows omitting a building symbolizer rule or emitting it with default values.", "status": "unstable" }, "fill": { "css": "building-fill", "default-value": "#FFFFFF", "doc": "The color of the buildings walls.", "type": "color" }, "fill-opacity": { "css": "building-fill-opacity", "type": "float", "doc": "The opacity of the building as a whole, including all walls.", "default-value": 1 }, "height": { "css": "building-height", "doc": "The height of the building in pixels.", "type": "float", "expression":true, "default-value": 0 } }, "debug": { "mode": { "css": "debug-mode", "type": [ "collision", "vertex" ], "default-value": "collision", "doc": "The mode for debug rendering" } } }, "colors": { "aliceblue": [240, 248, 255], "antiquewhite": [250, 235, 215], "aqua": [0, 255, 255], "aquamarine": [127, 255, 212], "azure": [240, 255, 255], "beige": [245, 245, 220], "bisque": [255, 228, 196], "black": [0, 0, 0], "blanchedalmond": [255,235,205], "blue": [0, 0, 255], "blueviolet": [138, 43, 226], "brown": [165, 42, 42], "burlywood": [222, 184, 135], "cadetblue": [95, 158, 160], "chartreuse": [127, 255, 0], "chocolate": [210, 105, 30], "coral": [255, 127, 80], "cornflowerblue": [100, 149, 237], "cornsilk": [255, 248, 220], "crimson": [220, 20, 60], "cyan": [0, 255, 255], "darkblue": [0, 0, 139], "darkcyan": [0, 139, 139], "darkgoldenrod": [184, 134, 11], "darkgray": [169, 169, 169], "darkgreen": [0, 100, 0], "darkgrey": [169, 169, 169], "darkkhaki": [189, 183, 107], "darkmagenta": [139, 0, 139], "darkolivegreen": [85, 107, 47], "darkorange": [255, 140, 0], "darkorchid": [153, 50, 204], "darkred": [139, 0, 0], "darksalmon": [233, 150, 122], "darkseagreen": [143, 188, 143], "darkslateblue": [72, 61, 139], "darkslategrey": [47, 79, 79], "darkturquoise": [0, 206, 209], "darkviolet": [148, 0, 211], "deeppink": [255, 20, 147], "deepskyblue": [0, 191, 255], "dimgray": [105, 105, 105], "dimgrey": [105, 105, 105], "dodgerblue": [30, 144, 255], "firebrick": [178, 34, 34], "floralwhite": [255, 250, 240], "forestgreen": [34, 139, 34], "fuchsia": [255, 0, 255], "gainsboro": [220, 220, 220], "ghostwhite": [248, 248, 255], "gold": [255, 215, 0], "goldenrod": [218, 165, 32], "gray": [128, 128, 128], "grey": [128, 128, 128], "green": [0, 128, 0], "greenyellow": [173, 255, 47], "honeydew": [240, 255, 240], "hotpink": [255, 105, 180], "indianred": [205, 92, 92], "indigo": [75, 0, 130], "ivory": [255, 255, 240], "khaki": [240, 230, 140], "lavender": [230, 230, 250], "lavenderblush": [255, 240, 245], "lawngreen": [124, 252, 0], "lemonchiffon": [255, 250, 205], "lightblue": [173, 216, 230], "lightcoral": [240, 128, 128], "lightcyan": [224, 255, 255], "lightgoldenrodyellow": [250, 250, 210], "lightgray": [211, 211, 211], "lightgreen": [144, 238, 144], "lightgrey": [211, 211, 211], "lightpink": [255, 182, 193], "lightsalmon": [255, 160, 122], "lightseagreen": [32, 178, 170], "lightskyblue": [135, 206, 250], "lightslategray": [119, 136, 153], "lightslategrey": [119, 136, 153], "lightsteelblue": [176, 196, 222], "lightyellow": [255, 255, 224], "lime": [0, 255, 0], "limegreen": [50, 205, 50], "linen": [250, 240, 230], "magenta": [255, 0, 255], "maroon": [128, 0, 0], "mediumaquamarine": [102, 205, 170], "mediumblue": [0, 0, 205], "mediumorchid": [186, 85, 211], "mediumpurple": [147, 112, 219], "mediumseagreen": [60, 179, 113], "mediumslateblue": [123, 104, 238], "mediumspringgreen": [0, 250, 154], "mediumturquoise": [72, 209, 204], "mediumvioletred": [199, 21, 133], "midnightblue": [25, 25, 112], "mintcream": [245, 255, 250], "mistyrose": [255, 228, 225], "moccasin": [255, 228, 181], "navajowhite": [255, 222, 173], "navy": [0, 0, 128], "oldlace": [253, 245, 230], "olive": [128, 128, 0], "olivedrab": [107, 142, 35], "orange": [255, 165, 0], "orangered": [255, 69, 0], "orchid": [218, 112, 214], "palegoldenrod": [238, 232, 170], "palegreen": [152, 251, 152], "paleturquoise": [175, 238, 238], "palevioletred": [219, 112, 147], "papayawhip": [255, 239, 213], "peachpuff": [255, 218, 185], "peru": [205, 133, 63], "pink": [255, 192, 203], "plum": [221, 160, 221], "powderblue": [176, 224, 230], "purple": [128, 0, 128], "red": [255, 0, 0], "rosybrown": [188, 143, 143], "royalblue": [65, 105, 225], "saddlebrown": [139, 69, 19], "salmon": [250, 128, 114], "sandybrown": [244, 164, 96], "seagreen": [46, 139, 87], "seashell": [255, 245, 238], "sienna": [160, 82, 45], "silver": [192, 192, 192], "skyblue": [135, 206, 235], "slateblue": [106, 90, 205], "slategray": [112, 128, 144], "slategrey": [112, 128, 144], "snow": [255, 250, 250], "springgreen": [0, 255, 127], "steelblue": [70, 130, 180], "tan": [210, 180, 140], "teal": [0, 128, 128], "thistle": [216, 191, 216], "tomato": [255, 99, 71], "turquoise": [64, 224, 208], "violet": [238, 130, 238], "wheat": [245, 222, 179], "white": [255, 255, 255], "whitesmoke": [245, 245, 245], "yellow": [255, 255, 0], "yellowgreen": [154, 205, 50], "transparent": [0, 0, 0, 0] }, "filter": { "value": [ "true", "false", "null", "point", "linestring", "polygon", "collection" ] } } mapnik-reference-8.10.0/2.3.0/000077500000000000000000000000001342311331100154435ustar00rootroot00000000000000mapnik-reference-8.10.0/2.3.0/datasources.json000066400000000000000000000402141342311331100206540ustar00rootroot00000000000000{ "datasources": { "csv": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem" }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values" }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)" }, "strict": { "type": "boolean", "doc": "Control if the datasource should throw on invalid rows", "default-value": false, "default-meaning": "Unless this option is set to true the datasource will skip invalid rows and attempt to parse as much data as possible" }, "inline": { "type": "string", "doc": "Raw tabular data to be read instead of reading data from a file", "default-value": "", "default-meaning": "Unless this option is provided data will be read from the `file` option" }, "escape": { "type": "string", "doc": "The escape character to use for parsing data", "default-value": "A single backslash (aka. reverse solidus): \\", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "quote": { "type": "string", "doc": "The quote character to use for parsing data", "default-value": "A quotation mark (aka. double quote): \"", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "separator": { "type": "string", "doc": "The separator character to use for parsing data", "default-value": "Basic autodetection is used to determine the best default value if the user does not manually supply a separator.", "default-meaning": "A comma will be used unless more tabs (\t), pipes (|), or semicolons (;) are detected than commas in the header row (in that order of preference)" }, "headers": { "type": "string", "doc": "A comma separated list of header names that can be set to add headers to data that lacks them", "default-value": "", "default-meaning": "Headers will be parsed from the first line of the data unless this option is set" }, "filesize_max": { "type": "float", "doc": "The maximum filesize in MB that will be accepted", "default-value": 20, "default-meaning": "A file that is larger that 20 MB will not be accepted and an error will be throw unless the user manually passes this option with a larger value (useful only in cases where your machine has a lot of memory)" } }, "gdal": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem" }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values" } }, "geojson": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem" }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values" } }, "occi": { "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values" } }, "ogr": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem" }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values" } }, "osm": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem" }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values" } }, "postgis": { "table": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": true }, "key_field": { "type": "boolean", "doc": "", "default-value": "", "default-meaning": "" }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values" }, "dbname": { "type": "string", "doc": "Database name", "default-value": "username", "default-meaning": "Will default to a database named after the user (as per libpq defaults)", "required": false }, "host": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "password": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "port": { "type": "unsigned", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "user": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "connect_timeout": { "type": "unsigned", "doc": "", "default-value": 4, "default-meaning": "", "required": false }, "schema": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "extent": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "estimate_extent": { "type": "boolean", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "geometry_table": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "geometry_field": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "cursor_size": { "type": "unsigned", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "srid": { "type": "unsigned", "doc": "", "default-value": 0, "default-meaning": "", "required": false }, "initial_size": { "type": "unsigned", "doc": "", "default-value": 1, "default-meaning": "", "required": false }, "max_size": { "type": "unsigned", "doc": "", "default-value": 10, "default-meaning": "", "required": false }, "simplify_geometries": { "type": "boolean", "doc": "", "default-value": false, "default-meaning": "", "required": false }, "autodetect_key_field": { "type": "boolean", "doc": "", "default-value": false, "default-meaning": "", "required": false }, "persist_connection": { "type": "boolean", "doc": "", "default-value": true, "default-meaning": "Connections, successfully created, will be kept open until Mapnik shuts down", "required": false }, "extent_from_subquery": { "type": "boolean", "doc": "", "default-value": false, "default-meaning": "", "required": false } }, "python": { "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values" } }, "raster": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem" } }, "rasterlite": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem" } }, "shape": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem" }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values" } }, "sqlite": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem" }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values" }, "table": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": true }, "key_field": { "type": "boolean", "doc": "", "default-value": "", "default-meaning": "" } } } }mapnik-reference-8.10.0/2.3.0/datasources.template.json000066400000000000000000000277621342311331100225030ustar00rootroot00000000000000{ "types": { "type": { "type": "string", "doc": "The type of the option", "values": ["string","float","boolean","unsigned"], "required": true }, "doc": { "type": "string", "doc": "The basic description of the option and the expected behavior if you provide it", "required": true }, "default-value": { "type": "string", "doc": "Either an empty string if there is no default value, a description of the default value, or the default value itself (if appropriate)", "required": true }, "default-meaning": { "type": "string", "doc": "A detailed description of what the behavior will be if the default value is left unchanged", "required": true }, "required": { "type": "boolean", "doc": "A boolean value to signify if the option is required. Can be left out and if not present it will be assumed that the option is not required", "required": false }, "recommended": { "type": "boolean", "doc": "A boolean value to signify if the option is recommended, even if it is not required. This is meant to indicate to users that better behavior or performance will be gained if they manually provide the option and that they should seek to understand why it exists (and also why/how it needs to be manually provided)", "required": false } }, "variables": { "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values" }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)" }, "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem" }, "extent" : { "type": "string", "doc": "A comma or space delimited bounding box in the format of minx,miny,maxx,maxy that, if provided, will be used to report the extent of the datasource. The primary reason the option exists is for performance: providing this option at datasource creation saves the time otherwise needed to scan the data for the actual extent, which for large datasets can be very significant. The datasource extent, whether manually provided or automatically calculated is used during rendering to decide if the datasource should be queried for features or not (skipped for best performance). If the extent intersects with the map rendering extent then the datasource will be queried and the query extent will be clipped to the reported datasource extent. So, this means that this option can also be used to restrict which features are available for a given datasource", "default-value": "", "default-meaning": "The datasource extent will be determined at runtime by querying the data, which may be slow, although the extent only needs to be determined once per datasource initialized and it will be cached for further rendering", "recommended": true }, "table" : { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": true }, "key_field": { "type": "boolean", "doc": "", "default-value": "", "default-meaning": "" } }, "datasources": { "csv": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "row_limit":"<@(row_limit)", "strict": { "type": "boolean", "doc": "Control if the datasource should throw on invalid rows", "default-value": false, "default-meaning": "Unless this option is set to true the datasource will skip invalid rows and attempt to parse as much data as possible" }, "inline": { "type": "string", "doc": "Raw tabular data to be read instead of reading data from a file", "default-value": "", "default-meaning": "Unless this option is provided data will be read from the `file` option" }, "escape": { "type": "string", "doc": "The escape character to use for parsing data", "default-value": "A single backslash (aka. reverse solidus): \\", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "quote": { "type": "string", "doc": "The quote character to use for parsing data", "default-value": "A quotation mark (aka. double quote): \"", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "separator": { "type": "string", "doc": "The separator character to use for parsing data", "default-value": "Basic autodetection is used to determine the best default value if the user does not manually supply a separator.", "default-meaning": "A comma will be used unless more tabs (\t), pipes (|), or semicolons (;) are detected than commas in the header row (in that order of preference)" }, "headers": { "type": "string", "doc": "A comma separated list of header names that can be set to add headers to data that lacks them", "default-value": "", "default-meaning": "Headers will be parsed from the first line of the data unless this option is set" }, "filesize_max": { "type": "float", "doc": "The maximum filesize in MB that will be accepted", "default-value": 20.0, "default-meaning": "A file that is larger that 20 MB will not be accepted and an error will be throw unless the user manually passes this option with a larger value (useful only in cases where your machine has a lot of memory)" } }, "gdal": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)" }, "geojson": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)" }, "occi": { "encoding":"<@(encoding)" }, "ogr": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)" }, "osm": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)" }, "postgis": { "table": "<@(table)", "key_field": "<@(key_field)", "encoding":"<@(encoding)", "dbname": { "type": "string", "doc": "Database name", "default-value": "username", "default-meaning": "Will default to a database named after the user (as per libpq defaults)", "required": false }, "host": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "password": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "port": { "type": "unsigned", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "user": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "connect_timeout": { "type": "unsigned", "doc": "", "default-value": 4, "default-meaning": "", "required": false }, "schema": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "extent": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "estimate_extent": { "type": "boolean", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "geometry_table": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "geometry_field": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "cursor_size": { "type": "unsigned", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "srid": { "type": "unsigned", "doc": "", "default-value": 0, "default-meaning": "", "required": false }, "initial_size": { "type": "unsigned", "doc": "", "default-value": 1, "default-meaning": "", "required": false }, "max_size": { "type": "unsigned", "doc": "", "default-value": 10, "default-meaning": "", "required": false }, "simplify_geometries": { "type": "boolean", "doc": "", "default-value": false, "default-meaning": "", "required": false }, "autodetect_key_field": { "type": "boolean", "doc": "", "default-value": false, "default-meaning": "", "required": false }, "persist_connection": { "type": "boolean", "doc": "", "default-value": true, "default-meaning": "Connections, successfully created, will be kept open until Mapnik shuts down", "required": false }, "extent_from_subquery": { "type": "boolean", "doc": "", "default-value": false, "default-meaning": "", "required": false } }, "python": { "encoding":"<@(encoding)" }, "raster": { "file":"<@(file)", "base":"<@(base)" }, "rasterlite": { "file":"<@(file)", "base":"<@(base)" }, "shape": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)" }, "sqlite": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "table": "<@(table)", "key_field": "<@(key_field)" } } } mapnik-reference-8.10.0/2.3.0/reference.json000066400000000000000000002632551342311331100203110ustar00rootroot00000000000000{ "version": "2.3.0", "style": { "filter-mode": { "type": [ "all", "first" ], "doc": "Control the processing behavior of Rule filters within a Style. If 'all' is used then all Rules are processed sequentially independent of whether any previous filters matched. If 'first' is used then it means processing ends after the first match (a positive filter evaluation) and no further Rules in the Style are processed ('first' is usually the default for CSS implementations on top of Mapnik to simplify translation from CSS to Mapnik XML).", "default-value": "all", "default-meaning": "All Rules in a Style are processed whether they have filters or not and whether or not the filter conditions evaluate to true." }, "image-filters": { "css": "image-filters", "default-value": "none", "default-meaning": "no filters", "type": "functions", "functions": [ ["agg-stack-blur", 2], ["emboss", 0], ["blur", 0], ["gray", 0], ["sobel", 0], ["edge-detect", 0], ["x-gradient", 0], ["y-gradient", 0], ["invert", 0], ["sharpen", 0], ["colorize-alpha", -1], ["color-to-alpha", 1], ["scale-hsla", 8] ], "doc": "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": { "css":"image-filters-inflate", "default-value": false, "type":"boolean", "default-meaning": "No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary", "doc": "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": { "css": "direct-image-filters", "default-value": "none", "default-meaning": "no filters", "type": "functions", "functions": [ ["agg-stack-blur", 2], ["emboss", 0], ["blur", 0], ["gray", 0], ["sobel", 0], ["edge-detect", 0], ["x-gradient", 0], ["y-gradient", 0], ["invert", 0], ["sharpen", 0], ["colorize-alpha", -1], ["color-to-alpha", 1], ["scale-hsla", 8] ], "doc": "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": { "css": "comp-op", "default-value": "src-over", "default-meaning": "add the current layer on top of other layers", "doc": "Composite operation. This defines how this layer should behave relative to layers atop or below it.", "type": ["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" ] }, "opacity": { "css": "opacity", "type": "float", "doc": "An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer).", "default-value": 1, "default-meaning": "no separate buffer will be used and no alpha will be applied to the style after rendering" } }, "layer" : { "name": { "default-value": "", "type":"string", "required" : true, "default-meaning": "No layer name has been provided", "doc": "The name of a layer. Can be anything you wish and is not strictly validated, but ideally unique in the map." }, "srs": { "default-value": "", "type":"string", "default-meaning": "No srs value is provided and the value will be inherited from the Map's srs", "doc": "The spatial reference system definition for the layer, aka the projection. Can either be a proj4 literal string like '+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs' or, if the proper proj4 epsg/nad/etc identifier files are installed, a string that uses an id like: '+init=epsg:4326'." }, "status": { "default-value": true, "type":"boolean", "default-meaning": "This layer will be marked as active and available for processing", "doc": "A property that can be set to false to disable this layer from being processed." }, "minzoom": { "default-value": 0, "type":"float", "default-meaning": "The layer will be visible at the minimum possible scale", "doc": "The minimum scale denominator that this layer will be visible at. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6." }, "maxzoom": { "default-value": "1.79769e+308", "type":"float", "default-meaning": "The layer will be visible at the maximum possible scale", "doc": "The maximum scale denominator that this layer will be visible at. The default is the numeric limit of the C++ double type, which may vary slightly by system, but is likely a massive number like 1.79769e+308 and ensures that this layer will always be visible unless the value is reduced. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6." }, "queryable": { "default-value": false, "type":"boolean", "default-meaning": "The layer will not be available for the direct querying of data values", "doc": "This property was added for GetFeatureInfo/WMS compatibility and is rarely used. It is off by default meaning that in a WMS context the layer will not be able to be queried unless the property is explicitly set to true." }, "clear-label-cache": { "default-value": false, "type":"boolean", "default-meaning": "The renderer's collision detector cache (used for avoiding duplicate labels and overlapping markers) will not be cleared immediately before processing this layer", "doc": "This property, by default off, can be enabled to allow a user to clear the collision detector cache before a given layer is processed. This may be desirable to ensure that a given layers data shows up on the map even if it normally would not because of collisions with previously rendered labels or markers." }, "group-by": { "default-value": "", "type":"string", "default-meaning": "No special layer grouping will be used during rendering", "doc": "https://github.com/mapnik/mapnik/wiki/Grouped-rendering" }, "buffer-size": { "default-value": 0, "type":"float", "default-meaning": "No custom buffer will be used for the layer and rather the Map buffer-size will be used", "doc": "Extra tolerance around the Layer extent (in pixels) used when querying the layer data during rendering. If set this will override the Map buffer-size." }, "maximum-extent": { "default-value": "none", "type":"bbox", "default-meaning": "No clipping extent will be used", "doc": "An extent to be used to limit the bounds used to query this specific layer data during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Layer." } }, "symbolizers" : { "map": { "background-color": { "css": "background-color", "default-value": "none", "default-meaning": "transparent", "type": "color", "doc": "Map Background color." }, "background-image": { "css": "background-image", "type": "uri", "default-value": "", "default-meaning": "transparent", "doc": "An image that is repeated below all features on a map as a background. Accepted formats: JPG, PNG." }, "background-image-comp-op": { "css": "background-image-comp-op", "type": "float", "doc": "Set the compositing operation used to blend the image into the background.", "default-value": "src-over", "default-meaning": "The background-image will be blended with the background normally (placed on top of any existing background-color)", "type": ["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" ] }, "background-image-opacity": { "css": "background-image-opacity", "type": "float", "doc": "Set the opacity of the image.", "default-value": 1, "default-meaning": "The image opacity will not be changed when applied to the map background" }, "srs": { "css": "srs", "type": "string", "default-value": "+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs", "default-meaning": "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", "doc": "Map spatial reference (proj4 string)." }, "buffer-size": { "css": "buffer-size", "default-value": 0, "type":"float", "default-meaning": "No buffer will be used", "doc": "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": { "css": "", "default-value": "none", "type":"bbox", "default-meaning": "No clipping extent will be used", "doc": "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": { "css": "base", "default-value": "", "default-meaning": "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.", "type": "string", "doc": "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." }, "paths-from-xml": { "css": "", "default-value": true, "default-meaning": "Paths read from XML will be interpreted from the location of the XML", "type": "boolean", "doc": "Value to control whether paths in the XML will be interpreted from the location of the XML or from the working directory of the program that calls load_map()." }, "minimum-version": { "css": "", "default-value": "none", "default-meaning": "Mapnik version will not be detected and no error will be thrown about compatibility", "type": "string", "doc": "The minumum Mapnik version (e.g. 0.7.2) needed to use certain functionality in the stylesheet." }, "font-directory": { "css": "font-directory", "type": "uri", "default-value": "none", "default-meaning": "No map-specific fonts will be registered", "doc": "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": { "default": { "css": "polygon", "type": [ "auto", "none" ], "doc": "Allows omitting a polygon symbolizer rule or emitting it with default values.", "status": "unstable" }, "fill": { "css": "polygon-fill", "type": "color", "default-value": "rgba(128,128,128,1)", "default-meaning": "gray and fully opaque (alpha = 1), same as rgb(128,128,128)", "doc": "Fill color to assign to a polygon." }, "fill-opacity": { "css": "polygon-opacity", "type": "float", "doc": "The opacity of the polygon.", "default-value": 1, "default-meaning": "opaque" }, "gamma": { "css": "polygon-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of polygon edges." }, "gamma-method": { "css": "polygon-gamma-method", "type": [ "power", "linear", "none", "threshold", "multiply" ], "default-value": "power", "default-meaning": "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", "doc": "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." }, "clip": { "css": "polygon-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "simplify": { "css": "polygon-simplify", "type": "float", "default-value": 0.0, "default-meaning": "geometry will not be simplified", "doc": "Simplify geometries by the given tolerance." }, "simplify-algorithm": { "css": "polygon-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt" ], "default-value": "radial-distance", "default-meaning": "geometry will be simplified using the radial distance algorithm", "doc": "Simplify gemoetries by the given algorithm." }, "smooth": { "css": "polygon-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "polygon-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "geometry will not be transformed", "doc": "Allows transformation functions to be applied to the geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "polygon-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "line": { "default": { "css": "line", "type": [ "auto", "none" ], "doc": "Allows omitting a line symbolizer rule or emitting it with default values.", "status": "unstable" }, "stroke": { "css": "line-color", "default-value": "rgba(0,0,0,1)", "type": "color", "default-meaning": "black and fully opaque (alpha = 1), same as rgb(0,0,0)", "doc": "The color of a drawn line." }, "stroke-width": { "css": "line-width", "default-value": 1, "type": "float", "doc": "The width of a line in pixels." }, "stroke-opacity": { "css": "line-opacity", "default-value": 1, "type": "float", "default-meaning": "opaque", "doc": "The opacity of a line." }, "stroke-linejoin": { "css": "line-join", "default-value": "miter", "type": [ "miter", "round", "bevel" ], "doc": "The behavior of lines when joining." }, "stroke-linecap": { "css": "line-cap", "default-value": "butt", "type": [ "butt", "round", "square" ], "doc": "The display of line endings." }, "stroke-gamma": { "css": "line-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of stroke line." }, "stroke-gamma-method": { "css": "line-gamma-method", "type": [ "power", "linear", "none", "threshold", "multiply" ], "default-value": "power", "default-meaning": "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", "doc": "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." }, "stroke-dasharray": { "css": "line-dasharray", "type": "numbers", "doc": "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.", "default-value": "none", "default-meaning": "solid line" }, "stroke-dashoffset": { "css": "line-dash-offset", "type": "numbers", "doc": "Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled).", "default-value": "none", "default-meaning": "solid line" }, "stroke-miterlimit": { "css": "line-miterlimit", "type": "float", "doc": "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.", "default-value": 4.0, "default-meaning": "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 )'" }, "clip": { "css": "line-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "simplify": { "css": "line-simplify", "type": "float", "default-value": 0.0, "default-meaning": "geometry will not be simplified", "doc": "Simplify gemoetries by the given tolerance" }, "simplify-algorithm": { "css": "line-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt" ], "default-value": "radial-distance", "default-meaning": "geometry will be simplified using the radial distance algorithm", "doc": "Simplify gemoetries by the given algorithm." }, "smooth": { "css": "line-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "offset": { "css": "line-offset", "type": "float", "default-value": 0, "default-meaning": "no offset", "doc": "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)." }, "rasterizer": { "css": "line-rasterizer", "type": [ "full", "fast" ], "default-value": "full", "doc": "Exposes an alternate AGG rendering method that sacrifices some accuracy for speed." }, "geometry-transform": { "css": "line-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "geometry will not be transformed", "doc": "Allows transformation functions to be applied to the geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "line-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "markers": { "default": { "css": "marker", "type": [ "auto", "none" ], "doc": "Allows omitting a marker symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "marker-file", "doc": "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.", "default-value": "none", "default-meaning": "An ellipse or circle, if width equals height.", "type": "uri" }, "opacity": { "css": "marker-opacity", "doc": "The overall opacity of the marker, if set, overrides both the opacity of the fill and the opacity of the stroke.", "default-value": 1, "default-meaning": "The stroke-opacity and fill-opacity of the marker.", "type": "float" }, "fill-opacity": { "css": "marker-fill-opacity", "doc": "The fill opacity of the marker.", "default-value": 1, "default-meaning": "opaque", "type": "float" }, "stroke": { "css": "marker-line-color", "doc": "The color of the stroke around the marker.", "default-value": "black", "type": "color" }, "stroke-width": { "css": "marker-line-width", "default-value": 0.5, "doc": "The width of the stroke around the marker, in pixels. This is positioned on the boundary, so high values can cover the area itself.", "type": "float" }, "stroke-opacity": { "css": "marker-line-opacity", "default-value": 1, "default-meaning": "opaque", "doc": "The opacity of the line.", "type": "float" }, "placement": { "css": "marker-placement", "type": [ "point", "line", "interior" ], "default-value": "point", "default-meaning": "Place markers at the center point (centroid) of the geometry", "doc": "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." }, "multi-policy": { "css": "marker-multi-policy", "type": [ "each", "whole", "largest" ], "default-value": "each", "default-meaning": "If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each", "doc": "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": { "css": "marker-type", "type": [ "arrow", "ellipse" ], "default-value": "ellipse", "doc": "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)." }, "width": { "css": "marker-width", "default-value": 10, "doc": "The width of the marker, if using one of the default types.", "type": "float", "expression":true }, "height": { "css": "marker-height", "default-value": 10, "doc": "The height of the marker, if using one of the default types.", "type": "float", "expression":true }, "fill": { "css": "marker-fill", "default-value": "blue", "doc": "The color of the area of the marker.", "type": "color" }, "allow-overlap": { "css": "marker-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping markers are shown or hidden.", "default-meaning": "Do not allow makers to overlap with each other - overlapping markers will not be shown." }, "ignore-placement": { "css": "marker-ignore-placement", "type": "boolean", "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache", "doc": "Value to control whether the placement of the feature will prevent the placement of other features." }, "spacing": { "css": "marker-spacing", "doc": "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.", "default-value": 100, "type": "float" }, "max-error": { "css": "marker-max-error", "type": "float", "default-value": 0.2, "doc": "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." }, "transform": { "css": "marker-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "none", "default-meaning": "No transformation", "doc": "SVG transformation definition." }, "clip": { "css": "marker-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "smooth": { "css": "marker-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "marker-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "geometry will not be transformed", "doc": "Allows transformation functions to be applied to the geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "marker-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "shield": { "default": { "css": "shield", "type": [ "none" ], "doc": "Allows omitting a shield symbolizer.", "status": "unstable" }, "name": { "css": "shield-name", "type": "string", "expression":true, "serialization": "content", "default-value": "", "doc": "Value to use for a shield\"s text label. Data columns are specified using brackets like [column_name]." }, "file": { "css": "shield-file", "required": true, "type": "uri", "default-value": "none", "doc": "Image file to render behind the shield text. Accepted formats: SVG, JPG, PNG." }, "face-name": { "css": "shield-face-name", "type": "string", "validate": "font", "doc": "Font name and style to use for the shield text", "default-value": "", "required": true }, "unlock-image": { "css": "shield-unlock-image", "type": "boolean", "doc": "This parameter should be set to true if you are trying to position text beside rather than on top of the shield image", "default-value": false, "default-meaning": "text alignment relative to the shield image uses the center of the image as the anchor for text positioning." }, "size": { "css": "shield-size", "type": "float", "default-value": 10, "doc": "The size of the shield text in pixels." }, "fill": { "css": "shield-fill", "type": "color", "default-value": "black", "doc": "The color of the shield text." }, "placement": { "css": "shield-placement", "type": [ "point", "line", "vertex", "interior" ], "default-value": "point", "doc": "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." }, "avoid-edges": { "css": "shield-avoid-edges", "doc": "Avoid placing shields that intersect with tile boundaries.", "type": "boolean", "default-value": false }, "allow-overlap": { "css": "shield-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping shields are shown or hidden.", "default-meaning": "Do not allow shields to overlap with other map elements already placed." }, "minimum-distance": { "css": "shield-min-distance", "type": "float", "default-value": 0, "doc": "Minimum distance to the next shield symbol, not necessarily the same shield." }, "spacing": { "css": "shield-spacing", "type": "float", "default-value": 0, "doc": "The spacing between repeated occurrences of the same shield on a line." }, "minimum-padding": { "css": "shield-min-padding", "default-value": 0, "doc": "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.", "type": "float" }, "wrap-width": { "css": "shield-wrap-width", "type": "unsigned", "default-value": 0, "doc": "Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap." }, "wrap-before": { "css": "shield-wrap-before", "type": "boolean", "default-value": false, "doc": "Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width." }, "wrap-character": { "css": "shield-wrap-character", "type": "string", "default-value": "\" \"", "doc": "Use this character instead of a space to wrap long names." }, "halo-fill": { "css": "shield-halo-fill", "type": "color", "default-value": "#FFFFFF", "doc": "Specifies the color of the halo around the text.", "default-meaning": "white" }, "halo-radius": { "css": "shield-halo-radius", "default-value": 0, "default-meaning": "no halo", "doc": "Specify the radius of the halo in pixels.", "type": "float" }, "halo-rasterizer": { "css": "shield-halo-rasterizer", "type": [ "full", "fast" ], "default-value": "full", "doc": "Exposes an alternate text halo rendering method that sacrifices quality for speed." }, "character-spacing": { "css": "shield-character-spacing", "type": "unsigned", "default-value": 0, "doc": "Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement." }, "line-spacing": { "css": "shield-line-spacing", "default-value": 0, "doc": "Vertical spacing between lines of multiline labels (in pixels).", "type": "float" }, "dx": { "css": "shield-text-dx", "type": "float", "doc": "Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right.", "default-value": 0 }, "dy": { "css": "shield-text-dy", "type": "float", "doc": "Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down.", "default-value": 0 }, "shield-dx": { "css": "shield-dx", "type": "float", "doc": "Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right.", "default-value": 0 }, "shield-dy": { "css": "shield-dy", "type": "float", "doc": "Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down.", "default-value": 0 }, "opacity": { "css": "shield-opacity", "type": "float", "doc": "The opacity of the image used for the shield", "default-value": 1 }, "text-opacity": { "css": "shield-text-opacity", "type": "float", "doc": "The opacity of the text placed on top of the shield", "default-value": 1 }, "horizontal-alignment": { "css": "shield-horizontal-alignment", "type": [ "left", "middle", "right", "auto" ], "doc": "The shield's horizontal alignment from its centerpoint", "default-value": "auto" }, "vertical-alignment": { "css": "shield-vertical-alignment", "type": [ "top", "middle", "bottom", "auto" ], "doc": "The shield's vertical alignment from its centerpoint", "default-value": "middle" }, "placement-type": { "css": "shield-placement-type", "doc": "Re-position and/or re-size shield to avoid overlaps. \"simple\" for basic algorithm (using shield-placements string,) \"dummy\" to turn this feature off.", "type": [ "dummy", "simple", "list" ], "default-value": "dummy" }, "placements": { "css": "shield-placements", "type": "string", "default-value": "", "doc": "If \"placement-type\" is set to \"simple\", use this \"POSITIONS,[SIZES]\" string. An example is `shield-placements: \"E,NE,SE,W,NW,SW\";` " }, "text-transform": { "css": "shield-text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize" ], "doc": "Transform the case of the characters.", "default-value": "none" }, "justify-alignment": { "css": "shield-justify-alignment", "type": [ "left", "center", "right", "auto" ], "doc": "Define how text in a shield's label is justified.", "default-value": "auto" }, "transform": { "css": "shield-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "none", "default-meaning": "No transformation", "doc": "SVG transformation definition." }, "clip": { "css": "shield-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "comp-op": { "css": "shield-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "line-pattern": { "default": { "css": "line-pattern", "type": [ "none" ], "doc": "Allows omitting a line pattern symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "line-pattern-file", "type": "uri", "default-value": "none", "required": true, "doc": "An image file to be repeated and warped along a line. Accepted formats: JPG, PNG." }, "clip": { "css": "line-pattern-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "simplify": { "css": "line-pattern-simplify", "type": "float", "default-value": 0.0, "default-meaning": "geometry will not be simplified", "doc": "geometries are simplified by the given tolerance" }, "simplify-algorithm": { "css": "line-pattern-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt" ], "default-value": "radial-distance", "default-meaning": "geometry will be simplified using the radial distance algorithm", "doc": "geometries are simplified by the given algorithm." }, "smooth": { "css": "line-pattern-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "offset": { "css": "line-pattern-offset", "type": "float", "default-value": 0, "default-meaning": "no offset", "doc": "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)." }, "geometry-transform": { "css": "line-pattern-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "geometry will not be transformed", "doc": "Allows transformation functions to be applied to the geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "line-pattern-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "polygon-pattern": { "default": { "css": "polygon-pattern", "type": [ "none" ], "doc": "Allows omitting a polygon pattern symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "polygon-pattern-file", "type": "uri", "default-value": "none", "required": true, "doc": "Image to use as a repeated pattern fill within a polygon. Accepted formats: JPG, PNG." }, "alignment": { "css": "polygon-pattern-alignment", "type": [ "local", "global" ], "default-value": "local", "doc": "Specify whether to align pattern fills to the layer or to the map." }, "gamma": { "css": "polygon-pattern-gamma", "type": "float", "default-value": 1, "default-meaning": "fully antialiased", "range": "0-1", "doc": "Level of antialiasing of polygon pattern edges" }, "opacity": { "css": "polygon-pattern-opacity", "type": "float", "doc": "Apply an opacity level to the image used for the pattern", "default-value": 1, "default-meaning": "The image is rendered without modifications" }, "clip": { "css": "polygon-pattern-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "simplify": { "css": "polygon-pattern-simplify", "type": "float", "default-value": 0.0, "default-meaning": "geometry will not be simplified", "doc": "geometries are simplified by the given tolerance" }, "simplify-algorithm": { "css": "polygon-pattern-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt" ], "default-value": "radial-distance", "default-meaning": "geometry will be simplified using the radial distance algorithm", "doc": "geometries are simplified by the given algorithm" }, "smooth": { "css": "polygon-pattern-smooth", "type": "float", "default-value": 0, "default-meaning": "no smoothing", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "polygon-pattern-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "geometry will not be transformed", "doc": "Allows transformation functions to be applied to the geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "polygon-pattern-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "raster": { "default": { "css": "raster", "type": [ "auto", "none" ], "doc": "Allows omitting a raster symbolizer rule or emitting it with default values.", "status": "unstable" }, "opacity": { "css": "raster-opacity", "default-value": 1, "default-meaning": "opaque", "type": "float", "doc": "The opacity of the raster symbolizer on top of other symbolizers." }, "filter-factor": { "css": "raster-filter-factor", "default-value": -1, "default-meaning": "Allow the datasource to choose appropriate downscaling.", "type": "float", "doc": "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." }, "scaling": { "css": "raster-scaling", "type": [ "near", "fast", "bilinear", "bicubic", "spline16", "spline36", "hanning", "hamming", "hermite", "kaiser", "quadric", "catrom", "gaussian", "bessel", "mitchell", "sinc", "lanczos", "blackman" ], "default-value": "near", "doc": "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." }, "mesh-size": { "css": "raster-mesh-size", "default-value": 16, "default-meaning": "Reprojection mesh will be 1/16 of the resolution of the source image", "type": "unsigned", "doc": "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." }, "comp-op": { "css": "raster-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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-mode": { "css": "raster-colorizer-default-mode", "type": [ "discrete", "linear", "exact" ], "doc": "This can be either `discrete`, `linear` or `exact`. If it is not specified then the default is `linear`.", "default-value": "linear", "default-meaning": "A linear interpolation is used to generate colors between the two nearest stops." }, "default-color": { "css": "raster-colorizer-default-color", "type": "color", "doc": "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", "default-value": "transparent", "default-meaning": "Pixels that are not colored by the colorizer stops will be transparent" }, "epsilon": { "css": "raster-colorizer-epsilon", "type": "float", "doc": "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.", "default-value": "1.1920928955078125e-07", "default-meaning": "Pixels must very closely match the stop filter otherwise they will not be colored." }, "stop": { "css": "raster-colorizer-stops", "type": "tags", "serialization": "tag", "tagname": "tagname", "doc": "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)`.", "default-value": "", "default-meaning": "No colorization will happen without supplying stops." } }, "point": { "default": { "css": "point", "type": [ "auto", "none" ], "doc": "Allows omitting a point symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "point-file", "type": "uri", "required": false, "default-value": "none", "doc": "Image file to represent a point. Accepted formats: SVG, PNG, JPG." }, "allow-overlap": { "css": "point-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping points are shown or hidden.", "default-meaning": "Do not allow points to overlap with each other - overlapping markers will not be shown." }, "ignore-placement": { "css": "point-ignore-placement", "type": "boolean", "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache", "doc": "Control whether the placement of the feature will prevent the placement of other features." }, "opacity": { "css": "point-opacity", "type": "float", "default-value": 1.0, "default-meaning": "Fully opaque", "doc": "A value from 0 to 1 to control the opacity of the point." }, "placement": { "css": "point-placement", "type": [ "centroid", "interior" ], "doc": "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.", "default-value": "centroid" }, "transform": { "css": "point-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "none", "default-meaning": "No transformation", "doc": "SVG transformation definition." }, "comp-op": { "css": "point-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "text": { "default": { "css": "text", "type": [ "none" ], "doc": "Allows omitting a text symbolizer rule.", "status": "unstable" }, "name": { "css": "text-name", "type": "string", "expression":true, "required": true, "default-value": "", "serialization": "content", "doc": "Value to use for a text label. Data columns are specified using brackets like [column_name]" }, "face-name": { "css": "text-face-name", "type": "string", "validate": "font", "default-value": "", "doc": "Font name and style to render a label in", "required": true }, "size": { "css": "text-size", "type": "float", "default-value": 10, "doc": "Text size in pixels" }, "text-ratio": { "css": "text-ratio", "doc": "Define the amount of text (of the total) present on successive lines when wrapping occurs", "default-value": 0, "type": "unsigned" }, "wrap-width": { "css": "text-wrap-width", "doc": "Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap.", "default-value": 0, "type": "unsigned" }, "wrap-before": { "css": "text-wrap-before", "type": "boolean", "default-value": false, "doc": "Wrap text before wrap-width is reached. If false, wrapped lines will be a bit longer than wrap-width." }, "wrap-character": { "css": "text-wrap-character", "type": "string", "default-value": "\" \"", "doc": "Use this character instead of a space to wrap long text." }, "spacing": { "css": "text-spacing", "type": "unsigned", "default-value": 0, "doc": "Distance between repeated text labels on a line (aka. label-spacing)." }, "character-spacing": { "css": "text-character-spacing", "type": "float", "default-value": 0, "doc": "Horizontal spacing adjustment between characters in pixels." }, "line-spacing": { "css": "text-line-spacing", "default-value": 0, "type": "float", "doc": "Vertical spacing adjustment between lines in pixels." }, "label-position-tolerance": { "css": "text-label-position-tolerance", "default-value": 0.0, "type": "float", "doc": "Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line)." }, "max-char-angle-delta": { "css": "text-max-char-angle-delta", "type": "float", "default-value": 22.5, "doc": "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." }, "fill": { "css": "text-fill", "doc": "Specifies the color for the text", "default-value": "#000000", "type": "color" }, "opacity": { "css": "text-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text", "default-value": 1.0, "default-meaning": "Fully opaque", "type": "float" }, "halo-fill": { "css": "text-halo-fill", "type": "color", "default-value": "#FFFFFF", "default-meaning": "white", "doc": "Specifies the color of the halo around the text." }, "halo-radius": { "css": "text-halo-radius", "doc": "Specify the radius of the halo in pixels", "default-value": 0, "default-meaning": "no halo", "type": "float" }, "halo-rasterizer": { "css": "text-halo-rasterizer", "type": [ "full", "fast" ], "default-value": "full", "doc": "Exposes an alternate text halo rendering method that sacrifices quality for speed." }, "dx": { "css": "text-dx", "type": "float", "doc": "Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right.", "default-value": 0 }, "dy": { "css": "text-dy", "type": "float", "doc": "Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text up.", "default-value": 0 }, "vertical-alignment": { "css": "text-vertical-alignment", "type": [ "top", "middle", "bottom", "auto" ], "doc": "Position of label relative to point position.", "default-value": "auto", "default-meaning": "Default affected by value of dy; \"top\" for dy>0, \"bottom\" for dy<0." }, "avoid-edges": { "css": "text-avoid-edges", "doc": "Avoid placing labels that intersect with tile boundaries.", "default-value": false, "type": "boolean" }, "minimum-distance": { "css": "text-min-distance", "doc": "Minimum permitted distance to the next text symbolizer.", "default-value": 0, "type": "float" }, "minimum-padding": { "css": "text-min-padding", "default-value": 0, "doc": "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.", "type": "float" }, "minimum-path-length": { "css": "text-min-path-length", "type": "float", "default-value": 0, "default-meaning": "place labels on all paths", "doc": "Place labels only on paths longer than this value." }, "allow-overlap": { "css": "text-allow-overlap", "type": "boolean", "default-value": false, "doc": "Control whether overlapping text is shown or hidden.", "default-meaning": "Do not allow text to overlap with other text - overlapping markers will not be shown." }, "orientation": { "css": "text-orientation", "type": "float", "expression":true, "default-value": 0, "doc": "Rotate the text." }, "placement": { "css": "text-placement", "default-value": "point", "type": [ "point", "line", "vertex", "interior" ], "doc": "Control the style of placement of a point versus the geometry it is attached to." }, "placement-type": { "css": "text-placement-type", "doc": "Re-position and/or re-size text to avoid overlaps. \"simple\" for basic algorithm (using text-placements string,) \"dummy\" to turn this feature off.", "type": [ "dummy", "simple", "list" ], "default-value": "dummy" }, "placements": { "css": "text-placements", "type": "string", "default-value": "", "doc": "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": { "css": "text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize" ], "doc": "Transform the case of the characters.", "default-value": "none" }, "horizontal-alignment": { "css": "text-horizontal-alignment", "type": [ "left", "middle", "right", "auto" ], "doc": "The text's horizontal alignment from its centerpoint.", "default-value": "auto" }, "justify-alignment": { "css": "text-align", "type": [ "left", "right", "center", "auto" ], "doc": "Define how text is justified", "default-value": "auto", "default-meaning": "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." }, "clip": { "css": "text-clip", "type": "boolean", "default-value": true, "default-meaning": "geometry will be clipped to map bounds before rendering", "doc": "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." }, "comp-op": { "css": "text-comp-op", "default-value": "src-over", "default-meaning": "add the current symbolizer on top of other symbolizer", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ] } }, "building": { "default": { "css": "building", "type": [ "auto", "none" ], "doc": "Allows omitting a building symbolizer rule or emitting it with default values.", "status": "unstable" }, "fill": { "css": "building-fill", "default-value": "#FFFFFF", "doc": "The color of the buildings walls.", "type": "color" }, "fill-opacity": { "css": "building-fill-opacity", "type": "float", "doc": "The opacity of the building as a whole, including all walls.", "default-value": 1 }, "height": { "css": "building-height", "doc": "The height of the building in pixels.", "type": "float", "expression":true, "default-value": 0 } }, "debug": { "mode": { "css": "debug-mode", "type": [ "collision", "vertex" ], "default-value": "collision", "doc": "The mode for debug rendering." } } }, "colors": { "aliceblue": [240, 248, 255], "antiquewhite": [250, 235, 215], "aqua": [0, 255, 255], "aquamarine": [127, 255, 212], "azure": [240, 255, 255], "beige": [245, 245, 220], "bisque": [255, 228, 196], "black": [0, 0, 0], "blanchedalmond": [255,235,205], "blue": [0, 0, 255], "blueviolet": [138, 43, 226], "brown": [165, 42, 42], "burlywood": [222, 184, 135], "cadetblue": [95, 158, 160], "chartreuse": [127, 255, 0], "chocolate": [210, 105, 30], "coral": [255, 127, 80], "cornflowerblue": [100, 149, 237], "cornsilk": [255, 248, 220], "crimson": [220, 20, 60], "cyan": [0, 255, 255], "darkblue": [0, 0, 139], "darkcyan": [0, 139, 139], "darkgoldenrod": [184, 134, 11], "darkgray": [169, 169, 169], "darkgreen": [0, 100, 0], "darkgrey": [169, 169, 169], "darkkhaki": [189, 183, 107], "darkmagenta": [139, 0, 139], "darkolivegreen": [85, 107, 47], "darkorange": [255, 140, 0], "darkorchid": [153, 50, 204], "darkred": [139, 0, 0], "darksalmon": [233, 150, 122], "darkseagreen": [143, 188, 143], "darkslateblue": [72, 61, 139], "darkslategrey": [47, 79, 79], "darkturquoise": [0, 206, 209], "darkviolet": [148, 0, 211], "deeppink": [255, 20, 147], "deepskyblue": [0, 191, 255], "dimgray": [105, 105, 105], "dimgrey": [105, 105, 105], "dodgerblue": [30, 144, 255], "firebrick": [178, 34, 34], "floralwhite": [255, 250, 240], "forestgreen": [34, 139, 34], "fuchsia": [255, 0, 255], "gainsboro": [220, 220, 220], "ghostwhite": [248, 248, 255], "gold": [255, 215, 0], "goldenrod": [218, 165, 32], "gray": [128, 128, 128], "grey": [128, 128, 128], "green": [0, 128, 0], "greenyellow": [173, 255, 47], "honeydew": [240, 255, 240], "hotpink": [255, 105, 180], "indianred": [205, 92, 92], "indigo": [75, 0, 130], "ivory": [255, 255, 240], "khaki": [240, 230, 140], "lavender": [230, 230, 250], "lavenderblush": [255, 240, 245], "lawngreen": [124, 252, 0], "lemonchiffon": [255, 250, 205], "lightblue": [173, 216, 230], "lightcoral": [240, 128, 128], "lightcyan": [224, 255, 255], "lightgoldenrodyellow": [250, 250, 210], "lightgray": [211, 211, 211], "lightgreen": [144, 238, 144], "lightgrey": [211, 211, 211], "lightpink": [255, 182, 193], "lightsalmon": [255, 160, 122], "lightseagreen": [32, 178, 170], "lightskyblue": [135, 206, 250], "lightslategray": [119, 136, 153], "lightslategrey": [119, 136, 153], "lightsteelblue": [176, 196, 222], "lightyellow": [255, 255, 224], "lime": [0, 255, 0], "limegreen": [50, 205, 50], "linen": [250, 240, 230], "magenta": [255, 0, 255], "maroon": [128, 0, 0], "mediumaquamarine": [102, 205, 170], "mediumblue": [0, 0, 205], "mediumorchid": [186, 85, 211], "mediumpurple": [147, 112, 219], "mediumseagreen": [60, 179, 113], "mediumslateblue": [123, 104, 238], "mediumspringgreen": [0, 250, 154], "mediumturquoise": [72, 209, 204], "mediumvioletred": [199, 21, 133], "midnightblue": [25, 25, 112], "mintcream": [245, 255, 250], "mistyrose": [255, 228, 225], "moccasin": [255, 228, 181], "navajowhite": [255, 222, 173], "navy": [0, 0, 128], "oldlace": [253, 245, 230], "olive": [128, 128, 0], "olivedrab": [107, 142, 35], "orange": [255, 165, 0], "orangered": [255, 69, 0], "orchid": [218, 112, 214], "palegoldenrod": [238, 232, 170], "palegreen": [152, 251, 152], "paleturquoise": [175, 238, 238], "palevioletred": [219, 112, 147], "papayawhip": [255, 239, 213], "peachpuff": [255, 218, 185], "peru": [205, 133, 63], "pink": [255, 192, 203], "plum": [221, 160, 221], "powderblue": [176, 224, 230], "purple": [128, 0, 128], "red": [255, 0, 0], "rosybrown": [188, 143, 143], "royalblue": [65, 105, 225], "saddlebrown": [139, 69, 19], "salmon": [250, 128, 114], "sandybrown": [244, 164, 96], "seagreen": [46, 139, 87], "seashell": [255, 245, 238], "sienna": [160, 82, 45], "silver": [192, 192, 192], "skyblue": [135, 206, 235], "slateblue": [106, 90, 205], "slategray": [112, 128, 144], "slategrey": [112, 128, 144], "snow": [255, 250, 250], "springgreen": [0, 255, 127], "steelblue": [70, 130, 180], "tan": [210, 180, 140], "teal": [0, 128, 128], "thistle": [216, 191, 216], "tomato": [255, 99, 71], "turquoise": [64, 224, 208], "violet": [238, 130, 238], "wheat": [245, 222, 179], "white": [255, 255, 255], "whitesmoke": [245, 245, 245], "yellow": [255, 255, 0], "yellowgreen": [154, 205, 50], "transparent": [0, 0, 0, 0] }, "filter": { "value": [ "true", "false", "null", "point", "linestring", "polygon", "collection" ] } } mapnik-reference-8.10.0/3.0.0/000077500000000000000000000000001342311331100154415ustar00rootroot00000000000000mapnik-reference-8.10.0/3.0.0/datasources.json000066400000000000000000000536571342311331100206710ustar00rootroot00000000000000{ "datasources": { "csv": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "strict": { "type": "boolean", "doc": "Control if the datasource should throw on invalid rows", "default-value": false, "default-meaning": "Unless this option is set to true the datasource will skip invalid rows and attempt to parse as much data as possible" }, "escape": { "type": "string", "doc": "The escape character to use for parsing data", "default-value": "A single backslash (aka. reverse solidus): \\", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "quote": { "type": "string", "doc": "The quote character to use for parsing data", "default-value": "A quotation mark (aka. double quote): \"", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "separator": { "type": "string", "doc": "The separator character to use for parsing data", "default-value": "Basic autodetection is used to determine the best default value if the user does not manually supply a separator.", "default-meaning": "A comma will be used unless more tabs (\t), pipes (|), or semicolons (;) are detected than commas in the header row (in that order of preference)" }, "headers": { "type": "string", "doc": "A comma separated list of header names that can be set to add headers to data that lacks them", "default-value": "", "default-meaning": "Headers will be parsed from the first line of the data unless this option is set" }, "filesize_max": { "type": "float", "doc": "The maximum filesize in MB that will be accepted", "default-value": 20, "default-meaning": "A file that is larger that 20 MB will not be accepted and an error will be throw unless the user manually passes this option with a larger value (useful only in cases where your machine has a lot of memory)" } }, "gdal": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "band": { "type": "unsigned", "doc": "A particular raster band to work with.", "default-value": 0, "default-meaning": "No particular raster band set, working with all bands.", "required": false }, "nodata": { "type": "float", "doc": "Overrides nodata value from the raster.", "default-value": 0, "default-meaning": "Nodata value from the raster is used.", "required": false }, "nodata_tolerance": { "type": "float", "doc": "Make pixels in this tolerance around nodata value transparent.", "default-value": 1e-12, "default-meaning": "The tolerance is effectively zero.", "required": false }, "shared": { "type": "boolean", "doc": "Allows to share the GDAL dataset handle with other GDAL datasources with the same file path.", "default-value": false, "default-meaning": "The datasource will use unique dataset instance.", "required": false } }, "geojson": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "inline": { "type": "string", "doc": "Raw tabular data to be read instead of reading data from a file", "default-value": "", "default-meaning": "Unless this option is provided data will be read from the `file` option" } }, "occi": { "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "ogr": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "osm": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "postgis": { "table": { "type": "string", "doc": "The table or query used", "default-value": "", "default-meaning": "", "required": true }, "key_field": { "type": "boolean", "doc": "User provided field name to interpret as the primary key of the table. If provided then the values from this field (which must be an integer) will be used as the feature id of the returned data", "default-value": "", "default-meaning": "By default no primary key is required and in this case the feature id for returned features will be auto-generated by Mapnik and is not certain to be globally unique.", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "dbname": { "type": "string", "doc": "Database name", "default-value": "username", "default-meaning": "Will default to a database named after the user (as per libpq defaults)", "required": false }, "host": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "password": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "port": { "type": "unsigned", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "user": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "connect_timeout": { "type": "unsigned", "doc": "", "default-value": 4, "default-meaning": "", "required": false }, "schema": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "extent": { "type": "string", "doc": "A comma or space delimited bounding box in the format of minx,miny,maxx,maxy that, if provided, will be used to report the extent of the datasource. The primary reason the option exists is for performance: providing this option at datasource creation saves the time otherwise needed to scan the data for the actual extent, which for large datasets can be very significant. The datasource extent, whether manually provided or automatically calculated is used during rendering to decide if the datasource should be queried for features or not (skipped for best performance). If the extent intersects with the map rendering extent then the datasource will be queried and the query extent will be clipped to the reported datasource extent. So, this means that this option can also be used to restrict which features are available for a given datasource", "default-value": "", "default-meaning": "The datasource extent will be determined at runtime by querying the data, which may be slow, although the extent only needs to be determined once per datasource initialized and it will be cached for further rendering", "recommended": true }, "estimate_extent": { "type": "boolean", "doc": "If an `extent` string is not provided then Mapnik dynamically queries the table to determine the extent. If this option is true then the faster but less accurate PostGIS `ST_EstimatedExtent` function is used instead of `ST_Extent`.", "default-value": false, "default-meaning": "", "required": false }, "geometry_table": { "type": "string", "doc": "Specifies geometry table to use to look up metadata", "default-value": "", "default-meaning": "Automatically parsed from 'table' value", "required": false }, "geometry_field": { "type": "string", "doc": "Specifies geometry field to use", "default-value": "", "default-meaning": "First entry in geometry_columns", "required": false }, "cursor_size": { "type": "unsigned", "doc": "Integer size of binary cursor to use", "default-value": 0, "default-meaning": "No binary cursor is used", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "srid": { "type": "unsigned", "doc": "SRID to use", "default-value": 0, "default-meaning": "Auto-detected from geometry_field", "required": false }, "initial_size": { "type": "unsigned", "doc": "Integer size of connection pool", "default-value": 1, "default-meaning": "", "required": false }, "max_size": { "type": "unsigned", "doc": "Integer max of connection pool", "default-value": 10, "default-meaning": "", "required": false }, "simplify_geometries": { "type": "boolean", "doc": "Simplify geometries with ST_Simplify", "default-value": false, "default-meaning": "Don't simplify geometries", "required": false }, "autodetect_key_field": { "type": "boolean", "doc": "Attempt to autodetect a primary key field", "default-value": false, "default-meaning": "Don't autodetect a primary key field", "required": false }, "persist_connection": { "type": "boolean", "doc": "Keep connection open", "default-value": true, "default-meaning": "Connections, successfully created, will be kept open until Mapnik shuts down", "required": false }, "extent_from_subquery": { "type": "boolean", "doc": "Direct Mapnik to query Postgis for the extent of the raw 'table' value", "default-value": false, "default-meaning": "Uses 'geometry_table' instead of querying", "required": false } }, "python": { "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "raster": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false } }, "rasterlite": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false } }, "shape": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "sqlite": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "table": { "type": "string", "doc": "The table or query used", "default-value": "", "default-meaning": "", "required": true }, "key_field": { "type": "boolean", "doc": "User provided field name to interpret as the primary key of the table. If provided then the values from this field (which must be an integer) will be used as the feature id of the returned data", "default-value": "", "default-meaning": "By default no primary key is required and in this case the feature id for returned features will be auto-generated by Mapnik and is not certain to be globally unique.", "required": false } }, "topojson": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "inline": { "type": "string", "doc": "Raw tabular data to be read instead of reading data from a file", "default-value": "", "default-meaning": "Unless this option is provided data will be read from the `file` option" } } } }mapnik-reference-8.10.0/3.0.0/datasources.template.json000066400000000000000000000347071342311331100224760ustar00rootroot00000000000000{ "types": { "type": { "type": "string", "doc": "The type of the option", "values": ["string","float","boolean","unsigned"], "required": true }, "doc": { "type": "string", "doc": "The basic description of the option and the expected behavior if you provide it", "required": true }, "default-value": { "type": "string", "doc": "Either an empty string if there is no default value, a description of the default value, or the default value itself (if appropriate)", "required": true }, "default-meaning": { "type": "string", "doc": "A detailed description of what the behavior will be if the default value is left unchanged", "required": true }, "required": { "type": "boolean", "doc": "A boolean value to signify if the option is required. Can be left out and if not present it will be assumed that the option is not required", "required": false }, "recommended": { "type": "boolean", "doc": "A boolean value to signify if the option is recommended, even if it is not required. This is meant to indicate to users that better behavior or performance will be gained if they manually provide the option and that they should seek to understand why it exists (and also why/how it needs to be manually provided)", "required": false } }, "variables": { "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "extent" : { "type": "string", "doc": "A comma or space delimited bounding box in the format of minx,miny,maxx,maxy that, if provided, will be used to report the extent of the datasource. The primary reason the option exists is for performance: providing this option at datasource creation saves the time otherwise needed to scan the data for the actual extent, which for large datasets can be very significant. The datasource extent, whether manually provided or automatically calculated is used during rendering to decide if the datasource should be queried for features or not (skipped for best performance). If the extent intersects with the map rendering extent then the datasource will be queried and the query extent will be clipped to the reported datasource extent. So, this means that this option can also be used to restrict which features are available for a given datasource", "default-value": "", "default-meaning": "The datasource extent will be determined at runtime by querying the data, which may be slow, although the extent only needs to be determined once per datasource initialized and it will be cached for further rendering", "recommended": true }, "table" : { "type": "string", "doc": "The table or query used", "default-value": "", "default-meaning": "", "required": true }, "key_field": { "type": "boolean", "doc": "User provided field name to interpret as the primary key of the table. If provided then the values from this field (which must be an integer) will be used as the feature id of the returned data", "default-value": "", "default-meaning": "By default no primary key is required and in this case the feature id for returned features will be auto-generated by Mapnik and is not certain to be globally unique.", "required": false }, "inline": { "type": "string", "doc": "Raw tabular data to be read instead of reading data from a file", "default-value": "", "default-meaning": "Unless this option is provided data will be read from the `file` option" } }, "datasources": { "csv": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "row_limit":"<@(row_limit)", "strict": { "type": "boolean", "doc": "Control if the datasource should throw on invalid rows", "default-value": false, "default-meaning": "Unless this option is set to true the datasource will skip invalid rows and attempt to parse as much data as possible" }, "escape": { "type": "string", "doc": "The escape character to use for parsing data", "default-value": "A single backslash (aka. reverse solidus): \\", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "quote": { "type": "string", "doc": "The quote character to use for parsing data", "default-value": "A quotation mark (aka. double quote): \"", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "separator": { "type": "string", "doc": "The separator character to use for parsing data", "default-value": "Basic autodetection is used to determine the best default value if the user does not manually supply a separator.", "default-meaning": "A comma will be used unless more tabs (\t), pipes (|), or semicolons (;) are detected than commas in the header row (in that order of preference)" }, "headers": { "type": "string", "doc": "A comma separated list of header names that can be set to add headers to data that lacks them", "default-value": "", "default-meaning": "Headers will be parsed from the first line of the data unless this option is set" }, "filesize_max": { "type": "float", "doc": "The maximum filesize in MB that will be accepted", "default-value": 20.0, "default-meaning": "A file that is larger that 20 MB will not be accepted and an error will be throw unless the user manually passes this option with a larger value (useful only in cases where your machine has a lot of memory)" } }, "gdal": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "band": { "type": "unsigned", "doc": "A particular raster band to work with.", "default-value": 0, "default-meaning": "No particular raster band set, working with all bands.", "required": false }, "nodata": { "type": "float", "doc": "Overrides nodata value from the raster.", "default-value": 0, "default-meaning": "Nodata value from the raster is used.", "required": false }, "nodata_tolerance": { "type": "float", "doc": "Make pixels in this tolerance around nodata value transparent.", "default-value": 1e-12, "default-meaning": "The tolerance is effectively zero.", "required": false }, "shared": { "type": "boolean", "doc": "Allows to share the GDAL dataset handle with other GDAL datasources with the same file path.", "default-value": false, "default-meaning": "The datasource will use unique dataset instance.", "required": false } }, "geojson": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "inline":"<@(inline)" }, "occi": { "encoding":"<@(encoding)" }, "ogr": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)" }, "osm": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)" }, "postgis": { "table": "<@(table)", "key_field": "<@(key_field)", "encoding":"<@(encoding)", "dbname": { "type": "string", "doc": "Database name", "default-value": "username", "default-meaning": "Will default to a database named after the user (as per libpq defaults)", "required": false }, "host": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "password": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "port": { "type": "unsigned", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "user": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "connect_timeout": { "type": "unsigned", "doc": "", "default-value": 4, "default-meaning": "", "required": false }, "schema": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "extent": "<@(extent)", "estimate_extent": { "type": "boolean", "doc": "If an `extent` string is not provided then Mapnik dynamically queries the table to determine the extent. If this option is true then the faster but less accurate PostGIS `ST_EstimatedExtent` function is used instead of `ST_Extent`.", "default-value": false, "default-meaning": "", "required": false }, "geometry_table": { "type": "string", "doc": "Specifies geometry table to use to look up metadata", "default-value": "", "default-meaning": "Automatically parsed from 'table' value", "required": false }, "geometry_field": { "type": "string", "doc": "Specifies geometry field to use", "default-value": "", "default-meaning": "First entry in geometry_columns", "required": false }, "cursor_size": { "type": "unsigned", "doc": "Integer size of binary cursor to use", "default-value": 0, "default-meaning": "No binary cursor is used", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "srid": { "type": "unsigned", "doc": "SRID to use", "default-value": 0, "default-meaning": "Auto-detected from geometry_field", "required": false }, "initial_size": { "type": "unsigned", "doc": "Integer size of connection pool", "default-value": 1, "default-meaning": "", "required": false }, "max_size": { "type": "unsigned", "doc": "Integer max of connection pool", "default-value": 10, "default-meaning": "", "required": false }, "simplify_geometries": { "type": "boolean", "doc": "Simplify geometries with ST_Simplify", "default-value": false, "default-meaning": "Don't simplify geometries", "required": false }, "autodetect_key_field": { "type": "boolean", "doc": "Attempt to autodetect a primary key field", "default-value": false, "default-meaning": "Don't autodetect a primary key field", "required": false }, "persist_connection": { "type": "boolean", "doc": "Keep connection open", "default-value": true, "default-meaning": "Connections, successfully created, will be kept open until Mapnik shuts down", "required": false }, "extent_from_subquery": { "type": "boolean", "doc": "Direct Mapnik to query Postgis for the extent of the raw 'table' value", "default-value": false, "default-meaning": "Uses 'geometry_table' instead of querying", "required": false } }, "python": { "encoding":"<@(encoding)" }, "raster": { "file":"<@(file)", "base":"<@(base)" }, "rasterlite": { "file":"<@(file)", "base":"<@(base)" }, "shape": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)" }, "sqlite": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "table": "<@(table)", "key_field": "<@(key_field)" }, "topojson": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "inline":"<@(inline)" } } } mapnik-reference-8.10.0/3.0.0/reference.json000066400000000000000000004002361342311331100202770ustar00rootroot00000000000000{ "version": "3.0.0", "style": { "filter-mode": { "type": [ "all", "first" ], "doc": "Control the processing behavior of Rule filters within a Style. If 'all' is used then all Rules are processed sequentially independent of whether any previous filters matched. If 'first' is used then it means processing ends after the first match (a positive filter evaluation) and no further Rules in the Style are processed ('first' is usually the default for CSS implementations on top of Mapnik to simplify translation from CSS to Mapnik XML).", "default-value": "all", "default-meaning": "All Rules in a Style are processed whether they have filters or not and whether or not the filter conditions evaluate to true." }, "image-filters": { "css": "image-filters", "default-value": "none", "default-meaning": "no filters", "type": "functions", "functions": [ ["agg-stack-blur", 2], ["emboss", 0], ["blur", 0], ["gray", 0], ["sobel", 0], ["edge-detect", 0], ["x-gradient", 0], ["y-gradient", 0], ["invert", 0], ["sharpen", 0], ["colorize-alpha", -1], ["color-to-alpha", 1], ["scale-hsla", 8] ], "doc": "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": { "css":"image-filters-inflate", "default-value": false, "type":"boolean", "default-meaning": "No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary", "doc": "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": { "css": "direct-image-filters", "default-value": "none", "default-meaning": "no filters", "type": "functions", "functions": [ ["agg-stack-blur", 2], ["emboss", 0], ["blur", 0], ["gray", 0], ["sobel", 0], ["edge-detect", 0], ["x-gradient", 0], ["y-gradient", 0], ["invert", 0], ["sharpen", 0], ["colorize-alpha", -1], ["color-to-alpha", 1], ["scale-hsla", 8] ], "doc": "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": { "css": "comp-op", "default-value": "src-over", "default-meaning": "add the current layer on top of other layers", "doc": "Composite operation. This defines how this layer should behave relative to layers atop or below it.", "type": [ "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" ] }, "opacity": { "css": "opacity", "type": "float", "doc": "An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer).", "default-value": 1.0, "default-meaning": "No separate buffer will be used and no alpha will be applied to the style after rendering." } }, "layer" : { "name": { "default-value": "", "type":"string", "required" : true, "default-meaning": "No layer name has been provided", "doc": "The name of a layer. Can be anything you wish and is not strictly validated, but ideally unique in the map." }, "srs": { "default-value": "", "type":"string", "default-meaning": "No srs value is provided and the value will be inherited from the Map's srs", "doc": "The spatial reference system definition for the layer, aka the projection. Can either be a proj4 literal string like '+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs' or, if the proper proj4 epsg/nad/etc identifier files are installed, a string that uses an id like: '+init=epsg:4326'." }, "status": { "default-value": true, "type":"boolean", "default-meaning": "This layer will be marked as active and available for processing", "doc": "A property that can be set to false to disable this layer from being processed." }, "minzoom": { "default-value": 0, "type":"float", "default-meaning": "The layer will be visible at the minimum possible scale", "doc": "The minimum scale denominator that this layer will be visible at. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6. This option has been deprecated in favor of `minimum-scale-denominator`.", "status": "deprecated" }, "maxzoom": { "default-value": "1.79769e+308", "type":"float", "default-meaning": "The layer will be visible at the maximum possible scale", "doc": "The maximum scale denominator that this layer will be visible at. The default is the numeric limit of the C++ double type, which may vary slightly by system, but is likely a massive number like 1.79769e+308 and ensures that this layer will always be visible unless the value is reduced. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6. This option has been deprecated in favor of `maximum-scale-denominator`.", "status": "deprecated" }, "minimum-scale-denominator": { "default-value": 0, "type":"float", "default-meaning": "The layer will be visible at the minimum possible scale denominator", "doc": "The minimum scale denominator that this layer will be visible at. A layer's visibility is determined by whether its status is true and if the Map scale denominator >= `minimum-scale-denominator` - 1e-6 and scale denominator < `maximum-scale-denominator` + 1e-6." }, "maximum-scale-denominator": { "default-value": "1.79769e+308", "type":"float", "default-meaning": "The layer will be visible at the maximum possible scale denominator", "doc": "The maximum scale denominator that this layer will be visible at. The default is the numeric limit of the C++ double type, which may vary slightly by system, but is likely a massive number like 1.79769e+308 and ensures that this layer will always be visible unless the value is reduced. A layer's visibility is determined by whether its status is true and if the Map scale denominator >= `minimum-scale-denominator` - 1e-6 and scale denominator < `maximum-scale-denominator` + 1e-6." }, "queryable": { "default-value": false, "type":"boolean", "default-meaning": "The layer will not be available for the direct querying of data values", "doc": "This property was added for GetFeatureInfo/WMS compatibility and is rarely used. It is off by default meaning that in a WMS context the layer will not be able to be queried unless the property is explicitly set to true." }, "clear-label-cache": { "default-value": false, "type":"boolean", "default-meaning": "The renderer's collision detector cache (used for avoiding duplicate labels and overlapping markers) will not be cleared immediately before processing this layer", "doc": "This property, by default off, can be enabled to allow a user to clear the collision detector cache before a given layer is processed. This may be desirable to ensure that a given layers data shows up on the map even if it normally would not because of collisions with previously rendered labels or markers." }, "group-by": { "default-value": "", "type":"string", "default-meaning": "No special layer grouping will be used during rendering", "doc": "https://github.com/mapnik/mapnik/wiki/Grouped-rendering" }, "buffer-size": { "default-value": 0, "type":"float", "default-meaning": "No custom buffer will be used for the layer and rather the Map buffer-size will be used", "doc": "Extra tolerance around the Layer extent (in pixels) used when querying the layer data during rendering. If set this will override the Map buffer-size." }, "maximum-extent": { "default-value": "none", "type":"bbox", "default-meaning": "No clipping extent will be used", "doc": "An extent to be used to limit the bounds used to query this specific layer data during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Layer." }, "cache-features": { "type":"boolean", "default-value": "off", "default-meaning": "Features are not cached between rendering multiple styles. The datasource is queried for each style.", "doc": "Setting this to `on` triggers Mapnik to attempt to cache features in memory for rendering when (and only when) a layer has multiple styles attached to it." } }, "symbolizers" : { "map": { "background-color": { "css": "background-color", "default-value": "none", "default-meaning": "Will be rendered transparent.", "type": "color", "doc": "Map Background color." }, "background-image": { "css": "background-image", "type": "uri", "default-value": "", "default-meaning": "No background image will be used.", "doc": "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": { "css": "background-image-comp-op", "doc": "Set the compositing operation used to blend the image into the background.", "default-value": "src-over", "default-meaning": "The background-image will be blended with the background normally (placed on top of any existing background-color).", "type": [ "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" ] }, "background-image-opacity": { "css": "background-image-opacity", "type": "float", "doc": "Set the opacity of the image.", "default-value": 1.0, "default-meaning": "The image opacity will not be changed when applied to the map background." }, "srs": { "css": "srs", "type": "string", "default-value": "+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs", "default-meaning": "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.", "doc": "Map spatial reference (proj4 string)." }, "buffer-size": { "css": "buffer-size", "default-value": 0, "type":"float", "default-meaning": "No buffer will be used.", "doc": "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": { "css": "maximum-extent", "default-value": "-20037508.34,-20037508.34,20037508.34,20037508.34", "type":"string", "default-meaning": "All data will be clipped to global mercator extent (default is applied in Carto.js).", "doc": "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": { "css": "base", "default-value": "", "default-meaning": "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.", "type": "string", "doc": "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." }, "paths-from-xml": { "css": "", "default-value": true, "default-meaning": "Paths read from XML will be interpreted from the location of the XML.", "type": "boolean", "doc": "Value to control whether paths in the XML will be interpreted from the location of the XML or from the working directory of the program that calls load_map()." }, "minimum-version": { "css": "", "default-value": "none", "default-meaning": "Mapnik version will not be detected and no error will be thrown about compatibility.", "type": "string", "doc": "The minumum Mapnik version (e.g. 0.7.2) needed to use certain functionality in the stylesheet." }, "font-directory": { "css": "font-directory", "type": "uri", "default-value": "none", "default-meaning": "No map-specific fonts will be registered.", "doc": "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": { "default": { "css": "polygon", "type": [ "auto", "none" ], "doc": "Allows omitting a polygon symbolizer rule or emitting it with default values.", "status": "unstable" }, "fill": { "css": "polygon-fill", "type": "color", "expression":true, "default-value": "The color gray will be used for fill.", "default-meaning": "Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).", "doc": "Fill color to assign to a polygon." }, "fill-opacity": { "css": "polygon-opacity", "type": "float", "expression":true, "doc": "The opacity of the polygon.", "default-value": 1.0, "default-meaning": "Color is fully opaque." }, "gamma": { "css": "polygon-gamma", "type": "float", "expression":true, "default-value": 1.0, "default-meaning": "Fully antialiased.", "range": "0-1", "doc": "Level of antialiasing of polygon edges." }, "gamma-method": { "css": "polygon-gamma-method", "type": [ "power", "linear", "none", "threshold", "multiply" ], "expression":true, "default-value": "power", "default-meaning": "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.", "doc": "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." }, "clip": { "css": "polygon-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "polygon-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "Simplify geometries by the given tolerance." }, "simplify-algorithm": { "css": "polygon-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "Simplify geometries by the given algorithm." }, "smooth": { "css": "polygon-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "polygon-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform polygon geometry with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "polygon-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "line": { "default": { "css": "line", "type": [ "auto", "none" ], "doc": "Allows omitting a line symbolizer rule or emitting it with default values.", "status": "unstable" }, "stroke": { "css": "line-color", "default-value": "black", "type": "color", "expression":true, "default-meaning": "black and fully opaque (alpha = 1), same as rgb(0,0,0) or rgba(0,0,0,1).", "doc": "The color of a drawn line." }, "stroke-width": { "css": "line-width", "default-value": 1.0, "type": "float", "expression":true, "doc": "The width of a line in pixels.", "default-meaning": "The line will be rendered 1 pixel wide." }, "stroke-opacity": { "css": "line-opacity", "default-value": 1.0, "type": "float", "expression":true, "default-meaning": "Color is fully opaque.", "doc": "The opacity of a line." }, "stroke-linejoin": { "css": "line-join", "default-value": "miter", "type": [ "miter", "miter-revert", "round", "bevel" ], "expression":true, "doc": "The behavior of lines when joining.", "default-meaning": "The line joins will be rendered using a miter look." }, "stroke-linecap": { "css": "line-cap", "default-value": "butt", "type": [ "butt", "round", "square" ], "expression":true, "doc": "The display of line endings.", "default-meaning": "The line endings will be rendered using a butt look." }, "stroke-gamma": { "css": "line-gamma", "type": "float", "expression":true, "default-value": 1.0, "default-meaning": "Fully antialiased.", "range": "0-1", "doc": "Level of antialiasing of stroke line." }, "stroke-gamma-method": { "css": "line-gamma-method", "type": [ "power", "linear", "none", "threshold", "multiply" ], "expression":true, "default-value": "power", "default-meaning": "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.", "doc": "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." }, "stroke-dasharray": { "css": "line-dasharray", "type": "numbers", "expression":true, "doc": "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.", "default-value": "none", "default-meaning": "The line will be drawn without dashes." }, "stroke-dashoffset": { "css": "line-dash-offset", "type": "numbers", "expression":true, "doc": "Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled).", "default-value": "none", "default-meaning": "The line will be drawn without dashes." }, "stroke-miterlimit": { "css": "line-miterlimit", "type": "float", "expression":true, "doc": "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.", "default-value": 4.0, "default-meaning": "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 )'." }, "clip": { "css": "line-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "line-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "Simplify geometries by the given tolerance." }, "simplify-algorithm": { "css": "line-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "Simplify geometries by the given algorithm." }, "smooth": { "css": "line-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "offset": { "css": "line-offset", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Will not be offset.", "doc": "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).", "status": "unstable" }, "rasterizer": { "css": "line-rasterizer", "type": [ "full", "fast" ], "expression":true, "default-value": "full", "doc": "Exposes an alternate AGG rendering method that sacrifices some accuracy for speed.", "default-meaning": "The line will be rendered using the highest quality method rather than the fastest." }, "geometry-transform": { "css": "line-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform line geometry with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "line-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "markers": { "default": { "css": "marker", "type": [ "auto", "none" ], "doc": "Allows omitting a marker symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "marker-file", "doc": "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.", "default-value": "none", "default-meaning": "An ellipse or circle, if width equals height.", "type": "uri", "expression":true }, "opacity": { "css": "marker-opacity", "doc": "The overall opacity of the marker, if set, overrides both the opacity of the fill and the opacity of the stroke.", "default-value": 1.0, "default-meaning": "The stroke-opacity and fill-opacity of the marker.", "type": "float", "expression":true }, "fill-opacity": { "css": "marker-fill-opacity", "doc": "The fill opacity of the marker. This property will also set the `fill-opacity` of elements in an SVG loaded from a file.", "default-value": 1.0, "expression":true, "default-meaning": "Color is fully opaque.", "type": "float" }, "stroke": { "css": "marker-line-color", "doc": "The color of the stroke around the marker. This property will also set the `stroke` of elements in an SVG loaded from a file.", "default-value": "black", "type": "color", "expression":true, "default-meaning": "The marker will be drawn with a black outline." }, "stroke-width": { "css": "marker-line-width", "default-value": 0.5, "doc": "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.", "type": "float", "expression":true, "default-meaning": "The marker will be drawn with an outline of .5 pixels wide." }, "stroke-opacity": { "css": "marker-line-opacity", "default-value": 1.0, "default-meaning": "Color is fully opaque. This property will also set the `stroke-opacity` of elements in an SVG loaded from a file.", "doc": "The opacity of a line.", "type": "float", "expression":true }, "placement": { "css": "marker-placement", "type": [ "point", "line", "interior", "vertex-first", "vertex-last" ], "expression":true, "default-value": "point", "default-meaning": "Place markers at the center point (centroid) of the geometry.", "doc": "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." }, "multi-policy": { "css": "marker-multi-policy", "type": [ "each", "whole", "largest" ], "expression":true, "default-value": "each", "default-meaning": "If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each.", "doc": "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": { "css": "marker-type", "type": [ "arrow", "ellipse" ], "expression":true, "default-value": "ellipse", "default-meaning": "The marker shape is an ellipse.", "doc": "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).", "status": "deprecated" }, "width": { "css": "marker-width", "default-value": 10.0, "doc": "The width of the marker, if using one of the default types.", "type": "float", "expression":true, "default-meaning": "The marker width is 10 pixels." }, "height": { "css": "marker-height", "default-value": 10.0, "doc": "The height of the marker, if using one of the default types.", "type": "float", "expression":true, "default-meaning": "The marker height is 10 pixels." }, "fill": { "css": "marker-fill", "default-value": "blue", "doc": "The color of the area of the marker. This property will also set the `fill` of elements in an SVG loaded from a file.", "type": "color", "expression":true, "default-meaning": "The marker fill color is blue." }, "allow-overlap": { "css": "marker-allow-overlap", "type": "boolean", "expression":true, "default-value": false, "doc": "Control whether overlapping markers are shown or hidden.", "default-meaning": "Do not allow markers to overlap with each other - overlapping markers will not be shown." }, "avoid-edges": { "css": "marker-avoid-edges", "doc": "Avoid placing markers that intersect with tile boundaries.", "type": "boolean", "expression":true, "default-meaning": "Markers will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.", "default-value": false }, "ignore-placement": { "css": "marker-ignore-placement", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache.", "doc": "Value to control whether the placement of the feature will prevent the placement of other features." }, "spacing": { "css": "marker-spacing", "doc": "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.", "default-value": 100.0, "type": "float", "expression":true, "default-meaning": "In the case of marker-placement:line then draw a marker every 100 pixels along a line." }, "max-error": { "css": "marker-max-error", "type": "float", "expression":true, "default-value": 0.2, "default-meaning": "N/A: not intended to be changed.", "doc": "N/A: not intended to be changed." }, "transform": { "css": "marker-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform marker instance with specified function. Ignores map scale factor." }, "clip": { "css": "marker-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "marker-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Geometry will not be simplified.", "doc": "geometries are simplified by the given tolerance." }, "simplify-algorithm": { "css": "marker-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "geometries are simplified by the given algorithm." }, "smooth": { "css": "marker-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "marker-geometry-transform", "type": "functions", "expression":true, "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform marker geometry with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "offset": { "css": "marker-offset", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Will not be offset.", "doc": "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)." }, "comp-op": { "css": "marker-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true }, "direction": { "css": "marker-direction", "default-value": "right", "type": [ "auto", "auto-down", "left", "right", "left-only", "right-only", "up", "down" ], "expression": true, "default-meaning": "Markers are oriented to the right in the line direction.", "doc": "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": { "default": { "css": "shield", "type": [ "none" ], "doc": "Allows omitting a shield symbolizer.", "status": "unstable" }, "name": { "css": "shield-name", "type": "string", "expression":true, "serialization": "content", "default-value": "", "default-meaning": "No text label will be rendered with the shield.", "doc": "Value to use for a shield\"s text label. Data columns are specified using brackets like [column_name]." }, "file": { "css": "shield-file", "required": true, "type": "uri", "expression":true, "default-value": "none", "doc": "Image file to render behind the shield text. Accepted formats: svg, jpg, png, tiff, and webp.", "default-meaning": "" }, "face-name": { "css": "shield-face-name", "type": "string", "expression":true, "validate": "font", "doc": "Font name and style to use for the shield text.", "default-value": "none", "required": true, "default-meaning": "" }, "unlock-image": { "css": "shield-unlock-image", "type": "boolean", "expression":true, "doc": "This parameter should be set to true if you are trying to position text beside rather than on top of the shield image.", "default-value": false, "default-meaning": "text alignment relative to the shield image uses the center of the image as the anchor for text positioning." }, "size": { "css": "shield-size", "type": "float", "expression":true, "default-value": 10.0, "doc": "The size of the shield text in pixels.", "default-meaning": "Font size of 10 will be used to render text." }, "fill": { "css": "shield-fill", "type": "color", "expression":true, "default-value": "black", "doc": "The color of the shield text.", "default-meaning": "The shield text will be rendered black." }, "placement": { "css": "shield-placement", "type": [ "point", "line", "vertex", "interior" ], "expression":true, "default-value": "point", "default-meaning": "One shield will be placed per geometry.", "doc": "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." }, "avoid-edges": { "css": "shield-avoid-edges", "doc": "Avoid placing shields that intersect with tile boundaries.", "type": "boolean", "expression":true, "default-meaning": "Shields will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.", "default-value": false }, "allow-overlap": { "css": "shield-allow-overlap", "type": "boolean", "expression":true, "default-value": false, "doc": "Control whether overlapping shields are shown or hidden.", "default-meaning": "Shields will not overlap and any shields that might collide with previously placed shields will not be rendered.", "default-meaning": "Do not allow shields to overlap with other map elements already placed." }, "margin": { "css": "shield-margin", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No extra margin will be used to determine if a shield collides with any other text, shield, or marker.", "doc": "Minimum distance that a shield can be placed from any other text, shield, or marker." }, "repeat-distance": { "css": "shield-repeat-distance", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Shields with the same text will be rendered without restriction.", "doc": "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." }, "minimum-distance": { "css": "shield-min-distance", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Shields with the same text will be rendered without restriction.", "doc": "Minimum distance to any other collision object. Deprecated: replaced by `shield-margin`.", "status": "deprecated" }, "spacing": { "css": "shield-spacing", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Only one shield per line will attempt to be placed.", "doc": "Distance the renderer should use to try to place repeated shields on a line." }, "minimum-padding": { "css": "shield-min-padding", "expression":true, "default-value": 0.0, "doc": "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.", "default-meaning": "No margin will be used to detect if a shield is nearby a tile boundary.", "type": "float" }, "label-position-tolerance": { "css": "shield-label-position-tolerance", "default-value": "shield-spacing/2.0", "type": "float", "expression":true, "default-meaning": "If a shield cannot be placed then the renderer will advance by shield-spacing/2.0 to try placement again.", "doc": "Allows the shield to be displaced from its ideal position by a number of pixels (only works with placement:line)." }, "wrap-width": { "css": "shield-wrap-width", "type": "unsigned", "expression":true, "default-value": 0, "default-meaning": "Text will not be wrapped.", "doc": "Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap." }, "wrap-before": { "css": "shield-wrap-before", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "Wrapped lines will be a bit longer than wrap-width.", "doc": "Wrap text before wrap-width is reached." }, "wrap-character": { "css": "shield-wrap-character", "type": "string", "expression":true, "default-value": "\" \"", "default-meaning": "Lines will be wrapped conforming to the (untailored) Unicode Line Break Algorithm provided by ICU BreakIterator.", "doc": "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." }, "halo-fill": { "css": "shield-halo-fill", "type": "color", "expression":true, "default-value": "white", "doc": "Specifies the color of the halo around the text.", "default-meaning": "The shield halo text will be rendered white." }, "halo-radius": { "css": "shield-halo-radius", "default-value": 0.0, "default-meaning": "no halo.", "doc": "Specify the radius of the halo in pixels.", "type": "float", "expression":true }, "halo-rasterizer": { "css": "shield-halo-rasterizer", "type": [ "full", "fast" ], "expression":true, "default-value": "full", "default-meaning": "The shield will be rendered using the highest quality method rather than the fastest.", "doc": "Exposes an alternate text halo rendering method that sacrifices quality for speed." }, "halo-transform": { "css": "shield-halo-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "", "default-meaning": "No transformation.", "doc": "Transform shield halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor." }, "halo-comp-op": { "css": "shield-halo-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ], "expression":true }, "halo-opacity": { "css": "shield-halo-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text halo.", "default-value": 1.0, "type": "float", "expression":true, "default-meaning": "Fully opaque." }, "character-spacing": { "css": "shield-character-spacing", "type": "unsigned", "expression":true, "default-value": 0, "default-meaning": "The default character spacing of the font will be used.", "doc": "Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement." }, "line-spacing": { "css": "shield-line-spacing", "default-value": 0, "doc": "Vertical spacing between lines of multiline labels (in pixels).", "type": "float", "expression":true, "default-meaning": "The default font spacing will be used." }, "dx": { "css": "shield-text-dx", "type": "float", "expression":true, "doc": "Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right.", "default-meaning": "Text will not be displaced.", "default-value": 0.0 }, "dy": { "css": "shield-text-dy", "type": "float", "expression":true, "doc": "Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down.", "default-meaning": "Text will not be displaced.", "default-value": 0.0 }, "shield-dx": { "css": "shield-dx", "type": "float", "expression":true, "doc": "Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right.", "default-meaning": "Shield will not be displaced.", "default-value": 0.0 }, "shield-dy": { "css": "shield-dy", "type": "float", "expression":true, "doc": "Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down.", "default-meaning": "Shield will not be displaced.", "default-value": 0.0 }, "opacity": { "css": "shield-opacity", "type": "float", "expression":true, "doc": "The opacity of the image used for the shield.", "default-meaning": "Color is fully opaque.", "default-value": 1.0 }, "text-opacity": { "css": "shield-text-opacity", "type": "float", "expression":true, "doc": "The opacity of the text placed on top of the shield.", "default-meaning": "Color is fully opaque.", "default-value": 1.0 }, "horizontal-alignment": { "css": "shield-horizontal-alignment", "type": [ "left", "middle", "right", "auto" ], "expression":true, "doc": "The shield's horizontal alignment from its centerpoint.", "default-meaning": "TODO.", "default-value": "auto" }, "vertical-alignment": { "css": "shield-vertical-alignment", "type": [ "top", "middle", "bottom", "auto" ], "expression":true, "doc": "The shield's vertical alignment from its centerpoint.", "default-meaning": "TODO.", "default-value": "middle" }, "placement-type": { "css": "shield-placement-type", "doc": "Re-position and/or re-size shield to avoid overlaps. \"simple\" for basic algorithm (using shield-placements string,) \"dummy\" to turn this feature off.", "type": [ "dummy", "simple", "list" ], "expression":true, "default-meaning": "Alternative placements will not be enabled.", "default-value": "dummy" }, "placements": { "css": "shield-placements", "type": "string", "expression":true, "default-value": "", "default-meaning": "No alternative placements will be used.", "doc": "If \"placement-type\" is set to \"simple\", use this \"POSITIONS,[SIZES]\" string. An example is `shield-placements: \"E,NE,SE,W,NW,SW\";`." }, "text-transform": { "css": "shield-text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize", "reverse" ], "expression":true, "doc": "Transform the case of the characters.", "default-meaning": "No text transformation will be applied.", "default-value": "none" }, "justify-alignment": { "css": "shield-justify-alignment", "type": [ "left", "center", "right", "auto" ], "expression":true, "doc": "Define how text in a shield's label is justified.", "default-meaning": "TODO.", "default-value": "auto" }, "transform": { "css": "shield-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform shield instance with specified function. Ignores map scale factor." }, "clip": { "css": "shield-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "shield-simplify", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "Simplify the geometries used for shield placement by the given tolerance." }, "simplify-algorithm": { "css": "shield-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression": true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "Simplify the geometries used for shield placement by the given algorithm." }, "smooth": { "css": "shield-smooth", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "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." }, "comp-op": { "css": "shield-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "line-pattern": { "default": { "css": "line-pattern", "type": [ "none" ], "doc": "Allows omitting a line pattern symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "line-pattern-file", "type": "uri", "expression":true, "default-value": "none", "required": true, "doc": "An image file to be repeated and warped along a line. Accepted formats: svg, jpg, png, tiff, and webp.", "default-meaning": "" }, "clip": { "css": "line-pattern-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "opacity": { "css": "line-pattern-opacity", "type": "float", "expression":true, "doc": "Apply an opacity level to the image used for the pattern.", "default-value": 1.0, "default-meaning": "The image is rendered without modifications." }, "simplify": { "css": "line-pattern-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "geometries are simplified by the given tolerance." }, "simplify-algorithm": { "css": "line-pattern-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "geometries are simplified by the given algorithm." }, "smooth": { "css": "line-pattern-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "offset": { "css": "line-pattern-offset", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "The line will not be offset.", "doc": "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)." }, "geometry-transform": { "css": "line-pattern-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform line geometry with specified function and apply pattern to transformed geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "transform": { "css": "line-pattern-transform", "type": "functions", "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform line pattern instance with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "line-pattern-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "polygon-pattern": { "default": { "css": "polygon-pattern", "type": [ "none" ], "doc": "Allows omitting a polygon pattern symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "polygon-pattern-file", "type": "uri", "expression":true, "default-value": "none", "required": true, "doc": "Image to use as a repeated pattern fill within a polygon. Accepted formats: svg, jpg, png, tiff, and webp.", "default-meaning": "" }, "alignment": { "css": "polygon-pattern-alignment", "type": [ "global", "local" ], "expression":true, "default-value": "global", "doc": "Specify whether to align pattern fills to the layer's geometry (local) or to the map (global).", "default-meaning":"Patterns will be aligned to the map (or tile boundaries) when being repeated across polygons. This is ideal for seamless patterns in tiled rendering." }, "gamma": { "css": "polygon-pattern-gamma", "type": "float", "expression":true, "default-value": 1.0, "default-meaning": "Fully antialiased.", "range": "0-1", "doc": "Level of antialiasing of polygon pattern edges." }, "opacity": { "css": "polygon-pattern-opacity", "type": "float", "expression":true, "doc": "Apply an opacity level to the image used for the pattern.", "default-value": 1.0, "default-meaning": "The image is rendered without modifications." }, "clip": { "css": "polygon-pattern-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "polygon-pattern-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "geometries are simplified by the given tolerance." }, "simplify-algorithm": { "css": "polygon-pattern-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "geometries are simplified by the given algorithm." }, "smooth": { "css": "polygon-pattern-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "polygon-pattern-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform polygon geometry with specified function and apply pattern to transformed geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "transform": { "css": "polygon-pattern-transform", "type": "functions", "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform polygon pattern instance with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "polygon-pattern-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "raster": { "default": { "css": "raster", "type": [ "auto", "none" ], "doc": "Allows omitting a raster symbolizer rule or emitting it with default values.", "status": "unstable" }, "opacity": { "css": "raster-opacity", "default-value": 1.0, "default-meaning": "Color is fully opaque.", "type": "float", "doc": "The opacity of the raster symbolizer on top of other symbolizers." }, "filter-factor": { "css": "raster-filter-factor", "default-value": -1.0, "default-meaning": "Allow the datasource to choose appropriate downscaling.", "type": "float", "doc": "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." }, "scaling": { "css": "raster-scaling", "type": [ "near", "fast", "bilinear", "bicubic", "spline16", "spline36", "hanning", "hamming", "hermite", "kaiser", "quadric", "catrom", "gaussian", "bessel", "mitchell", "sinc", "lanczos", "blackman" ], "default-value": "near", "default-meaning": "Nearest neighboor resampling will be used to scale the image to the target size of the map.", "doc": "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." }, "mesh-size": { "css": "raster-mesh-size", "default-value": 16, "default-meaning": "Reprojection mesh will be 1/16 of the resolution of the source image.", "type": "unsigned", "doc": "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." }, "comp-op": { "css": "raster-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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-mode": { "css": "raster-colorizer-default-mode", "type": [ "discrete", "linear", "exact" ], "doc": "This can be either `discrete`, `linear` or `exact`. If it is not specified then the default is `linear`.", "default-value": "linear", "default-meaning": "A linear interpolation is used to generate colors between the two nearest stops." }, "default-color": { "css": "raster-colorizer-default-color", "type": "color", "doc": "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.", "default-value": "transparent", "default-meaning": "Pixels that are not colored by the colorizer stops will be transparent." }, "epsilon": { "css": "raster-colorizer-epsilon", "type": "float", "doc": "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.", "default-value": "1.1920928955078125e-07", "default-meaning": "Pixels must very closely match the stop filter otherwise they will not be colored." }, "stop": { "css": "raster-colorizer-stops", "type": "tags", "serialization": "tag", "tagname": "tagname", "doc": "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)`.", "default-value": "", "default-meaning": "No colorization will happen without supplying stops." } }, "point": { "default": { "css": "point", "type": [ "auto", "none" ], "doc": "Allows omitting a point symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "point-file", "type": "uri", "expression":true, "required": false, "default-value": "none", "default-meaning": "A 4x4 black square will be rendered.", "doc": "Image file to represent a point. Accepted formats: svg, jpg, png, tiff, and webp." }, "allow-overlap": { "css": "point-allow-overlap", "type": "boolean", "expression":true, "default-value": false, "doc": "Control whether overlapping points are shown or hidden.", "default-meaning": "Do not allow points to overlap with each other - overlapping markers will not be shown." }, "ignore-placement": { "css": "point-ignore-placement", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache.", "doc": "Control whether the placement of the feature will prevent the placement of other features." }, "opacity": { "css": "point-opacity", "type": "float", "expression":true, "default-value": 1.0, "default-meaning": "Fully opaque.", "doc": "A value from 0 to 1 to control the opacity of the point." }, "placement": { "css": "point-placement", "type": [ "centroid", "interior" ], "expression":true, "doc": "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.", "default-meaning": "The centroid of the geometry will be used to place the point.", "default-value": "centroid" }, "transform": { "css": "point-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform point instance with specified function. Ignores map scale factor." }, "comp-op": { "css": "point-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "text": { "default": { "css": "text", "type": [ "none" ], "doc": "Allows omitting a text symbolizer rule.", "status": "unstable" }, "name": { "css": "text-name", "type": "string", "expression":true, "required": true, "default-value": "none", "serialization": "content", "doc": "Value to use for a text label. Data columns are specified using brackets like [column_name].", "default-meaning": "" }, "face-name": { "css": "text-face-name", "type": "string", "expression":false, "validate": "font", "default-value": "none", "doc": "Font name and style to render a label in.", "required": true, "default-meaning": "" }, "size": { "css": "text-size", "type": "float", "expression":true, "default-value": 10.0, "doc": "Text size in pixels.", "default-meaning": "Font size of 10 will be used to render text." }, "text-ratio": { "css": "text-ratio", "doc": "Define the amount of text (of the total) present on successive lines when wrapping occurs.", "default-value": 0, "type": "unsigned", "expression":true, "default-meaning":"TODO." }, "wrap-width": { "css": "text-wrap-width", "doc": "Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap.", "default-value": 0, "type": "unsigned", "expression":true, "default-meaning": "Text will not be wrapped." }, "wrap-before": { "css": "text-wrap-before", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "Wrapped lines will be a bit longer than wrap-width.", "doc": "Wrap text before wrap-width is reached." }, "wrap-character": { "css": "text-wrap-character", "type": "string", "expression":true, "default-value": "\" \"", "default-meaning": "Lines will be wrapped conforming to the (untailored) Unicode Line Break Algorithm provided by ICU BreakIterator.", "doc": "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." }, "repeat-wrap-character": { "css": "text-repeat-wrap-character", "type": "boolean", "expression": true, "default-value": false, "default-meaning": "Character will be removed when used to wrap a line.", "doc": "Keep the character used to wrap a line instead of removing it, and repeat it on the new line.", "status": "unstable" }, "spacing": { "css": "text-spacing", "type": "unsigned", "expression":true, "default-value": 0, "default-meaning": "Only one label per line will attempt to be placed.", "doc": "Distance the renderer should use to try to place repeated text labels on a line." }, "character-spacing": { "css": "text-character-spacing", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "The default character spacing of the font will be used.", "doc": "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." }, "line-spacing": { "css": "text-line-spacing", "default-value": 0, "type": "float", "expression":true, "default-meaning": "The default font spacing will be used.", "doc": "Vertical spacing adjustment between lines in pixels." }, "label-position-tolerance": { "css": "text-label-position-tolerance", "default-value": "text-spacing/2.0", "type": "float", "expression":true, "default-meaning": "If a shield cannot be placed then the renderer will advance by text-spacing/2.0 to try placement again.", "doc": "Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line)." }, "max-char-angle-delta": { "css": "text-max-char-angle-delta", "type": "float", "expression":true, "default-value": 22.5, "default-meaning":"The label will not be placed if a character falls on a line with an angle sharper than 22.5 degrees.", "doc": "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." }, "fill": { "css": "text-fill", "type": "color", "expression":true, "doc": "Specifies the color for the text.", "default-value": "black", "default-meaning": "The text will be rendered black." }, "opacity": { "css": "text-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text.", "default-value": 1.0, "default-meaning": "Fully opaque", "expression":true, "default-meaning": "Fully opaque.", "type": "float" }, "halo-opacity": { "css": "text-halo-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text halo.", "default-value": 1.0, "type": "float", "expression":true, "default-meaning": "Fully opaque." }, "halo-fill": { "css": "text-halo-fill", "type": "color", "expression":true, "default-value": "white", "default-meaning": "The halo will be rendered white.", "doc": "Specifies the color of the halo around the text." }, "halo-radius": { "css": "text-halo-radius", "doc": "Specify the radius of the halo in pixels.", "default-value": 0.0, "type": "float", "expression":true, "default-meaning": "no halo." }, "halo-rasterizer": { "css": "text-halo-rasterizer", "type": [ "full", "fast" ], "expression":true, "default-value": "full", "default-meaning": "The text will be rendered using the highest quality method rather than the fastest.", "doc": "Exposes an alternate text halo rendering method that sacrifices quality for speed." }, "halo-transform": { "css": "text-halo-transform", "type": "functions", "expression":true, "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "", "default-meaning": "No transformation.", "doc": "Transform text halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor." }, "dx": { "css": "text-dx", "type": "float", "expression":true, "doc": "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.", "default-meaning": "Text will not be displaced.", "default-value": 0.0 }, "dy": { "css": "text-dy", "type": "float", "expression":true, "doc": "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.", "default-meaning": "Text will not be displaced.", "default-value": 0.0 }, "vertical-alignment": { "css": "text-vertical-alignment", "type": [ "top", "middle", "bottom", "auto" ], "expression":true, "doc": "Position of label relative to point position.", "default-value": "auto", "default-meaning": "Default affected by value of dy; \"top\" for dy>0, \"bottom\" for dy<0." }, "avoid-edges": { "css": "text-avoid-edges", "doc": "Avoid placing labels that intersect with tile boundaries.", "default-value": false, "type": "boolean", "expression":true, "default-meaning": "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." }, "margin": { "css": "text-margin", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No extra margin will be used to determine if a label collides with any other text, shield, or marker.", "doc": "Minimum distance that a label can be placed from any other text, shield, or marker." }, "repeat-distance": { "css": "text-repeat-distance", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Labels with the same text will be rendered without restriction.", "doc": "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." }, "minimum-distance": { "css": "text-min-distance", "type": "float", "default-value": 0.0, "expression":true, "default-meaning": "Labels with the same text will be rendered without restriction.", "doc": "Minimum distance to the next label with the same text. Only works for line placement. Deprecated: replaced by `text-repeat-distance` and `text-margin`", "status": "deprecated" }, "minimum-padding": { "css": "text-min-padding", "default-value": 0.0, "type": "float", "expression":true, "doc": "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.", "default-meaning": "No margin will be used to detect if a text label is nearby a tile boundary." }, "minimum-path-length": { "css": "text-min-path-length", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "place labels on all geometries no matter how small they are.", "doc": "Place labels only on polygons and lines with a bounding width longer than this value (in pixels)." }, "allow-overlap": { "css": "text-allow-overlap", "type": "boolean", "expression":true, "default-value": false, "doc": "Control whether overlapping text is shown or hidden.", "default-meaning": "Do not allow text to overlap with other text - overlapping markers will not be shown." }, "orientation": { "css": "text-orientation", "type": "float", "expression":true, "default-value": 0.0, "doc": "Rotate the text. (only works with text-placement:point).", "default-meaning": "Text is not rotated and is displayed upright." }, "rotate-displacement": { "css": "text-rotate-displacement", "type": "boolean", "doc": "Rotates the displacement around the placement origin by the angle given by \"orientation\".", "default-value": false, "default-meaning": "Label center is used for rotation." }, "upright": { "css": "text-upright", "default-value": "auto", "type": [ "auto", "auto-down", "left", "right", "left-only", "right-only" ], "expression":true, "default-meaning": "Text will be positioned upright automatically.", "doc": "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." }, "placement": { "css": "text-placement", "default-value": "point", "type": [ "point", "line", "vertex", "interior" ], "expression":true, "default-meaning": "One shield will be placed per geometry.", "doc": "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." }, "placement-type": { "css": "text-placement-type", "doc": "Re-position and/or re-size text to avoid overlaps. \"simple\" for basic algorithm (using text-placements string,) \"dummy\" to turn this feature off.", "type": [ "dummy", "simple", "list" ], "expression":true, "default-meaning": "Alternative placements will not be enabled.", "default-value": "dummy" }, "placements": { "css": "text-placements", "type": "string", "default-meaning": "No alternative placements will be used.", "default-value": "", "expression":true, "doc": "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": { "css": "text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize", "reverse" ], "expression":true, "doc": "Transform the case of the characters.", "default-meaning": "Transform text instance with specified function. Ignores map scale factor.", "default-value": "none" }, "horizontal-alignment": { "css": "text-horizontal-alignment", "type": [ "left", "middle", "right", "auto", "adjust" ], "expression":true, "doc": "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`.", "default-value": "auto", "default-meaning":"TODO." }, "justify-alignment": { "css": "text-align", "type": [ "left", "right", "center", "auto" ], "expression":true, "doc": "Define how text is justified.", "default-value": "auto", "default-meaning": "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." }, "clip": { "css": "text-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "text-simplify", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "Simplify the geometries used for text placement by the given tolerance." }, "simplify-algorithm": { "css": "text-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression": true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "Simplify the geometries used for text placement by the given algorithm." }, "smooth": { "css": "text-smooth", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "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." }, "comp-op": { "css": "text-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true }, "halo-comp-op": { "css": "text-halo-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ], "expression":true }, "font-feature-settings": { "css": "text-font-feature-settings", "type": "string", "default-value": "", "default-meaning": "Default set of typographic features recommended by OpenType specification. Ligatures are turned off by default when `character-spacing` is greater than zero.", "doc": "Comma separated list of OpenType typographic features. The syntax and semantics conforms to `font-feature-settings` from W3C CSS." }, "largest-bbox-only": { "css": "text-largest-bbox-only", "type": "boolean", "expression": true, "default-value": true, "default-meaning": "For multipolygons only polygon with largest bbox area is labeled (does not apply to other geometries).", "doc": "Controls default labeling behavior on multipolygons. The default is true and means that only the polygon with largest bbox is labeled.", "status": "experimental" } }, "building": { "default": { "css": "building", "type": [ "auto", "none" ], "doc": "Allows omitting a building symbolizer rule or emitting it with default values.", "status": "unstable" }, "fill": { "css": "building-fill", "expression":true, "type":"color", "default-value": "The color gray will be used for fill.", "default-meaning": "Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).", "doc": "The color of the buildings fill. Note: 0.8 will be used to multiply each color component to auto-generate a darkened wall color." }, "fill-opacity": { "css": "building-fill-opacity", "type": "float", "expression":true, "doc": "The opacity of the building as a whole, including all walls.", "default-value": 1.0, "default-meaning": "Color is fully opaque." }, "height": { "css": "building-height", "doc": "The height of the building in pixels.", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Buildings will not have a visual height and will instead look like flat polygons." } }, "debug": { "mode": { "css": "debug-mode", "type": [ "collision", "vertex" ], "default-value": "collision", "doc": "The mode for debug rendering.", "expression":true, "default-meaning": "The otherwise invisible collision boxes will be rendered as squares on the map." } }, "dot": { "default": { "css": "dot", "type": [ "auto", "none" ], "doc": "Allows omitting a dot symbolizer rule or emitting it with default values.", "status": "unstable" }, "fill": { "css": "dot-fill", "default-value": "gray", "doc": "The color of the area of the dot.", "type": "color", "expression":true, "default-meaning": "The dot fill color is gray." }, "opacity": { "css": "dot-opacity", "doc": "The overall opacity of the dot.", "default-value": 1.0, "default-meaning": "The opacity of the dot.", "type": "float", "expression":true }, "width": { "css": "dot-width", "default-value": 1.0, "doc": "The width of the dot in pixels.", "type": "float", "expression":true, "default-meaning": "The marker width is 1 pixel." }, "height": { "css": "dot-height", "default-value": 1.0, "doc": "The height of the dot in pixels.", "type": "float", "expression":true, "default-meaning": "The marker height is 1 pixels." }, "comp-op": { "css": "dot-comp-op", "default-value": "src-over", "default-meaning": "Add the current layer on top of other layers.", "doc": "Composite operation. This defines how this layer should behave relative to layers atop or below it.", "type": [ "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" ] } } }, "colors": { "aliceblue": [240, 248, 255], "antiquewhite": [250, 235, 215], "aqua": [0, 255, 255], "aquamarine": [127, 255, 212], "azure": [240, 255, 255], "beige": [245, 245, 220], "bisque": [255, 228, 196], "black": [0, 0, 0], "blanchedalmond": [255,235,205], "blue": [0, 0, 255], "blueviolet": [138, 43, 226], "brown": [165, 42, 42], "burlywood": [222, 184, 135], "cadetblue": [95, 158, 160], "chartreuse": [127, 255, 0], "chocolate": [210, 105, 30], "coral": [255, 127, 80], "cornflowerblue": [100, 149, 237], "cornsilk": [255, 248, 220], "crimson": [220, 20, 60], "cyan": [0, 255, 255], "darkblue": [0, 0, 139], "darkcyan": [0, 139, 139], "darkgoldenrod": [184, 134, 11], "darkgray": [169, 169, 169], "darkgreen": [0, 100, 0], "darkgrey": [169, 169, 169], "darkkhaki": [189, 183, 107], "darkmagenta": [139, 0, 139], "darkolivegreen": [85, 107, 47], "darkorange": [255, 140, 0], "darkorchid": [153, 50, 204], "darkred": [139, 0, 0], "darksalmon": [233, 150, 122], "darkseagreen": [143, 188, 143], "darkslateblue": [72, 61, 139], "darkslategrey": [47, 79, 79], "darkturquoise": [0, 206, 209], "darkviolet": [148, 0, 211], "deeppink": [255, 20, 147], "deepskyblue": [0, 191, 255], "dimgray": [105, 105, 105], "dimgrey": [105, 105, 105], "dodgerblue": [30, 144, 255], "firebrick": [178, 34, 34], "floralwhite": [255, 250, 240], "forestgreen": [34, 139, 34], "fuchsia": [255, 0, 255], "gainsboro": [220, 220, 220], "ghostwhite": [248, 248, 255], "gold": [255, 215, 0], "goldenrod": [218, 165, 32], "gray": [128, 128, 128], "grey": [128, 128, 128], "green": [0, 128, 0], "greenyellow": [173, 255, 47], "honeydew": [240, 255, 240], "hotpink": [255, 105, 180], "indianred": [205, 92, 92], "indigo": [75, 0, 130], "ivory": [255, 255, 240], "khaki": [240, 230, 140], "lavender": [230, 230, 250], "lavenderblush": [255, 240, 245], "lawngreen": [124, 252, 0], "lemonchiffon": [255, 250, 205], "lightblue": [173, 216, 230], "lightcoral": [240, 128, 128], "lightcyan": [224, 255, 255], "lightgoldenrodyellow": [250, 250, 210], "lightgray": [211, 211, 211], "lightgreen": [144, 238, 144], "lightgrey": [211, 211, 211], "lightpink": [255, 182, 193], "lightsalmon": [255, 160, 122], "lightseagreen": [32, 178, 170], "lightskyblue": [135, 206, 250], "lightslategray": [119, 136, 153], "lightslategrey": [119, 136, 153], "lightsteelblue": [176, 196, 222], "lightyellow": [255, 255, 224], "lime": [0, 255, 0], "limegreen": [50, 205, 50], "linen": [250, 240, 230], "magenta": [255, 0, 255], "maroon": [128, 0, 0], "mediumaquamarine": [102, 205, 170], "mediumblue": [0, 0, 205], "mediumorchid": [186, 85, 211], "mediumpurple": [147, 112, 219], "mediumseagreen": [60, 179, 113], "mediumslateblue": [123, 104, 238], "mediumspringgreen": [0, 250, 154], "mediumturquoise": [72, 209, 204], "mediumvioletred": [199, 21, 133], "midnightblue": [25, 25, 112], "mintcream": [245, 255, 250], "mistyrose": [255, 228, 225], "moccasin": [255, 228, 181], "navajowhite": [255, 222, 173], "navy": [0, 0, 128], "oldlace": [253, 245, 230], "olive": [128, 128, 0], "olivedrab": [107, 142, 35], "orange": [255, 165, 0], "orangered": [255, 69, 0], "orchid": [218, 112, 214], "palegoldenrod": [238, 232, 170], "palegreen": [152, 251, 152], "paleturquoise": [175, 238, 238], "palevioletred": [219, 112, 147], "papayawhip": [255, 239, 213], "peachpuff": [255, 218, 185], "peru": [205, 133, 63], "pink": [255, 192, 203], "plum": [221, 160, 221], "powderblue": [176, 224, 230], "purple": [128, 0, 128], "red": [255, 0, 0], "rosybrown": [188, 143, 143], "royalblue": [65, 105, 225], "saddlebrown": [139, 69, 19], "salmon": [250, 128, 114], "sandybrown": [244, 164, 96], "seagreen": [46, 139, 87], "seashell": [255, 245, 238], "sienna": [160, 82, 45], "silver": [192, 192, 192], "skyblue": [135, 206, 235], "slateblue": [106, 90, 205], "slategray": [112, 128, 144], "slategrey": [112, 128, 144], "snow": [255, 250, 250], "springgreen": [0, 255, 127], "steelblue": [70, 130, 180], "tan": [210, 180, 140], "teal": [0, 128, 128], "thistle": [216, 191, 216], "tomato": [255, 99, 71], "turquoise": [64, 224, 208], "violet": [238, 130, 238], "wheat": [245, 222, 179], "white": [255, 255, 255], "whitesmoke": [245, 245, 245], "yellow": [255, 255, 0], "yellowgreen": [154, 205, 50], "transparent": [0, 0, 0, 0] }, "filter": { "value": [ "true", "false", "null", "point", "linestring", "polygon", "collection" ] } } mapnik-reference-8.10.0/3.0.20/000077500000000000000000000000001342311331100155235ustar00rootroot00000000000000mapnik-reference-8.10.0/3.0.20/datasources.json000066400000000000000000000557071342311331100207510ustar00rootroot00000000000000{ "datasources": { "csv": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "strict": { "type": "boolean", "doc": "Control if the datasource should throw on invalid rows", "default-value": false, "default-meaning": "Unless this option is set to true the datasource will skip invalid rows and attempt to parse as much data as possible" }, "escape": { "type": "string", "doc": "The escape character to use for parsing data", "default-value": "A single backslash (aka. reverse solidus): \\", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "quote": { "type": "string", "doc": "The quote character to use for parsing data", "default-value": "A quotation mark (aka. double quote): \"", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "separator": { "type": "string", "doc": "The separator character to use for parsing data", "default-value": "Basic autodetection is used to determine the best default value if the user does not manually supply a separator.", "default-meaning": "A comma will be used unless more tabs (\t), pipes (|), or semicolons (;) are detected than commas in the header row (in that order of preference)" }, "headers": { "type": "string", "doc": "A comma separated list of header names that can be set to add headers to data that lacks them", "default-value": "", "default-meaning": "Headers will be parsed from the first line of the data unless this option is set" }, "filesize_max": { "type": "float", "doc": "The maximum filesize in MB that will be accepted", "default-value": 20, "default-meaning": "A file that is larger that 20 MB will not be accepted and an error will be throw unless the user manually passes this option with a larger value (useful only in cases where your machine has a lot of memory)" } }, "gdal": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "max_image_area": { "type": "unsigned", "doc": "Maximum memory limitation for image will be simply based on the maximum area we allow for an image. The true memory footprint therefore will vary based on the type of imagery that exists. This is not the maximum size of an image on disk but rather the maximum size we will load into mapnik from GDAL. `max_im_area` based on 50 mb limit for RGBA", "default-value": 13107200, "default-meaning": "50Mb", "required": false }, "band": { "type": "unsigned", "doc": "A particular raster band to work with.", "default-value": 0, "default-meaning": "No particular raster band set, working with all bands.", "required": false }, "nodata": { "type": "float", "doc": "Overrides nodata value from the raster.", "default-value": 0, "default-meaning": "Nodata value from the raster is used.", "required": false }, "nodata_tolerance": { "type": "float", "doc": "Make pixels in this tolerance around nodata value transparent.", "default-value": 1e-12, "default-meaning": "The tolerance is effectively zero.", "required": false }, "shared": { "type": "boolean", "doc": "Allows to share the GDAL dataset handle with other GDAL datasources with the same file path.", "default-value": false, "default-meaning": "The datasource will use unique dataset instance.", "required": false } }, "geojson": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "inline": { "type": "string", "doc": "Raw tabular data to be read instead of reading data from a file", "default-value": "", "default-meaning": "Unless this option is provided data will be read from the `file` option" } }, "occi": { "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "ogr": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "osm": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "postgis": { "table": { "type": "string", "doc": "The table or query used", "default-value": "", "default-meaning": "", "required": true }, "key_field": { "type": "boolean", "doc": "User provided field name to interpret as the primary key of the table. If provided then the values from this field (which must be an integer) will be used as the feature id of the returned data", "default-value": "", "default-meaning": "By default no primary key is required and in this case the feature id for returned features will be auto-generated by Mapnik and is not certain to be globally unique.", "required": false }, "key_field_as_attribute": { "type": "boolean", "doc": "User provided option to control whether the key_field will be duplicated as a feature attribute (as well as being used for the feature.id value)", "default-value": true, "default-meaning": "By default if key_field is provided then it is also available in the feature attributes by field name", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "dbname": { "type": "string", "doc": "Database name", "default-value": "username", "default-meaning": "Will default to a database named after the user (as per libpq defaults)", "required": false }, "host": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "password": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "port": { "type": "unsigned", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "user": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "connect_timeout": { "type": "unsigned", "doc": "", "default-value": 4, "default-meaning": "", "required": false }, "schema": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "extent": { "type": "string", "doc": "A comma or space delimited bounding box in the format of minx,miny,maxx,maxy that, if provided, will be used to report the extent of the datasource. The primary reason the option exists is for performance: providing this option at datasource creation saves the time otherwise needed to scan the data for the actual extent, which for large datasets can be very significant. The datasource extent, whether manually provided or automatically calculated is used during rendering to decide if the datasource should be queried for features or not (skipped for best performance). If the extent intersects with the map rendering extent then the datasource will be queried and the query extent will be clipped to the reported datasource extent. So, this means that this option can also be used to restrict which features are available for a given datasource", "default-value": "", "default-meaning": "The datasource extent will be determined at runtime by querying the data, which may be slow, although the extent only needs to be determined once per datasource initialized and it will be cached for further rendering", "recommended": true }, "estimate_extent": { "type": "boolean", "doc": "If an `extent` string is not provided then Mapnik dynamically queries the table to determine the extent. If this option is true then the faster but less accurate PostGIS `ST_EstimatedExtent` function is used instead of `ST_Extent`.", "default-value": false, "default-meaning": "", "required": false }, "geometry_table": { "type": "string", "doc": "Specifies geometry table to use to look up metadata", "default-value": "", "default-meaning": "Automatically parsed from 'table' value", "required": false }, "geometry_field": { "type": "string", "doc": "Specifies geometry field to use", "default-value": "", "default-meaning": "First entry in geometry_columns", "required": false }, "cursor_size": { "type": "unsigned", "doc": "Integer size of binary cursor to use", "default-value": 0, "default-meaning": "No binary cursor is used", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "srid": { "type": "unsigned", "doc": "SRID to use", "default-value": 0, "default-meaning": "Auto-detected from geometry_field", "required": false }, "initial_size": { "type": "unsigned", "doc": "Integer size of connection pool", "default-value": 1, "default-meaning": "", "required": false }, "max_size": { "type": "unsigned", "doc": "Integer max of connection pool", "default-value": 10, "default-meaning": "", "required": false }, "simplify_geometries": { "type": "boolean", "doc": "Simplify geometries with ST_Simplify", "default-value": false, "default-meaning": "Don't simplify geometries", "required": false }, "autodetect_key_field": { "type": "boolean", "doc": "Attempt to autodetect a primary key field", "default-value": false, "default-meaning": "Don't autodetect a primary key field", "required": false }, "persist_connection": { "type": "boolean", "doc": "Keep connection open", "default-value": true, "default-meaning": "Connections, successfully created, will be kept open until Mapnik shuts down", "required": false }, "extent_from_subquery": { "type": "boolean", "doc": "Direct Mapnik to query Postgis for the extent of the raw 'table' value", "default-value": false, "default-meaning": "Uses 'geometry_table' instead of querying", "required": false } }, "python": { "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "raster": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false } }, "rasterlite": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false } }, "shape": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "sqlite": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "table": { "type": "string", "doc": "The table or query used", "default-value": "", "default-meaning": "", "required": true }, "key_field": { "type": "boolean", "doc": "User provided field name to interpret as the primary key of the table. If provided then the values from this field (which must be an integer) will be used as the feature id of the returned data", "default-value": "", "default-meaning": "By default no primary key is required and in this case the feature id for returned features will be auto-generated by Mapnik and is not certain to be globally unique.", "required": false } }, "topojson": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "inline": { "type": "string", "doc": "Raw tabular data to be read instead of reading data from a file", "default-value": "", "default-meaning": "Unless this option is provided data will be read from the `file` option" } } } }mapnik-reference-8.10.0/3.0.20/datasources.template.json000066400000000000000000000366701342311331100225610ustar00rootroot00000000000000{ "types": { "type": { "type": "string", "doc": "The type of the option", "values": ["string","float","boolean","unsigned"], "required": true }, "doc": { "type": "string", "doc": "The basic description of the option and the expected behavior if you provide it", "required": true }, "default-value": { "type": "string", "doc": "Either an empty string if there is no default value, a description of the default value, or the default value itself (if appropriate)", "required": true }, "default-meaning": { "type": "string", "doc": "A detailed description of what the behavior will be if the default value is left unchanged", "required": true }, "required": { "type": "boolean", "doc": "A boolean value to signify if the option is required. Can be left out and if not present it will be assumed that the option is not required", "required": false }, "recommended": { "type": "boolean", "doc": "A boolean value to signify if the option is recommended, even if it is not required. This is meant to indicate to users that better behavior or performance will be gained if they manually provide the option and that they should seek to understand why it exists (and also why/how it needs to be manually provided)", "required": false } }, "variables": { "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "extent" : { "type": "string", "doc": "A comma or space delimited bounding box in the format of minx,miny,maxx,maxy that, if provided, will be used to report the extent of the datasource. The primary reason the option exists is for performance: providing this option at datasource creation saves the time otherwise needed to scan the data for the actual extent, which for large datasets can be very significant. The datasource extent, whether manually provided or automatically calculated is used during rendering to decide if the datasource should be queried for features or not (skipped for best performance). If the extent intersects with the map rendering extent then the datasource will be queried and the query extent will be clipped to the reported datasource extent. So, this means that this option can also be used to restrict which features are available for a given datasource", "default-value": "", "default-meaning": "The datasource extent will be determined at runtime by querying the data, which may be slow, although the extent only needs to be determined once per datasource initialized and it will be cached for further rendering", "recommended": true }, "table" : { "type": "string", "doc": "The table or query used", "default-value": "", "default-meaning": "", "required": true }, "key_field": { "type": "boolean", "doc": "User provided field name to interpret as the primary key of the table. If provided then the values from this field (which must be an integer) will be used as the feature id of the returned data", "default-value": "", "default-meaning": "By default no primary key is required and in this case the feature id for returned features will be auto-generated by Mapnik and is not certain to be globally unique.", "required": false }, "inline": { "type": "string", "doc": "Raw tabular data to be read instead of reading data from a file", "default-value": "", "default-meaning": "Unless this option is provided data will be read from the `file` option" } }, "datasources": { "csv": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "row_limit":"<@(row_limit)", "strict": { "type": "boolean", "doc": "Control if the datasource should throw on invalid rows", "default-value": false, "default-meaning": "Unless this option is set to true the datasource will skip invalid rows and attempt to parse as much data as possible" }, "escape": { "type": "string", "doc": "The escape character to use for parsing data", "default-value": "A single backslash (aka. reverse solidus): \\", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "quote": { "type": "string", "doc": "The quote character to use for parsing data", "default-value": "A quotation mark (aka. double quote): \"", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "separator": { "type": "string", "doc": "The separator character to use for parsing data", "default-value": "Basic autodetection is used to determine the best default value if the user does not manually supply a separator.", "default-meaning": "A comma will be used unless more tabs (\t), pipes (|), or semicolons (;) are detected than commas in the header row (in that order of preference)" }, "headers": { "type": "string", "doc": "A comma separated list of header names that can be set to add headers to data that lacks them", "default-value": "", "default-meaning": "Headers will be parsed from the first line of the data unless this option is set" }, "filesize_max": { "type": "float", "doc": "The maximum filesize in MB that will be accepted", "default-value": 20.0, "default-meaning": "A file that is larger that 20 MB will not be accepted and an error will be throw unless the user manually passes this option with a larger value (useful only in cases where your machine has a lot of memory)" } }, "gdal": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "max_image_area": { "type": "unsigned", "doc": "Maximum memory limitation for image will be simply based on the maximum area we allow for an image. The true memory footprint therefore will vary based on the type of imagery that exists. This is not the maximum size of an image on disk but rather the maximum size we will load into mapnik from GDAL. `max_im_area` based on 50 mb limit for RGBA", "default-value": 13107200, "default-meaning": "50Mb", "required":false }, "band": { "type": "unsigned", "doc": "A particular raster band to work with.", "default-value": 0, "default-meaning": "No particular raster band set, working with all bands.", "required": false }, "nodata": { "type": "float", "doc": "Overrides nodata value from the raster.", "default-value": 0, "default-meaning": "Nodata value from the raster is used.", "required": false }, "nodata_tolerance": { "type": "float", "doc": "Make pixels in this tolerance around nodata value transparent.", "default-value": 1e-12, "default-meaning": "The tolerance is effectively zero.", "required": false }, "shared": { "type": "boolean", "doc": "Allows to share the GDAL dataset handle with other GDAL datasources with the same file path.", "default-value": false, "default-meaning": "The datasource will use unique dataset instance.", "required": false } }, "geojson": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "inline":"<@(inline)" }, "occi": { "encoding":"<@(encoding)" }, "ogr": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)" }, "osm": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)" }, "postgis": { "table": "<@(table)", "key_field": "<@(key_field)", "key_field_as_attribute": { "type": "boolean", "doc": "User provided option to control whether the key_field will be duplicated as a feature attribute (as well as being used for the feature.id value)", "default-value": true, "default-meaning": "By default if key_field is provided then it is also available in the feature attributes by field name", "required": false }, "encoding":"<@(encoding)", "dbname": { "type": "string", "doc": "Database name", "default-value": "username", "default-meaning": "Will default to a database named after the user (as per libpq defaults)", "required": false }, "host": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "password": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "port": { "type": "unsigned", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "user": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "connect_timeout": { "type": "unsigned", "doc": "", "default-value": 4, "default-meaning": "", "required": false }, "schema": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "extent": "<@(extent)", "estimate_extent": { "type": "boolean", "doc": "If an `extent` string is not provided then Mapnik dynamically queries the table to determine the extent. If this option is true then the faster but less accurate PostGIS `ST_EstimatedExtent` function is used instead of `ST_Extent`.", "default-value": false, "default-meaning": "", "required": false }, "geometry_table": { "type": "string", "doc": "Specifies geometry table to use to look up metadata", "default-value": "", "default-meaning": "Automatically parsed from 'table' value", "required": false }, "geometry_field": { "type": "string", "doc": "Specifies geometry field to use", "default-value": "", "default-meaning": "First entry in geometry_columns", "required": false }, "cursor_size": { "type": "unsigned", "doc": "Integer size of binary cursor to use", "default-value": 0, "default-meaning": "No binary cursor is used", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "srid": { "type": "unsigned", "doc": "SRID to use", "default-value": 0, "default-meaning": "Auto-detected from geometry_field", "required": false }, "initial_size": { "type": "unsigned", "doc": "Integer size of connection pool", "default-value": 1, "default-meaning": "", "required": false }, "max_size": { "type": "unsigned", "doc": "Integer max of connection pool", "default-value": 10, "default-meaning": "", "required": false }, "simplify_geometries": { "type": "boolean", "doc": "Simplify geometries with ST_Simplify", "default-value": false, "default-meaning": "Don't simplify geometries", "required": false }, "autodetect_key_field": { "type": "boolean", "doc": "Attempt to autodetect a primary key field", "default-value": false, "default-meaning": "Don't autodetect a primary key field", "required": false }, "persist_connection": { "type": "boolean", "doc": "Keep connection open", "default-value": true, "default-meaning": "Connections, successfully created, will be kept open until Mapnik shuts down", "required": false }, "extent_from_subquery": { "type": "boolean", "doc": "Direct Mapnik to query Postgis for the extent of the raw 'table' value", "default-value": false, "default-meaning": "Uses 'geometry_table' instead of querying", "required": false } }, "python": { "encoding":"<@(encoding)" }, "raster": { "file":"<@(file)", "base":"<@(base)" }, "rasterlite": { "file":"<@(file)", "base":"<@(base)" }, "shape": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)" }, "sqlite": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "table": "<@(table)", "key_field": "<@(key_field)" }, "topojson": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "inline":"<@(inline)" } } } mapnik-reference-8.10.0/3.0.20/reference.json000066400000000000000000004064311342311331100203640ustar00rootroot00000000000000{ "version": "3.0.20", "style": { "filter-mode": { "type": [ "all", "first" ], "doc": "Control the processing behavior of Rule filters within a Style. If 'all' is used then all Rules are processed sequentially independent of whether any previous filters matched. If 'first' is used then it means processing ends after the first match (a positive filter evaluation) and no further Rules in the Style are processed ('first' is usually the default for CSS implementations on top of Mapnik to simplify translation from CSS to Mapnik XML).", "default-value": "all", "default-meaning": "All Rules in a Style are processed whether they have filters or not and whether or not the filter conditions evaluate to true." }, "image-filters": { "css": "image-filters", "default-value": "none", "default-meaning": "no filters", "type": "functions", "functions": [ ["agg-stack-blur", 2], ["emboss", 0], ["blur", 0], ["gray", 0], ["sobel", 0], ["edge-detect", 0], ["x-gradient", 0], ["y-gradient", 0], ["invert", 0], ["sharpen", 0], ["color-blind-protanope", 0], ["color-blind-deuteranope", 0], ["color-blind-tritanope", 0], ["colorize-alpha", -1], ["color-to-alpha", 1], ["scale-hsla", 8] ], "doc": "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": { "css":"image-filters-inflate", "default-value": false, "type":"boolean", "default-meaning": "No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary", "doc": "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": { "css": "direct-image-filters", "default-value": "none", "default-meaning": "no filters", "type": "functions", "functions": [ ["agg-stack-blur", 2], ["emboss", 0], ["blur", 0], ["gray", 0], ["sobel", 0], ["edge-detect", 0], ["x-gradient", 0], ["y-gradient", 0], ["invert", 0], ["sharpen", 0], ["color-blind-protanope", 0], ["color-blind-deuteranope", 0], ["color-blind-tritanope", 0], ["colorize-alpha", -1], ["color-to-alpha", 1], ["scale-hsla", 8] ], "doc": "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": { "css": "comp-op", "default-value": "src-over", "default-meaning": "add the current layer on top of other layers", "doc": "Composite operation. This defines how this layer should behave relative to layers atop or below it.", "type": [ "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" ] }, "opacity": { "css": "opacity", "type": "float", "doc": "An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer).", "default-value": 1.0, "default-meaning": "No separate buffer will be used and no alpha will be applied to the style after rendering." } }, "layer" : { "name": { "default-value": "", "type":"string", "required" : true, "default-meaning": "No layer name has been provided", "doc": "The name of a layer. Can be anything you wish and is not strictly validated, but ideally unique in the map." }, "srs": { "default-value": "", "type":"string", "default-meaning": "No srs value is provided and the value will be inherited from the Map's srs", "doc": "The spatial reference system definition for the layer, aka the projection. Can either be a proj4 literal string like '+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs' or, if the proper proj4 epsg/nad/etc identifier files are installed, a string that uses an id like: '+init=epsg:4326'." }, "status": { "default-value": true, "type":"boolean", "default-meaning": "This layer will be marked as active and available for processing", "doc": "A property that can be set to false to disable this layer from being processed." }, "minzoom": { "default-value": 0, "type":"float", "default-meaning": "The layer will be visible at the minimum possible scale", "doc": "The minimum scale denominator that this layer will be visible at. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6. This option has been deprecated in favor of `minimum-scale-denominator`.", "status": "deprecated" }, "maxzoom": { "default-value": "1.79769e+308", "type":"float", "default-meaning": "The layer will be visible at the maximum possible scale", "doc": "The maximum scale denominator that this layer will be visible at. The default is the numeric limit of the C++ double type, which may vary slightly by system, but is likely a massive number like 1.79769e+308 and ensures that this layer will always be visible unless the value is reduced. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6. This option has been deprecated in favor of `maximum-scale-denominator`.", "status": "deprecated" }, "minimum-scale-denominator": { "default-value": 0, "type":"float", "default-meaning": "The layer will be visible at the minimum possible scale denominator", "doc": "The minimum scale denominator that this layer will be visible at. A layer's visibility is determined by whether its status is true and if the Map scale denominator >= `minimum-scale-denominator` - 1e-6 and scale denominator < 'maximum-scale-denominator' + 1e-6." }, "maximum-scale-denominator": { "default-value": "1.79769e+308", "type":"float", "default-meaning": "The layer will be visible at the maximum possible scale denominator", "doc": "The maximum scale denominator that this layer will be visible at. The default is the numeric limit of the C++ double type, which may vary slightly by system, but is likely a massive number like 1.79769e+308 and ensures that this layer will always be visible unless the value is reduced. A layer's visibility is determined by whether its status is true and if the Map scale denominator >= `minimum-scale-denominator` - 1e-6 and scale denominator < `maximum-scale-denominator` + 1e-6." }, "queryable": { "default-value": false, "type":"boolean", "default-meaning": "The layer will not be available for the direct querying of data values", "doc": "This property was added for GetFeatureInfo/WMS compatibility and is rarely used. It is off by default meaning that in a WMS context the layer will not be able to be queried unless the property is explicitly set to true." }, "clear-label-cache": { "default-value": false, "type":"boolean", "default-meaning": "The renderer's collision detector cache (used for avoiding duplicate labels and overlapping markers) will not be cleared immediately before processing this layer", "doc": "This property, by default off, can be enabled to allow a user to clear the collision detector cache before a given layer is processed. This may be desirable to ensure that a given layers data shows up on the map even if it normally would not because of collisions with previously rendered labels or markers." }, "group-by": { "default-value": "", "type":"string", "default-meaning": "No special layer grouping will be used during rendering", "doc": "https://github.com/mapnik/mapnik/wiki/Grouped-rendering" }, "buffer-size": { "default-value": 0, "type":"float", "default-meaning": "No custom buffer will be used for the layer and rather the Map buffer-size will be used", "doc": "Extra tolerance around the Layer extent (in pixels) used when querying the layer data during rendering. If set this will override the Map buffer-size." }, "maximum-extent": { "default-value": "none", "type":"bbox", "default-meaning": "No clipping extent will be used", "doc": "An extent to be used to limit the bounds used to query this specific layer data during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Layer." }, "cache-features": { "type":"boolean", "default-value": "off", "default-meaning": "Features are not cached between rendering multiple styles. The datasource is queried for each style.", "doc": "Setting this to `on` triggers Mapnik to attempt to cache features in memory for rendering when (and only when) a layer has multiple styles attached to it." } }, "symbolizers" : { "map": { "background-color": { "css": "background-color", "default-value": "none", "default-meaning": "Will be rendered transparent.", "type": "color", "doc": "Map Background color." }, "background-image": { "css": "background-image", "type": "uri", "default-value": "", "default-meaning": "No background image will be used.", "doc": "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": { "css": "background-image-comp-op", "doc": "Set the compositing operation used to blend the image into the background.", "default-value": "src-over", "default-meaning": "The background-image will be blended with the background normally (placed on top of any existing background-color).", "type": [ "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" ] }, "background-image-opacity": { "css": "background-image-opacity", "type": "float", "doc": "Set the opacity of the image.", "default-value": 1.0, "default-meaning": "The image opacity will not be changed when applied to the map background." }, "srs": { "css": "srs", "type": "string", "default-value": "+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs", "default-meaning": "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.", "doc": "Map spatial reference (proj4 string)." }, "buffer-size": { "css": "buffer-size", "default-value": 0, "type":"float", "default-meaning": "No buffer will be used.", "doc": "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": { "css": "maximum-extent", "default-value": "-20037508.34,-20037508.34,20037508.34,20037508.34", "type":"string", "default-meaning": "All data will be clipped to global mercator extent (default is applied in Carto.js).", "doc": "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": { "css": "base", "default-value": "", "default-meaning": "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.", "type": "string", "doc": "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." }, "paths-from-xml": { "css": "", "default-value": true, "default-meaning": "Paths read from XML will be interpreted from the location of the XML.", "type": "boolean", "doc": "Value to control whether paths in the XML will be interpreted from the location of the XML or from the working directory of the program that calls load_map()." }, "minimum-version": { "css": "", "default-value": "none", "default-meaning": "Mapnik version will not be detected and no error will be thrown about compatibility.", "type": "string", "doc": "The minumum Mapnik version (e.g. 0.7.2) needed to use certain functionality in the stylesheet." }, "font-directory": { "css": "font-directory", "type": "uri", "default-value": "none", "default-meaning": "No map-specific fonts will be registered.", "doc": "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": { "default": { "css": "polygon", "type": [ "auto", "none" ], "doc": "Allows omitting a polygon symbolizer rule or emitting it with default values.", "status": "unstable" }, "fill": { "css": "polygon-fill", "type": "color", "expression":true, "default-value": "rgba(128,128,128,1)", "default-meaning": "Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).", "doc": "Fill color to assign to a polygon." }, "fill-opacity": { "css": "polygon-opacity", "type": "float", "expression":true, "doc": "The opacity of the polygon.", "default-value": 1.0, "default-meaning": "Color is fully opaque." }, "gamma": { "css": "polygon-gamma", "type": "float", "expression":true, "default-value": 1.0, "default-meaning": "Fully antialiased.", "range": "0-1", "doc": "Level of antialiasing of polygon edges." }, "gamma-method": { "css": "polygon-gamma-method", "type": [ "power", "linear", "none", "threshold", "multiply" ], "expression":true, "default-value": "power", "default-meaning": "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.", "doc": "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." }, "clip": { "css": "polygon-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "polygon-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "Simplify geometries by the given tolerance." }, "simplify-algorithm": { "css": "polygon-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "Simplify geometries by the given algorithm." }, "smooth": { "css": "polygon-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "polygon-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform polygon geometry with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "polygon-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "line": { "default": { "css": "line", "type": [ "auto", "none" ], "doc": "Allows omitting a line symbolizer rule or emitting it with default values.", "status": "unstable" }, "stroke": { "css": "line-color", "default-value": "black", "type": "color", "expression":true, "default-meaning": "black and fully opaque (alpha = 1), same as rgb(0,0,0) or rgba(0,0,0,1).", "doc": "The color of a drawn line." }, "stroke-width": { "css": "line-width", "default-value": 1.0, "type": "float", "expression":true, "doc": "The width of a line in pixels.", "default-meaning": "The line will be rendered 1 pixel wide." }, "stroke-opacity": { "css": "line-opacity", "default-value": 1.0, "type": "float", "expression":true, "default-meaning": "Color is fully opaque.", "doc": "The opacity of a line." }, "stroke-linejoin": { "css": "line-join", "default-value": "miter", "type": [ "miter", "miter-revert", "round", "bevel" ], "expression":true, "doc": "The behavior of lines when joining.", "default-meaning": "The line joins will be rendered using a miter look." }, "stroke-linecap": { "css": "line-cap", "default-value": "butt", "type": [ "butt", "round", "square" ], "expression":true, "doc": "The display of line endings.", "default-meaning": "The line endings will be rendered using a butt look." }, "stroke-gamma": { "css": "line-gamma", "type": "float", "expression":true, "default-value": 1.0, "default-meaning": "Fully antialiased.", "range": "0-1", "doc": "Level of antialiasing of stroke line." }, "stroke-gamma-method": { "css": "line-gamma-method", "type": [ "power", "linear", "none", "threshold", "multiply" ], "expression":true, "default-value": "power", "default-meaning": "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.", "doc": "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." }, "stroke-dasharray": { "css": "line-dasharray", "type": "numbers", "expression":true, "doc": "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.", "default-value": "none", "default-meaning": "The line will be drawn without dashes." }, "stroke-dashoffset": { "css": "line-dash-offset", "type": "numbers", "expression":true, "doc": "Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled).", "default-value": "none", "default-meaning": "The line will be drawn without dashes." }, "stroke-miterlimit": { "css": "line-miterlimit", "type": "float", "expression":true, "doc": "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.", "default-value": 4.0, "default-meaning": "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 )'." }, "clip": { "css": "line-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "line-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "Simplify geometries by the given tolerance." }, "simplify-algorithm": { "css": "line-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "Simplify geometries by the given algorithm." }, "smooth": { "css": "line-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "offset": { "css": "line-offset", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Will not be offset.", "doc": "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).", "status": "unstable" }, "rasterizer": { "css": "line-rasterizer", "type": [ "full", "fast" ], "expression":true, "default-value": "full", "doc": "Exposes an alternate AGG rendering method that sacrifices some accuracy for speed.", "default-meaning": "The line will be rendered using the highest quality method rather than the fastest." }, "geometry-transform": { "css": "line-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform line geometry with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "line-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "markers": { "default": { "css": "marker", "type": [ "auto", "none" ], "doc": "Allows omitting a marker symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "marker-file", "doc": "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.", "default-value": "none", "default-meaning": "An ellipse or circle, if width equals height.", "type": "uri", "expression":true }, "opacity": { "css": "marker-opacity", "doc": "The overall opacity of the marker, if set, overrides both the opacity of the fill and the opacity of the stroke.", "default-value": 1.0, "default-meaning": "The stroke-opacity and fill-opacity of the marker.", "type": "float", "expression":true }, "fill-opacity": { "css": "marker-fill-opacity", "doc": "The fill opacity of the marker. This property will also set the `fill-opacity` of elements in an SVG loaded from a file.", "default-value": 1.0, "expression":true, "default-meaning": "Color is fully opaque.", "type": "float" }, "stroke": { "css": "marker-line-color", "doc": "The color of the stroke around the marker. This property will also set the `stroke` of elements in an SVG loaded from a file.", "default-value": "black", "type": "color", "expression":true, "default-meaning": "The marker will be drawn with a black outline." }, "stroke-width": { "css": "marker-line-width", "default-value": 0.5, "doc": "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.", "type": "float", "expression":true, "default-meaning": "The marker will be drawn with an outline of .5 pixels wide." }, "stroke-opacity": { "css": "marker-line-opacity", "default-value": 1.0, "default-meaning": "Color is fully opaque. This property will also set the `stroke-opacity` of elements in an SVG loaded from a file.", "doc": "The opacity of a line.", "type": "float", "expression":true }, "placement": { "css": "marker-placement", "type": [ "point", "line", "interior", "vertex-first", "vertex-last" ], "expression":true, "default-value": "point", "default-meaning": "Place markers at the center point (centroid) of the geometry.", "doc": "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." }, "multi-policy": { "css": "marker-multi-policy", "type": [ "each", "whole", "largest" ], "expression":true, "default-value": "each", "default-meaning": "If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each.", "doc": "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": { "css": "marker-type", "type": [ "arrow", "ellipse" ], "expression":true, "default-value": "ellipse", "default-meaning": "The marker shape is an ellipse.", "doc": "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).", "status": "deprecated" }, "width": { "css": "marker-width", "default-value": 10.0, "doc": "The width of the marker, if using one of the default types.", "type": "float", "expression":true, "default-meaning": "The marker width is 10 pixels." }, "height": { "css": "marker-height", "default-value": 10.0, "doc": "The height of the marker, if using one of the default types.", "type": "float", "expression":true, "default-meaning": "The marker height is 10 pixels." }, "fill": { "css": "marker-fill", "default-value": "blue", "doc": "The color of the area of the marker. This property will also set the `fill` of elements in an SVG loaded from a file.", "type": "color", "expression":true, "default-meaning": "The marker fill color is blue." }, "allow-overlap": { "css": "marker-allow-overlap", "type": "boolean", "expression":true, "default-value": false, "doc": "Control whether overlapping markers are shown or hidden.", "default-meaning": "Do not allow markers to overlap with each other - overlapping markers will not be shown." }, "avoid-edges": { "css": "marker-avoid-edges", "doc": "Avoid placing markers that intersect with tile boundaries.", "type": "boolean", "expression":true, "default-meaning": "Markers will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.", "default-value": false }, "ignore-placement": { "css": "marker-ignore-placement", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache.", "doc": "Value to control whether the placement of the feature will prevent the placement of other features." }, "spacing": { "css": "marker-spacing", "doc": "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.", "default-value": 100.0, "type": "float", "expression":true, "default-meaning": "In the case of marker-placement:line then draw a marker every 100 pixels along a line." }, "max-error": { "css": "marker-max-error", "type": "float", "expression":true, "default-value": 0.2, "default-meaning": "N/A: not intended to be changed.", "doc": "N/A: not intended to be changed." }, "transform": { "css": "marker-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform marker instance with specified function. Ignores map scale factor." }, "clip": { "css": "marker-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "marker-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Geometry will not be simplified.", "doc": "geometries are simplified by the given tolerance." }, "simplify-algorithm": { "css": "marker-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "geometries are simplified by the given algorithm." }, "smooth": { "css": "marker-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "marker-geometry-transform", "type": "functions", "expression":true, "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform marker geometry with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "offset": { "css": "marker-offset", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Will not be offset.", "doc": "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)." }, "comp-op": { "css": "marker-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true }, "direction": { "css": "marker-direction", "default-value": "right", "type": [ "auto", "auto-down", "left", "right", "left-only", "right-only", "up", "down" ], "expression": true, "default-meaning": "Markers are oriented to the right in the line direction.", "doc": "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": { "default": { "css": "shield", "type": [ "none" ], "doc": "Allows omitting a shield symbolizer rule.", "status": "unstable" }, "name": { "css": "shield-name", "type": "string", "expression":true, "serialization": "content", "default-value": "", "default-meaning": "No text label will be rendered with the shield.", "doc": "Value to use for a shield\"s text label. Data columns are specified using brackets like [column_name]." }, "file": { "css": "shield-file", "required": true, "type": "uri", "expression":true, "default-value": "none", "doc": "Image file to render behind the shield text. Accepted formats: svg, jpg, png, tiff, and webp.", "default-meaning": "" }, "face-name": { "css": "shield-face-name", "type": "string", "expression":true, "validate": "font", "doc": "Font name and style to use for the shield text.", "default-value": "none", "required": true, "default-meaning": "" }, "unlock-image": { "css": "shield-unlock-image", "type": "boolean", "expression":true, "doc": "This parameter should be set to true if you are trying to position text beside rather than on top of the shield image.", "default-value": false, "default-meaning": "text alignment relative to the shield image uses the center of the image as the anchor for text positioning." }, "size": { "css": "shield-size", "type": "float", "expression":true, "default-value": 10.0, "doc": "The size of the shield text in pixels.", "default-meaning": "Font size of 10 will be used to render text." }, "fill": { "css": "shield-fill", "type": "color", "expression":true, "default-value": "black", "doc": "The color of the shield text.", "default-meaning": "The shield text will be rendered black." }, "placement": { "css": "shield-placement", "type": [ "point", "line", "vertex", "interior", "grid", "alternating-grid" ], "expression":true, "default-value": "point", "default-meaning": "One shield will be placed per geometry.", "doc": "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." }, "avoid-edges": { "css": "shield-avoid-edges", "doc": "Avoid placing shields that intersect with tile boundaries.", "type": "boolean", "expression":true, "default-meaning": "Shields will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.", "default-value": false }, "allow-overlap": { "css": "shield-allow-overlap", "type": "boolean", "expression":true, "default-value": false, "doc": "Control whether overlapping shields are shown or hidden.", "default-meaning": "Shields will not overlap and any shields that might collide with previously placed shields will not be rendered.", "default-meaning": "Do not allow shields to overlap with other map elements already placed." }, "margin": { "css": "shield-margin", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No extra margin will be used to determine if a shield collides with any other text, shield, or marker.", "doc": "Minimum distance that a shield can be placed from any other text, shield, or marker." }, "repeat-distance": { "css": "shield-repeat-distance", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Shields with the same text will be rendered without restriction.", "doc": "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." }, "minimum-distance": { "css": "shield-min-distance", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Shields with the same text will be rendered without restriction.", "doc": "Minimum distance to any other collision object. Deprecated: replaced by `shield-margin`.", "status": "deprecated" }, "spacing": { "css": "shield-spacing", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Only one shield per line will attempt to be placed.", "doc": "Distance the renderer should use to try to place repeated shields on a line." }, "minimum-padding": { "css": "shield-min-padding", "expression":true, "default-value": 0.0, "doc": "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.", "default-meaning": "No margin will be used to detect if a shield is nearby a tile boundary.", "type": "float" }, "label-position-tolerance": { "css": "shield-label-position-tolerance", "default-value": "shield-spacing/2.0", "type": "float", "expression":true, "default-meaning": "If a shield cannot be placed then the renderer will advance by shield-spacing/2.0 to try placement again.", "doc": "Allows the shield to be displaced from its ideal position by a number of pixels (only works with placement:line)." }, "wrap-width": { "css": "shield-wrap-width", "type": "unsigned", "expression":true, "default-value": 0, "default-meaning": "Text will not be wrapped.", "doc": "Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap." }, "wrap-before": { "css": "shield-wrap-before", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "Wrapped lines will be a bit longer than wrap-width.", "doc": "Wrap text before wrap-width is reached." }, "wrap-character": { "css": "shield-wrap-character", "type": "string", "expression":true, "default-value": "\" \"", "default-meaning": "Lines will be wrapped conforming to the (untailored) Unicode Line Break Algorithm provided by ICU BreakIterator.", "doc": "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." }, "halo-fill": { "css": "shield-halo-fill", "type": "color", "expression":true, "default-value": "white", "doc": "Specifies the color of the halo around the text.", "default-meaning": "The shield halo text will be rendered white." }, "halo-radius": { "css": "shield-halo-radius", "default-value": 0.0, "default-meaning": "no halo.", "doc": "Specify the radius of the halo in pixels.", "type": "float", "expression":true }, "halo-rasterizer": { "css": "shield-halo-rasterizer", "type": [ "full", "fast" ], "expression":true, "default-value": "full", "default-meaning": "The shield will be rendered using the highest quality method rather than the fastest.", "doc": "Exposes an alternate text halo rendering method that sacrifices quality for speed." }, "halo-transform": { "css": "shield-halo-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "", "default-meaning": "No transformation.", "doc": "Transform shield halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor." }, "halo-comp-op": { "css": "shield-halo-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ], "expression":true }, "halo-opacity": { "css": "shield-halo-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text halo.", "default-value": 1.0, "type": "float", "expression":true, "default-meaning": "Fully opaque." }, "character-spacing": { "css": "shield-character-spacing", "type": "unsigned", "expression":true, "default-value": 0, "default-meaning": "The default character spacing of the font will be used.", "doc": "Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement." }, "line-spacing": { "css": "shield-line-spacing", "default-value": 0, "doc": "Vertical spacing between lines of multiline labels (in pixels).", "type": "float", "expression":true, "default-meaning": "The default font spacing will be used." }, "dx": { "css": "shield-text-dx", "type": "float", "expression":true, "doc": "Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right.", "default-meaning": "Text will not be displaced.", "default-value": 0.0 }, "dy": { "css": "shield-text-dy", "type": "float", "expression":true, "doc": "Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down.", "default-meaning": "Text will not be displaced.", "default-value": 0.0 }, "shield-dx": { "css": "shield-dx", "type": "float", "expression":true, "doc": "Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right.", "default-meaning": "Shield will not be displaced.", "default-value": 0.0 }, "shield-dy": { "css": "shield-dy", "type": "float", "expression":true, "doc": "Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down.", "default-meaning": "Shield will not be displaced.", "default-value": 0.0 }, "opacity": { "css": "shield-opacity", "type": "float", "expression":true, "doc": "The opacity of the image used for the shield.", "default-meaning": "Color is fully opaque.", "default-value": 1.0 }, "text-opacity": { "css": "shield-text-opacity", "type": "float", "expression":true, "doc": "The opacity of the text placed on top of the shield.", "default-meaning": "Color is fully opaque.", "default-value": 1.0 }, "horizontal-alignment": { "css": "shield-horizontal-alignment", "type": [ "left", "middle", "right", "auto" ], "expression":true, "doc": "The shield's horizontal alignment from its centerpoint.", "default-meaning": "TODO.", "default-value": "auto" }, "vertical-alignment": { "css": "shield-vertical-alignment", "type": [ "top", "middle", "bottom", "auto" ], "expression":true, "doc": "The shield's vertical alignment from its centerpoint.", "default-meaning": "TODO.", "default-value": "middle" }, "placement-type": { "css": "shield-placement-type", "doc": "Re-position and/or re-size shield to avoid overlaps. \"simple\" for basic algorithm (using shield-placements string,) \"dummy\" to turn this feature off.", "type": [ "dummy", "simple", "list" ], "expression":true, "default-meaning": "Alternative placements will not be enabled.", "default-value": "dummy" }, "placements": { "css": "shield-placements", "type": "string", "expression":true, "default-value": "", "default-meaning": "No alternative placements will be used.", "doc": "If \"placement-type\" is set to \"simple\", use this \"POSITIONS,[SIZES]\" string. An example is `shield-placements: \"E,NE,SE,W,NW,SW\";`." }, "text-transform": { "css": "shield-text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize", "reverse" ], "expression":true, "doc": "Transform the case of the characters.", "default-meaning": "No text transformation will be applied.", "default-value": "none" }, "justify-alignment": { "css": "shield-justify-alignment", "type": [ "left", "center", "right", "auto" ], "expression":true, "doc": "Define how text in a shield's label is justified.", "default-meaning": "TODO.", "default-value": "auto" }, "transform": { "css": "shield-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform shield instance with specified function. Ignores map scale factor." }, "clip": { "css": "shield-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "shield-simplify", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "Simplify the geometries used for shield placement by the given tolerance." }, "simplify-algorithm": { "css": "shield-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression": true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "Simplify the geometries used for shield placement by the given algorithm." }, "smooth": { "css": "shield-smooth", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "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." }, "comp-op": { "css": "shield-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true }, "grid-cell-width": { "css": "shield-grid-cell-width", "type": "float", "expression": true, "default-value": 0, "default-meaning": "No placement will be done.", "doc": "Controls horizontal spacing between placements of placement type `grid` or `alternating-grid`." }, "grid-cell-height": { "css": "shield-grid-cell-height", "type": "float", "expression": true, "default-value": 0, "default-meaning": "No placement will be done.", "doc": "Controls vertical spacing between placements of placement type `grid` or `alternating-grid`." }, "offset": { "css": "shield-offset", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "Will not be offset.", "doc": "In case of `line` placement, offsets a shield position a number of pixels parallel to its actual path. In case of `grid` placement, reduces or expands the polygon area. Positive values move the line left or expand the polygon, negative values move it right or shrink the polygon (relative to the directionality of the line or polygon winding).", "status": "unstable" } }, "line-pattern": { "default": { "css": "line-pattern", "type": [ "none" ], "doc": "Allows omitting a line pattern symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "line-pattern-file", "type": "uri", "expression":true, "default-value": "none", "required": true, "doc": "An image file to be repeated and warped along a line. Accepted formats: svg, jpg, png, tiff, and webp.", "default-meaning": "" }, "clip": { "css": "line-pattern-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "opacity": { "css": "line-pattern-opacity", "type": "float", "expression":true, "doc": "Apply an opacity level to the image used for the pattern.", "default-value": 1.0, "default-meaning": "The image is rendered without modifications." }, "simplify": { "css": "line-pattern-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "geometries are simplified by the given tolerance." }, "simplify-algorithm": { "css": "line-pattern-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "geometries are simplified by the given algorithm." }, "smooth": { "css": "line-pattern-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "offset": { "css": "line-pattern-offset", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "The line will not be offset.", "doc": "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)." }, "geometry-transform": { "css": "line-pattern-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform line geometry with specified function and apply pattern to transformed geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "transform": { "css": "line-pattern-transform", "type": "functions", "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform line pattern instance with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "line-pattern-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "polygon-pattern": { "default": { "css": "polygon-pattern", "type": [ "none" ], "doc": "Allows omitting a polygon pattern symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "polygon-pattern-file", "type": "uri", "expression":true, "default-value": "none", "required": true, "doc": "Image to use as a repeated pattern fill within a polygon. Accepted formats: svg, jpg, png, tiff, and webp.", "default-meaning": "" }, "alignment": { "css": "polygon-pattern-alignment", "type": [ "global", "local" ], "expression":true, "default-value": "global", "doc": "Specify whether to align pattern fills to the layer's geometry (local) or to the map (global).", "default-meaning":"Patterns will be aligned to the map (or tile boundaries) when being repeated across polygons. This is ideal for seamless patterns in tiled rendering." }, "gamma": { "css": "polygon-pattern-gamma", "type": "float", "expression":true, "default-value": 1.0, "default-meaning": "Fully antialiased.", "range": "0-1", "doc": "Level of antialiasing of polygon pattern edges." }, "opacity": { "css": "polygon-pattern-opacity", "type": "float", "expression":true, "doc": "Apply an opacity level to the image used for the pattern.", "default-value": 1.0, "default-meaning": "The image is rendered without modifications." }, "clip": { "css": "polygon-pattern-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "polygon-pattern-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "geometries are simplified by the given tolerance." }, "simplify-algorithm": { "css": "polygon-pattern-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "geometries are simplified by the given algorithm." }, "smooth": { "css": "polygon-pattern-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "polygon-pattern-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform polygon geometry with specified function and apply pattern to transformed geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "transform": { "css": "polygon-pattern-transform", "type": "functions", "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform polygon pattern instance with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "polygon-pattern-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "raster": { "default": { "css": "raster", "type": [ "auto", "none" ], "doc": "Allows omitting a raster symbolizer rule or emitting it with default values.", "status": "unstable" }, "opacity": { "css": "raster-opacity", "default-value": 1.0, "default-meaning": "Color is fully opaque.", "type": "float", "doc": "The opacity of the raster symbolizer on top of other symbolizers." }, "filter-factor": { "css": "raster-filter-factor", "default-value": -1.0, "default-meaning": "Allow the datasource to choose appropriate downscaling.", "type": "float", "doc": "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." }, "scaling": { "css": "raster-scaling", "type": [ "near", "fast", "bilinear", "bicubic", "spline16", "spline36", "hanning", "hamming", "hermite", "kaiser", "quadric", "catrom", "gaussian", "bessel", "mitchell", "sinc", "lanczos", "blackman" ], "default-value": "near", "default-meaning": "Nearest neighboor resampling will be used to scale the image to the target size of the map.", "doc": "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." }, "mesh-size": { "css": "raster-mesh-size", "default-value": 16, "default-meaning": "Reprojection mesh will be 1/16 of the resolution of the source image.", "type": "unsigned", "doc": "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." }, "comp-op": { "css": "raster-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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-mode": { "css": "raster-colorizer-default-mode", "type": [ "discrete", "linear", "exact" ], "doc": "This can be either `discrete`, `linear` or `exact`. If it is not specified then the default is `linear`.", "default-value": "linear", "default-meaning": "A linear interpolation is used to generate colors between the two nearest stops." }, "default-color": { "css": "raster-colorizer-default-color", "type": "color", "doc": "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.", "default-value": "transparent", "default-meaning": "Pixels that are not colored by the colorizer stops will be transparent." }, "epsilon": { "css": "raster-colorizer-epsilon", "type": "float", "doc": "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.", "default-value": "1.1920928955078125e-07", "default-meaning": "Pixels must very closely match the stop filter otherwise they will not be colored." }, "stop": { "css": "raster-colorizer-stops", "type": "tags", "serialization": "tag", "tagname": "tagname", "doc": "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)`.", "default-value": "", "default-meaning": "No colorization will happen without supplying stops." } }, "point": { "default": { "css": "point", "type": [ "auto", "none" ], "doc": "Allows omitting a point symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "point-file", "type": "uri", "expression":true, "required": false, "default-value": "none", "default-meaning": "A 4x4 black square will be rendered.", "doc": "Image file to represent a point. Accepted formats: svg, jpg, png, tiff, and webp." }, "allow-overlap": { "css": "point-allow-overlap", "type": "boolean", "expression":true, "default-value": false, "doc": "Control whether overlapping points are shown or hidden.", "default-meaning": "Do not allow points to overlap with each other - overlapping markers will not be shown." }, "ignore-placement": { "css": "point-ignore-placement", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache.", "doc": "Control whether the placement of the feature will prevent the placement of other features." }, "opacity": { "css": "point-opacity", "type": "float", "expression":true, "default-value": 1.0, "default-meaning": "Fully opaque.", "doc": "A value from 0 to 1 to control the opacity of the point." }, "placement": { "css": "point-placement", "type": [ "centroid", "interior" ], "expression":true, "doc": "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.", "default-meaning": "The centroid of the geometry will be used to place the point.", "default-value": "centroid" }, "transform": { "css": "point-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform point instance with specified function. Ignores map scale factor." }, "comp-op": { "css": "point-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "text": { "default": { "css": "text", "type": [ "none" ], "doc": "Allows omitting a text symbolizer rule.", "status": "unstable" }, "name": { "css": "text-name", "type": "string", "expression":true, "required": true, "default-value": "none", "serialization": "content", "doc": "Value to use for a text label. Data columns are specified using brackets like [column_name].", "default-meaning": "" }, "face-name": { "css": "text-face-name", "type": "string", "expression":false, "validate": "font", "default-value": "none", "doc": "Font name and style to render a label in.", "required": true, "default-meaning": "" }, "size": { "css": "text-size", "type": "float", "expression":true, "default-value": 10.0, "doc": "Text size in pixels.", "default-meaning": "Font size of 10 will be used to render text." }, "text-ratio": { "css": "text-ratio", "doc": "Define the amount of text (of the total) present on successive lines when wrapping occurs.", "default-value": 0, "type": "unsigned", "expression":true, "default-meaning":"TODO." }, "wrap-width": { "css": "text-wrap-width", "doc": "Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap.", "default-value": 0, "type": "unsigned", "expression":true, "default-meaning": "Text will not be wrapped." }, "wrap-before": { "css": "text-wrap-before", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "Wrapped lines will be a bit longer than wrap-width.", "doc": "Wrap text before wrap-width is reached." }, "wrap-character": { "css": "text-wrap-character", "type": "string", "expression":true, "default-value": "\" \"", "default-meaning": "Lines will be wrapped conforming to the (untailored) Unicode Line Break Algorithm provided by ICU BreakIterator.", "doc": "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." }, "repeat-wrap-character": { "css": "text-repeat-wrap-character", "type": "boolean", "expression": true, "default-value": false, "default-meaning": "Character will be removed when used to wrap a line.", "doc": "Keep the character used to wrap a line instead of removing it, and repeat it on the new line.", "status": "unstable" }, "spacing": { "css": "text-spacing", "type": "unsigned", "expression":true, "default-value": 0, "default-meaning": "Only one label per line will attempt to be placed.", "doc": "Distance the renderer should use to try to place repeated text labels on a line." }, "character-spacing": { "css": "text-character-spacing", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "The default character spacing of the font will be used.", "doc": "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." }, "line-spacing": { "css": "text-line-spacing", "default-value": 0, "type": "float", "expression":true, "default-meaning": "The default font spacing will be used.", "doc": "Vertical spacing adjustment between lines in pixels." }, "label-position-tolerance": { "css": "text-label-position-tolerance", "default-value": "text-spacing/2.0", "type": "float", "expression":true, "default-meaning": "If a shield cannot be placed then the renderer will advance by text-spacing/2.0 to try placement again.", "doc": "Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line)." }, "max-char-angle-delta": { "css": "text-max-char-angle-delta", "type": "float", "expression":true, "default-value": 22.5, "default-meaning":"The label will not be placed if a character falls on a line with an angle sharper than 22.5 degrees.", "doc": "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." }, "fill": { "css": "text-fill", "type": "color", "expression":true, "doc": "Specifies the color for the text.", "default-value": "black", "default-meaning": "The text will be rendered black." }, "opacity": { "css": "text-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text.", "default-value": 1.0, "expression":true, "default-meaning": "Fully opaque.", "type": "float" }, "halo-opacity": { "css": "text-halo-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text halo.", "default-value": 1.0, "type": "float", "expression":true, "default-meaning": "Fully opaque." }, "halo-fill": { "css": "text-halo-fill", "type": "color", "expression":true, "default-value": "white", "default-meaning": "The halo will be rendered white.", "doc": "Specifies the color of the halo around the text." }, "halo-radius": { "css": "text-halo-radius", "doc": "Specify the radius of the halo in pixels.", "default-value": 0.0, "type": "float", "expression":true, "default-meaning": "no halo." }, "halo-rasterizer": { "css": "text-halo-rasterizer", "type": [ "full", "fast" ], "expression":true, "default-value": "full", "default-meaning": "The text will be rendered using the highest quality method rather than the fastest.", "doc": "Exposes an alternate text halo rendering method that sacrifices quality for speed." }, "halo-transform": { "css": "text-halo-transform", "type": "functions", "expression":true, "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "", "default-meaning": "No transformation.", "doc": "Transform text halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor." }, "dx": { "css": "text-dx", "type": "float", "expression":true, "doc": "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.", "default-meaning": "Text will not be displaced.", "default-value": 0.0 }, "dy": { "css": "text-dy", "type": "float", "expression":true, "doc": "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.", "default-meaning": "Text will not be displaced.", "default-value": 0.0 }, "vertical-alignment": { "css": "text-vertical-alignment", "type": [ "top", "middle", "bottom", "auto" ], "expression":true, "doc": "Position of label relative to point position.", "default-value": "auto", "default-meaning": "Default affected by value of dy; \"top\" for dy>0, \"bottom\" for dy<0." }, "avoid-edges": { "css": "text-avoid-edges", "doc": "Avoid placing labels that intersect with tile boundaries.", "default-value": false, "type": "boolean", "expression":true, "default-meaning": "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." }, "margin": { "css": "text-margin", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No extra margin will be used to determine if a label collides with any other text, shield, or marker.", "doc": "Minimum distance that a label can be placed from any other text, shield, or marker." }, "repeat-distance": { "css": "text-repeat-distance", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Labels with the same text will be rendered without restriction.", "doc": "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." }, "minimum-distance": { "css": "text-min-distance", "type": "float", "default-value": 0.0, "expression":true, "default-meaning": "Labels with the same text will be rendered without restriction.", "doc": "Minimum distance to the next label with the same text. Only works for line placement. Deprecated: replaced by `text-repeat-distance` and `text-margin`", "status": "deprecated" }, "minimum-padding": { "css": "text-min-padding", "default-value": 0.0, "type": "float", "expression":true, "doc": "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.", "default-meaning": "No margin will be used to detect if a text label is nearby a tile boundary." }, "minimum-path-length": { "css": "text-min-path-length", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "place labels on all geometries no matter how small they are.", "doc": "Place labels only on polygons and lines with a bounding width longer than this value (in pixels)." }, "allow-overlap": { "css": "text-allow-overlap", "type": "boolean", "expression":true, "default-value": false, "doc": "Control whether overlapping text is shown or hidden.", "default-meaning": "Do not allow text to overlap with other text - overlapping markers will not be shown." }, "orientation": { "css": "text-orientation", "type": "float", "expression":true, "default-value": 0.0, "doc": "Rotate the text. (only works with text-placement:point).", "default-meaning": "Text is not rotated and is displayed upright." }, "rotate-displacement": { "css": "text-rotate-displacement", "type": "boolean", "doc": "Rotates the displacement around the placement origin by the angle given by \"orientation\".", "default-value": false, "default-meaning": "Label center is used for rotation." }, "upright": { "css": "text-upright", "default-value": "auto", "type": [ "auto", "auto-down", "left", "right", "left-only", "right-only" ], "expression":true, "default-meaning": "Text will be positioned upright automatically.", "doc": "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." }, "placement": { "css": "text-placement", "default-value": "point", "type": [ "point", "line", "vertex", "interior", "grid", "alternating-grid" ], "expression":true, "default-meaning": "One shield will be placed per geometry.", "doc": "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." }, "placement-type": { "css": "text-placement-type", "doc": "Re-position and/or re-size text to avoid overlaps. \"simple\" for basic algorithm (using text-placements string,) \"dummy\" to turn this feature off.", "type": [ "dummy", "simple", "list" ], "expression":true, "default-meaning": "Alternative placements will not be enabled.", "default-value": "dummy" }, "placements": { "css": "text-placements", "type": "string", "default-meaning": "No alternative placements will be used.", "default-value": "", "expression":true, "doc": "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": { "css": "text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize", "reverse" ], "expression":true, "doc": "Transform the case of the characters.", "default-meaning": "Transform text instance with specified function. Ignores map scale factor.", "default-value": "none" }, "horizontal-alignment": { "css": "text-horizontal-alignment", "type": [ "left", "middle", "right", "auto", "adjust" ], "expression":true, "doc": "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`.", "default-value": "auto", "default-meaning":"TODO." }, "justify-alignment": { "css": "text-align", "type": [ "left", "right", "center", "auto" ], "expression":true, "doc": "Define how text is justified.", "default-value": "auto", "default-meaning": "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." }, "clip": { "css": "text-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "text-simplify", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "Simplify the geometries used for text placement by the given tolerance." }, "simplify-algorithm": { "css": "text-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression": true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "Simplify the geometries used for text placement by the given algorithm." }, "smooth": { "css": "text-smooth", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "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." }, "comp-op": { "css": "text-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true }, "halo-comp-op": { "css": "text-halo-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ], "expression":true }, "font-feature-settings": { "css": "text-font-feature-settings", "type": "string", "default-value": "", "default-meaning": "Default set of typographic features recommended by OpenType specification. Ligatures are turned off by default when `character-spacing` is greater than zero.", "doc": "Comma separated list of OpenType typographic features. The syntax and semantics conforms to `font-feature-settings` from W3C CSS." }, "largest-bbox-only": { "css": "text-largest-bbox-only", "type": "boolean", "expression": true, "default-value": true, "default-meaning": "For multipolygons only polygon with largest bbox area is labeled (does not apply to other geometries).", "doc": "Controls default labeling behavior on multipolygons. The default is true and means that only the polygon with largest bbox is labeled.", "status": "experimental" }, "grid-cell-width": { "css": "text-grid-cell-width", "type": "float", "expression": true, "default-value": 0, "default-meaning": "No placement will be done.", "doc": "Controls horizontal spacing between placements of placement type `grid` or `alternating-grid`." }, "grid-cell-height": { "css": "text-grid-cell-height", "type": "float", "expression": true, "default-value": 0, "default-meaning": "No placement will be done.", "doc": "Controls vertical spacing between placements of placement type `grid` or `alternating-grid`." }, "offset": { "css": "text-offset", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "Will not be offset.", "doc": "In case of `line` placement, offsets a text position a number of pixels parallel to its actual path. In case of `grid` placement, reduces or expands the polygon area. Positive values move the line left or expand the polygon, negative values move it right or shrink the polygon (relative to the directionality of the line or polygon winding).", "status": "unstable" } }, "building": { "default": { "css": "building", "type": [ "auto", "none" ], "doc": "Allows omitting a building symbolizer rule or emitting it with default values.", "status": "unstable" }, "fill": { "css": "building-fill", "expression":true, "type":"color", "default-value": "The color gray will be used for fill.", "default-meaning": "Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).", "doc": "The color of the buildings fill. Note: 0.8 will be used to multiply each color component to auto-generate a darkened wall color." }, "fill-opacity": { "css": "building-fill-opacity", "type": "float", "expression":true, "doc": "The opacity of the building as a whole, including all walls.", "default-value": 1.0, "default-meaning": "Color is fully opaque." }, "height": { "css": "building-height", "doc": "The height of the building in pixels.", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Buildings will not have a visual height and will instead look like flat polygons." } }, "debug": { "mode": { "css": "debug-mode", "type": [ "collision", "vertex" ], "default-value": "collision", "doc": "The mode for debug rendering.", "expression":true, "default-meaning": "The otherwise invisible collision boxes will be rendered as squares on the map." } }, "dot": { "default": { "css": "dot", "type": [ "auto", "none" ], "doc": "Allows omitting a dot symbolizer rule or emitting it with default values.", "status": "unstable" }, "fill": { "css": "dot-fill", "default-value": "gray", "doc": "The color of the area of the dot.", "type": "color", "expression":true, "default-meaning": "The dot fill color is gray." }, "opacity": { "css": "dot-opacity", "doc": "The overall opacity of the dot.", "default-value": 1.0, "default-meaning": "The opacity of the dot.", "type": "float", "expression":true }, "width": { "css": "dot-width", "default-value": 1.0, "doc": "The width of the dot in pixels.", "type": "float", "expression":true, "default-meaning": "The marker width is 1 pixel." }, "height": { "css": "dot-height", "default-value": 1.0, "doc": "The height of the dot in pixels.", "type": "float", "expression":true, "default-meaning": "The marker height is 1 pixels." }, "comp-op": { "css": "dot-comp-op", "default-value": "src-over", "default-meaning": "Add the current layer on top of other layers.", "doc": "Composite operation. This defines how this layer should behave relative to layers atop or below it.", "type": [ "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" ] } } }, "colors": { "aliceblue": [240, 248, 255], "antiquewhite": [250, 235, 215], "aqua": [0, 255, 255], "aquamarine": [127, 255, 212], "azure": [240, 255, 255], "beige": [245, 245, 220], "bisque": [255, 228, 196], "black": [0, 0, 0], "blanchedalmond": [255,235,205], "blue": [0, 0, 255], "blueviolet": [138, 43, 226], "brown": [165, 42, 42], "burlywood": [222, 184, 135], "cadetblue": [95, 158, 160], "chartreuse": [127, 255, 0], "chocolate": [210, 105, 30], "coral": [255, 127, 80], "cornflowerblue": [100, 149, 237], "cornsilk": [255, 248, 220], "crimson": [220, 20, 60], "cyan": [0, 255, 255], "darkblue": [0, 0, 139], "darkcyan": [0, 139, 139], "darkgoldenrod": [184, 134, 11], "darkgray": [169, 169, 169], "darkgreen": [0, 100, 0], "darkgrey": [169, 169, 169], "darkkhaki": [189, 183, 107], "darkmagenta": [139, 0, 139], "darkolivegreen": [85, 107, 47], "darkorange": [255, 140, 0], "darkorchid": [153, 50, 204], "darkred": [139, 0, 0], "darksalmon": [233, 150, 122], "darkseagreen": [143, 188, 143], "darkslateblue": [72, 61, 139], "darkslategrey": [47, 79, 79], "darkturquoise": [0, 206, 209], "darkviolet": [148, 0, 211], "deeppink": [255, 20, 147], "deepskyblue": [0, 191, 255], "dimgray": [105, 105, 105], "dimgrey": [105, 105, 105], "dodgerblue": [30, 144, 255], "firebrick": [178, 34, 34], "floralwhite": [255, 250, 240], "forestgreen": [34, 139, 34], "fuchsia": [255, 0, 255], "gainsboro": [220, 220, 220], "ghostwhite": [248, 248, 255], "gold": [255, 215, 0], "goldenrod": [218, 165, 32], "gray": [128, 128, 128], "grey": [128, 128, 128], "green": [0, 128, 0], "greenyellow": [173, 255, 47], "honeydew": [240, 255, 240], "hotpink": [255, 105, 180], "indianred": [205, 92, 92], "indigo": [75, 0, 130], "ivory": [255, 255, 240], "khaki": [240, 230, 140], "lavender": [230, 230, 250], "lavenderblush": [255, 240, 245], "lawngreen": [124, 252, 0], "lemonchiffon": [255, 250, 205], "lightblue": [173, 216, 230], "lightcoral": [240, 128, 128], "lightcyan": [224, 255, 255], "lightgoldenrodyellow": [250, 250, 210], "lightgray": [211, 211, 211], "lightgreen": [144, 238, 144], "lightgrey": [211, 211, 211], "lightpink": [255, 182, 193], "lightsalmon": [255, 160, 122], "lightseagreen": [32, 178, 170], "lightskyblue": [135, 206, 250], "lightslategray": [119, 136, 153], "lightslategrey": [119, 136, 153], "lightsteelblue": [176, 196, 222], "lightyellow": [255, 255, 224], "lime": [0, 255, 0], "limegreen": [50, 205, 50], "linen": [250, 240, 230], "magenta": [255, 0, 255], "maroon": [128, 0, 0], "mediumaquamarine": [102, 205, 170], "mediumblue": [0, 0, 205], "mediumorchid": [186, 85, 211], "mediumpurple": [147, 112, 219], "mediumseagreen": [60, 179, 113], "mediumslateblue": [123, 104, 238], "mediumspringgreen": [0, 250, 154], "mediumturquoise": [72, 209, 204], "mediumvioletred": [199, 21, 133], "midnightblue": [25, 25, 112], "mintcream": [245, 255, 250], "mistyrose": [255, 228, 225], "moccasin": [255, 228, 181], "navajowhite": [255, 222, 173], "navy": [0, 0, 128], "oldlace": [253, 245, 230], "olive": [128, 128, 0], "olivedrab": [107, 142, 35], "orange": [255, 165, 0], "orangered": [255, 69, 0], "orchid": [218, 112, 214], "palegoldenrod": [238, 232, 170], "palegreen": [152, 251, 152], "paleturquoise": [175, 238, 238], "palevioletred": [219, 112, 147], "papayawhip": [255, 239, 213], "peachpuff": [255, 218, 185], "peru": [205, 133, 63], "pink": [255, 192, 203], "plum": [221, 160, 221], "powderblue": [176, 224, 230], "purple": [128, 0, 128], "red": [255, 0, 0], "rosybrown": [188, 143, 143], "royalblue": [65, 105, 225], "saddlebrown": [139, 69, 19], "salmon": [250, 128, 114], "sandybrown": [244, 164, 96], "seagreen": [46, 139, 87], "seashell": [255, 245, 238], "sienna": [160, 82, 45], "silver": [192, 192, 192], "skyblue": [135, 206, 235], "slateblue": [106, 90, 205], "slategray": [112, 128, 144], "slategrey": [112, 128, 144], "snow": [255, 250, 250], "springgreen": [0, 255, 127], "steelblue": [70, 130, 180], "tan": [210, 180, 140], "teal": [0, 128, 128], "thistle": [216, 191, 216], "tomato": [255, 99, 71], "turquoise": [64, 224, 208], "violet": [238, 130, 238], "wheat": [245, 222, 179], "white": [255, 255, 255], "whitesmoke": [245, 245, 245], "yellow": [255, 255, 0], "yellowgreen": [154, 205, 50], "transparent": [0, 0, 0, 0] }, "filter": { "value": [ "true", "false", "null", "point", "linestring", "polygon", "collection" ] } } mapnik-reference-8.10.0/3.0.22/000077500000000000000000000000001342311331100155255ustar00rootroot00000000000000mapnik-reference-8.10.0/3.0.22/datasources.json000066400000000000000000000557071342311331100207530ustar00rootroot00000000000000{ "datasources": { "csv": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "strict": { "type": "boolean", "doc": "Control if the datasource should throw on invalid rows", "default-value": false, "default-meaning": "Unless this option is set to true the datasource will skip invalid rows and attempt to parse as much data as possible" }, "escape": { "type": "string", "doc": "The escape character to use for parsing data", "default-value": "A single backslash (aka. reverse solidus): \\", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "quote": { "type": "string", "doc": "The quote character to use for parsing data", "default-value": "A quotation mark (aka. double quote): \"", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "separator": { "type": "string", "doc": "The separator character to use for parsing data", "default-value": "Basic autodetection is used to determine the best default value if the user does not manually supply a separator.", "default-meaning": "A comma will be used unless more tabs (\t), pipes (|), or semicolons (;) are detected than commas in the header row (in that order of preference)" }, "headers": { "type": "string", "doc": "A comma separated list of header names that can be set to add headers to data that lacks them", "default-value": "", "default-meaning": "Headers will be parsed from the first line of the data unless this option is set" }, "filesize_max": { "type": "float", "doc": "The maximum filesize in MB that will be accepted", "default-value": 20, "default-meaning": "A file that is larger that 20 MB will not be accepted and an error will be throw unless the user manually passes this option with a larger value (useful only in cases where your machine has a lot of memory)" } }, "gdal": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "max_image_area": { "type": "unsigned", "doc": "Maximum memory limitation for image will be simply based on the maximum area we allow for an image. The true memory footprint therefore will vary based on the type of imagery that exists. This is not the maximum size of an image on disk but rather the maximum size we will load into mapnik from GDAL. `max_im_area` based on 50 mb limit for RGBA", "default-value": 13107200, "default-meaning": "50Mb", "required": false }, "band": { "type": "unsigned", "doc": "A particular raster band to work with.", "default-value": 0, "default-meaning": "No particular raster band set, working with all bands.", "required": false }, "nodata": { "type": "float", "doc": "Overrides nodata value from the raster.", "default-value": 0, "default-meaning": "Nodata value from the raster is used.", "required": false }, "nodata_tolerance": { "type": "float", "doc": "Make pixels in this tolerance around nodata value transparent.", "default-value": 1e-12, "default-meaning": "The tolerance is effectively zero.", "required": false }, "shared": { "type": "boolean", "doc": "Allows to share the GDAL dataset handle with other GDAL datasources with the same file path.", "default-value": false, "default-meaning": "The datasource will use unique dataset instance.", "required": false } }, "geojson": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "inline": { "type": "string", "doc": "Raw tabular data to be read instead of reading data from a file", "default-value": "", "default-meaning": "Unless this option is provided data will be read from the `file` option" } }, "occi": { "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "ogr": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "osm": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "postgis": { "table": { "type": "string", "doc": "The table or query used", "default-value": "", "default-meaning": "", "required": true }, "key_field": { "type": "boolean", "doc": "User provided field name to interpret as the primary key of the table. If provided then the values from this field (which must be an integer) will be used as the feature id of the returned data", "default-value": "", "default-meaning": "By default no primary key is required and in this case the feature id for returned features will be auto-generated by Mapnik and is not certain to be globally unique.", "required": false }, "key_field_as_attribute": { "type": "boolean", "doc": "User provided option to control whether the key_field will be duplicated as a feature attribute (as well as being used for the feature.id value)", "default-value": true, "default-meaning": "By default if key_field is provided then it is also available in the feature attributes by field name", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "dbname": { "type": "string", "doc": "Database name", "default-value": "username", "default-meaning": "Will default to a database named after the user (as per libpq defaults)", "required": false }, "host": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "password": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "port": { "type": "unsigned", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "user": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "connect_timeout": { "type": "unsigned", "doc": "", "default-value": 4, "default-meaning": "", "required": false }, "schema": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "extent": { "type": "string", "doc": "A comma or space delimited bounding box in the format of minx,miny,maxx,maxy that, if provided, will be used to report the extent of the datasource. The primary reason the option exists is for performance: providing this option at datasource creation saves the time otherwise needed to scan the data for the actual extent, which for large datasets can be very significant. The datasource extent, whether manually provided or automatically calculated is used during rendering to decide if the datasource should be queried for features or not (skipped for best performance). If the extent intersects with the map rendering extent then the datasource will be queried and the query extent will be clipped to the reported datasource extent. So, this means that this option can also be used to restrict which features are available for a given datasource", "default-value": "", "default-meaning": "The datasource extent will be determined at runtime by querying the data, which may be slow, although the extent only needs to be determined once per datasource initialized and it will be cached for further rendering", "recommended": true }, "estimate_extent": { "type": "boolean", "doc": "If an `extent` string is not provided then Mapnik dynamically queries the table to determine the extent. If this option is true then the faster but less accurate PostGIS `ST_EstimatedExtent` function is used instead of `ST_Extent`.", "default-value": false, "default-meaning": "", "required": false }, "geometry_table": { "type": "string", "doc": "Specifies geometry table to use to look up metadata", "default-value": "", "default-meaning": "Automatically parsed from 'table' value", "required": false }, "geometry_field": { "type": "string", "doc": "Specifies geometry field to use", "default-value": "", "default-meaning": "First entry in geometry_columns", "required": false }, "cursor_size": { "type": "unsigned", "doc": "Integer size of binary cursor to use", "default-value": 0, "default-meaning": "No binary cursor is used", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "srid": { "type": "unsigned", "doc": "SRID to use", "default-value": 0, "default-meaning": "Auto-detected from geometry_field", "required": false }, "initial_size": { "type": "unsigned", "doc": "Integer size of connection pool", "default-value": 1, "default-meaning": "", "required": false }, "max_size": { "type": "unsigned", "doc": "Integer max of connection pool", "default-value": 10, "default-meaning": "", "required": false }, "simplify_geometries": { "type": "boolean", "doc": "Simplify geometries with ST_Simplify", "default-value": false, "default-meaning": "Don't simplify geometries", "required": false }, "autodetect_key_field": { "type": "boolean", "doc": "Attempt to autodetect a primary key field", "default-value": false, "default-meaning": "Don't autodetect a primary key field", "required": false }, "persist_connection": { "type": "boolean", "doc": "Keep connection open", "default-value": true, "default-meaning": "Connections, successfully created, will be kept open until Mapnik shuts down", "required": false }, "extent_from_subquery": { "type": "boolean", "doc": "Direct Mapnik to query Postgis for the extent of the raw 'table' value", "default-value": false, "default-meaning": "Uses 'geometry_table' instead of querying", "required": false } }, "python": { "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "raster": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false } }, "rasterlite": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false } }, "shape": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "sqlite": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "table": { "type": "string", "doc": "The table or query used", "default-value": "", "default-meaning": "", "required": true }, "key_field": { "type": "boolean", "doc": "User provided field name to interpret as the primary key of the table. If provided then the values from this field (which must be an integer) will be used as the feature id of the returned data", "default-value": "", "default-meaning": "By default no primary key is required and in this case the feature id for returned features will be auto-generated by Mapnik and is not certain to be globally unique.", "required": false } }, "topojson": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "inline": { "type": "string", "doc": "Raw tabular data to be read instead of reading data from a file", "default-value": "", "default-meaning": "Unless this option is provided data will be read from the `file` option" } } } }mapnik-reference-8.10.0/3.0.22/datasources.template.json000066400000000000000000000366701342311331100225630ustar00rootroot00000000000000{ "types": { "type": { "type": "string", "doc": "The type of the option", "values": ["string","float","boolean","unsigned"], "required": true }, "doc": { "type": "string", "doc": "The basic description of the option and the expected behavior if you provide it", "required": true }, "default-value": { "type": "string", "doc": "Either an empty string if there is no default value, a description of the default value, or the default value itself (if appropriate)", "required": true }, "default-meaning": { "type": "string", "doc": "A detailed description of what the behavior will be if the default value is left unchanged", "required": true }, "required": { "type": "boolean", "doc": "A boolean value to signify if the option is required. Can be left out and if not present it will be assumed that the option is not required", "required": false }, "recommended": { "type": "boolean", "doc": "A boolean value to signify if the option is recommended, even if it is not required. This is meant to indicate to users that better behavior or performance will be gained if they manually provide the option and that they should seek to understand why it exists (and also why/how it needs to be manually provided)", "required": false } }, "variables": { "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "extent" : { "type": "string", "doc": "A comma or space delimited bounding box in the format of minx,miny,maxx,maxy that, if provided, will be used to report the extent of the datasource. The primary reason the option exists is for performance: providing this option at datasource creation saves the time otherwise needed to scan the data for the actual extent, which for large datasets can be very significant. The datasource extent, whether manually provided or automatically calculated is used during rendering to decide if the datasource should be queried for features or not (skipped for best performance). If the extent intersects with the map rendering extent then the datasource will be queried and the query extent will be clipped to the reported datasource extent. So, this means that this option can also be used to restrict which features are available for a given datasource", "default-value": "", "default-meaning": "The datasource extent will be determined at runtime by querying the data, which may be slow, although the extent only needs to be determined once per datasource initialized and it will be cached for further rendering", "recommended": true }, "table" : { "type": "string", "doc": "The table or query used", "default-value": "", "default-meaning": "", "required": true }, "key_field": { "type": "boolean", "doc": "User provided field name to interpret as the primary key of the table. If provided then the values from this field (which must be an integer) will be used as the feature id of the returned data", "default-value": "", "default-meaning": "By default no primary key is required and in this case the feature id for returned features will be auto-generated by Mapnik and is not certain to be globally unique.", "required": false }, "inline": { "type": "string", "doc": "Raw tabular data to be read instead of reading data from a file", "default-value": "", "default-meaning": "Unless this option is provided data will be read from the `file` option" } }, "datasources": { "csv": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "row_limit":"<@(row_limit)", "strict": { "type": "boolean", "doc": "Control if the datasource should throw on invalid rows", "default-value": false, "default-meaning": "Unless this option is set to true the datasource will skip invalid rows and attempt to parse as much data as possible" }, "escape": { "type": "string", "doc": "The escape character to use for parsing data", "default-value": "A single backslash (aka. reverse solidus): \\", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "quote": { "type": "string", "doc": "The quote character to use for parsing data", "default-value": "A quotation mark (aka. double quote): \"", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "separator": { "type": "string", "doc": "The separator character to use for parsing data", "default-value": "Basic autodetection is used to determine the best default value if the user does not manually supply a separator.", "default-meaning": "A comma will be used unless more tabs (\t), pipes (|), or semicolons (;) are detected than commas in the header row (in that order of preference)" }, "headers": { "type": "string", "doc": "A comma separated list of header names that can be set to add headers to data that lacks them", "default-value": "", "default-meaning": "Headers will be parsed from the first line of the data unless this option is set" }, "filesize_max": { "type": "float", "doc": "The maximum filesize in MB that will be accepted", "default-value": 20.0, "default-meaning": "A file that is larger that 20 MB will not be accepted and an error will be throw unless the user manually passes this option with a larger value (useful only in cases where your machine has a lot of memory)" } }, "gdal": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "max_image_area": { "type": "unsigned", "doc": "Maximum memory limitation for image will be simply based on the maximum area we allow for an image. The true memory footprint therefore will vary based on the type of imagery that exists. This is not the maximum size of an image on disk but rather the maximum size we will load into mapnik from GDAL. `max_im_area` based on 50 mb limit for RGBA", "default-value": 13107200, "default-meaning": "50Mb", "required":false }, "band": { "type": "unsigned", "doc": "A particular raster band to work with.", "default-value": 0, "default-meaning": "No particular raster band set, working with all bands.", "required": false }, "nodata": { "type": "float", "doc": "Overrides nodata value from the raster.", "default-value": 0, "default-meaning": "Nodata value from the raster is used.", "required": false }, "nodata_tolerance": { "type": "float", "doc": "Make pixels in this tolerance around nodata value transparent.", "default-value": 1e-12, "default-meaning": "The tolerance is effectively zero.", "required": false }, "shared": { "type": "boolean", "doc": "Allows to share the GDAL dataset handle with other GDAL datasources with the same file path.", "default-value": false, "default-meaning": "The datasource will use unique dataset instance.", "required": false } }, "geojson": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "inline":"<@(inline)" }, "occi": { "encoding":"<@(encoding)" }, "ogr": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)" }, "osm": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)" }, "postgis": { "table": "<@(table)", "key_field": "<@(key_field)", "key_field_as_attribute": { "type": "boolean", "doc": "User provided option to control whether the key_field will be duplicated as a feature attribute (as well as being used for the feature.id value)", "default-value": true, "default-meaning": "By default if key_field is provided then it is also available in the feature attributes by field name", "required": false }, "encoding":"<@(encoding)", "dbname": { "type": "string", "doc": "Database name", "default-value": "username", "default-meaning": "Will default to a database named after the user (as per libpq defaults)", "required": false }, "host": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "password": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "port": { "type": "unsigned", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "user": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "connect_timeout": { "type": "unsigned", "doc": "", "default-value": 4, "default-meaning": "", "required": false }, "schema": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "extent": "<@(extent)", "estimate_extent": { "type": "boolean", "doc": "If an `extent` string is not provided then Mapnik dynamically queries the table to determine the extent. If this option is true then the faster but less accurate PostGIS `ST_EstimatedExtent` function is used instead of `ST_Extent`.", "default-value": false, "default-meaning": "", "required": false }, "geometry_table": { "type": "string", "doc": "Specifies geometry table to use to look up metadata", "default-value": "", "default-meaning": "Automatically parsed from 'table' value", "required": false }, "geometry_field": { "type": "string", "doc": "Specifies geometry field to use", "default-value": "", "default-meaning": "First entry in geometry_columns", "required": false }, "cursor_size": { "type": "unsigned", "doc": "Integer size of binary cursor to use", "default-value": 0, "default-meaning": "No binary cursor is used", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "srid": { "type": "unsigned", "doc": "SRID to use", "default-value": 0, "default-meaning": "Auto-detected from geometry_field", "required": false }, "initial_size": { "type": "unsigned", "doc": "Integer size of connection pool", "default-value": 1, "default-meaning": "", "required": false }, "max_size": { "type": "unsigned", "doc": "Integer max of connection pool", "default-value": 10, "default-meaning": "", "required": false }, "simplify_geometries": { "type": "boolean", "doc": "Simplify geometries with ST_Simplify", "default-value": false, "default-meaning": "Don't simplify geometries", "required": false }, "autodetect_key_field": { "type": "boolean", "doc": "Attempt to autodetect a primary key field", "default-value": false, "default-meaning": "Don't autodetect a primary key field", "required": false }, "persist_connection": { "type": "boolean", "doc": "Keep connection open", "default-value": true, "default-meaning": "Connections, successfully created, will be kept open until Mapnik shuts down", "required": false }, "extent_from_subquery": { "type": "boolean", "doc": "Direct Mapnik to query Postgis for the extent of the raw 'table' value", "default-value": false, "default-meaning": "Uses 'geometry_table' instead of querying", "required": false } }, "python": { "encoding":"<@(encoding)" }, "raster": { "file":"<@(file)", "base":"<@(base)" }, "rasterlite": { "file":"<@(file)", "base":"<@(base)" }, "shape": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)" }, "sqlite": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "table": "<@(table)", "key_field": "<@(key_field)" }, "topojson": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "inline":"<@(inline)" } } } mapnik-reference-8.10.0/3.0.22/reference.json000066400000000000000000004162001342311331100203610ustar00rootroot00000000000000{ "version": "3.0.22", "style": { "filter-mode": { "type": [ "all", "first" ], "doc": "Control the processing behavior of Rule filters within a Style. If 'all' is used then all Rules are processed sequentially independent of whether any previous filters matched. If 'first' is used then it means processing ends after the first match (a positive filter evaluation) and no further Rules in the Style are processed ('first' is usually the default for CSS implementations on top of Mapnik to simplify translation from CSS to Mapnik XML).", "default-value": "all", "default-meaning": "All Rules in a Style are processed whether they have filters or not and whether or not the filter conditions evaluate to true." }, "image-filters": { "css": "image-filters", "default-value": "none", "default-meaning": "no filters", "type": "functions", "functions": [ ["agg-stack-blur", 2], ["emboss", 0], ["blur", 0], ["gray", 0], ["sobel", 0], ["edge-detect", 0], ["x-gradient", 0], ["y-gradient", 0], ["invert", 0], ["sharpen", 0], ["color-blind-protanope", 0], ["color-blind-deuteranope", 0], ["color-blind-tritanope", 0], ["colorize-alpha", -1], ["color-to-alpha", 1], ["scale-hsla", 8] ], "doc": "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": { "css":"image-filters-inflate", "default-value": false, "type":"boolean", "default-meaning": "No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary", "doc": "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": { "css": "direct-image-filters", "default-value": "none", "default-meaning": "no filters", "type": "functions", "functions": [ ["agg-stack-blur", 2], ["emboss", 0], ["blur", 0], ["gray", 0], ["sobel", 0], ["edge-detect", 0], ["x-gradient", 0], ["y-gradient", 0], ["invert", 0], ["sharpen", 0], ["color-blind-protanope", 0], ["color-blind-deuteranope", 0], ["color-blind-tritanope", 0], ["colorize-alpha", -1], ["color-to-alpha", 1], ["scale-hsla", 8] ], "doc": "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": { "css": "comp-op", "default-value": "src-over", "default-meaning": "add the current layer on top of other layers", "doc": "Composite operation. This defines how this layer should behave relative to layers atop or below it.", "type": [ "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" ] }, "opacity": { "css": "opacity", "type": "float", "doc": "An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer).", "default-value": 1.0, "default-meaning": "No separate buffer will be used and no alpha will be applied to the style after rendering." } }, "layer" : { "name": { "default-value": "", "type":"string", "required" : true, "default-meaning": "No layer name has been provided", "doc": "The name of a layer. Can be anything you wish and is not strictly validated, but ideally unique in the map." }, "srs": { "default-value": "", "type":"string", "default-meaning": "No srs value is provided and the value will be inherited from the Map's srs", "doc": "The spatial reference system definition for the layer, aka the projection. Can either be a proj4 literal string like '+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs' or, if the proper proj4 epsg/nad/etc identifier files are installed, a string that uses an id like: '+init=epsg:4326'." }, "status": { "default-value": true, "type":"boolean", "default-meaning": "This layer will be marked as active and available for processing", "doc": "A property that can be set to false to disable this layer from being processed." }, "minzoom": { "default-value": 0, "type":"float", "default-meaning": "The layer will be visible at the minimum possible scale", "doc": "The minimum scale denominator that this layer will be visible at. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6. This option has been deprecated in favor of `minimum-scale-denominator`.", "status": "deprecated" }, "maxzoom": { "default-value": "1.79769e+308", "type":"float", "default-meaning": "The layer will be visible at the maximum possible scale", "doc": "The maximum scale denominator that this layer will be visible at. The default is the numeric limit of the C++ double type, which may vary slightly by system, but is likely a massive number like 1.79769e+308 and ensures that this layer will always be visible unless the value is reduced. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6. This option has been deprecated in favor of `maximum-scale-denominator`.", "status": "deprecated" }, "minimum-scale-denominator": { "default-value": 0, "type":"float", "default-meaning": "The layer will be visible at the minimum possible scale denominator", "doc": "The minimum scale denominator that this layer will be visible at. A layer's visibility is determined by whether its status is true and if the Map scale denominator >= `minimum-scale-denominator` - 1e-6 and scale denominator < 'maximum-scale-denominator' + 1e-6." }, "maximum-scale-denominator": { "default-value": "1.79769e+308", "type":"float", "default-meaning": "The layer will be visible at the maximum possible scale denominator", "doc": "The maximum scale denominator that this layer will be visible at. The default is the numeric limit of the C++ double type, which may vary slightly by system, but is likely a massive number like 1.79769e+308 and ensures that this layer will always be visible unless the value is reduced. A layer's visibility is determined by whether its status is true and if the Map scale denominator >= `minimum-scale-denominator` - 1e-6 and scale denominator < `maximum-scale-denominator` + 1e-6." }, "queryable": { "default-value": false, "type":"boolean", "default-meaning": "The layer will not be available for the direct querying of data values", "doc": "This property was added for GetFeatureInfo/WMS compatibility and is rarely used. It is off by default meaning that in a WMS context the layer will not be able to be queried unless the property is explicitly set to true." }, "clear-label-cache": { "default-value": false, "type":"boolean", "default-meaning": "The renderer's collision detector cache (used for avoiding duplicate labels and overlapping markers) will not be cleared immediately before processing this layer", "doc": "This property, by default off, can be enabled to allow a user to clear the collision detector cache before a given layer is processed. This may be desirable to ensure that a given layers data shows up on the map even if it normally would not because of collisions with previously rendered labels or markers." }, "group-by": { "default-value": "", "type":"string", "default-meaning": "No special layer grouping will be used during rendering", "doc": "https://github.com/mapnik/mapnik/wiki/Grouped-rendering" }, "buffer-size": { "default-value": 0, "type":"float", "default-meaning": "No custom buffer will be used for the layer and rather the Map buffer-size will be used", "doc": "Extra tolerance around the Layer extent (in pixels) used when querying the layer data during rendering. If set this will override the Map buffer-size." }, "maximum-extent": { "default-value": "none", "type":"bbox", "default-meaning": "No clipping extent will be used", "doc": "An extent to be used to limit the bounds used to query this specific layer data during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Layer." }, "cache-features": { "type":"boolean", "default-value": "off", "default-meaning": "Features are not cached between rendering multiple styles. The datasource is queried for each style.", "doc": "Setting this to `on` triggers Mapnik to attempt to cache features in memory for rendering when (and only when) a layer has multiple styles attached to it." } }, "symbolizers" : { "map": { "background-color": { "css": "background-color", "default-value": "none", "default-meaning": "Will be rendered transparent.", "type": "color", "doc": "Map Background color." }, "background-image": { "css": "background-image", "type": "uri", "default-value": "", "default-meaning": "No background image will be used.", "doc": "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": { "css": "background-image-comp-op", "doc": "Set the compositing operation used to blend the image into the background.", "default-value": "src-over", "default-meaning": "The background-image will be blended with the background normally (placed on top of any existing background-color).", "type": [ "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" ] }, "background-image-opacity": { "css": "background-image-opacity", "type": "float", "doc": "Set the opacity of the image.", "default-value": 1.0, "default-meaning": "The image opacity will not be changed when applied to the map background." }, "srs": { "css": "srs", "type": "string", "default-value": "+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs", "default-meaning": "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.", "doc": "Map spatial reference (proj4 string)." }, "buffer-size": { "css": "buffer-size", "default-value": 0, "type":"float", "default-meaning": "No buffer will be used.", "doc": "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": { "css": "maximum-extent", "default-value": "-20037508.34,-20037508.34,20037508.34,20037508.34", "type":"string", "default-meaning": "All data will be clipped to global mercator extent (default is applied in Carto.js).", "doc": "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": { "css": "base", "default-value": "", "default-meaning": "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.", "type": "string", "doc": "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." }, "paths-from-xml": { "css": "", "default-value": true, "default-meaning": "Paths read from XML will be interpreted from the location of the XML.", "type": "boolean", "doc": "Value to control whether paths in the XML will be interpreted from the location of the XML or from the working directory of the program that calls load_map()." }, "minimum-version": { "css": "", "default-value": "none", "default-meaning": "Mapnik version will not be detected and no error will be thrown about compatibility.", "type": "string", "doc": "The minumum Mapnik version (e.g. 0.7.2) needed to use certain functionality in the stylesheet." }, "font-directory": { "css": "font-directory", "type": "uri", "default-value": "none", "default-meaning": "No map-specific fonts will be registered.", "doc": "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": { "default": { "css": "polygon", "type": [ "auto", "none" ], "doc": "Allows omitting a polygon symbolizer rule or emitting it with default values.", "status": "unstable" }, "fill": { "css": "polygon-fill", "type": "color", "expression":true, "default-value": "rgba(128,128,128,1)", "default-meaning": "Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).", "doc": "Fill color to assign to a polygon." }, "fill-opacity": { "css": "polygon-opacity", "type": "float", "expression":true, "doc": "The opacity of the polygon.", "default-value": 1.0, "default-meaning": "Color is fully opaque." }, "gamma": { "css": "polygon-gamma", "type": "float", "expression":true, "default-value": 1.0, "default-meaning": "Fully antialiased.", "range": "0-1", "doc": "Level of antialiasing of polygon edges." }, "gamma-method": { "css": "polygon-gamma-method", "type": [ "power", "linear", "none", "threshold", "multiply" ], "expression":true, "default-value": "power", "default-meaning": "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.", "doc": "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." }, "clip": { "css": "polygon-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "polygon-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "Simplify geometries by the given tolerance." }, "simplify-algorithm": { "css": "polygon-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "Simplify geometries by the given algorithm." }, "smooth": { "css": "polygon-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "polygon-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform polygon geometry with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "polygon-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "line": { "default": { "css": "line", "type": [ "auto", "none" ], "doc": "Allows omitting a line symbolizer rule or emitting it with default values.", "status": "unstable" }, "stroke": { "css": "line-color", "default-value": "black", "type": "color", "expression":true, "default-meaning": "black and fully opaque (alpha = 1), same as rgb(0,0,0) or rgba(0,0,0,1).", "doc": "The color of a drawn line." }, "stroke-width": { "css": "line-width", "default-value": 1.0, "type": "float", "expression":true, "doc": "The width of a line in pixels.", "default-meaning": "The line will be rendered 1 pixel wide." }, "stroke-opacity": { "css": "line-opacity", "default-value": 1.0, "type": "float", "expression":true, "default-meaning": "Color is fully opaque.", "doc": "The opacity of a line." }, "stroke-linejoin": { "css": "line-join", "default-value": "miter", "type": [ "miter", "miter-revert", "round", "bevel" ], "expression":true, "doc": "The behavior of lines when joining.", "default-meaning": "The line joins will be rendered using a miter look." }, "stroke-linecap": { "css": "line-cap", "default-value": "butt", "type": [ "butt", "round", "square" ], "expression":true, "doc": "The display of line endings.", "default-meaning": "The line endings will be rendered using a butt look." }, "stroke-gamma": { "css": "line-gamma", "type": "float", "expression":true, "default-value": 1.0, "default-meaning": "Fully antialiased.", "range": "0-1", "doc": "Level of antialiasing of stroke line." }, "stroke-gamma-method": { "css": "line-gamma-method", "type": [ "power", "linear", "none", "threshold", "multiply" ], "expression":true, "default-value": "power", "default-meaning": "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.", "doc": "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." }, "stroke-dasharray": { "css": "line-dasharray", "type": "numbers", "expression":true, "doc": "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.", "default-value": "none", "default-meaning": "The line will be drawn without dashes." }, "stroke-dashoffset": { "css": "line-dash-offset", "type": "numbers", "expression":true, "doc": "Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled).", "default-value": "none", "default-meaning": "The line will be drawn without dashes." }, "stroke-miterlimit": { "css": "line-miterlimit", "type": "float", "expression":true, "doc": "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.", "default-value": 4.0, "default-meaning": "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 )'." }, "clip": { "css": "line-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "line-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "Simplify geometries by the given tolerance." }, "simplify-algorithm": { "css": "line-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "Simplify geometries by the given algorithm." }, "smooth": { "css": "line-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "offset": { "css": "line-offset", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Will not be offset.", "doc": "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).", "status": "unstable" }, "rasterizer": { "css": "line-rasterizer", "type": [ "full", "fast" ], "expression":true, "default-value": "full", "doc": "Exposes an alternate AGG rendering method that sacrifices some accuracy for speed.", "default-meaning": "The line will be rendered using the highest quality method rather than the fastest." }, "geometry-transform": { "css": "line-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform line geometry with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "line-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "markers": { "default": { "css": "marker", "type": [ "auto", "none" ], "doc": "Allows omitting a marker symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "marker-file", "doc": "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.", "default-value": "none", "default-meaning": "An ellipse or circle, if width equals height.", "type": "uri", "expression":true }, "opacity": { "css": "marker-opacity", "doc": "The overall opacity of the marker, if set, overrides both the opacity of the fill and the opacity of the stroke.", "default-value": 1.0, "default-meaning": "The stroke-opacity and fill-opacity of the marker.", "type": "float", "expression":true }, "fill-opacity": { "css": "marker-fill-opacity", "doc": "The fill opacity of the marker. This property will also set the `fill-opacity` of elements in an SVG loaded from a file.", "default-value": 1.0, "expression":true, "default-meaning": "Color is fully opaque.", "type": "float" }, "stroke": { "css": "marker-line-color", "doc": "The color of the stroke around the marker. This property will also set the `stroke` of elements in an SVG loaded from a file.", "default-value": "black", "type": "color", "expression":true, "default-meaning": "The marker will be drawn with a black outline." }, "stroke-width": { "css": "marker-line-width", "default-value": 0.5, "doc": "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.", "type": "float", "expression":true, "default-meaning": "The marker will be drawn with an outline of .5 pixels wide." }, "stroke-opacity": { "css": "marker-line-opacity", "default-value": 1.0, "default-meaning": "Color is fully opaque. This property will also set the `stroke-opacity` of elements in an SVG loaded from a file.", "doc": "The opacity of a line.", "type": "float", "expression":true }, "placement": { "css": "marker-placement", "type": [ "point", "line", "interior", "vertex-first", "vertex-last" ], "expression":true, "default-value": "point", "default-meaning": "Place markers at the center point (centroid) of the geometry.", "doc": "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." }, "multi-policy": { "css": "marker-multi-policy", "type": [ "each", "whole", "largest" ], "expression":true, "default-value": "each", "default-meaning": "If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each.", "doc": "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": { "css": "marker-type", "type": [ "arrow", "ellipse" ], "expression":true, "default-value": "ellipse", "default-meaning": "The marker shape is an ellipse.", "doc": "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).", "status": "deprecated" }, "width": { "css": "marker-width", "default-value": 10.0, "doc": "The width of the marker, if using one of the default types.", "type": "float", "expression":true, "default-meaning": "The marker width is 10 pixels." }, "height": { "css": "marker-height", "default-value": 10.0, "doc": "The height of the marker, if using one of the default types.", "type": "float", "expression":true, "default-meaning": "The marker height is 10 pixels." }, "fill": { "css": "marker-fill", "default-value": "blue", "doc": "The color of the area of the marker. This property will also set the `fill` of elements in an SVG loaded from a file.", "type": "color", "expression":true, "default-meaning": "The marker fill color is blue." }, "allow-overlap": { "css": "marker-allow-overlap", "type": "boolean", "expression":true, "default-value": false, "doc": "Control whether overlapping markers are shown or hidden.", "default-meaning": "Do not allow markers to overlap with each other - overlapping markers will not be shown." }, "avoid-edges": { "css": "marker-avoid-edges", "doc": "Avoid placing markers that intersect with tile boundaries.", "type": "boolean", "expression":true, "default-meaning": "Markers will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.", "default-value": false }, "ignore-placement": { "css": "marker-ignore-placement", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache.", "doc": "Value to control whether the placement of the feature will prevent the placement of other features." }, "spacing": { "css": "marker-spacing", "doc": "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.", "default-value": 100.0, "type": "float", "expression":true, "default-meaning": "In the case of marker-placement:line then draw a marker every 100 pixels along a line." }, "max-error": { "css": "marker-max-error", "type": "float", "expression":true, "default-value": 0.2, "default-meaning": "N/A: not intended to be changed.", "doc": "N/A: not intended to be changed." }, "transform": { "css": "marker-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform marker instance with specified function. Ignores map scale factor." }, "clip": { "css": "marker-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "marker-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Geometry will not be simplified.", "doc": "geometries are simplified by the given tolerance." }, "simplify-algorithm": { "css": "marker-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "geometries are simplified by the given algorithm." }, "smooth": { "css": "marker-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "marker-geometry-transform", "type": "functions", "expression":true, "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform marker geometry with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "offset": { "css": "marker-offset", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Will not be offset.", "doc": "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)." }, "comp-op": { "css": "marker-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true }, "direction": { "css": "marker-direction", "default-value": "right", "type": [ "auto", "auto-down", "left", "right", "left-only", "right-only", "up", "down" ], "expression": true, "default-meaning": "Markers are oriented to the right in the line direction.", "doc": "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": { "default": { "css": "shield", "type": [ "none" ], "doc": "Allows omitting a shield symbolizer rule.", "status": "unstable" }, "name": { "css": "shield-name", "type": "string", "expression":true, "serialization": "content", "default-value": "", "default-meaning": "No text label will be rendered with the shield.", "doc": "Value to use for a shield\"s text label. Data columns are specified using brackets like [column_name]." }, "file": { "css": "shield-file", "required": true, "type": "uri", "expression":true, "default-value": "none", "doc": "Image file to render behind the shield text. Accepted formats: svg, jpg, png, tiff, and webp.", "default-meaning": "" }, "face-name": { "css": "shield-face-name", "type": "string", "expression":true, "validate": "font", "doc": "Font name and style to use for the shield text.", "default-value": "none", "required": true, "default-meaning": "" }, "unlock-image": { "css": "shield-unlock-image", "type": "boolean", "expression":true, "doc": "This parameter should be set to true if you are trying to position text beside rather than on top of the shield image.", "default-value": false, "default-meaning": "text alignment relative to the shield image uses the center of the image as the anchor for text positioning." }, "size": { "css": "shield-size", "type": "float", "expression":true, "default-value": 10.0, "doc": "The size of the shield text in pixels.", "default-meaning": "Font size of 10 will be used to render text." }, "fill": { "css": "shield-fill", "type": "color", "expression":true, "default-value": "black", "doc": "The color of the shield text.", "default-meaning": "The shield text will be rendered black." }, "placement": { "css": "shield-placement", "type": [ "point", "line", "vertex", "interior", "grid", "alternating-grid" ], "expression":true, "default-value": "point", "default-meaning": "One shield will be placed per geometry.", "doc": "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." }, "avoid-edges": { "css": "shield-avoid-edges", "doc": "Avoid placing shields that intersect with tile boundaries.", "type": "boolean", "expression":true, "default-meaning": "Shields will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.", "default-value": false }, "allow-overlap": { "css": "shield-allow-overlap", "type": "boolean", "expression":true, "default-value": false, "doc": "Control whether overlapping shields are shown or hidden.", "default-meaning": "Shields will not overlap and any shields that might collide with previously placed shields will not be rendered.", "default-meaning": "Do not allow shields to overlap with other map elements already placed." }, "margin": { "css": "shield-margin", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No extra margin will be used to determine if a shield collides with any other text, shield, or marker.", "doc": "Minimum distance that a shield can be placed from any other text, shield, or marker." }, "repeat-distance": { "css": "shield-repeat-distance", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Shields with the same text will be rendered without restriction.", "doc": "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." }, "minimum-distance": { "css": "shield-min-distance", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Shields with the same text will be rendered without restriction.", "doc": "Minimum distance to any other collision object. Deprecated: replaced by `shield-margin`.", "status": "deprecated" }, "spacing": { "css": "shield-spacing", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Only one shield per line will attempt to be placed.", "doc": "Distance the renderer should use to try to place repeated shields on a line." }, "minimum-padding": { "css": "shield-min-padding", "expression":true, "default-value": 0.0, "doc": "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.", "default-meaning": "No margin will be used to detect if a shield is nearby a tile boundary.", "type": "float" }, "label-position-tolerance": { "css": "shield-label-position-tolerance", "default-value": "shield-spacing/2.0", "type": "float", "expression":true, "default-meaning": "If a shield cannot be placed then the renderer will advance by shield-spacing/2.0 to try placement again.", "doc": "Allows the shield to be displaced from its ideal position by a number of pixels (only works with placement:line)." }, "wrap-width": { "css": "shield-wrap-width", "type": "unsigned", "expression":true, "default-value": 0, "default-meaning": "Text will not be wrapped.", "doc": "Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap." }, "wrap-before": { "css": "shield-wrap-before", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "Wrapped lines will be a bit longer than wrap-width.", "doc": "Wrap text before wrap-width is reached." }, "wrap-character": { "css": "shield-wrap-character", "type": "string", "expression":true, "default-value": "\" \"", "default-meaning": "Lines will be wrapped conforming to the (untailored) Unicode Line Break Algorithm provided by ICU BreakIterator.", "doc": "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." }, "halo-fill": { "css": "shield-halo-fill", "type": "color", "expression":true, "default-value": "white", "doc": "Specifies the color of the halo around the text.", "default-meaning": "The shield halo text will be rendered white." }, "halo-radius": { "css": "shield-halo-radius", "default-value": 0.0, "default-meaning": "no halo.", "doc": "Specify the radius of the halo in pixels.", "type": "float", "expression":true }, "halo-rasterizer": { "css": "shield-halo-rasterizer", "type": [ "full", "fast" ], "expression":true, "default-value": "full", "default-meaning": "The shield will be rendered using the highest quality method rather than the fastest.", "doc": "Exposes an alternate text halo rendering method that sacrifices quality for speed." }, "halo-transform": { "css": "shield-halo-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "", "default-meaning": "No transformation.", "doc": "Transform shield halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor." }, "halo-comp-op": { "css": "shield-halo-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ], "expression":true }, "halo-opacity": { "css": "shield-halo-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text halo.", "default-value": 1.0, "type": "float", "expression":true, "default-meaning": "Fully opaque." }, "character-spacing": { "css": "shield-character-spacing", "type": "unsigned", "expression":true, "default-value": 0, "default-meaning": "The default character spacing of the font will be used.", "doc": "Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement." }, "line-spacing": { "css": "shield-line-spacing", "default-value": 0, "doc": "Vertical spacing between lines of multiline labels (in pixels).", "type": "float", "expression":true, "default-meaning": "The default font spacing will be used." }, "dx": { "css": "shield-text-dx", "type": "float", "expression":true, "doc": "Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right.", "default-meaning": "Text will not be displaced.", "default-value": 0.0 }, "dy": { "css": "shield-text-dy", "type": "float", "expression":true, "doc": "Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down.", "default-meaning": "Text will not be displaced.", "default-value": 0.0 }, "shield-dx": { "css": "shield-dx", "type": "float", "expression":true, "doc": "Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right.", "default-meaning": "Shield will not be displaced.", "default-value": 0.0 }, "shield-dy": { "css": "shield-dy", "type": "float", "expression":true, "doc": "Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down.", "default-meaning": "Shield will not be displaced.", "default-value": 0.0 }, "opacity": { "css": "shield-opacity", "type": "float", "expression":true, "doc": "The opacity of the image used for the shield.", "default-meaning": "Color is fully opaque.", "default-value": 1.0 }, "text-opacity": { "css": "shield-text-opacity", "type": "float", "expression":true, "doc": "The opacity of the text placed on top of the shield.", "default-meaning": "Color is fully opaque.", "default-value": 1.0 }, "horizontal-alignment": { "css": "shield-horizontal-alignment", "type": [ "left", "middle", "right", "auto" ], "expression":true, "doc": "The shield's horizontal alignment from its centerpoint.", "default-meaning": "TODO.", "default-value": "auto" }, "vertical-alignment": { "css": "shield-vertical-alignment", "type": [ "top", "middle", "bottom", "auto" ], "expression":true, "doc": "The shield's vertical alignment from its centerpoint.", "default-meaning": "TODO.", "default-value": "middle" }, "placement-type": { "css": "shield-placement-type", "doc": "Re-position and/or re-size shield to avoid overlaps. \"simple\" for basic algorithm (using shield-placements string,) \"dummy\" to turn this feature off.", "type": [ "dummy", "simple", "list" ], "expression":true, "default-meaning": "Alternative placements will not be enabled.", "default-value": "dummy" }, "placements": { "css": "shield-placements", "type": "string", "expression":true, "default-value": "", "default-meaning": "No alternative placements will be used.", "doc": "If \"placement-type\" is set to \"simple\", use this \"POSITIONS,[SIZES]\" string. An example is `shield-placements: \"E,NE,SE,W,NW,SW\";`." }, "text-transform": { "css": "shield-text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize", "reverse" ], "expression":true, "doc": "Transform the case of the characters.", "default-meaning": "No text transformation will be applied.", "default-value": "none" }, "justify-alignment": { "css": "shield-justify-alignment", "type": [ "left", "center", "right", "auto" ], "expression":true, "doc": "Define how text in a shield's label is justified.", "default-meaning": "TODO.", "default-value": "auto" }, "transform": { "css": "shield-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform shield instance with specified function. Ignores map scale factor." }, "clip": { "css": "shield-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "shield-simplify", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "Simplify the geometries used for shield placement by the given tolerance." }, "simplify-algorithm": { "css": "shield-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression": true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "Simplify the geometries used for shield placement by the given algorithm." }, "smooth": { "css": "shield-smooth", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "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." }, "comp-op": { "css": "shield-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true }, "grid-cell-width": { "css": "shield-grid-cell-width", "type": "float", "expression": true, "default-value": 0, "default-meaning": "No placement will be done.", "doc": "Controls horizontal spacing between placements of placement type `grid` or `alternating-grid`." }, "grid-cell-height": { "css": "shield-grid-cell-height", "type": "float", "expression": true, "default-value": 0, "default-meaning": "No placement will be done.", "doc": "Controls vertical spacing between placements of placement type `grid` or `alternating-grid`." }, "offset": { "css": "shield-offset", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "Will not be offset.", "doc": "In case of `line` placement, offsets a shield position a number of pixels parallel to its actual path. In case of `grid` placement, reduces or expands the polygon area. Positive values move the line left or expand the polygon, negative values move it right or shrink the polygon (relative to the directionality of the line or polygon winding).", "status": "unstable" } }, "line-pattern": { "default": { "css": "line-pattern", "type": [ "none" ], "doc": "Allows omitting a line pattern symbolizer rule or emitting it with default values.", "status": "unstable" }, "line-pattern": { "css": "line-pattern-type", "type": ["warp", "repeat" ], "expression": true, "default-value": "warp", "default-meaning": "The pattern will be warped along a linear geometry.", "doc": "Sets the way how pattern is rendered. The `warp` options warps the pattern in direction of the geometry. The `repeat` option can be used to repeat pattern in an area given by options `stroke-pattern-width`, `stroke-pattern-linecap`, `line-pattern-join`, `line-pattern-miterlimit`, `line-pattern-dasharray`." }, "file": { "css": "line-pattern-file", "type": "uri", "expression":true, "default-value": "none", "required": true, "doc": "An image file to be repeated and warped along a line. Accepted formats: svg, jpg, png, tiff, and webp.", "default-meaning": "" }, "clip": { "css": "line-pattern-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "opacity": { "css": "line-pattern-opacity", "type": "float", "expression":true, "doc": "Apply an opacity level to the image used for the pattern.", "default-value": 1.0, "default-meaning": "The image is rendered without modifications." }, "simplify": { "css": "line-pattern-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "geometries are simplified by the given tolerance." }, "simplify-algorithm": { "css": "line-pattern-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "geometries are simplified by the given algorithm." }, "smooth": { "css": "line-pattern-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "offset": { "css": "line-pattern-offset", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "The line will not be offset.", "doc": "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)." }, "geometry-transform": { "css": "line-pattern-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform line geometry with specified function and apply pattern to transformed geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "transform": { "css": "line-pattern-transform", "type": "functions", "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform line pattern instance with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "line-pattern-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true }, "alignment": { "css": "line-pattern-alignment", "type": [ "global", "local" ], "expression": true, "default-value": "global", "doc": "Specify whether to align pattern fills to the feature's geometry (local) or to the map (global).", "default-meaning":"Patterns will be aligned to the map when being repeated. This is ideal for seamless patterns in tiled rendering." }, "stroke-width": { "css": "line-pattern-width", "default-value": 1.0, "type": "float", "expression": true, "doc": "The width of a line in pixels. Used for rendering line pattern of type `repeat`.", "default-meaning": "The line will be rendered 1 pixel wide." }, "stroke-linecap": { "css": "line-pattern-cap", "default-value": "butt", "type": [ "butt", "round", "square" ], "expression": true, "doc": "The display of line endings. Used for rendering line pattern of type `repeat`.", "default-meaning": "The line endings will be rendered using a butt look." }, "stroke-linejoin": { "css": "line-pattern-join", "default-value": "miter", "type": [ "miter", "miter-revert", "round", "bevel" ], "expression": true, "doc": "The behavior of lines when joining. Used for rendering line pattern of type `repeat`.", "default-meaning": "The line joins will be rendered using a miter look." }, "stroke-miterlimit": { "css": "line-pattern-miterlimit", "type": "float", "expression": true, "doc": "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. Used for rendering line pattern of type `repeat`.", "default-value": 4.0, "default-meaning": "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 )'." }, "stroke-dasharray": { "css": "line-pattern-dasharray", "type": "numbers", "expression": true, "doc": "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. Used for rendering line pattern of type `repeat`.", "default-value": "none", "default-meaning": "The line will be drawn without dashes." } }, "polygon-pattern": { "default": { "css": "polygon-pattern", "type": [ "none" ], "doc": "Allows omitting a polygon pattern symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "polygon-pattern-file", "type": "uri", "expression":true, "default-value": "none", "required": true, "doc": "Image to use as a repeated pattern fill within a polygon. Accepted formats: svg, jpg, png, tiff, and webp.", "default-meaning": "" }, "alignment": { "css": "polygon-pattern-alignment", "type": [ "global", "local" ], "expression":true, "default-value": "global", "doc": "Specify whether to align pattern fills to the layer's geometry (local) or to the map (global).", "default-meaning":"Patterns will be aligned to the map (or tile boundaries) when being repeated across polygons. This is ideal for seamless patterns in tiled rendering." }, "gamma": { "css": "polygon-pattern-gamma", "type": "float", "expression":true, "default-value": 1.0, "default-meaning": "Fully antialiased.", "range": "0-1", "doc": "Level of antialiasing of polygon pattern edges." }, "opacity": { "css": "polygon-pattern-opacity", "type": "float", "expression":true, "doc": "Apply an opacity level to the image used for the pattern.", "default-value": 1.0, "default-meaning": "The image is rendered without modifications." }, "clip": { "css": "polygon-pattern-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "polygon-pattern-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "geometries are simplified by the given tolerance." }, "simplify-algorithm": { "css": "polygon-pattern-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "geometries are simplified by the given algorithm." }, "smooth": { "css": "polygon-pattern-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "polygon-pattern-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform polygon geometry with specified function and apply pattern to transformed geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "transform": { "css": "polygon-pattern-transform", "type": "functions", "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform polygon pattern instance with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "polygon-pattern-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "raster": { "default": { "css": "raster", "type": [ "auto", "none" ], "doc": "Allows omitting a raster symbolizer rule or emitting it with default values.", "status": "unstable" }, "opacity": { "css": "raster-opacity", "default-value": 1.0, "default-meaning": "Color is fully opaque.", "type": "float", "doc": "The opacity of the raster symbolizer on top of other symbolizers." }, "filter-factor": { "css": "raster-filter-factor", "default-value": -1.0, "default-meaning": "Allow the datasource to choose appropriate downscaling.", "type": "float", "doc": "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." }, "scaling": { "css": "raster-scaling", "type": [ "near", "fast", "bilinear", "bicubic", "spline16", "spline36", "hanning", "hamming", "hermite", "kaiser", "quadric", "catrom", "gaussian", "bessel", "mitchell", "sinc", "lanczos", "blackman" ], "default-value": "near", "default-meaning": "Nearest neighboor resampling will be used to scale the image to the target size of the map.", "doc": "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." }, "mesh-size": { "css": "raster-mesh-size", "default-value": 16, "default-meaning": "Reprojection mesh will be 1/16 of the resolution of the source image.", "type": "unsigned", "doc": "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." }, "comp-op": { "css": "raster-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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-mode": { "css": "raster-colorizer-default-mode", "type": [ "discrete", "linear", "exact" ], "doc": "This can be either `discrete`, `linear` or `exact`. If it is not specified then the default is `linear`.", "default-value": "linear", "default-meaning": "A linear interpolation is used to generate colors between the two nearest stops." }, "default-color": { "css": "raster-colorizer-default-color", "type": "color", "doc": "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.", "default-value": "transparent", "default-meaning": "Pixels that are not colored by the colorizer stops will be transparent." }, "epsilon": { "css": "raster-colorizer-epsilon", "type": "float", "doc": "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.", "default-value": "1.1920928955078125e-07", "default-meaning": "Pixels must very closely match the stop filter otherwise they will not be colored." }, "stop": { "css": "raster-colorizer-stops", "type": "tags", "serialization": "tag", "tagname": "tagname", "doc": "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)`.", "default-value": "", "default-meaning": "No colorization will happen without supplying stops." } }, "point": { "default": { "css": "point", "type": [ "auto", "none" ], "doc": "Allows omitting a point symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "point-file", "type": "uri", "expression":true, "required": false, "default-value": "none", "default-meaning": "A 4x4 black square will be rendered.", "doc": "Image file to represent a point. Accepted formats: svg, jpg, png, tiff, and webp." }, "allow-overlap": { "css": "point-allow-overlap", "type": "boolean", "expression":true, "default-value": false, "doc": "Control whether overlapping points are shown or hidden.", "default-meaning": "Do not allow points to overlap with each other - overlapping markers will not be shown." }, "ignore-placement": { "css": "point-ignore-placement", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache.", "doc": "Control whether the placement of the feature will prevent the placement of other features." }, "opacity": { "css": "point-opacity", "type": "float", "expression":true, "default-value": 1.0, "default-meaning": "Fully opaque.", "doc": "A value from 0 to 1 to control the opacity of the point." }, "placement": { "css": "point-placement", "type": [ "centroid", "interior" ], "expression":true, "doc": "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.", "default-meaning": "The centroid of the geometry will be used to place the point.", "default-value": "centroid" }, "transform": { "css": "point-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform point instance with specified function. Ignores map scale factor." }, "comp-op": { "css": "point-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "text": { "default": { "css": "text", "type": [ "none" ], "doc": "Allows omitting a text symbolizer rule.", "status": "unstable" }, "name": { "css": "text-name", "type": "string", "expression":true, "required": true, "default-value": "none", "serialization": "content", "doc": "Value to use for a text label. Data columns are specified using brackets like [column_name].", "default-meaning": "" }, "face-name": { "css": "text-face-name", "type": "string", "expression":false, "validate": "font", "default-value": "none", "doc": "Font name and style to render a label in.", "required": true, "default-meaning": "" }, "size": { "css": "text-size", "type": "float", "expression":true, "default-value": 10.0, "doc": "Text size in pixels.", "default-meaning": "Font size of 10 will be used to render text." }, "text-ratio": { "css": "text-ratio", "doc": "Define the amount of text (of the total) present on successive lines when wrapping occurs.", "default-value": 0, "type": "unsigned", "expression":true, "default-meaning":"TODO." }, "wrap-width": { "css": "text-wrap-width", "doc": "Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap.", "default-value": 0, "type": "unsigned", "expression":true, "default-meaning": "Text will not be wrapped." }, "wrap-before": { "css": "text-wrap-before", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "Wrapped lines will be a bit longer than wrap-width.", "doc": "Wrap text before wrap-width is reached." }, "wrap-character": { "css": "text-wrap-character", "type": "string", "expression":true, "default-value": "\" \"", "default-meaning": "Lines will be wrapped conforming to the (untailored) Unicode Line Break Algorithm provided by ICU BreakIterator.", "doc": "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." }, "repeat-wrap-character": { "css": "text-repeat-wrap-character", "type": "boolean", "expression": true, "default-value": false, "default-meaning": "Character will be removed when used to wrap a line.", "doc": "Keep the character used to wrap a line instead of removing it, and repeat it on the new line.", "status": "unstable" }, "spacing": { "css": "text-spacing", "type": "unsigned", "expression":true, "default-value": 0, "default-meaning": "Only one label per line will attempt to be placed.", "doc": "Distance the renderer should use to try to place repeated text labels on a line." }, "character-spacing": { "css": "text-character-spacing", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "The default character spacing of the font will be used.", "doc": "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." }, "line-spacing": { "css": "text-line-spacing", "default-value": 0, "type": "float", "expression":true, "default-meaning": "The default font spacing will be used.", "doc": "Vertical spacing adjustment between lines in pixels." }, "label-position-tolerance": { "css": "text-label-position-tolerance", "default-value": "text-spacing/2.0", "type": "float", "expression":true, "default-meaning": "If a shield cannot be placed then the renderer will advance by text-spacing/2.0 to try placement again.", "doc": "Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line)." }, "max-char-angle-delta": { "css": "text-max-char-angle-delta", "type": "float", "expression":true, "default-value": 22.5, "default-meaning":"The label will not be placed if a character falls on a line with an angle sharper than 22.5 degrees.", "doc": "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." }, "fill": { "css": "text-fill", "type": "color", "expression":true, "doc": "Specifies the color for the text.", "default-value": "black", "default-meaning": "The text will be rendered black." }, "opacity": { "css": "text-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text.", "default-value": 1.0, "expression":true, "default-meaning": "Fully opaque.", "type": "float" }, "halo-opacity": { "css": "text-halo-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text halo.", "default-value": 1.0, "type": "float", "expression":true, "default-meaning": "Fully opaque." }, "halo-fill": { "css": "text-halo-fill", "type": "color", "expression":true, "default-value": "white", "default-meaning": "The halo will be rendered white.", "doc": "Specifies the color of the halo around the text." }, "halo-radius": { "css": "text-halo-radius", "doc": "Specify the radius of the halo in pixels.", "default-value": 0.0, "type": "float", "expression":true, "default-meaning": "no halo." }, "halo-rasterizer": { "css": "text-halo-rasterizer", "type": [ "full", "fast" ], "expression":true, "default-value": "full", "default-meaning": "The text will be rendered using the highest quality method rather than the fastest.", "doc": "Exposes an alternate text halo rendering method that sacrifices quality for speed." }, "halo-transform": { "css": "text-halo-transform", "type": "functions", "expression":true, "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "", "default-meaning": "No transformation.", "doc": "Transform text halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor." }, "dx": { "css": "text-dx", "type": "float", "expression":true, "doc": "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.", "default-meaning": "Text will not be displaced.", "default-value": 0.0 }, "dy": { "css": "text-dy", "type": "float", "expression":true, "doc": "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.", "default-meaning": "Text will not be displaced.", "default-value": 0.0 }, "vertical-alignment": { "css": "text-vertical-alignment", "type": [ "top", "middle", "bottom", "auto" ], "expression":true, "doc": "Position of label relative to point position.", "default-value": "auto", "default-meaning": "Default affected by value of dy; \"top\" for dy>0, \"bottom\" for dy<0." }, "avoid-edges": { "css": "text-avoid-edges", "doc": "Avoid placing labels that intersect with tile boundaries.", "default-value": false, "type": "boolean", "expression":true, "default-meaning": "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." }, "margin": { "css": "text-margin", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No extra margin will be used to determine if a label collides with any other text, shield, or marker.", "doc": "Minimum distance that a label can be placed from any other text, shield, or marker." }, "repeat-distance": { "css": "text-repeat-distance", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Labels with the same text will be rendered without restriction.", "doc": "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." }, "minimum-distance": { "css": "text-min-distance", "type": "float", "default-value": 0.0, "expression":true, "default-meaning": "Labels with the same text will be rendered without restriction.", "doc": "Minimum distance to the next label with the same text. Only works for line placement. Deprecated: replaced by `text-repeat-distance` and `text-margin`", "status": "deprecated" }, "minimum-padding": { "css": "text-min-padding", "default-value": 0.0, "type": "float", "expression":true, "doc": "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.", "default-meaning": "No margin will be used to detect if a text label is nearby a tile boundary." }, "minimum-path-length": { "css": "text-min-path-length", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "place labels on all geometries no matter how small they are.", "doc": "Place labels only on polygons and lines with a bounding width longer than this value (in pixels)." }, "allow-overlap": { "css": "text-allow-overlap", "type": "boolean", "expression":true, "default-value": false, "doc": "Control whether overlapping text is shown or hidden.", "default-meaning": "Do not allow text to overlap with other text - overlapping markers will not be shown." }, "orientation": { "css": "text-orientation", "type": "float", "expression":true, "default-value": 0.0, "doc": "Rotate the text. (only works with text-placement:point).", "default-meaning": "Text is not rotated and is displayed upright." }, "rotate-displacement": { "css": "text-rotate-displacement", "type": "boolean", "doc": "Rotates the displacement around the placement origin by the angle given by \"orientation\".", "default-value": false, "default-meaning": "Label center is used for rotation." }, "upright": { "css": "text-upright", "default-value": "auto", "type": [ "auto", "auto-down", "left", "right", "left-only", "right-only" ], "expression":true, "default-meaning": "Text will be positioned upright automatically.", "doc": "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." }, "placement": { "css": "text-placement", "default-value": "point", "type": [ "point", "line", "vertex", "interior", "grid", "alternating-grid" ], "expression":true, "default-meaning": "One shield will be placed per geometry.", "doc": "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." }, "placement-type": { "css": "text-placement-type", "doc": "Re-position and/or re-size text to avoid overlaps. \"simple\" for basic algorithm (using text-placements string,) \"dummy\" to turn this feature off.", "type": [ "dummy", "simple", "list" ], "expression":true, "default-meaning": "Alternative placements will not be enabled.", "default-value": "dummy" }, "placements": { "css": "text-placements", "type": "string", "default-meaning": "No alternative placements will be used.", "default-value": "", "expression":true, "doc": "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": { "css": "text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize", "reverse" ], "expression":true, "doc": "Transform the case of the characters.", "default-meaning": "Transform text instance with specified function. Ignores map scale factor.", "default-value": "none" }, "horizontal-alignment": { "css": "text-horizontal-alignment", "type": [ "left", "middle", "right", "auto", "adjust" ], "expression":true, "doc": "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`.", "default-value": "auto", "default-meaning":"TODO." }, "justify-alignment": { "css": "text-align", "type": [ "left", "right", "center", "auto" ], "expression":true, "doc": "Define how text is justified.", "default-value": "auto", "default-meaning": "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." }, "clip": { "css": "text-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "text-simplify", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "Simplify the geometries used for text placement by the given tolerance." }, "simplify-algorithm": { "css": "text-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression": true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "Simplify the geometries used for text placement by the given algorithm." }, "smooth": { "css": "text-smooth", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "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." }, "comp-op": { "css": "text-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true }, "halo-comp-op": { "css": "text-halo-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ], "expression":true }, "font-feature-settings": { "css": "text-font-feature-settings", "type": "string", "default-value": "", "default-meaning": "Default set of typographic features recommended by OpenType specification. Ligatures are turned off by default when `character-spacing` is greater than zero.", "doc": "Comma separated list of OpenType typographic features. The syntax and semantics conforms to `font-feature-settings` from W3C CSS." }, "largest-bbox-only": { "css": "text-largest-bbox-only", "type": "boolean", "expression": true, "default-value": true, "default-meaning": "For multipolygons only polygon with largest bbox area is labeled (does not apply to other geometries).", "doc": "Controls default labeling behavior on multipolygons. The default is true and means that only the polygon with largest bbox is labeled.", "status": "experimental" }, "grid-cell-width": { "css": "text-grid-cell-width", "type": "float", "expression": true, "default-value": 0, "default-meaning": "No placement will be done.", "doc": "Controls horizontal spacing between placements of placement type `grid` or `alternating-grid`." }, "grid-cell-height": { "css": "text-grid-cell-height", "type": "float", "expression": true, "default-value": 0, "default-meaning": "No placement will be done.", "doc": "Controls vertical spacing between placements of placement type `grid` or `alternating-grid`." }, "offset": { "css": "text-offset", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "Will not be offset.", "doc": "In case of `line` placement, offsets a text position a number of pixels parallel to its actual path. In case of `grid` placement, reduces or expands the polygon area. Positive values move the line left or expand the polygon, negative values move it right or shrink the polygon (relative to the directionality of the line or polygon winding).", "status": "unstable" } }, "building": { "default": { "css": "building", "type": [ "auto", "none" ], "doc": "Allows omitting a building symbolizer rule or emitting it with default values.", "status": "unstable" }, "fill": { "css": "building-fill", "expression":true, "type":"color", "default-value": "The color gray will be used for fill.", "default-meaning": "Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).", "doc": "The color of the buildings fill. Note: 0.8 will be used to multiply each color component to auto-generate a darkened wall color." }, "fill-opacity": { "css": "building-fill-opacity", "type": "float", "expression":true, "doc": "The opacity of the building as a whole, including all walls.", "default-value": 1.0, "default-meaning": "Color is fully opaque." }, "height": { "css": "building-height", "doc": "The height of the building in pixels.", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Buildings will not have a visual height and will instead look like flat polygons." } }, "debug": { "mode": { "css": "debug-mode", "type": [ "collision", "vertex" ], "default-value": "collision", "doc": "The mode for debug rendering.", "expression":true, "default-meaning": "The otherwise invisible collision boxes will be rendered as squares on the map." } }, "dot": { "default": { "css": "dot", "type": [ "auto", "none" ], "doc": "Allows omitting a dot symbolizer rule or emitting it with default values.", "status": "unstable" }, "fill": { "css": "dot-fill", "default-value": "gray", "doc": "The color of the area of the dot.", "type": "color", "expression":true, "default-meaning": "The dot fill color is gray." }, "opacity": { "css": "dot-opacity", "doc": "The overall opacity of the dot.", "default-value": 1.0, "default-meaning": "The opacity of the dot.", "type": "float", "expression":true }, "width": { "css": "dot-width", "default-value": 1.0, "doc": "The width of the dot in pixels.", "type": "float", "expression":true, "default-meaning": "The marker width is 1 pixel." }, "height": { "css": "dot-height", "default-value": 1.0, "doc": "The height of the dot in pixels.", "type": "float", "expression":true, "default-meaning": "The marker height is 1 pixels." }, "comp-op": { "css": "dot-comp-op", "default-value": "src-over", "default-meaning": "Add the current layer on top of other layers.", "doc": "Composite operation. This defines how this layer should behave relative to layers atop or below it.", "type": [ "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" ] } } }, "colors": { "aliceblue": [240, 248, 255], "antiquewhite": [250, 235, 215], "aqua": [0, 255, 255], "aquamarine": [127, 255, 212], "azure": [240, 255, 255], "beige": [245, 245, 220], "bisque": [255, 228, 196], "black": [0, 0, 0], "blanchedalmond": [255,235,205], "blue": [0, 0, 255], "blueviolet": [138, 43, 226], "brown": [165, 42, 42], "burlywood": [222, 184, 135], "cadetblue": [95, 158, 160], "chartreuse": [127, 255, 0], "chocolate": [210, 105, 30], "coral": [255, 127, 80], "cornflowerblue": [100, 149, 237], "cornsilk": [255, 248, 220], "crimson": [220, 20, 60], "cyan": [0, 255, 255], "darkblue": [0, 0, 139], "darkcyan": [0, 139, 139], "darkgoldenrod": [184, 134, 11], "darkgray": [169, 169, 169], "darkgreen": [0, 100, 0], "darkgrey": [169, 169, 169], "darkkhaki": [189, 183, 107], "darkmagenta": [139, 0, 139], "darkolivegreen": [85, 107, 47], "darkorange": [255, 140, 0], "darkorchid": [153, 50, 204], "darkred": [139, 0, 0], "darksalmon": [233, 150, 122], "darkseagreen": [143, 188, 143], "darkslateblue": [72, 61, 139], "darkslategrey": [47, 79, 79], "darkturquoise": [0, 206, 209], "darkviolet": [148, 0, 211], "deeppink": [255, 20, 147], "deepskyblue": [0, 191, 255], "dimgray": [105, 105, 105], "dimgrey": [105, 105, 105], "dodgerblue": [30, 144, 255], "firebrick": [178, 34, 34], "floralwhite": [255, 250, 240], "forestgreen": [34, 139, 34], "fuchsia": [255, 0, 255], "gainsboro": [220, 220, 220], "ghostwhite": [248, 248, 255], "gold": [255, 215, 0], "goldenrod": [218, 165, 32], "gray": [128, 128, 128], "grey": [128, 128, 128], "green": [0, 128, 0], "greenyellow": [173, 255, 47], "honeydew": [240, 255, 240], "hotpink": [255, 105, 180], "indianred": [205, 92, 92], "indigo": [75, 0, 130], "ivory": [255, 255, 240], "khaki": [240, 230, 140], "lavender": [230, 230, 250], "lavenderblush": [255, 240, 245], "lawngreen": [124, 252, 0], "lemonchiffon": [255, 250, 205], "lightblue": [173, 216, 230], "lightcoral": [240, 128, 128], "lightcyan": [224, 255, 255], "lightgoldenrodyellow": [250, 250, 210], "lightgray": [211, 211, 211], "lightgreen": [144, 238, 144], "lightgrey": [211, 211, 211], "lightpink": [255, 182, 193], "lightsalmon": [255, 160, 122], "lightseagreen": [32, 178, 170], "lightskyblue": [135, 206, 250], "lightslategray": [119, 136, 153], "lightslategrey": [119, 136, 153], "lightsteelblue": [176, 196, 222], "lightyellow": [255, 255, 224], "lime": [0, 255, 0], "limegreen": [50, 205, 50], "linen": [250, 240, 230], "magenta": [255, 0, 255], "maroon": [128, 0, 0], "mediumaquamarine": [102, 205, 170], "mediumblue": [0, 0, 205], "mediumorchid": [186, 85, 211], "mediumpurple": [147, 112, 219], "mediumseagreen": [60, 179, 113], "mediumslateblue": [123, 104, 238], "mediumspringgreen": [0, 250, 154], "mediumturquoise": [72, 209, 204], "mediumvioletred": [199, 21, 133], "midnightblue": [25, 25, 112], "mintcream": [245, 255, 250], "mistyrose": [255, 228, 225], "moccasin": [255, 228, 181], "navajowhite": [255, 222, 173], "navy": [0, 0, 128], "oldlace": [253, 245, 230], "olive": [128, 128, 0], "olivedrab": [107, 142, 35], "orange": [255, 165, 0], "orangered": [255, 69, 0], "orchid": [218, 112, 214], "palegoldenrod": [238, 232, 170], "palegreen": [152, 251, 152], "paleturquoise": [175, 238, 238], "palevioletred": [219, 112, 147], "papayawhip": [255, 239, 213], "peachpuff": [255, 218, 185], "peru": [205, 133, 63], "pink": [255, 192, 203], "plum": [221, 160, 221], "powderblue": [176, 224, 230], "purple": [128, 0, 128], "red": [255, 0, 0], "rosybrown": [188, 143, 143], "royalblue": [65, 105, 225], "saddlebrown": [139, 69, 19], "salmon": [250, 128, 114], "sandybrown": [244, 164, 96], "seagreen": [46, 139, 87], "seashell": [255, 245, 238], "sienna": [160, 82, 45], "silver": [192, 192, 192], "skyblue": [135, 206, 235], "slateblue": [106, 90, 205], "slategray": [112, 128, 144], "slategrey": [112, 128, 144], "snow": [255, 250, 250], "springgreen": [0, 255, 127], "steelblue": [70, 130, 180], "tan": [210, 180, 140], "teal": [0, 128, 128], "thistle": [216, 191, 216], "tomato": [255, 99, 71], "turquoise": [64, 224, 208], "violet": [238, 130, 238], "wheat": [245, 222, 179], "white": [255, 255, 255], "whitesmoke": [245, 245, 245], "yellow": [255, 255, 0], "yellowgreen": [154, 205, 50], "transparent": [0, 0, 0, 0] }, "filter": { "value": [ "true", "false", "null", "point", "linestring", "polygon", "collection" ] } } mapnik-reference-8.10.0/3.0.3/000077500000000000000000000000001342311331100154445ustar00rootroot00000000000000mapnik-reference-8.10.0/3.0.3/datasources.json000066400000000000000000000536571342311331100206740ustar00rootroot00000000000000{ "datasources": { "csv": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "strict": { "type": "boolean", "doc": "Control if the datasource should throw on invalid rows", "default-value": false, "default-meaning": "Unless this option is set to true the datasource will skip invalid rows and attempt to parse as much data as possible" }, "escape": { "type": "string", "doc": "The escape character to use for parsing data", "default-value": "A single backslash (aka. reverse solidus): \\", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "quote": { "type": "string", "doc": "The quote character to use for parsing data", "default-value": "A quotation mark (aka. double quote): \"", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "separator": { "type": "string", "doc": "The separator character to use for parsing data", "default-value": "Basic autodetection is used to determine the best default value if the user does not manually supply a separator.", "default-meaning": "A comma will be used unless more tabs (\t), pipes (|), or semicolons (;) are detected than commas in the header row (in that order of preference)" }, "headers": { "type": "string", "doc": "A comma separated list of header names that can be set to add headers to data that lacks them", "default-value": "", "default-meaning": "Headers will be parsed from the first line of the data unless this option is set" }, "filesize_max": { "type": "float", "doc": "The maximum filesize in MB that will be accepted", "default-value": 20, "default-meaning": "A file that is larger that 20 MB will not be accepted and an error will be throw unless the user manually passes this option with a larger value (useful only in cases where your machine has a lot of memory)" } }, "gdal": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "band": { "type": "unsigned", "doc": "A particular raster band to work with.", "default-value": 0, "default-meaning": "No particular raster band set, working with all bands.", "required": false }, "nodata": { "type": "float", "doc": "Overrides nodata value from the raster.", "default-value": 0, "default-meaning": "Nodata value from the raster is used.", "required": false }, "nodata_tolerance": { "type": "float", "doc": "Make pixels in this tolerance around nodata value transparent.", "default-value": 1e-12, "default-meaning": "The tolerance is effectively zero.", "required": false }, "shared": { "type": "boolean", "doc": "Allows to share the GDAL dataset handle with other GDAL datasources with the same file path.", "default-value": false, "default-meaning": "The datasource will use unique dataset instance.", "required": false } }, "geojson": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "inline": { "type": "string", "doc": "Raw tabular data to be read instead of reading data from a file", "default-value": "", "default-meaning": "Unless this option is provided data will be read from the `file` option" } }, "occi": { "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "ogr": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "osm": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "postgis": { "table": { "type": "string", "doc": "The table or query used", "default-value": "", "default-meaning": "", "required": true }, "key_field": { "type": "boolean", "doc": "User provided field name to interpret as the primary key of the table. If provided then the values from this field (which must be an integer) will be used as the feature id of the returned data", "default-value": "", "default-meaning": "By default no primary key is required and in this case the feature id for returned features will be auto-generated by Mapnik and is not certain to be globally unique.", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "dbname": { "type": "string", "doc": "Database name", "default-value": "username", "default-meaning": "Will default to a database named after the user (as per libpq defaults)", "required": false }, "host": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "password": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "port": { "type": "unsigned", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "user": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "connect_timeout": { "type": "unsigned", "doc": "", "default-value": 4, "default-meaning": "", "required": false }, "schema": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "extent": { "type": "string", "doc": "A comma or space delimited bounding box in the format of minx,miny,maxx,maxy that, if provided, will be used to report the extent of the datasource. The primary reason the option exists is for performance: providing this option at datasource creation saves the time otherwise needed to scan the data for the actual extent, which for large datasets can be very significant. The datasource extent, whether manually provided or automatically calculated is used during rendering to decide if the datasource should be queried for features or not (skipped for best performance). If the extent intersects with the map rendering extent then the datasource will be queried and the query extent will be clipped to the reported datasource extent. So, this means that this option can also be used to restrict which features are available for a given datasource", "default-value": "", "default-meaning": "The datasource extent will be determined at runtime by querying the data, which may be slow, although the extent only needs to be determined once per datasource initialized and it will be cached for further rendering", "recommended": true }, "estimate_extent": { "type": "boolean", "doc": "If an `extent` string is not provided then Mapnik dynamically queries the table to determine the extent. If this option is true then the faster but less accurate PostGIS `ST_EstimatedExtent` function is used instead of `ST_Extent`.", "default-value": false, "default-meaning": "", "required": false }, "geometry_table": { "type": "string", "doc": "Specifies geometry table to use to look up metadata", "default-value": "", "default-meaning": "Automatically parsed from 'table' value", "required": false }, "geometry_field": { "type": "string", "doc": "Specifies geometry field to use", "default-value": "", "default-meaning": "First entry in geometry_columns", "required": false }, "cursor_size": { "type": "unsigned", "doc": "Integer size of binary cursor to use", "default-value": 0, "default-meaning": "No binary cursor is used", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "srid": { "type": "unsigned", "doc": "SRID to use", "default-value": 0, "default-meaning": "Auto-detected from geometry_field", "required": false }, "initial_size": { "type": "unsigned", "doc": "Integer size of connection pool", "default-value": 1, "default-meaning": "", "required": false }, "max_size": { "type": "unsigned", "doc": "Integer max of connection pool", "default-value": 10, "default-meaning": "", "required": false }, "simplify_geometries": { "type": "boolean", "doc": "Simplify geometries with ST_Simplify", "default-value": false, "default-meaning": "Don't simplify geometries", "required": false }, "autodetect_key_field": { "type": "boolean", "doc": "Attempt to autodetect a primary key field", "default-value": false, "default-meaning": "Don't autodetect a primary key field", "required": false }, "persist_connection": { "type": "boolean", "doc": "Keep connection open", "default-value": true, "default-meaning": "Connections, successfully created, will be kept open until Mapnik shuts down", "required": false }, "extent_from_subquery": { "type": "boolean", "doc": "Direct Mapnik to query Postgis for the extent of the raw 'table' value", "default-value": false, "default-meaning": "Uses 'geometry_table' instead of querying", "required": false } }, "python": { "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "raster": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false } }, "rasterlite": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false } }, "shape": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "sqlite": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "table": { "type": "string", "doc": "The table or query used", "default-value": "", "default-meaning": "", "required": true }, "key_field": { "type": "boolean", "doc": "User provided field name to interpret as the primary key of the table. If provided then the values from this field (which must be an integer) will be used as the feature id of the returned data", "default-value": "", "default-meaning": "By default no primary key is required and in this case the feature id for returned features will be auto-generated by Mapnik and is not certain to be globally unique.", "required": false } }, "topojson": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "inline": { "type": "string", "doc": "Raw tabular data to be read instead of reading data from a file", "default-value": "", "default-meaning": "Unless this option is provided data will be read from the `file` option" } } } }mapnik-reference-8.10.0/3.0.3/datasources.template.json000066400000000000000000000347071342311331100225010ustar00rootroot00000000000000{ "types": { "type": { "type": "string", "doc": "The type of the option", "values": ["string","float","boolean","unsigned"], "required": true }, "doc": { "type": "string", "doc": "The basic description of the option and the expected behavior if you provide it", "required": true }, "default-value": { "type": "string", "doc": "Either an empty string if there is no default value, a description of the default value, or the default value itself (if appropriate)", "required": true }, "default-meaning": { "type": "string", "doc": "A detailed description of what the behavior will be if the default value is left unchanged", "required": true }, "required": { "type": "boolean", "doc": "A boolean value to signify if the option is required. Can be left out and if not present it will be assumed that the option is not required", "required": false }, "recommended": { "type": "boolean", "doc": "A boolean value to signify if the option is recommended, even if it is not required. This is meant to indicate to users that better behavior or performance will be gained if they manually provide the option and that they should seek to understand why it exists (and also why/how it needs to be manually provided)", "required": false } }, "variables": { "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "extent" : { "type": "string", "doc": "A comma or space delimited bounding box in the format of minx,miny,maxx,maxy that, if provided, will be used to report the extent of the datasource. The primary reason the option exists is for performance: providing this option at datasource creation saves the time otherwise needed to scan the data for the actual extent, which for large datasets can be very significant. The datasource extent, whether manually provided or automatically calculated is used during rendering to decide if the datasource should be queried for features or not (skipped for best performance). If the extent intersects with the map rendering extent then the datasource will be queried and the query extent will be clipped to the reported datasource extent. So, this means that this option can also be used to restrict which features are available for a given datasource", "default-value": "", "default-meaning": "The datasource extent will be determined at runtime by querying the data, which may be slow, although the extent only needs to be determined once per datasource initialized and it will be cached for further rendering", "recommended": true }, "table" : { "type": "string", "doc": "The table or query used", "default-value": "", "default-meaning": "", "required": true }, "key_field": { "type": "boolean", "doc": "User provided field name to interpret as the primary key of the table. If provided then the values from this field (which must be an integer) will be used as the feature id of the returned data", "default-value": "", "default-meaning": "By default no primary key is required and in this case the feature id for returned features will be auto-generated by Mapnik and is not certain to be globally unique.", "required": false }, "inline": { "type": "string", "doc": "Raw tabular data to be read instead of reading data from a file", "default-value": "", "default-meaning": "Unless this option is provided data will be read from the `file` option" } }, "datasources": { "csv": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "row_limit":"<@(row_limit)", "strict": { "type": "boolean", "doc": "Control if the datasource should throw on invalid rows", "default-value": false, "default-meaning": "Unless this option is set to true the datasource will skip invalid rows and attempt to parse as much data as possible" }, "escape": { "type": "string", "doc": "The escape character to use for parsing data", "default-value": "A single backslash (aka. reverse solidus): \\", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "quote": { "type": "string", "doc": "The quote character to use for parsing data", "default-value": "A quotation mark (aka. double quote): \"", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "separator": { "type": "string", "doc": "The separator character to use for parsing data", "default-value": "Basic autodetection is used to determine the best default value if the user does not manually supply a separator.", "default-meaning": "A comma will be used unless more tabs (\t), pipes (|), or semicolons (;) are detected than commas in the header row (in that order of preference)" }, "headers": { "type": "string", "doc": "A comma separated list of header names that can be set to add headers to data that lacks them", "default-value": "", "default-meaning": "Headers will be parsed from the first line of the data unless this option is set" }, "filesize_max": { "type": "float", "doc": "The maximum filesize in MB that will be accepted", "default-value": 20.0, "default-meaning": "A file that is larger that 20 MB will not be accepted and an error will be throw unless the user manually passes this option with a larger value (useful only in cases where your machine has a lot of memory)" } }, "gdal": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "band": { "type": "unsigned", "doc": "A particular raster band to work with.", "default-value": 0, "default-meaning": "No particular raster band set, working with all bands.", "required": false }, "nodata": { "type": "float", "doc": "Overrides nodata value from the raster.", "default-value": 0, "default-meaning": "Nodata value from the raster is used.", "required": false }, "nodata_tolerance": { "type": "float", "doc": "Make pixels in this tolerance around nodata value transparent.", "default-value": 1e-12, "default-meaning": "The tolerance is effectively zero.", "required": false }, "shared": { "type": "boolean", "doc": "Allows to share the GDAL dataset handle with other GDAL datasources with the same file path.", "default-value": false, "default-meaning": "The datasource will use unique dataset instance.", "required": false } }, "geojson": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "inline":"<@(inline)" }, "occi": { "encoding":"<@(encoding)" }, "ogr": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)" }, "osm": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)" }, "postgis": { "table": "<@(table)", "key_field": "<@(key_field)", "encoding":"<@(encoding)", "dbname": { "type": "string", "doc": "Database name", "default-value": "username", "default-meaning": "Will default to a database named after the user (as per libpq defaults)", "required": false }, "host": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "password": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "port": { "type": "unsigned", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "user": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "connect_timeout": { "type": "unsigned", "doc": "", "default-value": 4, "default-meaning": "", "required": false }, "schema": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "extent": "<@(extent)", "estimate_extent": { "type": "boolean", "doc": "If an `extent` string is not provided then Mapnik dynamically queries the table to determine the extent. If this option is true then the faster but less accurate PostGIS `ST_EstimatedExtent` function is used instead of `ST_Extent`.", "default-value": false, "default-meaning": "", "required": false }, "geometry_table": { "type": "string", "doc": "Specifies geometry table to use to look up metadata", "default-value": "", "default-meaning": "Automatically parsed from 'table' value", "required": false }, "geometry_field": { "type": "string", "doc": "Specifies geometry field to use", "default-value": "", "default-meaning": "First entry in geometry_columns", "required": false }, "cursor_size": { "type": "unsigned", "doc": "Integer size of binary cursor to use", "default-value": 0, "default-meaning": "No binary cursor is used", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "srid": { "type": "unsigned", "doc": "SRID to use", "default-value": 0, "default-meaning": "Auto-detected from geometry_field", "required": false }, "initial_size": { "type": "unsigned", "doc": "Integer size of connection pool", "default-value": 1, "default-meaning": "", "required": false }, "max_size": { "type": "unsigned", "doc": "Integer max of connection pool", "default-value": 10, "default-meaning": "", "required": false }, "simplify_geometries": { "type": "boolean", "doc": "Simplify geometries with ST_Simplify", "default-value": false, "default-meaning": "Don't simplify geometries", "required": false }, "autodetect_key_field": { "type": "boolean", "doc": "Attempt to autodetect a primary key field", "default-value": false, "default-meaning": "Don't autodetect a primary key field", "required": false }, "persist_connection": { "type": "boolean", "doc": "Keep connection open", "default-value": true, "default-meaning": "Connections, successfully created, will be kept open until Mapnik shuts down", "required": false }, "extent_from_subquery": { "type": "boolean", "doc": "Direct Mapnik to query Postgis for the extent of the raw 'table' value", "default-value": false, "default-meaning": "Uses 'geometry_table' instead of querying", "required": false } }, "python": { "encoding":"<@(encoding)" }, "raster": { "file":"<@(file)", "base":"<@(base)" }, "rasterlite": { "file":"<@(file)", "base":"<@(base)" }, "shape": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)" }, "sqlite": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "table": "<@(table)", "key_field": "<@(key_field)" }, "topojson": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "inline":"<@(inline)" } } } mapnik-reference-8.10.0/3.0.3/reference.json000066400000000000000000004006731342311331100203070ustar00rootroot00000000000000{ "version": "3.0.3", "style": { "filter-mode": { "type": [ "all", "first" ], "doc": "Control the processing behavior of Rule filters within a Style. If 'all' is used then all Rules are processed sequentially independent of whether any previous filters matched. If 'first' is used then it means processing ends after the first match (a positive filter evaluation) and no further Rules in the Style are processed ('first' is usually the default for CSS implementations on top of Mapnik to simplify translation from CSS to Mapnik XML).", "default-value": "all", "default-meaning": "All Rules in a Style are processed whether they have filters or not and whether or not the filter conditions evaluate to true." }, "image-filters": { "css": "image-filters", "default-value": "none", "default-meaning": "no filters", "type": "functions", "functions": [ ["agg-stack-blur", 2], ["emboss", 0], ["blur", 0], ["gray", 0], ["sobel", 0], ["edge-detect", 0], ["x-gradient", 0], ["y-gradient", 0], ["invert", 0], ["sharpen", 0], ["color-blind-protanope", 0], ["color-blind-deuteranope", 0], ["color-blind-tritanope", 0], ["colorize-alpha", -1], ["color-to-alpha", 1], ["scale-hsla", 8] ], "doc": "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": { "css":"image-filters-inflate", "default-value": false, "type":"boolean", "default-meaning": "No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary", "doc": "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": { "css": "direct-image-filters", "default-value": "none", "default-meaning": "no filters", "type": "functions", "functions": [ ["agg-stack-blur", 2], ["emboss", 0], ["blur", 0], ["gray", 0], ["sobel", 0], ["edge-detect", 0], ["x-gradient", 0], ["y-gradient", 0], ["invert", 0], ["sharpen", 0], ["color-blind-protanope", 0], ["color-blind-deuteranope", 0], ["color-blind-tritanope", 0], ["colorize-alpha", -1], ["color-to-alpha", 1], ["scale-hsla", 8] ], "doc": "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": { "css": "comp-op", "default-value": "src-over", "default-meaning": "add the current layer on top of other layers", "doc": "Composite operation. This defines how this layer should behave relative to layers atop or below it.", "type": [ "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" ] }, "opacity": { "css": "opacity", "type": "float", "doc": "An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer).", "default-value": 1.0, "default-meaning": "No separate buffer will be used and no alpha will be applied to the style after rendering." } }, "layer" : { "name": { "default-value": "", "type":"string", "required" : true, "default-meaning": "No layer name has been provided", "doc": "The name of a layer. Can be anything you wish and is not strictly validated, but ideally unique in the map." }, "srs": { "default-value": "", "type":"string", "default-meaning": "No srs value is provided and the value will be inherited from the Map's srs", "doc": "The spatial reference system definition for the layer, aka the projection. Can either be a proj4 literal string like '+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs' or, if the proper proj4 epsg/nad/etc identifier files are installed, a string that uses an id like: '+init=epsg:4326'." }, "status": { "default-value": true, "type":"boolean", "default-meaning": "This layer will be marked as active and available for processing", "doc": "A property that can be set to false to disable this layer from being processed." }, "minzoom": { "default-value": 0, "type":"float", "default-meaning": "The layer will be visible at the minimum possible scale", "doc": "The minimum scale denominator that this layer will be visible at. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6. This option has been deprecated in favor of `minimum-scale-denominator`.", "status": "deprecated" }, "maxzoom": { "default-value": "1.79769e+308", "type":"float", "default-meaning": "The layer will be visible at the maximum possible scale", "doc": "The maximum scale denominator that this layer will be visible at. The default is the numeric limit of the C++ double type, which may vary slightly by system, but is likely a massive number like 1.79769e+308 and ensures that this layer will always be visible unless the value is reduced. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6. This option has been deprecated in favor of `maximum-scale-denominator`.", "status": "deprecated" }, "minimum-scale-denominator": { "default-value": 0, "type":"float", "default-meaning": "The layer will be visible at the minimum possible scale denominator", "doc": "The minimum scale denominator that this layer will be visible at. A layer's visibility is determined by whether its status is true and if the Map scale denominator >= `minimum-scale-denominator` - 1e-6 and scale denominator < 'maximum-scale-denominator' + 1e-6." }, "maximum-scale-denominator": { "default-value": "1.79769e+308", "type":"float", "default-meaning": "The layer will be visible at the maximum possible scale denominator", "doc": "The maximum scale denominator that this layer will be visible at. The default is the numeric limit of the C++ double type, which may vary slightly by system, but is likely a massive number like 1.79769e+308 and ensures that this layer will always be visible unless the value is reduced. A layer's visibility is determined by whether its status is true and if the Map scale denominator >= `minimum-scale-denominator` - 1e-6 and scale denominator < `maximum-scale-denominator` + 1e-6." }, "queryable": { "default-value": false, "type":"boolean", "default-meaning": "The layer will not be available for the direct querying of data values", "doc": "This property was added for GetFeatureInfo/WMS compatibility and is rarely used. It is off by default meaning that in a WMS context the layer will not be able to be queried unless the property is explicitly set to true." }, "clear-label-cache": { "default-value": false, "type":"boolean", "default-meaning": "The renderer's collision detector cache (used for avoiding duplicate labels and overlapping markers) will not be cleared immediately before processing this layer", "doc": "This property, by default off, can be enabled to allow a user to clear the collision detector cache before a given layer is processed. This may be desirable to ensure that a given layers data shows up on the map even if it normally would not because of collisions with previously rendered labels or markers." }, "group-by": { "default-value": "", "type":"string", "default-meaning": "No special layer grouping will be used during rendering", "doc": "https://github.com/mapnik/mapnik/wiki/Grouped-rendering" }, "buffer-size": { "default-value": 0, "type":"float", "default-meaning": "No custom buffer will be used for the layer and rather the Map buffer-size will be used", "doc": "Extra tolerance around the Layer extent (in pixels) used when querying the layer data during rendering. If set this will override the Map buffer-size." }, "maximum-extent": { "default-value": "none", "type":"bbox", "default-meaning": "No clipping extent will be used", "doc": "An extent to be used to limit the bounds used to query this specific layer data during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Layer." }, "cache-features": { "type":"boolean", "default-value": "off", "default-meaning": "Features are not cached between rendering multiple styles. The datasource is queried for each style.", "doc": "Setting this to `on` triggers Mapnik to attempt to cache features in memory for rendering when (and only when) a layer has multiple styles attached to it." } }, "symbolizers" : { "map": { "background-color": { "css": "background-color", "default-value": "none", "default-meaning": "Will be rendered transparent.", "type": "color", "doc": "Map Background color." }, "background-image": { "css": "background-image", "type": "uri", "default-value": "", "default-meaning": "No background image will be used.", "doc": "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": { "css": "background-image-comp-op", "doc": "Set the compositing operation used to blend the image into the background.", "default-value": "src-over", "default-meaning": "The background-image will be blended with the background normally (placed on top of any existing background-color).", "type": [ "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" ] }, "background-image-opacity": { "css": "background-image-opacity", "type": "float", "doc": "Set the opacity of the image.", "default-value": 1.0, "default-meaning": "The image opacity will not be changed when applied to the map background." }, "srs": { "css": "srs", "type": "string", "default-value": "+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs", "default-meaning": "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.", "doc": "Map spatial reference (proj4 string)." }, "buffer-size": { "css": "buffer-size", "default-value": 0, "type":"float", "default-meaning": "No buffer will be used.", "doc": "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": { "css": "maximum-extent", "default-value": "-20037508.34,-20037508.34,20037508.34,20037508.34", "type":"string", "default-meaning": "All data will be clipped to global mercator extent (default is applied in Carto.js).", "doc": "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": { "css": "base", "default-value": "", "default-meaning": "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.", "type": "string", "doc": "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." }, "paths-from-xml": { "css": "", "default-value": true, "default-meaning": "Paths read from XML will be interpreted from the location of the XML.", "type": "boolean", "doc": "Value to control whether paths in the XML will be interpreted from the location of the XML or from the working directory of the program that calls load_map()." }, "minimum-version": { "css": "", "default-value": "none", "default-meaning": "Mapnik version will not be detected and no error will be thrown about compatibility.", "type": "string", "doc": "The minumum Mapnik version (e.g. 0.7.2) needed to use certain functionality in the stylesheet." }, "font-directory": { "css": "font-directory", "type": "uri", "default-value": "none", "default-meaning": "No map-specific fonts will be registered.", "doc": "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": { "default": { "css": "polygon", "type": [ "auto", "none" ], "doc": "Allows omitting a polygon symbolizer rule or emitting it with default values.", "status": "unstable" }, "fill": { "css": "polygon-fill", "type": "color", "expression":true, "default-value": "The color gray will be used for fill.", "default-meaning": "Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).", "doc": "Fill color to assign to a polygon." }, "fill-opacity": { "css": "polygon-opacity", "type": "float", "expression":true, "doc": "The opacity of the polygon.", "default-value": 1.0, "default-meaning": "Color is fully opaque." }, "gamma": { "css": "polygon-gamma", "type": "float", "expression":true, "default-value": 1.0, "default-meaning": "Fully antialiased.", "range": "0-1", "doc": "Level of antialiasing of polygon edges." }, "gamma-method": { "css": "polygon-gamma-method", "type": [ "power", "linear", "none", "threshold", "multiply" ], "expression":true, "default-value": "power", "default-meaning": "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.", "doc": "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." }, "clip": { "css": "polygon-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "polygon-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "Simplify geometries by the given tolerance." }, "simplify-algorithm": { "css": "polygon-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "Simplify geometries by the given algorithm." }, "smooth": { "css": "polygon-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "polygon-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform polygon geometry with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "polygon-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "line": { "default": { "css": "line", "type": [ "auto", "none" ], "doc": "Allows omitting a line symbolizer rule or emitting it with default values.", "status": "unstable" }, "stroke": { "css": "line-color", "default-value": "black", "type": "color", "expression":true, "default-meaning": "black and fully opaque (alpha = 1), same as rgb(0,0,0) or rgba(0,0,0,1).", "doc": "The color of a drawn line." }, "stroke-width": { "css": "line-width", "default-value": 1.0, "type": "float", "expression":true, "doc": "The width of a line in pixels.", "default-meaning": "The line will be rendered 1 pixel wide." }, "stroke-opacity": { "css": "line-opacity", "default-value": 1.0, "type": "float", "expression":true, "default-meaning": "Color is fully opaque.", "doc": "The opacity of a line." }, "stroke-linejoin": { "css": "line-join", "default-value": "miter", "type": [ "miter", "miter-revert", "round", "bevel" ], "expression":true, "doc": "The behavior of lines when joining.", "default-meaning": "The line joins will be rendered using a miter look." }, "stroke-linecap": { "css": "line-cap", "default-value": "butt", "type": [ "butt", "round", "square" ], "expression":true, "doc": "The display of line endings.", "default-meaning": "The line endings will be rendered using a butt look." }, "stroke-gamma": { "css": "line-gamma", "type": "float", "expression":true, "default-value": 1.0, "default-meaning": "Fully antialiased.", "range": "0-1", "doc": "Level of antialiasing of stroke line." }, "stroke-gamma-method": { "css": "line-gamma-method", "type": [ "power", "linear", "none", "threshold", "multiply" ], "expression":true, "default-value": "power", "default-meaning": "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.", "doc": "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." }, "stroke-dasharray": { "css": "line-dasharray", "type": "numbers", "expression":true, "doc": "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.", "default-value": "none", "default-meaning": "The line will be drawn without dashes." }, "stroke-dashoffset": { "css": "line-dash-offset", "type": "numbers", "expression":true, "doc": "Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled).", "default-value": "none", "default-meaning": "The line will be drawn without dashes." }, "stroke-miterlimit": { "css": "line-miterlimit", "type": "float", "expression":true, "doc": "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.", "default-value": 4.0, "default-meaning": "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 )'." }, "clip": { "css": "line-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "line-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "Simplify geometries by the given tolerance." }, "simplify-algorithm": { "css": "line-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "Simplify geometries by the given algorithm." }, "smooth": { "css": "line-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "offset": { "css": "line-offset", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Will not be offset.", "doc": "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).", "status": "unstable" }, "rasterizer": { "css": "line-rasterizer", "type": [ "full", "fast" ], "expression":true, "default-value": "full", "doc": "Exposes an alternate AGG rendering method that sacrifices some accuracy for speed.", "default-meaning": "The line will be rendered using the highest quality method rather than the fastest." }, "geometry-transform": { "css": "line-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform line geometry with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "line-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "markers": { "default": { "css": "marker", "type": [ "auto", "none" ], "doc": "Allows omitting a marker symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "marker-file", "doc": "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.", "default-value": "none", "default-meaning": "An ellipse or circle, if width equals height.", "type": "uri", "expression":true }, "opacity": { "css": "marker-opacity", "doc": "The overall opacity of the marker, if set, overrides both the opacity of the fill and the opacity of the stroke.", "default-value": 1.0, "default-meaning": "The stroke-opacity and fill-opacity of the marker.", "type": "float", "expression":true }, "fill-opacity": { "css": "marker-fill-opacity", "doc": "The fill opacity of the marker. This property will also set the `fill-opacity` of elements in an SVG loaded from a file.", "default-value": 1.0, "expression":true, "default-meaning": "Color is fully opaque.", "type": "float" }, "stroke": { "css": "marker-line-color", "doc": "The color of the stroke around the marker. This property will also set the `stroke` of elements in an SVG loaded from a file.", "default-value": "black", "type": "color", "expression":true, "default-meaning": "The marker will be drawn with a black outline." }, "stroke-width": { "css": "marker-line-width", "default-value": 0.5, "doc": "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.", "type": "float", "expression":true, "default-meaning": "The marker will be drawn with an outline of .5 pixels wide." }, "stroke-opacity": { "css": "marker-line-opacity", "default-value": 1.0, "default-meaning": "Color is fully opaque. This property will also set the `stroke-opacity` of elements in an SVG loaded from a file.", "doc": "The opacity of a line.", "type": "float", "expression":true }, "placement": { "css": "marker-placement", "type": [ "point", "line", "interior", "vertex-first", "vertex-last" ], "expression":true, "default-value": "point", "default-meaning": "Place markers at the center point (centroid) of the geometry.", "doc": "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." }, "multi-policy": { "css": "marker-multi-policy", "type": [ "each", "whole", "largest" ], "expression":true, "default-value": "each", "default-meaning": "If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each.", "doc": "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": { "css": "marker-type", "type": [ "arrow", "ellipse" ], "expression":true, "default-value": "ellipse", "default-meaning": "The marker shape is an ellipse.", "doc": "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).", "status": "deprecated" }, "width": { "css": "marker-width", "default-value": 10.0, "doc": "The width of the marker, if using one of the default types.", "type": "float", "expression":true, "default-meaning": "The marker width is 10 pixels." }, "height": { "css": "marker-height", "default-value": 10.0, "doc": "The height of the marker, if using one of the default types.", "type": "float", "expression":true, "default-meaning": "The marker height is 10 pixels." }, "fill": { "css": "marker-fill", "default-value": "blue", "doc": "The color of the area of the marker. This property will also set the `fill` of elements in an SVG loaded from a file.", "type": "color", "expression":true, "default-meaning": "The marker fill color is blue." }, "allow-overlap": { "css": "marker-allow-overlap", "type": "boolean", "expression":true, "default-value": false, "doc": "Control whether overlapping markers are shown or hidden.", "default-meaning": "Do not allow markers to overlap with each other - overlapping markers will not be shown." }, "avoid-edges": { "css": "marker-avoid-edges", "doc": "Avoid placing markers that intersect with tile boundaries.", "type": "boolean", "expression":true, "default-meaning": "Markers will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.", "default-value": false }, "ignore-placement": { "css": "marker-ignore-placement", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache.", "doc": "Value to control whether the placement of the feature will prevent the placement of other features." }, "spacing": { "css": "marker-spacing", "doc": "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.", "default-value": 100.0, "type": "float", "expression":true, "default-meaning": "In the case of marker-placement:line then draw a marker every 100 pixels along a line." }, "max-error": { "css": "marker-max-error", "type": "float", "expression":true, "default-value": 0.2, "default-meaning": "N/A: not intended to be changed.", "doc": "N/A: not intended to be changed." }, "transform": { "css": "marker-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform marker instance with specified function. Ignores map scale factor." }, "clip": { "css": "marker-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "marker-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Geometry will not be simplified.", "doc": "geometries are simplified by the given tolerance." }, "simplify-algorithm": { "css": "marker-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "geometries are simplified by the given algorithm." }, "smooth": { "css": "marker-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "marker-geometry-transform", "type": "functions", "expression":true, "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform marker geometry with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "offset": { "css": "marker-offset", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Will not be offset.", "doc": "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)." }, "comp-op": { "css": "marker-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true }, "direction": { "css": "marker-direction", "default-value": "right", "type": [ "auto", "auto-down", "left", "right", "left-only", "right-only", "up", "down" ], "expression": true, "default-meaning": "Markers are oriented to the right in the line direction.", "doc": "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": { "default": { "css": "shield", "type": [ "none" ], "doc": "Allows omitting a shield symbolizer rule.", "status": "unstable" }, "name": { "css": "shield-name", "type": "string", "expression":true, "serialization": "content", "default-value": "", "default-meaning": "No text label will be rendered with the shield.", "doc": "Value to use for a shield\"s text label. Data columns are specified using brackets like [column_name]." }, "file": { "css": "shield-file", "required": true, "type": "uri", "expression":true, "default-value": "none", "doc": "Image file to render behind the shield text. Accepted formats: svg, jpg, png, tiff, and webp.", "default-meaning": "" }, "face-name": { "css": "shield-face-name", "type": "string", "expression":true, "validate": "font", "doc": "Font name and style to use for the shield text.", "default-value": "none", "required": true, "default-meaning": "" }, "unlock-image": { "css": "shield-unlock-image", "type": "boolean", "expression":true, "doc": "This parameter should be set to true if you are trying to position text beside rather than on top of the shield image.", "default-value": false, "default-meaning": "text alignment relative to the shield image uses the center of the image as the anchor for text positioning." }, "size": { "css": "shield-size", "type": "float", "expression":true, "default-value": 10.0, "doc": "The size of the shield text in pixels.", "default-meaning": "Font size of 10 will be used to render text." }, "fill": { "css": "shield-fill", "type": "color", "expression":true, "default-value": "black", "doc": "The color of the shield text.", "default-meaning": "The shield text will be rendered black." }, "placement": { "css": "shield-placement", "type": [ "point", "line", "vertex", "interior" ], "expression":true, "default-value": "point", "default-meaning": "One shield will be placed per geometry.", "doc": "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." }, "avoid-edges": { "css": "shield-avoid-edges", "doc": "Avoid placing shields that intersect with tile boundaries.", "type": "boolean", "expression":true, "default-meaning": "Shields will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.", "default-value": false }, "allow-overlap": { "css": "shield-allow-overlap", "type": "boolean", "expression":true, "default-value": false, "doc": "Control whether overlapping shields are shown or hidden.", "default-meaning": "Shields will not overlap and any shields that might collide with previously placed shields will not be rendered.", "default-meaning": "Do not allow shields to overlap with other map elements already placed." }, "margin": { "css": "shield-margin", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No extra margin will be used to determine if a shield collides with any other text, shield, or marker.", "doc": "Minimum distance that a shield can be placed from any other text, shield, or marker." }, "repeat-distance": { "css": "shield-repeat-distance", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Shields with the same text will be rendered without restriction.", "doc": "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." }, "minimum-distance": { "css": "shield-min-distance", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Shields with the same text will be rendered without restriction.", "doc": "Minimum distance to any other collision object. Deprecated: replaced by `shield-margin`.", "status": "deprecated" }, "spacing": { "css": "shield-spacing", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Only one shield per line will attempt to be placed.", "doc": "Distance the renderer should use to try to place repeated shields on a line." }, "minimum-padding": { "css": "shield-min-padding", "expression":true, "default-value": 0.0, "doc": "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.", "default-meaning": "No margin will be used to detect if a shield is nearby a tile boundary.", "type": "float" }, "label-position-tolerance": { "css": "shield-label-position-tolerance", "default-value": "shield-spacing/2.0", "type": "float", "expression":true, "default-meaning": "If a shield cannot be placed then the renderer will advance by shield-spacing/2.0 to try placement again.", "doc": "Allows the shield to be displaced from its ideal position by a number of pixels (only works with placement:line)." }, "wrap-width": { "css": "shield-wrap-width", "type": "unsigned", "expression":true, "default-value": 0, "default-meaning": "Text will not be wrapped.", "doc": "Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap." }, "wrap-before": { "css": "shield-wrap-before", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "Wrapped lines will be a bit longer than wrap-width.", "doc": "Wrap text before wrap-width is reached." }, "wrap-character": { "css": "shield-wrap-character", "type": "string", "expression":true, "default-value": "\" \"", "default-meaning": "Lines will be wrapped conforming to the (untailored) Unicode Line Break Algorithm provided by ICU BreakIterator.", "doc": "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." }, "halo-fill": { "css": "shield-halo-fill", "type": "color", "expression":true, "default-value": "white", "doc": "Specifies the color of the halo around the text.", "default-meaning": "The shield halo text will be rendered white." }, "halo-radius": { "css": "shield-halo-radius", "default-value": 0.0, "default-meaning": "no halo.", "doc": "Specify the radius of the halo in pixels.", "type": "float", "expression":true }, "halo-rasterizer": { "css": "shield-halo-rasterizer", "type": [ "full", "fast" ], "expression":true, "default-value": "full", "default-meaning": "The shield will be rendered using the highest quality method rather than the fastest.", "doc": "Exposes an alternate text halo rendering method that sacrifices quality for speed." }, "halo-transform": { "css": "shield-halo-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "", "default-meaning": "No transformation.", "doc": "Transform shield halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor." }, "halo-comp-op": { "css": "shield-halo-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ], "expression":true }, "halo-opacity": { "css": "shield-halo-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text halo.", "default-value": 1.0, "type": "float", "expression":true, "default-meaning": "Fully opaque." }, "character-spacing": { "css": "shield-character-spacing", "type": "unsigned", "expression":true, "default-value": 0, "default-meaning": "The default character spacing of the font will be used.", "doc": "Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement." }, "line-spacing": { "css": "shield-line-spacing", "default-value": 0, "doc": "Vertical spacing between lines of multiline labels (in pixels).", "type": "float", "expression":true, "default-meaning": "The default font spacing will be used." }, "dx": { "css": "shield-text-dx", "type": "float", "expression":true, "doc": "Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right.", "default-meaning": "Text will not be displaced.", "default-value": 0.0 }, "dy": { "css": "shield-text-dy", "type": "float", "expression":true, "doc": "Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down.", "default-meaning": "Text will not be displaced.", "default-value": 0.0 }, "shield-dx": { "css": "shield-dx", "type": "float", "expression":true, "doc": "Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right.", "default-meaning": "Shield will not be displaced.", "default-value": 0.0 }, "shield-dy": { "css": "shield-dy", "type": "float", "expression":true, "doc": "Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down.", "default-meaning": "Shield will not be displaced.", "default-value": 0.0 }, "opacity": { "css": "shield-opacity", "type": "float", "expression":true, "doc": "The opacity of the image used for the shield.", "default-meaning": "Color is fully opaque.", "default-value": 1.0 }, "text-opacity": { "css": "shield-text-opacity", "type": "float", "expression":true, "doc": "The opacity of the text placed on top of the shield.", "default-meaning": "Color is fully opaque.", "default-value": 1.0 }, "horizontal-alignment": { "css": "shield-horizontal-alignment", "type": [ "left", "middle", "right", "auto" ], "expression":true, "doc": "The shield's horizontal alignment from its centerpoint.", "default-meaning": "TODO.", "default-value": "auto" }, "vertical-alignment": { "css": "shield-vertical-alignment", "type": [ "top", "middle", "bottom", "auto" ], "expression":true, "doc": "The shield's vertical alignment from its centerpoint.", "default-meaning": "TODO.", "default-value": "middle" }, "placement-type": { "css": "shield-placement-type", "doc": "Re-position and/or re-size shield to avoid overlaps. \"simple\" for basic algorithm (using shield-placements string,) \"dummy\" to turn this feature off.", "type": [ "dummy", "simple", "list" ], "expression":true, "default-meaning": "Alternative placements will not be enabled.", "default-value": "dummy" }, "placements": { "css": "shield-placements", "type": "string", "expression":true, "default-value": "", "default-meaning": "No alternative placements will be used.", "doc": "If \"placement-type\" is set to \"simple\", use this \"POSITIONS,[SIZES]\" string. An example is `shield-placements: \"E,NE,SE,W,NW,SW\";`." }, "text-transform": { "css": "shield-text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize", "reverse" ], "expression":true, "doc": "Transform the case of the characters.", "default-meaning": "No text transformation will be applied.", "default-value": "none" }, "justify-alignment": { "css": "shield-justify-alignment", "type": [ "left", "center", "right", "auto" ], "expression":true, "doc": "Define how text in a shield's label is justified.", "default-meaning": "TODO.", "default-value": "auto" }, "transform": { "css": "shield-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform shield instance with specified function. Ignores map scale factor." }, "clip": { "css": "shield-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "shield-simplify", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "Simplify the geometries used for shield placement by the given tolerance." }, "simplify-algorithm": { "css": "shield-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression": true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "Simplify the geometries used for shield placement by the given algorithm." }, "smooth": { "css": "shield-smooth", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "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." }, "comp-op": { "css": "shield-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "line-pattern": { "default": { "css": "line-pattern", "type": [ "none" ], "doc": "Allows omitting a line pattern symbolizer rule.", "status": "unstable" }, "file": { "css": "line-pattern-file", "type": "uri", "expression":true, "default-value": "none", "required": true, "doc": "An image file to be repeated and warped along a line. Accepted formats: svg, jpg, png, tiff, and webp.", "default-meaning": "" }, "clip": { "css": "line-pattern-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "opacity": { "css": "line-pattern-opacity", "type": "float", "expression":true, "doc": "Apply an opacity level to the image used for the pattern.", "default-value": 1.0, "default-meaning": "The image is rendered without modifications." }, "simplify": { "css": "line-pattern-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "geometries are simplified by the given tolerance." }, "simplify-algorithm": { "css": "line-pattern-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "geometries are simplified by the given algorithm." }, "smooth": { "css": "line-pattern-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "offset": { "css": "line-pattern-offset", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "The line will not be offset.", "doc": "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)." }, "geometry-transform": { "css": "line-pattern-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform line geometry with specified function and apply pattern to transformed geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "transform": { "css": "line-pattern-transform", "type": "functions", "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform line pattern instance with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "line-pattern-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "polygon-pattern": { "default": { "css": "polygon-pattern", "type": [ "none" ], "doc": "Allows omitting a polygon pattern symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "polygon-pattern-file", "type": "uri", "expression":true, "default-value": "none", "required": true, "doc": "Image to use as a repeated pattern fill within a polygon. Accepted formats: svg, jpg, png, tiff, and webp.", "default-meaning": "" }, "alignment": { "css": "polygon-pattern-alignment", "type": [ "global", "local" ], "expression":true, "default-value": "global", "doc": "Specify whether to align pattern fills to the layer's geometry (local) or to the map (global).", "default-meaning":"Patterns will be aligned to the map (or tile boundaries) when being repeated across polygons. This is ideal for seamless patterns in tiled rendering." }, "gamma": { "css": "polygon-pattern-gamma", "type": "float", "expression":true, "default-value": 1.0, "default-meaning": "Fully antialiased.", "range": "0-1", "doc": "Level of antialiasing of polygon pattern edges." }, "opacity": { "css": "polygon-pattern-opacity", "type": "float", "expression":true, "doc": "Apply an opacity level to the image used for the pattern.", "default-value": 1.0, "default-meaning": "The image is rendered without modifications." }, "clip": { "css": "polygon-pattern-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "polygon-pattern-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "geometries are simplified by the given tolerance." }, "simplify-algorithm": { "css": "polygon-pattern-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "geometries are simplified by the given algorithm." }, "smooth": { "css": "polygon-pattern-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "polygon-pattern-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform polygon geometry with specified function and apply pattern to transformed geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "transform": { "css": "polygon-pattern-transform", "type": "functions", "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform polygon pattern instance with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "polygon-pattern-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "raster": { "default": { "css": "raster", "type": [ "auto", "none" ], "doc": "Allows omitting a raster symbolizer rule or emitting it with default values.", "status": "unstable" }, "opacity": { "css": "raster-opacity", "default-value": 1.0, "default-meaning": "Color is fully opaque.", "type": "float", "doc": "The opacity of the raster symbolizer on top of other symbolizers." }, "filter-factor": { "css": "raster-filter-factor", "default-value": -1.0, "default-meaning": "Allow the datasource to choose appropriate downscaling.", "type": "float", "doc": "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." }, "scaling": { "css": "raster-scaling", "type": [ "near", "fast", "bilinear", "bicubic", "spline16", "spline36", "hanning", "hamming", "hermite", "kaiser", "quadric", "catrom", "gaussian", "bessel", "mitchell", "sinc", "lanczos", "blackman" ], "default-value": "near", "default-meaning": "Nearest neighboor resampling will be used to scale the image to the target size of the map.", "doc": "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." }, "mesh-size": { "css": "raster-mesh-size", "default-value": 16, "default-meaning": "Reprojection mesh will be 1/16 of the resolution of the source image.", "type": "unsigned", "doc": "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." }, "comp-op": { "css": "raster-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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-mode": { "css": "raster-colorizer-default-mode", "type": [ "discrete", "linear", "exact" ], "doc": "This can be either `discrete`, `linear` or `exact`. If it is not specified then the default is `linear`.", "default-value": "linear", "default-meaning": "A linear interpolation is used to generate colors between the two nearest stops." }, "default-color": { "css": "raster-colorizer-default-color", "type": "color", "doc": "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.", "default-value": "transparent", "default-meaning": "Pixels that are not colored by the colorizer stops will be transparent." }, "epsilon": { "css": "raster-colorizer-epsilon", "type": "float", "doc": "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.", "default-value": "1.1920928955078125e-07", "default-meaning": "Pixels must very closely match the stop filter otherwise they will not be colored." }, "stop": { "css": "raster-colorizer-stops", "type": "tags", "serialization": "tag", "tagname": "tagname", "doc": "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)`.", "default-value": "", "default-meaning": "No colorization will happen without supplying stops." } }, "point": { "default": { "css": "point", "type": [ "auto", "none" ], "doc": "Allows omitting a point symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "point-file", "type": "uri", "expression":true, "required": false, "default-value": "none", "default-meaning": "A 4x4 black square will be rendered.", "doc": "Image file to represent a point. Accepted formats: svg, jpg, png, tiff, and webp." }, "allow-overlap": { "css": "point-allow-overlap", "type": "boolean", "expression":true, "default-value": false, "doc": "Control whether overlapping points are shown or hidden.", "default-meaning": "Do not allow points to overlap with each other - overlapping markers will not be shown." }, "ignore-placement": { "css": "point-ignore-placement", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache.", "doc": "Control whether the placement of the feature will prevent the placement of other features." }, "opacity": { "css": "point-opacity", "type": "float", "expression":true, "default-value": 1.0, "default-meaning": "Fully opaque.", "doc": "A value from 0 to 1 to control the opacity of the point." }, "placement": { "css": "point-placement", "type": [ "centroid", "interior" ], "expression":true, "doc": "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.", "default-meaning": "The centroid of the geometry will be used to place the point.", "default-value": "centroid" }, "transform": { "css": "point-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform point instance with specified function. Ignores map scale factor." }, "comp-op": { "css": "point-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "text": { "default": { "css": "text", "type": [ "none" ], "doc": "Allows omitting a text symbolizer rule or emitting it with default values.", "status": "unstable" }, "name": { "css": "text-name", "type": "string", "expression":true, "required": true, "default-value": "none", "serialization": "content", "doc": "Value to use for a text label. Data columns are specified using brackets like [column_name].", "default-meaning": "" }, "face-name": { "css": "text-face-name", "type": "string", "expression":false, "validate": "font", "default-value": "none", "doc": "Font name and style to render a label in.", "required": true, "default-meaning": "" }, "size": { "css": "text-size", "type": "float", "expression":true, "default-value": 10.0, "doc": "Text size in pixels.", "default-meaning": "Font size of 10 will be used to render text." }, "text-ratio": { "css": "text-ratio", "doc": "Define the amount of text (of the total) present on successive lines when wrapping occurs.", "default-value": 0, "type": "unsigned", "expression":true, "default-meaning":"TODO." }, "wrap-width": { "css": "text-wrap-width", "doc": "Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap.", "default-value": 0, "type": "unsigned", "expression":true, "default-meaning": "Text will not be wrapped." }, "wrap-before": { "css": "text-wrap-before", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "Wrapped lines will be a bit longer than wrap-width.", "doc": "Wrap text before wrap-width is reached." }, "wrap-character": { "css": "text-wrap-character", "type": "string", "expression":true, "default-value": "\" \"", "default-meaning": "Lines will be wrapped conforming to the (untailored) Unicode Line Break Algorithm provided by ICU BreakIterator.", "doc": "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." }, "repeat-wrap-character": { "css": "text-repeat-wrap-character", "type": "boolean", "expression": true, "default-value": false, "default-meaning": "Character will be removed when used to wrap a line.", "doc": "Keep the character used to wrap a line instead of removing it, and repeat it on the new line.", "status": "unstable" }, "spacing": { "css": "text-spacing", "type": "unsigned", "expression":true, "default-value": 0, "default-meaning": "Only one label per line will attempt to be placed.", "doc": "Distance the renderer should use to try to place repeated text labels on a line." }, "character-spacing": { "css": "text-character-spacing", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "The default character spacing of the font will be used.", "doc": "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." }, "line-spacing": { "css": "text-line-spacing", "default-value": 0, "type": "float", "expression":true, "default-meaning": "The default font spacing will be used.", "doc": "Vertical spacing adjustment between lines in pixels." }, "label-position-tolerance": { "css": "text-label-position-tolerance", "default-value": "text-spacing/2.0", "type": "float", "expression":true, "default-meaning": "If a shield cannot be placed then the renderer will advance by text-spacing/2.0 to try placement again.", "doc": "Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line)." }, "max-char-angle-delta": { "css": "text-max-char-angle-delta", "type": "float", "expression":true, "default-value": 22.5, "default-meaning":"The label will not be placed if a character falls on a line with an angle sharper than 22.5 degrees.", "doc": "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." }, "fill": { "css": "text-fill", "type": "color", "expression":true, "doc": "Specifies the color for the text.", "default-value": "black", "default-meaning": "The text will be rendered black." }, "opacity": { "css": "text-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text.", "default-value": 1.0, "default-meaning": "Fully opaque", "expression":true, "default-meaning": "Fully opaque.", "type": "float" }, "halo-opacity": { "css": "text-halo-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text halo.", "default-value": 1.0, "type": "float", "expression":true, "default-meaning": "Fully opaque." }, "halo-fill": { "css": "text-halo-fill", "type": "color", "expression":true, "default-value": "white", "default-meaning": "The halo will be rendered white.", "doc": "Specifies the color of the halo around the text." }, "halo-radius": { "css": "text-halo-radius", "doc": "Specify the radius of the halo in pixels.", "default-value": 0.0, "type": "float", "expression":true, "default-meaning": "no halo." }, "halo-rasterizer": { "css": "text-halo-rasterizer", "type": [ "full", "fast" ], "expression":true, "default-value": "full", "default-meaning": "The text will be rendered using the highest quality method rather than the fastest.", "doc": "Exposes an alternate text halo rendering method that sacrifices quality for speed." }, "halo-transform": { "css": "text-halo-transform", "type": "functions", "expression":true, "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "", "default-meaning": "No transformation.", "doc": "Transform text halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor." }, "dx": { "css": "text-dx", "type": "float", "expression":true, "doc": "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.", "default-meaning": "Text will not be displaced.", "default-value": 0.0 }, "dy": { "css": "text-dy", "type": "float", "expression":true, "doc": "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.", "default-meaning": "Text will not be displaced.", "default-value": 0.0 }, "vertical-alignment": { "css": "text-vertical-alignment", "type": [ "top", "middle", "bottom", "auto" ], "expression":true, "doc": "Position of label relative to point position.", "default-value": "auto", "default-meaning": "Default affected by value of dy; \"top\" for dy>0, \"bottom\" for dy<0." }, "avoid-edges": { "css": "text-avoid-edges", "doc": "Avoid placing labels that intersect with tile boundaries.", "default-value": false, "type": "boolean", "expression":true, "default-meaning": "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." }, "margin": { "css": "text-margin", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No extra margin will be used to determine if a label collides with any other text, shield, or marker.", "doc": "Minimum distance that a label can be placed from any other text, shield, or marker." }, "repeat-distance": { "css": "text-repeat-distance", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Labels with the same text will be rendered without restriction.", "doc": "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." }, "minimum-distance": { "css": "text-min-distance", "type": "float", "default-value": 0.0, "expression":true, "default-meaning": "Labels with the same text will be rendered without restriction.", "doc": "Minimum distance to the next label with the same text. Only works for line placement. Deprecated: replaced by `text-repeat-distance` and `text-margin`", "status": "deprecated" }, "minimum-padding": { "css": "text-min-padding", "default-value": 0.0, "type": "float", "expression":true, "doc": "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.", "default-meaning": "No margin will be used to detect if a text label is nearby a tile boundary." }, "minimum-path-length": { "css": "text-min-path-length", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "place labels on all geometries no matter how small they are.", "doc": "Place labels only on polygons and lines with a bounding width longer than this value (in pixels)." }, "allow-overlap": { "css": "text-allow-overlap", "type": "boolean", "expression":true, "default-value": false, "doc": "Control whether overlapping text is shown or hidden.", "default-meaning": "Do not allow text to overlap with other text - overlapping markers will not be shown." }, "orientation": { "css": "text-orientation", "type": "float", "expression":true, "default-value": 0.0, "doc": "Rotate the text. (only works with text-placement:point).", "default-meaning": "Text is not rotated and is displayed upright." }, "rotate-displacement": { "css": "text-rotate-displacement", "type": "boolean", "doc": "Rotates the displacement around the placement origin by the angle given by \"orientation\".", "default-value": false, "default-meaning": "Label center is used for rotation." }, "upright": { "css": "text-upright", "default-value": "auto", "type": [ "auto", "auto-down", "left", "right", "left-only", "right-only" ], "expression":true, "default-meaning": "Text will be positioned upright automatically.", "doc": "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." }, "placement": { "css": "text-placement", "default-value": "point", "type": [ "point", "line", "vertex", "interior" ], "expression":true, "default-meaning": "One shield will be placed per geometry.", "doc": "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." }, "placement-type": { "css": "text-placement-type", "doc": "Re-position and/or re-size text to avoid overlaps. \"simple\" for basic algorithm (using text-placements string,) \"dummy\" to turn this feature off.", "type": [ "dummy", "simple", "list" ], "expression":true, "default-meaning": "Alternative placements will not be enabled.", "default-value": "dummy" }, "placements": { "css": "text-placements", "type": "string", "default-meaning": "No alternative placements will be used.", "default-value": "", "expression":true, "doc": "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": { "css": "text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize", "reverse" ], "expression":true, "doc": "Transform the case of the characters.", "default-meaning": "Transform text instance with specified function. Ignores map scale factor.", "default-value": "none" }, "horizontal-alignment": { "css": "text-horizontal-alignment", "type": [ "left", "middle", "right", "auto", "adjust" ], "expression":true, "doc": "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`.", "default-value": "auto", "default-meaning":"TODO." }, "justify-alignment": { "css": "text-align", "type": [ "left", "right", "center", "auto" ], "expression":true, "doc": "Define how text is justified.", "default-value": "auto", "default-meaning": "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." }, "clip": { "css": "text-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "text-simplify", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "Simplify the geometries used for text placement by the given tolerance." }, "simplify-algorithm": { "css": "text-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression": true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "Simplify the geometries used for text placement by the given algorithm." }, "smooth": { "css": "text-smooth", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "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." }, "comp-op": { "css": "text-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true }, "halo-comp-op": { "css": "text-halo-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ], "expression":true }, "font-feature-settings": { "css": "text-font-feature-settings", "type": "string", "default-value": "", "default-meaning": "Default set of typographic features recommended by OpenType specification. Ligatures are turned off by default when `character-spacing` is greater than zero.", "doc": "Comma separated list of OpenType typographic features. The syntax and semantics conforms to `font-feature-settings` from W3C CSS." }, "largest-bbox-only": { "css": "text-largest-bbox-only", "type": "boolean", "expression": true, "default-value": true, "default-meaning": "For multipolygons only polygon with largest bbox area is labeled (does not apply to other geometries).", "doc": "Controls default labeling behavior on multipolygons. The default is true and means that only the polygon with largest bbox is labeled.", "status": "experimental" } }, "building": { "default": { "css": "building", "type": [ "auto", "none" ], "doc": "Allows omitting a building symbolizer rule or emitting it with default values.", "status": "unstable" }, "fill": { "css": "building-fill", "expression":true, "type":"color", "default-value": "The color gray will be used for fill.", "default-meaning": "Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).", "doc": "The color of the buildings fill. Note: 0.8 will be used to multiply each color component to auto-generate a darkened wall color." }, "fill-opacity": { "css": "building-fill-opacity", "type": "float", "expression":true, "doc": "The opacity of the building as a whole, including all walls.", "default-value": 1.0, "default-meaning": "Color is fully opaque." }, "height": { "css": "building-height", "doc": "The height of the building in pixels.", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Buildings will not have a visual height and will instead look like flat polygons." } }, "debug": { "mode": { "css": "debug-mode", "type": [ "collision", "vertex" ], "default-value": "collision", "doc": "The mode for debug rendering.", "expression":true, "default-meaning": "The otherwise invisible collision boxes will be rendered as squares on the map." } }, "dot": { "default": { "css": "dot", "type": [ "auto", "none" ], "doc": "Allows omitting a dot symbolizer rule or emitting it with default values.", "status": "unstable" }, "fill": { "css": "dot-fill", "default-value": "gray", "doc": "The color of the area of the dot.", "type": "color", "expression":true, "default-meaning": "The dot fill color is gray." }, "opacity": { "css": "dot-opacity", "doc": "The overall opacity of the dot.", "default-value": 1.0, "default-meaning": "The opacity of the dot.", "type": "float", "expression":true }, "width": { "css": "dot-width", "default-value": 1.0, "doc": "The width of the dot in pixels.", "type": "float", "expression":true, "default-meaning": "The marker width is 1 pixel." }, "height": { "css": "dot-height", "default-value": 1.0, "doc": "The height of the dot in pixels.", "type": "float", "expression":true, "default-meaning": "The marker height is 1 pixels." }, "comp-op": { "css": "dot-comp-op", "default-value": "src-over", "default-meaning": "Add the current layer on top of other layers.", "doc": "Composite operation. This defines how this layer should behave relative to layers atop or below it.", "type": [ "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" ] } } }, "colors": { "aliceblue": [240, 248, 255], "antiquewhite": [250, 235, 215], "aqua": [0, 255, 255], "aquamarine": [127, 255, 212], "azure": [240, 255, 255], "beige": [245, 245, 220], "bisque": [255, 228, 196], "black": [0, 0, 0], "blanchedalmond": [255,235,205], "blue": [0, 0, 255], "blueviolet": [138, 43, 226], "brown": [165, 42, 42], "burlywood": [222, 184, 135], "cadetblue": [95, 158, 160], "chartreuse": [127, 255, 0], "chocolate": [210, 105, 30], "coral": [255, 127, 80], "cornflowerblue": [100, 149, 237], "cornsilk": [255, 248, 220], "crimson": [220, 20, 60], "cyan": [0, 255, 255], "darkblue": [0, 0, 139], "darkcyan": [0, 139, 139], "darkgoldenrod": [184, 134, 11], "darkgray": [169, 169, 169], "darkgreen": [0, 100, 0], "darkgrey": [169, 169, 169], "darkkhaki": [189, 183, 107], "darkmagenta": [139, 0, 139], "darkolivegreen": [85, 107, 47], "darkorange": [255, 140, 0], "darkorchid": [153, 50, 204], "darkred": [139, 0, 0], "darksalmon": [233, 150, 122], "darkseagreen": [143, 188, 143], "darkslateblue": [72, 61, 139], "darkslategrey": [47, 79, 79], "darkturquoise": [0, 206, 209], "darkviolet": [148, 0, 211], "deeppink": [255, 20, 147], "deepskyblue": [0, 191, 255], "dimgray": [105, 105, 105], "dimgrey": [105, 105, 105], "dodgerblue": [30, 144, 255], "firebrick": [178, 34, 34], "floralwhite": [255, 250, 240], "forestgreen": [34, 139, 34], "fuchsia": [255, 0, 255], "gainsboro": [220, 220, 220], "ghostwhite": [248, 248, 255], "gold": [255, 215, 0], "goldenrod": [218, 165, 32], "gray": [128, 128, 128], "grey": [128, 128, 128], "green": [0, 128, 0], "greenyellow": [173, 255, 47], "honeydew": [240, 255, 240], "hotpink": [255, 105, 180], "indianred": [205, 92, 92], "indigo": [75, 0, 130], "ivory": [255, 255, 240], "khaki": [240, 230, 140], "lavender": [230, 230, 250], "lavenderblush": [255, 240, 245], "lawngreen": [124, 252, 0], "lemonchiffon": [255, 250, 205], "lightblue": [173, 216, 230], "lightcoral": [240, 128, 128], "lightcyan": [224, 255, 255], "lightgoldenrodyellow": [250, 250, 210], "lightgray": [211, 211, 211], "lightgreen": [144, 238, 144], "lightgrey": [211, 211, 211], "lightpink": [255, 182, 193], "lightsalmon": [255, 160, 122], "lightseagreen": [32, 178, 170], "lightskyblue": [135, 206, 250], "lightslategray": [119, 136, 153], "lightslategrey": [119, 136, 153], "lightsteelblue": [176, 196, 222], "lightyellow": [255, 255, 224], "lime": [0, 255, 0], "limegreen": [50, 205, 50], "linen": [250, 240, 230], "magenta": [255, 0, 255], "maroon": [128, 0, 0], "mediumaquamarine": [102, 205, 170], "mediumblue": [0, 0, 205], "mediumorchid": [186, 85, 211], "mediumpurple": [147, 112, 219], "mediumseagreen": [60, 179, 113], "mediumslateblue": [123, 104, 238], "mediumspringgreen": [0, 250, 154], "mediumturquoise": [72, 209, 204], "mediumvioletred": [199, 21, 133], "midnightblue": [25, 25, 112], "mintcream": [245, 255, 250], "mistyrose": [255, 228, 225], "moccasin": [255, 228, 181], "navajowhite": [255, 222, 173], "navy": [0, 0, 128], "oldlace": [253, 245, 230], "olive": [128, 128, 0], "olivedrab": [107, 142, 35], "orange": [255, 165, 0], "orangered": [255, 69, 0], "orchid": [218, 112, 214], "palegoldenrod": [238, 232, 170], "palegreen": [152, 251, 152], "paleturquoise": [175, 238, 238], "palevioletred": [219, 112, 147], "papayawhip": [255, 239, 213], "peachpuff": [255, 218, 185], "peru": [205, 133, 63], "pink": [255, 192, 203], "plum": [221, 160, 221], "powderblue": [176, 224, 230], "purple": [128, 0, 128], "red": [255, 0, 0], "rosybrown": [188, 143, 143], "royalblue": [65, 105, 225], "saddlebrown": [139, 69, 19], "salmon": [250, 128, 114], "sandybrown": [244, 164, 96], "seagreen": [46, 139, 87], "seashell": [255, 245, 238], "sienna": [160, 82, 45], "silver": [192, 192, 192], "skyblue": [135, 206, 235], "slateblue": [106, 90, 205], "slategray": [112, 128, 144], "slategrey": [112, 128, 144], "snow": [255, 250, 250], "springgreen": [0, 255, 127], "steelblue": [70, 130, 180], "tan": [210, 180, 140], "teal": [0, 128, 128], "thistle": [216, 191, 216], "tomato": [255, 99, 71], "turquoise": [64, 224, 208], "violet": [238, 130, 238], "wheat": [245, 222, 179], "white": [255, 255, 255], "whitesmoke": [245, 245, 245], "yellow": [255, 255, 0], "yellowgreen": [154, 205, 50], "transparent": [0, 0, 0, 0] }, "filter": { "value": [ "true", "false", "null", "point", "linestring", "polygon", "collection" ] } } mapnik-reference-8.10.0/3.0.6/000077500000000000000000000000001342311331100154475ustar00rootroot00000000000000mapnik-reference-8.10.0/3.0.6/datasources.json000066400000000000000000000546111342311331100206660ustar00rootroot00000000000000{ "datasources": { "csv": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "strict": { "type": "boolean", "doc": "Control if the datasource should throw on invalid rows", "default-value": false, "default-meaning": "Unless this option is set to true the datasource will skip invalid rows and attempt to parse as much data as possible" }, "escape": { "type": "string", "doc": "The escape character to use for parsing data", "default-value": "A single backslash (aka. reverse solidus): \\", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "quote": { "type": "string", "doc": "The quote character to use for parsing data", "default-value": "A quotation mark (aka. double quote): \"", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "separator": { "type": "string", "doc": "The separator character to use for parsing data", "default-value": "Basic autodetection is used to determine the best default value if the user does not manually supply a separator.", "default-meaning": "A comma will be used unless more tabs (\t), pipes (|), or semicolons (;) are detected than commas in the header row (in that order of preference)" }, "headers": { "type": "string", "doc": "A comma separated list of header names that can be set to add headers to data that lacks them", "default-value": "", "default-meaning": "Headers will be parsed from the first line of the data unless this option is set" }, "filesize_max": { "type": "float", "doc": "The maximum filesize in MB that will be accepted", "default-value": 20, "default-meaning": "A file that is larger that 20 MB will not be accepted and an error will be throw unless the user manually passes this option with a larger value (useful only in cases where your machine has a lot of memory)" } }, "gdal": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "band": { "type": "unsigned", "doc": "A particular raster band to work with.", "default-value": 0, "default-meaning": "No particular raster band set, working with all bands.", "required": false }, "nodata": { "type": "float", "doc": "Overrides nodata value from the raster.", "default-value": 0, "default-meaning": "Nodata value from the raster is used.", "required": false }, "nodata_tolerance": { "type": "float", "doc": "Make pixels in this tolerance around nodata value transparent.", "default-value": 1e-12, "default-meaning": "The tolerance is effectively zero.", "required": false }, "shared": { "type": "boolean", "doc": "Allows to share the GDAL dataset handle with other GDAL datasources with the same file path.", "default-value": false, "default-meaning": "The datasource will use unique dataset instance.", "required": false } }, "geojson": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "inline": { "type": "string", "doc": "Raw tabular data to be read instead of reading data from a file", "default-value": "", "default-meaning": "Unless this option is provided data will be read from the `file` option" } }, "occi": { "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "ogr": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "osm": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "postgis": { "table": { "type": "string", "doc": "The table or query used", "default-value": "", "default-meaning": "", "required": true }, "key_field": { "type": "boolean", "doc": "User provided field name to interpret as the primary key of the table. If provided then the values from this field (which must be an integer) will be used as the feature id of the returned data", "default-value": "", "default-meaning": "By default no primary key is required and in this case the feature id for returned features will be auto-generated by Mapnik and is not certain to be globally unique.", "required": false }, "key_field_as_attribute": { "type": "boolean", "doc": "User provided option to control whether the key_field will be duplicated as a feature attribute (as well as being used for the feature.id value)", "default-value": true, "default-meaning": "By default if key_field is provided then it is also available in the feature attributes by field name", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "dbname": { "type": "string", "doc": "Database name", "default-value": "username", "default-meaning": "Will default to a database named after the user (as per libpq defaults)", "required": false }, "host": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "password": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "port": { "type": "unsigned", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "user": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "connect_timeout": { "type": "unsigned", "doc": "", "default-value": 4, "default-meaning": "", "required": false }, "schema": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "extent": { "type": "string", "doc": "A comma or space delimited bounding box in the format of minx,miny,maxx,maxy that, if provided, will be used to report the extent of the datasource. The primary reason the option exists is for performance: providing this option at datasource creation saves the time otherwise needed to scan the data for the actual extent, which for large datasets can be very significant. The datasource extent, whether manually provided or automatically calculated is used during rendering to decide if the datasource should be queried for features or not (skipped for best performance). If the extent intersects with the map rendering extent then the datasource will be queried and the query extent will be clipped to the reported datasource extent. So, this means that this option can also be used to restrict which features are available for a given datasource", "default-value": "", "default-meaning": "The datasource extent will be determined at runtime by querying the data, which may be slow, although the extent only needs to be determined once per datasource initialized and it will be cached for further rendering", "recommended": true }, "estimate_extent": { "type": "boolean", "doc": "If an `extent` string is not provided then Mapnik dynamically queries the table to determine the extent. If this option is true then the faster but less accurate PostGIS `ST_EstimatedExtent` function is used instead of `ST_Extent`.", "default-value": false, "default-meaning": "", "required": false }, "geometry_table": { "type": "string", "doc": "Specifies geometry table to use to look up metadata", "default-value": "", "default-meaning": "Automatically parsed from 'table' value", "required": false }, "geometry_field": { "type": "string", "doc": "Specifies geometry field to use", "default-value": "", "default-meaning": "First entry in geometry_columns", "required": false }, "cursor_size": { "type": "unsigned", "doc": "Integer size of binary cursor to use", "default-value": 0, "default-meaning": "No binary cursor is used", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "srid": { "type": "unsigned", "doc": "SRID to use", "default-value": 0, "default-meaning": "Auto-detected from geometry_field", "required": false }, "initial_size": { "type": "unsigned", "doc": "Integer size of connection pool", "default-value": 1, "default-meaning": "", "required": false }, "max_size": { "type": "unsigned", "doc": "Integer max of connection pool", "default-value": 10, "default-meaning": "", "required": false }, "simplify_geometries": { "type": "boolean", "doc": "Simplify geometries with ST_Simplify", "default-value": false, "default-meaning": "Don't simplify geometries", "required": false }, "autodetect_key_field": { "type": "boolean", "doc": "Attempt to autodetect a primary key field", "default-value": false, "default-meaning": "Don't autodetect a primary key field", "required": false }, "persist_connection": { "type": "boolean", "doc": "Keep connection open", "default-value": true, "default-meaning": "Connections, successfully created, will be kept open until Mapnik shuts down", "required": false }, "extent_from_subquery": { "type": "boolean", "doc": "Direct Mapnik to query Postgis for the extent of the raw 'table' value", "default-value": false, "default-meaning": "Uses 'geometry_table' instead of querying", "required": false } }, "python": { "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "raster": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false } }, "rasterlite": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false } }, "shape": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false } }, "sqlite": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "table": { "type": "string", "doc": "The table or query used", "default-value": "", "default-meaning": "", "required": true }, "key_field": { "type": "boolean", "doc": "User provided field name to interpret as the primary key of the table. If provided then the values from this field (which must be an integer) will be used as the feature id of the returned data", "default-value": "", "default-meaning": "By default no primary key is required and in this case the feature id for returned features will be auto-generated by Mapnik and is not certain to be globally unique.", "required": false } }, "topojson": { "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "inline": { "type": "string", "doc": "Raw tabular data to be read instead of reading data from a file", "default-value": "", "default-meaning": "Unless this option is provided data will be read from the `file` option" } } } }mapnik-reference-8.10.0/3.0.6/datasources.template.json000066400000000000000000000356231342311331100225020ustar00rootroot00000000000000{ "types": { "type": { "type": "string", "doc": "The type of the option", "values": ["string","float","boolean","unsigned"], "required": true }, "doc": { "type": "string", "doc": "The basic description of the option and the expected behavior if you provide it", "required": true }, "default-value": { "type": "string", "doc": "Either an empty string if there is no default value, a description of the default value, or the default value itself (if appropriate)", "required": true }, "default-meaning": { "type": "string", "doc": "A detailed description of what the behavior will be if the default value is left unchanged", "required": true }, "required": { "type": "boolean", "doc": "A boolean value to signify if the option is required. Can be left out and if not present it will be assumed that the option is not required", "required": false }, "recommended": { "type": "boolean", "doc": "A boolean value to signify if the option is recommended, even if it is not required. This is meant to indicate to users that better behavior or performance will be gained if they manually provide the option and that they should seek to understand why it exists (and also why/how it needs to be manually provided)", "required": false } }, "variables": { "encoding": { "type": "string", "doc": "The encoding value for the datasource attributes", "default-value": "utf-8", "default-meaning": "UTF8 will be the assumed encoding for string attribute values", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "file": { "type": "string", "doc": "Path to the file for the datasource", "default-value": "", "default-meaning": "", "required": true }, "base": { "type": "string", "doc": "A base path used to complete a full path to a file.", "default-value": "", "default-meaning": "Only the `file` option will be used to attempt to load data from the filesystem", "required": false }, "extent" : { "type": "string", "doc": "A comma or space delimited bounding box in the format of minx,miny,maxx,maxy that, if provided, will be used to report the extent of the datasource. The primary reason the option exists is for performance: providing this option at datasource creation saves the time otherwise needed to scan the data for the actual extent, which for large datasets can be very significant. The datasource extent, whether manually provided or automatically calculated is used during rendering to decide if the datasource should be queried for features or not (skipped for best performance). If the extent intersects with the map rendering extent then the datasource will be queried and the query extent will be clipped to the reported datasource extent. So, this means that this option can also be used to restrict which features are available for a given datasource", "default-value": "", "default-meaning": "The datasource extent will be determined at runtime by querying the data, which may be slow, although the extent only needs to be determined once per datasource initialized and it will be cached for further rendering", "recommended": true }, "table" : { "type": "string", "doc": "The table or query used", "default-value": "", "default-meaning": "", "required": true }, "key_field": { "type": "boolean", "doc": "User provided field name to interpret as the primary key of the table. If provided then the values from this field (which must be an integer) will be used as the feature id of the returned data", "default-value": "", "default-meaning": "By default no primary key is required and in this case the feature id for returned features will be auto-generated by Mapnik and is not certain to be globally unique.", "required": false }, "inline": { "type": "string", "doc": "Raw tabular data to be read instead of reading data from a file", "default-value": "", "default-meaning": "Unless this option is provided data will be read from the `file` option" } }, "datasources": { "csv": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "row_limit":"<@(row_limit)", "strict": { "type": "boolean", "doc": "Control if the datasource should throw on invalid rows", "default-value": false, "default-meaning": "Unless this option is set to true the datasource will skip invalid rows and attempt to parse as much data as possible" }, "escape": { "type": "string", "doc": "The escape character to use for parsing data", "default-value": "A single backslash (aka. reverse solidus): \\", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "quote": { "type": "string", "doc": "The quote character to use for parsing data", "default-value": "A quotation mark (aka. double quote): \"", "default-meaning": "A backslash will be used as the assumed character that the data uses for escaping other characters" }, "separator": { "type": "string", "doc": "The separator character to use for parsing data", "default-value": "Basic autodetection is used to determine the best default value if the user does not manually supply a separator.", "default-meaning": "A comma will be used unless more tabs (\t), pipes (|), or semicolons (;) are detected than commas in the header row (in that order of preference)" }, "headers": { "type": "string", "doc": "A comma separated list of header names that can be set to add headers to data that lacks them", "default-value": "", "default-meaning": "Headers will be parsed from the first line of the data unless this option is set" }, "filesize_max": { "type": "float", "doc": "The maximum filesize in MB that will be accepted", "default-value": 20.0, "default-meaning": "A file that is larger that 20 MB will not be accepted and an error will be throw unless the user manually passes this option with a larger value (useful only in cases where your machine has a lot of memory)" } }, "gdal": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "band": { "type": "unsigned", "doc": "A particular raster band to work with.", "default-value": 0, "default-meaning": "No particular raster band set, working with all bands.", "required": false }, "nodata": { "type": "float", "doc": "Overrides nodata value from the raster.", "default-value": 0, "default-meaning": "Nodata value from the raster is used.", "required": false }, "nodata_tolerance": { "type": "float", "doc": "Make pixels in this tolerance around nodata value transparent.", "default-value": 1e-12, "default-meaning": "The tolerance is effectively zero.", "required": false }, "shared": { "type": "boolean", "doc": "Allows to share the GDAL dataset handle with other GDAL datasources with the same file path.", "default-value": false, "default-meaning": "The datasource will use unique dataset instance.", "required": false } }, "geojson": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "inline":"<@(inline)" }, "occi": { "encoding":"<@(encoding)" }, "ogr": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)" }, "osm": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)" }, "postgis": { "table": "<@(table)", "key_field": "<@(key_field)", "key_field_as_attribute": { "type": "boolean", "doc": "User provided option to control whether the key_field will be duplicated as a feature attribute (as well as being used for the feature.id value)", "default-value": true, "default-meaning": "By default if key_field is provided then it is also available in the feature attributes by field name", "required": false }, "encoding":"<@(encoding)", "dbname": { "type": "string", "doc": "Database name", "default-value": "username", "default-meaning": "Will default to a database named after the user (as per libpq defaults)", "required": false }, "host": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "password": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "port": { "type": "unsigned", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "user": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "connect_timeout": { "type": "unsigned", "doc": "", "default-value": 4, "default-meaning": "", "required": false }, "schema": { "type": "string", "doc": "", "default-value": "", "default-meaning": "", "required": false }, "extent": "<@(extent)", "estimate_extent": { "type": "boolean", "doc": "If an `extent` string is not provided then Mapnik dynamically queries the table to determine the extent. If this option is true then the faster but less accurate PostGIS `ST_EstimatedExtent` function is used instead of `ST_Extent`.", "default-value": false, "default-meaning": "", "required": false }, "geometry_table": { "type": "string", "doc": "Specifies geometry table to use to look up metadata", "default-value": "", "default-meaning": "Automatically parsed from 'table' value", "required": false }, "geometry_field": { "type": "string", "doc": "Specifies geometry field to use", "default-value": "", "default-meaning": "First entry in geometry_columns", "required": false }, "cursor_size": { "type": "unsigned", "doc": "Integer size of binary cursor to use", "default-value": 0, "default-meaning": "No binary cursor is used", "required": false }, "row_limit": { "type": "unsigned", "doc": "Max amount of features to read from the datasource", "default-value": 0, "default-meaning": "All features will be read from the datasource (unless row_limit is > 1)", "required": false }, "srid": { "type": "unsigned", "doc": "SRID to use", "default-value": 0, "default-meaning": "Auto-detected from geometry_field", "required": false }, "initial_size": { "type": "unsigned", "doc": "Integer size of connection pool", "default-value": 1, "default-meaning": "", "required": false }, "max_size": { "type": "unsigned", "doc": "Integer max of connection pool", "default-value": 10, "default-meaning": "", "required": false }, "simplify_geometries": { "type": "boolean", "doc": "Simplify geometries with ST_Simplify", "default-value": false, "default-meaning": "Don't simplify geometries", "required": false }, "autodetect_key_field": { "type": "boolean", "doc": "Attempt to autodetect a primary key field", "default-value": false, "default-meaning": "Don't autodetect a primary key field", "required": false }, "persist_connection": { "type": "boolean", "doc": "Keep connection open", "default-value": true, "default-meaning": "Connections, successfully created, will be kept open until Mapnik shuts down", "required": false }, "extent_from_subquery": { "type": "boolean", "doc": "Direct Mapnik to query Postgis for the extent of the raw 'table' value", "default-value": false, "default-meaning": "Uses 'geometry_table' instead of querying", "required": false } }, "python": { "encoding":"<@(encoding)" }, "raster": { "file":"<@(file)", "base":"<@(base)" }, "rasterlite": { "file":"<@(file)", "base":"<@(base)" }, "shape": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)" }, "sqlite": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "table": "<@(table)", "key_field": "<@(key_field)" }, "topojson": { "file":"<@(file)", "base":"<@(base)", "encoding":"<@(encoding)", "inline":"<@(inline)" } } } mapnik-reference-8.10.0/3.0.6/reference.json000066400000000000000000004005661342311331100203130ustar00rootroot00000000000000{ "version": "3.0.6", "style": { "filter-mode": { "type": [ "all", "first" ], "doc": "Control the processing behavior of Rule filters within a Style. If 'all' is used then all Rules are processed sequentially independent of whether any previous filters matched. If 'first' is used then it means processing ends after the first match (a positive filter evaluation) and no further Rules in the Style are processed ('first' is usually the default for CSS implementations on top of Mapnik to simplify translation from CSS to Mapnik XML).", "default-value": "all", "default-meaning": "All Rules in a Style are processed whether they have filters or not and whether or not the filter conditions evaluate to true." }, "image-filters": { "css": "image-filters", "default-value": "none", "default-meaning": "no filters", "type": "functions", "functions": [ ["agg-stack-blur", 2], ["emboss", 0], ["blur", 0], ["gray", 0], ["sobel", 0], ["edge-detect", 0], ["x-gradient", 0], ["y-gradient", 0], ["invert", 0], ["sharpen", 0], ["color-blind-protanope", 0], ["color-blind-deuteranope", 0], ["color-blind-tritanope", 0], ["colorize-alpha", -1], ["color-to-alpha", 1], ["scale-hsla", 8] ], "doc": "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": { "css":"image-filters-inflate", "default-value": false, "type":"boolean", "default-meaning": "No special handling will be done and image filters that blur data will only blur up to the edge of a tile boundary", "doc": "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": { "css": "direct-image-filters", "default-value": "none", "default-meaning": "no filters", "type": "functions", "functions": [ ["agg-stack-blur", 2], ["emboss", 0], ["blur", 0], ["gray", 0], ["sobel", 0], ["edge-detect", 0], ["x-gradient", 0], ["y-gradient", 0], ["invert", 0], ["sharpen", 0], ["color-blind-protanope", 0], ["color-blind-deuteranope", 0], ["color-blind-tritanope", 0], ["colorize-alpha", -1], ["color-to-alpha", 1], ["scale-hsla", 8] ], "doc": "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": { "css": "comp-op", "default-value": "src-over", "default-meaning": "add the current layer on top of other layers", "doc": "Composite operation. This defines how this layer should behave relative to layers atop or below it.", "type": [ "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" ] }, "opacity": { "css": "opacity", "type": "float", "doc": "An alpha value for the style (which means an alpha applied to all features in separate buffer and then composited back to main buffer).", "default-value": 1.0, "default-meaning": "No separate buffer will be used and no alpha will be applied to the style after rendering." } }, "layer" : { "name": { "default-value": "", "type":"string", "required" : true, "default-meaning": "No layer name has been provided", "doc": "The name of a layer. Can be anything you wish and is not strictly validated, but ideally unique in the map." }, "srs": { "default-value": "", "type":"string", "default-meaning": "No srs value is provided and the value will be inherited from the Map's srs", "doc": "The spatial reference system definition for the layer, aka the projection. Can either be a proj4 literal string like '+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs' or, if the proper proj4 epsg/nad/etc identifier files are installed, a string that uses an id like: '+init=epsg:4326'." }, "status": { "default-value": true, "type":"boolean", "default-meaning": "This layer will be marked as active and available for processing", "doc": "A property that can be set to false to disable this layer from being processed." }, "minzoom": { "default-value": 0, "type":"float", "default-meaning": "The layer will be visible at the minimum possible scale", "doc": "The minimum scale denominator that this layer will be visible at. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6. This option has been deprecated in favor of `minimum-scale-denominator`.", "status": "deprecated" }, "maxzoom": { "default-value": "1.79769e+308", "type":"float", "default-meaning": "The layer will be visible at the maximum possible scale", "doc": "The maximum scale denominator that this layer will be visible at. The default is the numeric limit of the C++ double type, which may vary slightly by system, but is likely a massive number like 1.79769e+308 and ensures that this layer will always be visible unless the value is reduced. A layer's visibility is determined by whether its status is true and if the Map scale >= minzoom - 1e-6 and scale < maxzoom + 1e-6. This option has been deprecated in favor of `maximum-scale-denominator`.", "status": "deprecated" }, "minimum-scale-denominator": { "default-value": 0, "type":"float", "default-meaning": "The layer will be visible at the minimum possible scale denominator", "doc": "The minimum scale denominator that this layer will be visible at. A layer's visibility is determined by whether its status is true and if the Map scale denominator >= `minimum-scale-denominator` - 1e-6 and scale denominator < 'maximum-scale-denominator' + 1e-6." }, "maximum-scale-denominator": { "default-value": "1.79769e+308", "type":"float", "default-meaning": "The layer will be visible at the maximum possible scale denominator", "doc": "The maximum scale denominator that this layer will be visible at. The default is the numeric limit of the C++ double type, which may vary slightly by system, but is likely a massive number like 1.79769e+308 and ensures that this layer will always be visible unless the value is reduced. A layer's visibility is determined by whether its status is true and if the Map scale denominator >= `minimum-scale-denominator` - 1e-6 and scale denominator < `maximum-scale-denominator` + 1e-6." }, "queryable": { "default-value": false, "type":"boolean", "default-meaning": "The layer will not be available for the direct querying of data values", "doc": "This property was added for GetFeatureInfo/WMS compatibility and is rarely used. It is off by default meaning that in a WMS context the layer will not be able to be queried unless the property is explicitly set to true." }, "clear-label-cache": { "default-value": false, "type":"boolean", "default-meaning": "The renderer's collision detector cache (used for avoiding duplicate labels and overlapping markers) will not be cleared immediately before processing this layer", "doc": "This property, by default off, can be enabled to allow a user to clear the collision detector cache before a given layer is processed. This may be desirable to ensure that a given layers data shows up on the map even if it normally would not because of collisions with previously rendered labels or markers." }, "group-by": { "default-value": "", "type":"string", "default-meaning": "No special layer grouping will be used during rendering", "doc": "https://github.com/mapnik/mapnik/wiki/Grouped-rendering" }, "buffer-size": { "default-value": 0, "type":"float", "default-meaning": "No custom buffer will be used for the layer and rather the Map buffer-size will be used", "doc": "Extra tolerance around the Layer extent (in pixels) used when querying the layer data during rendering. If set this will override the Map buffer-size." }, "maximum-extent": { "default-value": "none", "type":"bbox", "default-meaning": "No clipping extent will be used", "doc": "An extent to be used to limit the bounds used to query this specific layer data during rendering. Should be minx, miny, maxx, maxy in the coordinates of the Layer." }, "cache-features": { "type":"boolean", "default-value": "off", "default-meaning": "Features are not cached between rendering multiple styles. The datasource is queried for each style.", "doc": "Setting this to `on` triggers Mapnik to attempt to cache features in memory for rendering when (and only when) a layer has multiple styles attached to it." } }, "symbolizers" : { "map": { "background-color": { "css": "background-color", "default-value": "none", "default-meaning": "Will be rendered transparent.", "type": "color", "doc": "Map Background color." }, "background-image": { "css": "background-image", "type": "uri", "default-value": "", "default-meaning": "No background image will be used.", "doc": "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": { "css": "background-image-comp-op", "doc": "Set the compositing operation used to blend the image into the background.", "default-value": "src-over", "default-meaning": "The background-image will be blended with the background normally (placed on top of any existing background-color).", "type": [ "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" ] }, "background-image-opacity": { "css": "background-image-opacity", "type": "float", "doc": "Set the opacity of the image.", "default-value": 1.0, "default-meaning": "The image opacity will not be changed when applied to the map background." }, "srs": { "css": "srs", "type": "string", "default-value": "+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs", "default-meaning": "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.", "doc": "Map spatial reference (proj4 string)." }, "buffer-size": { "css": "buffer-size", "default-value": 0, "type":"float", "default-meaning": "No buffer will be used.", "doc": "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": { "css": "maximum-extent", "default-value": "-20037508.34,-20037508.34,20037508.34,20037508.34", "type":"string", "default-meaning": "All data will be clipped to global mercator extent (default is applied in Carto.js).", "doc": "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": { "css": "base", "default-value": "", "default-meaning": "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.", "type": "string", "doc": "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." }, "paths-from-xml": { "css": "", "default-value": true, "default-meaning": "Paths read from XML will be interpreted from the location of the XML.", "type": "boolean", "doc": "Value to control whether paths in the XML will be interpreted from the location of the XML or from the working directory of the program that calls load_map()." }, "minimum-version": { "css": "", "default-value": "none", "default-meaning": "Mapnik version will not be detected and no error will be thrown about compatibility.", "type": "string", "doc": "The minumum Mapnik version (e.g. 0.7.2) needed to use certain functionality in the stylesheet." }, "font-directory": { "css": "font-directory", "type": "uri", "default-value": "none", "default-meaning": "No map-specific fonts will be registered.", "doc": "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": { "default": { "css": "polygon", "type": [ "auto", "none" ], "doc": "Allows omitting a polygon symbolizer rule or emitting it with default values.", "status": "unstable" }, "fill": { "css": "polygon-fill", "type": "color", "expression":true, "default-value": "rgba(128,128,128,1)", "default-meaning": "Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).", "doc": "Fill color to assign to a polygon." }, "fill-opacity": { "css": "polygon-opacity", "type": "float", "expression":true, "doc": "The opacity of the polygon.", "default-value": 1.0, "default-meaning": "Color is fully opaque." }, "gamma": { "css": "polygon-gamma", "type": "float", "expression":true, "default-value": 1.0, "default-meaning": "Fully antialiased.", "range": "0-1", "doc": "Level of antialiasing of polygon edges." }, "gamma-method": { "css": "polygon-gamma-method", "type": [ "power", "linear", "none", "threshold", "multiply" ], "expression":true, "default-value": "power", "default-meaning": "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.", "doc": "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." }, "clip": { "css": "polygon-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "polygon-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "Simplify geometries by the given tolerance." }, "simplify-algorithm": { "css": "polygon-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "Simplify geometries by the given algorithm." }, "smooth": { "css": "polygon-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "polygon-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform polygon geometry with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "polygon-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "line": { "default": { "css": "line", "type": [ "auto", "none" ], "doc": "Allows omitting a line symbolizer rule or emitting it with default values.", "status": "unstable" }, "stroke": { "css": "line-color", "default-value": "black", "type": "color", "expression":true, "default-meaning": "black and fully opaque (alpha = 1), same as rgb(0,0,0) or rgba(0,0,0,1).", "doc": "The color of a drawn line." }, "stroke-width": { "css": "line-width", "default-value": 1.0, "type": "float", "expression":true, "doc": "The width of a line in pixels.", "default-meaning": "The line will be rendered 1 pixel wide." }, "stroke-opacity": { "css": "line-opacity", "default-value": 1.0, "type": "float", "expression":true, "default-meaning": "Color is fully opaque.", "doc": "The opacity of a line." }, "stroke-linejoin": { "css": "line-join", "default-value": "miter", "type": [ "miter", "miter-revert", "round", "bevel" ], "expression":true, "doc": "The behavior of lines when joining.", "default-meaning": "The line joins will be rendered using a miter look." }, "stroke-linecap": { "css": "line-cap", "default-value": "butt", "type": [ "butt", "round", "square" ], "expression":true, "doc": "The display of line endings.", "default-meaning": "The line endings will be rendered using a butt look." }, "stroke-gamma": { "css": "line-gamma", "type": "float", "expression":true, "default-value": 1.0, "default-meaning": "Fully antialiased.", "range": "0-1", "doc": "Level of antialiasing of stroke line." }, "stroke-gamma-method": { "css": "line-gamma-method", "type": [ "power", "linear", "none", "threshold", "multiply" ], "expression":true, "default-value": "power", "default-meaning": "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.", "doc": "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." }, "stroke-dasharray": { "css": "line-dasharray", "type": "numbers", "expression":true, "doc": "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.", "default-value": "none", "default-meaning": "The line will be drawn without dashes." }, "stroke-dashoffset": { "css": "line-dash-offset", "type": "numbers", "expression":true, "doc": "Valid parameter but not currently used in renderers (only exists for experimental svg support in Mapnik which is not yet enabled).", "default-value": "none", "default-meaning": "The line will be drawn without dashes." }, "stroke-miterlimit": { "css": "line-miterlimit", "type": "float", "expression":true, "doc": "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.", "default-value": 4.0, "default-meaning": "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 )'." }, "clip": { "css": "line-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "line-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "Simplify geometries by the given tolerance." }, "simplify-algorithm": { "css": "line-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "Simplify geometries by the given algorithm." }, "smooth": { "css": "line-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "offset": { "css": "line-offset", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Will not be offset.", "doc": "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).", "status": "unstable" }, "rasterizer": { "css": "line-rasterizer", "type": [ "full", "fast" ], "expression":true, "default-value": "full", "doc": "Exposes an alternate AGG rendering method that sacrifices some accuracy for speed.", "default-meaning": "The line will be rendered using the highest quality method rather than the fastest." }, "geometry-transform": { "css": "line-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform line geometry with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "line-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "markers": { "default": { "css": "marker", "type": [ "auto", "none" ], "doc": "Allows omitting a marker symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "marker-file", "doc": "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.", "default-value": "none", "default-meaning": "An ellipse or circle, if width equals height.", "type": "uri", "expression":true }, "opacity": { "css": "marker-opacity", "doc": "The overall opacity of the marker, if set, overrides both the opacity of the fill and the opacity of the stroke.", "default-value": 1.0, "default-meaning": "The stroke-opacity and fill-opacity of the marker.", "type": "float", "expression":true }, "fill-opacity": { "css": "marker-fill-opacity", "doc": "The fill opacity of the marker. This property will also set the `fill-opacity` of elements in an SVG loaded from a file.", "default-value": 1.0, "expression":true, "default-meaning": "Color is fully opaque.", "type": "float" }, "stroke": { "css": "marker-line-color", "doc": "The color of the stroke around the marker. This property will also set the `stroke` of elements in an SVG loaded from a file.", "default-value": "black", "type": "color", "expression":true, "default-meaning": "The marker will be drawn with a black outline." }, "stroke-width": { "css": "marker-line-width", "default-value": 0.5, "doc": "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.", "type": "float", "expression":true, "default-meaning": "The marker will be drawn with an outline of .5 pixels wide." }, "stroke-opacity": { "css": "marker-line-opacity", "default-value": 1.0, "default-meaning": "Color is fully opaque. This property will also set the `stroke-opacity` of elements in an SVG loaded from a file.", "doc": "The opacity of a line.", "type": "float", "expression":true }, "placement": { "css": "marker-placement", "type": [ "point", "line", "interior", "vertex-first", "vertex-last" ], "expression":true, "default-value": "point", "default-meaning": "Place markers at the center point (centroid) of the geometry.", "doc": "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." }, "multi-policy": { "css": "marker-multi-policy", "type": [ "each", "whole", "largest" ], "expression":true, "default-value": "each", "default-meaning": "If a feature contains multiple geometries and the placement type is either point or interior then a marker will be rendered for each.", "doc": "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": { "css": "marker-type", "type": [ "arrow", "ellipse" ], "expression":true, "default-value": "ellipse", "default-meaning": "The marker shape is an ellipse.", "doc": "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).", "status": "deprecated" }, "width": { "css": "marker-width", "default-value": 10.0, "doc": "The width of the marker, if using one of the default types.", "type": "float", "expression":true, "default-meaning": "The marker width is 10 pixels." }, "height": { "css": "marker-height", "default-value": 10.0, "doc": "The height of the marker, if using one of the default types.", "type": "float", "expression":true, "default-meaning": "The marker height is 10 pixels." }, "fill": { "css": "marker-fill", "default-value": "blue", "doc": "The color of the area of the marker. This property will also set the `fill` of elements in an SVG loaded from a file.", "type": "color", "expression":true, "default-meaning": "The marker fill color is blue." }, "allow-overlap": { "css": "marker-allow-overlap", "type": "boolean", "expression":true, "default-value": false, "doc": "Control whether overlapping markers are shown or hidden.", "default-meaning": "Do not allow markers to overlap with each other - overlapping markers will not be shown." }, "avoid-edges": { "css": "marker-avoid-edges", "doc": "Avoid placing markers that intersect with tile boundaries.", "type": "boolean", "expression":true, "default-meaning": "Markers will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.", "default-value": false }, "ignore-placement": { "css": "marker-ignore-placement", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache.", "doc": "Value to control whether the placement of the feature will prevent the placement of other features." }, "spacing": { "css": "marker-spacing", "doc": "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.", "default-value": 100.0, "type": "float", "expression":true, "default-meaning": "In the case of marker-placement:line then draw a marker every 100 pixels along a line." }, "max-error": { "css": "marker-max-error", "type": "float", "expression":true, "default-value": 0.2, "default-meaning": "N/A: not intended to be changed.", "doc": "N/A: not intended to be changed." }, "transform": { "css": "marker-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform marker instance with specified function. Ignores map scale factor." }, "clip": { "css": "marker-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "marker-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Geometry will not be simplified.", "doc": "geometries are simplified by the given tolerance." }, "simplify-algorithm": { "css": "marker-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "geometries are simplified by the given algorithm." }, "smooth": { "css": "marker-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "marker-geometry-transform", "type": "functions", "expression":true, "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform marker geometry with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "offset": { "css": "marker-offset", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Will not be offset.", "doc": "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)." }, "comp-op": { "css": "marker-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true }, "direction": { "css": "marker-direction", "default-value": "right", "type": [ "auto", "auto-down", "left", "right", "left-only", "right-only", "up", "down" ], "expression": true, "default-meaning": "Markers are oriented to the right in the line direction.", "doc": "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": { "default": { "css": "shield", "type": [ "none" ], "doc": "Allows omitting a shield symbolizer rule.", "status": "unstable" }, "name": { "css": "shield-name", "type": "string", "expression":true, "serialization": "content", "default-value": "", "default-meaning": "No text label will be rendered with the shield.", "doc": "Value to use for a shield\"s text label. Data columns are specified using brackets like [column_name]." }, "file": { "css": "shield-file", "required": true, "type": "uri", "expression":true, "default-value": "none", "doc": "Image file to render behind the shield text. Accepted formats: svg, jpg, png, tiff, and webp.", "default-meaning": "" }, "face-name": { "css": "shield-face-name", "type": "string", "expression":true, "validate": "font", "doc": "Font name and style to use for the shield text.", "default-value": "none", "required": true, "default-meaning": "" }, "unlock-image": { "css": "shield-unlock-image", "type": "boolean", "expression":true, "doc": "This parameter should be set to true if you are trying to position text beside rather than on top of the shield image.", "default-value": false, "default-meaning": "text alignment relative to the shield image uses the center of the image as the anchor for text positioning." }, "size": { "css": "shield-size", "type": "float", "expression":true, "default-value": 10.0, "doc": "The size of the shield text in pixels.", "default-meaning": "Font size of 10 will be used to render text." }, "fill": { "css": "shield-fill", "type": "color", "expression":true, "default-value": "black", "doc": "The color of the shield text.", "default-meaning": "The shield text will be rendered black." }, "placement": { "css": "shield-placement", "type": [ "point", "line", "vertex", "interior" ], "expression":true, "default-value": "point", "default-meaning": "One shield will be placed per geometry.", "doc": "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." }, "avoid-edges": { "css": "shield-avoid-edges", "doc": "Avoid placing shields that intersect with tile boundaries.", "type": "boolean", "expression":true, "default-meaning": "Shields will be potentially placed near tile edges and therefore may look cut off unless they are rendered on each adjacent tile.", "default-value": false }, "allow-overlap": { "css": "shield-allow-overlap", "type": "boolean", "expression":true, "default-value": false, "doc": "Control whether overlapping shields are shown or hidden.", "default-meaning": "Shields will not overlap and any shields that might collide with previously placed shields will not be rendered.", "default-meaning": "Do not allow shields to overlap with other map elements already placed." }, "margin": { "css": "shield-margin", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No extra margin will be used to determine if a shield collides with any other text, shield, or marker.", "doc": "Minimum distance that a shield can be placed from any other text, shield, or marker." }, "repeat-distance": { "css": "shield-repeat-distance", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Shields with the same text will be rendered without restriction.", "doc": "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." }, "minimum-distance": { "css": "shield-min-distance", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Shields with the same text will be rendered without restriction.", "doc": "Minimum distance to any other collision object. Deprecated: replaced by `shield-margin`.", "status": "deprecated" }, "spacing": { "css": "shield-spacing", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Only one shield per line will attempt to be placed.", "doc": "Distance the renderer should use to try to place repeated shields on a line." }, "minimum-padding": { "css": "shield-min-padding", "expression":true, "default-value": 0.0, "doc": "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.", "default-meaning": "No margin will be used to detect if a shield is nearby a tile boundary.", "type": "float" }, "label-position-tolerance": { "css": "shield-label-position-tolerance", "default-value": "shield-spacing/2.0", "type": "float", "expression":true, "default-meaning": "If a shield cannot be placed then the renderer will advance by shield-spacing/2.0 to try placement again.", "doc": "Allows the shield to be displaced from its ideal position by a number of pixels (only works with placement:line)." }, "wrap-width": { "css": "shield-wrap-width", "type": "unsigned", "expression":true, "default-value": 0, "default-meaning": "Text will not be wrapped.", "doc": "Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap." }, "wrap-before": { "css": "shield-wrap-before", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "Wrapped lines will be a bit longer than wrap-width.", "doc": "Wrap text before wrap-width is reached." }, "wrap-character": { "css": "shield-wrap-character", "type": "string", "expression":true, "default-value": "\" \"", "default-meaning": "Lines will be wrapped conforming to the (untailored) Unicode Line Break Algorithm provided by ICU BreakIterator.", "doc": "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." }, "halo-fill": { "css": "shield-halo-fill", "type": "color", "expression":true, "default-value": "white", "doc": "Specifies the color of the halo around the text.", "default-meaning": "The shield halo text will be rendered white." }, "halo-radius": { "css": "shield-halo-radius", "default-value": 0.0, "default-meaning": "no halo.", "doc": "Specify the radius of the halo in pixels.", "type": "float", "expression":true }, "halo-rasterizer": { "css": "shield-halo-rasterizer", "type": [ "full", "fast" ], "expression":true, "default-value": "full", "default-meaning": "The shield will be rendered using the highest quality method rather than the fastest.", "doc": "Exposes an alternate text halo rendering method that sacrifices quality for speed." }, "halo-transform": { "css": "shield-halo-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "", "default-meaning": "No transformation.", "doc": "Transform shield halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor." }, "halo-comp-op": { "css": "shield-halo-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ], "expression":true }, "halo-opacity": { "css": "shield-halo-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text halo.", "default-value": 1.0, "type": "float", "expression":true, "default-meaning": "Fully opaque." }, "character-spacing": { "css": "shield-character-spacing", "type": "unsigned", "expression":true, "default-value": 0, "default-meaning": "The default character spacing of the font will be used.", "doc": "Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement." }, "line-spacing": { "css": "shield-line-spacing", "default-value": 0, "doc": "Vertical spacing between lines of multiline labels (in pixels).", "type": "float", "expression":true, "default-meaning": "The default font spacing will be used." }, "dx": { "css": "shield-text-dx", "type": "float", "expression":true, "doc": "Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the shield right.", "default-meaning": "Text will not be displaced.", "default-value": 0.0 }, "dy": { "css": "shield-text-dy", "type": "float", "expression":true, "doc": "Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the shield down.", "default-meaning": "Text will not be displaced.", "default-value": 0.0 }, "shield-dx": { "css": "shield-dx", "type": "float", "expression":true, "doc": "Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right.", "default-meaning": "Shield will not be displaced.", "default-value": 0.0 }, "shield-dy": { "css": "shield-dy", "type": "float", "expression":true, "doc": "Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down.", "default-meaning": "Shield will not be displaced.", "default-value": 0.0 }, "opacity": { "css": "shield-opacity", "type": "float", "expression":true, "doc": "The opacity of the image used for the shield.", "default-meaning": "Color is fully opaque.", "default-value": 1.0 }, "text-opacity": { "css": "shield-text-opacity", "type": "float", "expression":true, "doc": "The opacity of the text placed on top of the shield.", "default-meaning": "Color is fully opaque.", "default-value": 1.0 }, "horizontal-alignment": { "css": "shield-horizontal-alignment", "type": [ "left", "middle", "right", "auto" ], "expression":true, "doc": "The shield's horizontal alignment from its centerpoint.", "default-meaning": "TODO.", "default-value": "auto" }, "vertical-alignment": { "css": "shield-vertical-alignment", "type": [ "top", "middle", "bottom", "auto" ], "expression":true, "doc": "The shield's vertical alignment from its centerpoint.", "default-meaning": "TODO.", "default-value": "middle" }, "placement-type": { "css": "shield-placement-type", "doc": "Re-position and/or re-size shield to avoid overlaps. \"simple\" for basic algorithm (using shield-placements string,) \"dummy\" to turn this feature off.", "type": [ "dummy", "simple", "list" ], "expression":true, "default-meaning": "Alternative placements will not be enabled.", "default-value": "dummy" }, "placements": { "css": "shield-placements", "type": "string", "expression":true, "default-value": "", "default-meaning": "No alternative placements will be used.", "doc": "If \"placement-type\" is set to \"simple\", use this \"POSITIONS,[SIZES]\" string. An example is `shield-placements: \"E,NE,SE,W,NW,SW\";`." }, "text-transform": { "css": "shield-text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize", "reverse" ], "expression":true, "doc": "Transform the case of the characters.", "default-meaning": "No text transformation will be applied.", "default-value": "none" }, "justify-alignment": { "css": "shield-justify-alignment", "type": [ "left", "center", "right", "auto" ], "expression":true, "doc": "Define how text in a shield's label is justified.", "default-meaning": "TODO.", "default-value": "auto" }, "transform": { "css": "shield-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform shield instance with specified function. Ignores map scale factor." }, "clip": { "css": "shield-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "shield-simplify", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "Simplify the geometries used for shield placement by the given tolerance." }, "simplify-algorithm": { "css": "shield-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression": true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "Simplify the geometries used for shield placement by the given algorithm." }, "smooth": { "css": "shield-smooth", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "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." }, "comp-op": { "css": "shield-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "line-pattern": { "default": { "css": "line-pattern", "type": [ "none" ], "doc": "Allows omitting a line pattern symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "line-pattern-file", "type": "uri", "expression":true, "default-value": "none", "required": true, "doc": "An image file to be repeated and warped along a line. Accepted formats: svg, jpg, png, tiff, and webp.", "default-meaning": "" }, "clip": { "css": "line-pattern-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "opacity": { "css": "line-pattern-opacity", "type": "float", "expression":true, "doc": "Apply an opacity level to the image used for the pattern.", "default-value": 1.0, "default-meaning": "The image is rendered without modifications." }, "simplify": { "css": "line-pattern-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "geometries are simplified by the given tolerance." }, "simplify-algorithm": { "css": "line-pattern-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "geometries are simplified by the given algorithm." }, "smooth": { "css": "line-pattern-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "offset": { "css": "line-pattern-offset", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "The line will not be offset.", "doc": "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)." }, "geometry-transform": { "css": "line-pattern-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform line geometry with specified function and apply pattern to transformed geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "transform": { "css": "line-pattern-transform", "type": "functions", "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform line pattern instance with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "line-pattern-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "polygon-pattern": { "default": { "css": "polygon-pattern", "type": [ "none" ], "doc": "Allows omitting a polygon pattern symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "polygon-pattern-file", "type": "uri", "expression":true, "default-value": "none", "required": true, "doc": "Image to use as a repeated pattern fill within a polygon. Accepted formats: svg, jpg, png, tiff, and webp.", "default-meaning": "" }, "alignment": { "css": "polygon-pattern-alignment", "type": [ "global", "local" ], "expression":true, "default-value": "global", "doc": "Specify whether to align pattern fills to the layer's geometry (local) or to the map (global).", "default-meaning":"Patterns will be aligned to the map (or tile boundaries) when being repeated across polygons. This is ideal for seamless patterns in tiled rendering." }, "gamma": { "css": "polygon-pattern-gamma", "type": "float", "expression":true, "default-value": 1.0, "default-meaning": "Fully antialiased.", "range": "0-1", "doc": "Level of antialiasing of polygon pattern edges." }, "opacity": { "css": "polygon-pattern-opacity", "type": "float", "expression":true, "doc": "Apply an opacity level to the image used for the pattern.", "default-value": 1.0, "default-meaning": "The image is rendered without modifications." }, "clip": { "css": "polygon-pattern-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "polygon-pattern-simplify", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "geometries are simplified by the given tolerance." }, "simplify-algorithm": { "css": "polygon-pattern-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression":true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "geometries are simplified by the given algorithm." }, "smooth": { "css": "polygon-pattern-smooth", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "Smooths out geometry angles. 0 is no smoothing, 1 is fully smoothed. Values greater than 1 will produce wild, looping geometries." }, "geometry-transform": { "css": "polygon-pattern-geometry-transform", "type": "functions", "default-value": "none", "default-meaning": "The geometry will not be transformed.", "doc": "Transform polygon geometry with specified function and apply pattern to transformed geometry.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "transform": { "css": "polygon-pattern-transform", "type": "functions", "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform polygon pattern instance with specified function.", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ] }, "comp-op": { "css": "polygon-pattern-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "raster": { "default": { "css": "raster", "type": [ "auto", "none" ], "doc": "Allows omitting a raster symbolizer rule or emitting it with default values.", "status": "unstable" }, "opacity": { "css": "raster-opacity", "default-value": 1.0, "default-meaning": "Color is fully opaque.", "type": "float", "doc": "The opacity of the raster symbolizer on top of other symbolizers." }, "filter-factor": { "css": "raster-filter-factor", "default-value": -1.0, "default-meaning": "Allow the datasource to choose appropriate downscaling.", "type": "float", "doc": "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." }, "scaling": { "css": "raster-scaling", "type": [ "near", "fast", "bilinear", "bicubic", "spline16", "spline36", "hanning", "hamming", "hermite", "kaiser", "quadric", "catrom", "gaussian", "bessel", "mitchell", "sinc", "lanczos", "blackman" ], "default-value": "near", "default-meaning": "Nearest neighboor resampling will be used to scale the image to the target size of the map.", "doc": "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." }, "mesh-size": { "css": "raster-mesh-size", "default-value": 16, "default-meaning": "Reprojection mesh will be 1/16 of the resolution of the source image.", "type": "unsigned", "doc": "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." }, "comp-op": { "css": "raster-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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-mode": { "css": "raster-colorizer-default-mode", "type": [ "discrete", "linear", "exact" ], "doc": "This can be either `discrete`, `linear` or `exact`. If it is not specified then the default is `linear`.", "default-value": "linear", "default-meaning": "A linear interpolation is used to generate colors between the two nearest stops." }, "default-color": { "css": "raster-colorizer-default-color", "type": "color", "doc": "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.", "default-value": "transparent", "default-meaning": "Pixels that are not colored by the colorizer stops will be transparent." }, "epsilon": { "css": "raster-colorizer-epsilon", "type": "float", "doc": "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.", "default-value": "1.1920928955078125e-07", "default-meaning": "Pixels must very closely match the stop filter otherwise they will not be colored." }, "stop": { "css": "raster-colorizer-stops", "type": "tags", "serialization": "tag", "tagname": "tagname", "doc": "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)`.", "default-value": "", "default-meaning": "No colorization will happen without supplying stops." } }, "point": { "default": { "css": "point", "type": [ "auto", "none" ], "doc": "Allows omitting a point symbolizer rule or emitting it with default values.", "status": "unstable" }, "file": { "css": "point-file", "type": "uri", "expression":true, "required": false, "default-value": "none", "default-meaning": "A 4x4 black square will be rendered.", "doc": "Image file to represent a point. Accepted formats: svg, jpg, png, tiff, and webp." }, "allow-overlap": { "css": "point-allow-overlap", "type": "boolean", "expression":true, "default-value": false, "doc": "Control whether overlapping points are shown or hidden.", "default-meaning": "Do not allow points to overlap with each other - overlapping markers will not be shown." }, "ignore-placement": { "css": "point-ignore-placement", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "do not store the bbox of this geometry in the collision detector cache.", "doc": "Control whether the placement of the feature will prevent the placement of other features." }, "opacity": { "css": "point-opacity", "type": "float", "expression":true, "default-value": 1.0, "default-meaning": "Fully opaque.", "doc": "A value from 0 to 1 to control the opacity of the point." }, "placement": { "css": "point-placement", "type": [ "centroid", "interior" ], "expression":true, "doc": "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.", "default-meaning": "The centroid of the geometry will be used to place the point.", "default-value": "centroid" }, "transform": { "css": "point-transform", "type": "functions", "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "none", "default-meaning": "No transformation.", "doc": "Transform point instance with specified function. Ignores map scale factor." }, "comp-op": { "css": "point-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true } }, "text": { "default": { "css": "text", "type": [ "none" ], "doc": "Allows omitting a text symbolizer rule.", "status": "unstable" }, "name": { "css": "text-name", "type": "string", "expression":true, "required": true, "default-value": "none", "serialization": "content", "doc": "Value to use for a text label. Data columns are specified using brackets like [column_name].", "default-meaning": "" }, "face-name": { "css": "text-face-name", "type": "string", "expression":false, "validate": "font", "default-value": "none", "doc": "Font name and style to render a label in.", "required": true, "default-meaning": "" }, "size": { "css": "text-size", "type": "float", "expression":true, "default-value": 10.0, "doc": "Text size in pixels.", "default-meaning": "Font size of 10 will be used to render text." }, "text-ratio": { "css": "text-ratio", "doc": "Define the amount of text (of the total) present on successive lines when wrapping occurs.", "default-value": 0, "type": "unsigned", "expression":true, "default-meaning":"TODO." }, "wrap-width": { "css": "text-wrap-width", "doc": "Length of a chunk of text in pixels before wrapping text. If set to zero, text doesn't wrap.", "default-value": 0, "type": "unsigned", "expression":true, "default-meaning": "Text will not be wrapped." }, "wrap-before": { "css": "text-wrap-before", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "Wrapped lines will be a bit longer than wrap-width.", "doc": "Wrap text before wrap-width is reached." }, "wrap-character": { "css": "text-wrap-character", "type": "string", "expression":true, "default-value": "\" \"", "default-meaning": "Lines will be wrapped conforming to the (untailored) Unicode Line Break Algorithm provided by ICU BreakIterator.", "doc": "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." }, "repeat-wrap-character": { "css": "text-repeat-wrap-character", "type": "boolean", "expression": true, "default-value": false, "default-meaning": "Character will be removed when used to wrap a line.", "doc": "Keep the character used to wrap a line instead of removing it, and repeat it on the new line.", "status": "unstable" }, "spacing": { "css": "text-spacing", "type": "unsigned", "expression":true, "default-value": 0, "default-meaning": "Only one label per line will attempt to be placed.", "doc": "Distance the renderer should use to try to place repeated text labels on a line." }, "character-spacing": { "css": "text-character-spacing", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "The default character spacing of the font will be used.", "doc": "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." }, "line-spacing": { "css": "text-line-spacing", "default-value": 0, "type": "float", "expression":true, "default-meaning": "The default font spacing will be used.", "doc": "Vertical spacing adjustment between lines in pixels." }, "label-position-tolerance": { "css": "text-label-position-tolerance", "default-value": "text-spacing/2.0", "type": "float", "expression":true, "default-meaning": "If a shield cannot be placed then the renderer will advance by text-spacing/2.0 to try placement again.", "doc": "Allows the label to be displaced from its ideal position by a number of pixels (only works with placement:line)." }, "max-char-angle-delta": { "css": "text-max-char-angle-delta", "type": "float", "expression":true, "default-value": 22.5, "default-meaning":"The label will not be placed if a character falls on a line with an angle sharper than 22.5 degrees.", "doc": "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." }, "fill": { "css": "text-fill", "type": "color", "expression":true, "doc": "Specifies the color for the text.", "default-value": "black", "default-meaning": "The text will be rendered black." }, "opacity": { "css": "text-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text.", "default-value": 1.0, "expression":true, "default-meaning": "Fully opaque.", "type": "float" }, "halo-opacity": { "css": "text-halo-opacity", "doc": "A number from 0 to 1 specifying the opacity for the text halo.", "default-value": 1.0, "type": "float", "expression":true, "default-meaning": "Fully opaque." }, "halo-fill": { "css": "text-halo-fill", "type": "color", "expression":true, "default-value": "white", "default-meaning": "The halo will be rendered white.", "doc": "Specifies the color of the halo around the text." }, "halo-radius": { "css": "text-halo-radius", "doc": "Specify the radius of the halo in pixels.", "default-value": 0.0, "type": "float", "expression":true, "default-meaning": "no halo." }, "halo-rasterizer": { "css": "text-halo-rasterizer", "type": [ "full", "fast" ], "expression":true, "default-value": "full", "default-meaning": "The text will be rendered using the highest quality method rather than the fastest.", "doc": "Exposes an alternate text halo rendering method that sacrifices quality for speed." }, "halo-transform": { "css": "text-halo-transform", "type": "functions", "expression":true, "functions": [ ["matrix", 6], ["translate", 2], ["scale", 2], ["rotate", 3], ["skewX", 1], ["skewY", 1] ], "default-value": "", "default-meaning": "No transformation.", "doc": "Transform text halo relative to the actual text with specified function. Allows for shadow or embossed effects. Ignores map scale factor." }, "dx": { "css": "text-dx", "type": "float", "expression":true, "doc": "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.", "default-meaning": "Text will not be displaced.", "default-value": 0.0 }, "dy": { "css": "text-dy", "type": "float", "expression":true, "doc": "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.", "default-meaning": "Text will not be displaced.", "default-value": 0.0 }, "vertical-alignment": { "css": "text-vertical-alignment", "type": [ "top", "middle", "bottom", "auto" ], "expression":true, "doc": "Position of label relative to point position.", "default-value": "auto", "default-meaning": "Default affected by value of dy; \"top\" for dy>0, \"bottom\" for dy<0." }, "avoid-edges": { "css": "text-avoid-edges", "doc": "Avoid placing labels that intersect with tile boundaries.", "default-value": false, "type": "boolean", "expression":true, "default-meaning": "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." }, "margin": { "css": "text-margin", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "No extra margin will be used to determine if a label collides with any other text, shield, or marker.", "doc": "Minimum distance that a label can be placed from any other text, shield, or marker." }, "repeat-distance": { "css": "text-repeat-distance", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Labels with the same text will be rendered without restriction.", "doc": "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." }, "minimum-distance": { "css": "text-min-distance", "type": "float", "default-value": 0.0, "expression":true, "default-meaning": "Labels with the same text will be rendered without restriction.", "doc": "Minimum distance to the next label with the same text. Only works for line placement. Deprecated: replaced by `text-repeat-distance` and `text-margin`", "status": "deprecated" }, "minimum-padding": { "css": "text-min-padding", "default-value": 0.0, "type": "float", "expression":true, "doc": "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.", "default-meaning": "No margin will be used to detect if a text label is nearby a tile boundary." }, "minimum-path-length": { "css": "text-min-path-length", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "place labels on all geometries no matter how small they are.", "doc": "Place labels only on polygons and lines with a bounding width longer than this value (in pixels)." }, "allow-overlap": { "css": "text-allow-overlap", "type": "boolean", "expression":true, "default-value": false, "doc": "Control whether overlapping text is shown or hidden.", "default-meaning": "Do not allow text to overlap with other text - overlapping markers will not be shown." }, "orientation": { "css": "text-orientation", "type": "float", "expression":true, "default-value": 0.0, "doc": "Rotate the text. (only works with text-placement:point).", "default-meaning": "Text is not rotated and is displayed upright." }, "rotate-displacement": { "css": "text-rotate-displacement", "type": "boolean", "doc": "Rotates the displacement around the placement origin by the angle given by \"orientation\".", "default-value": false, "default-meaning": "Label center is used for rotation." }, "upright": { "css": "text-upright", "default-value": "auto", "type": [ "auto", "auto-down", "left", "right", "left-only", "right-only" ], "expression":true, "default-meaning": "Text will be positioned upright automatically.", "doc": "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." }, "placement": { "css": "text-placement", "default-value": "point", "type": [ "point", "line", "vertex", "interior" ], "expression":true, "default-meaning": "One shield will be placed per geometry.", "doc": "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." }, "placement-type": { "css": "text-placement-type", "doc": "Re-position and/or re-size text to avoid overlaps. \"simple\" for basic algorithm (using text-placements string,) \"dummy\" to turn this feature off.", "type": [ "dummy", "simple", "list" ], "expression":true, "default-meaning": "Alternative placements will not be enabled.", "default-value": "dummy" }, "placements": { "css": "text-placements", "type": "string", "default-meaning": "No alternative placements will be used.", "default-value": "", "expression":true, "doc": "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": { "css": "text-transform", "type": [ "none", "uppercase", "lowercase", "capitalize", "reverse" ], "expression":true, "doc": "Transform the case of the characters.", "default-meaning": "Transform text instance with specified function. Ignores map scale factor.", "default-value": "none" }, "horizontal-alignment": { "css": "text-horizontal-alignment", "type": [ "left", "middle", "right", "auto", "adjust" ], "expression":true, "doc": "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`.", "default-value": "auto", "default-meaning":"TODO." }, "justify-alignment": { "css": "text-align", "type": [ "left", "right", "center", "auto" ], "expression":true, "doc": "Define how text is justified.", "default-value": "auto", "default-meaning": "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." }, "clip": { "css": "text-clip", "type": "boolean", "expression":true, "default-value": false, "default-meaning": "The geometry will not be clipped to map bounds before rendering.", "doc": "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." }, "simplify": { "css": "text-simplify", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "geometry will not be simplified.", "doc": "Simplify the geometries used for text placement by the given tolerance." }, "simplify-algorithm": { "css": "text-simplify-algorithm", "type": ["radial-distance", "zhao-saalfeld", "visvalingam-whyatt", "douglas-peucker" ], "expression": true, "default-value": "radial-distance", "default-meaning": "The geometry will be simplified using the radial distance algorithm.", "doc": "Simplify the geometries used for text placement by the given algorithm." }, "smooth": { "css": "text-smooth", "type": "float", "expression": true, "default-value": 0.0, "default-meaning": "No smoothing.", "range": "0-1", "doc": "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." }, "comp-op": { "css": "text-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": [ "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" ], "expression":true }, "halo-comp-op": { "css": "text-halo-comp-op", "default-value": "src-over", "default-meaning": "Add the current symbolizer on top of other symbolizer.", "doc": "Composite operation. This defines how this symbolizer should behave relative to symbolizers atop or below it.", "type": ["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" ], "expression":true }, "font-feature-settings": { "css": "text-font-feature-settings", "type": "string", "default-value": "", "default-meaning": "Default set of typographic features recommended by OpenType specification. Ligatures are turned off by default when `character-spacing` is greater than zero.", "doc": "Comma separated list of OpenType typographic features. The syntax and semantics conforms to `font-feature-settings` from W3C CSS." }, "largest-bbox-only": { "css": "text-largest-bbox-only", "type": "boolean", "expression": true, "default-value": true, "default-meaning": "For multipolygons only polygon with largest bbox area is labeled (does not apply to other geometries).", "doc": "Controls default labeling behavior on multipolygons. The default is true and means that only the polygon with largest bbox is labeled.", "status": "experimental" } }, "building": { "default": { "css": "building", "type": [ "auto", "none" ], "doc": "Allows omitting a building symbolizer rule or emitting it with default values.", "status": "unstable" }, "fill": { "css": "building-fill", "expression":true, "type":"color", "default-value": "The color gray will be used for fill.", "default-meaning": "Gray and fully opaque (alpha = 1), same as rgb(128,128,128) or rgba(128,128,128,1).", "doc": "The color of the buildings fill. Note: 0.8 will be used to multiply each color component to auto-generate a darkened wall color." }, "fill-opacity": { "css": "building-fill-opacity", "type": "float", "expression":true, "doc": "The opacity of the building as a whole, including all walls.", "default-value": 1.0, "default-meaning": "Color is fully opaque." }, "height": { "css": "building-height", "doc": "The height of the building in pixels.", "type": "float", "expression":true, "default-value": 0.0, "default-meaning": "Buildings will not have a visual height and will instead look like flat polygons." } }, "debug": { "mode": { "css": "debug-mode", "type": [ "collision", "vertex" ], "default-value": "collision", "doc": "The mode for debug rendering.", "expression":true, "default-meaning": "The otherwise invisible collision boxes will be rendered as squares on the map." } }, "dot": { "default": { "css": "dot", "type": [ "auto", "none" ], "doc": "Allows omitting a dot symbolizer rule or emitting it with default values.", "status": "unstable" }, "fill": { "css": "dot-fill", "default-value": "gray", "doc": "The color of the area of the dot.", "type": "color", "expression":true, "default-meaning": "The dot fill color is gray." }, "opacity": { "css": "dot-opacity", "doc": "The overall opacity of the dot.", "default-value": 1.0, "default-meaning": "The opacity of the dot.", "type": "float", "expression":true }, "width": { "css": "dot-width", "default-value": 1.0, "doc": "The width of the dot in pixels.", "type": "float", "expression":true, "default-meaning": "The marker width is 1 pixel." }, "height": { "css": "dot-height", "default-value": 1.0, "doc": "The height of the dot in pixels.", "type": "float", "expression":true, "default-meaning": "The marker height is 1 pixels." }, "comp-op": { "css": "dot-comp-op", "default-value": "src-over", "default-meaning": "Add the current layer on top of other layers.", "doc": "Composite operation. This defines how this layer should behave relative to layers atop or below it.", "type": [ "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" ] } } }, "colors": { "aliceblue": [240, 248, 255], "antiquewhite": [250, 235, 215], "aqua": [0, 255, 255], "aquamarine": [127, 255, 212], "azure": [240, 255, 255], "beige": [245, 245, 220], "bisque": [255, 228, 196], "black": [0, 0, 0], "blanchedalmond": [255,235,205], "blue": [0, 0, 255], "blueviolet": [138, 43, 226], "brown": [165, 42, 42], "burlywood": [222, 184, 135], "cadetblue": [95, 158, 160], "chartreuse": [127, 255, 0], "chocolate": [210, 105, 30], "coral": [255, 127, 80], "cornflowerblue": [100, 149, 237], "cornsilk": [255, 248, 220], "crimson": [220, 20, 60], "cyan": [0, 255, 255], "darkblue": [0, 0, 139], "darkcyan": [0, 139, 139], "darkgoldenrod": [184, 134, 11], "darkgray": [169, 169, 169], "darkgreen": [0, 100, 0], "darkgrey": [169, 169, 169], "darkkhaki": [189, 183, 107], "darkmagenta": [139, 0, 139], "darkolivegreen": [85, 107, 47], "darkorange": [255, 140, 0], "darkorchid": [153, 50, 204], "darkred": [139, 0, 0], "darksalmon": [233, 150, 122], "darkseagreen": [143, 188, 143], "darkslateblue": [72, 61, 139], "darkslategrey": [47, 79, 79], "darkturquoise": [0, 206, 209], "darkviolet": [148, 0, 211], "deeppink": [255, 20, 147], "deepskyblue": [0, 191, 255], "dimgray": [105, 105, 105], "dimgrey": [105, 105, 105], "dodgerblue": [30, 144, 255], "firebrick": [178, 34, 34], "floralwhite": [255, 250, 240], "forestgreen": [34, 139, 34], "fuchsia": [255, 0, 255], "gainsboro": [220, 220, 220], "ghostwhite": [248, 248, 255], "gold": [255, 215, 0], "goldenrod": [218, 165, 32], "gray": [128, 128, 128], "grey": [128, 128, 128], "green": [0, 128, 0], "greenyellow": [173, 255, 47], "honeydew": [240, 255, 240], "hotpink": [255, 105, 180], "indianred": [205, 92, 92], "indigo": [75, 0, 130], "ivory": [255, 255, 240], "khaki": [240, 230, 140], "lavender": [230, 230, 250], "lavenderblush": [255, 240, 245], "lawngreen": [124, 252, 0], "lemonchiffon": [255, 250, 205], "lightblue": [173, 216, 230], "lightcoral": [240, 128, 128], "lightcyan": [224, 255, 255], "lightgoldenrodyellow": [250, 250, 210], "lightgray": [211, 211, 211], "lightgreen": [144, 238, 144], "lightgrey": [211, 211, 211], "lightpink": [255, 182, 193], "lightsalmon": [255, 160, 122], "lightseagreen": [32, 178, 170], "lightskyblue": [135, 206, 250], "lightslategray": [119, 136, 153], "lightslategrey": [119, 136, 153], "lightsteelblue": [176, 196, 222], "lightyellow": [255, 255, 224], "lime": [0, 255, 0], "limegreen": [50, 205, 50], "linen": [250, 240, 230], "magenta": [255, 0, 255], "maroon": [128, 0, 0], "mediumaquamarine": [102, 205, 170], "mediumblue": [0, 0, 205], "mediumorchid": [186, 85, 211], "mediumpurple": [147, 112, 219], "mediumseagreen": [60, 179, 113], "mediumslateblue": [123, 104, 238], "mediumspringgreen": [0, 250, 154], "mediumturquoise": [72, 209, 204], "mediumvioletred": [199, 21, 133], "midnightblue": [25, 25, 112], "mintcream": [245, 255, 250], "mistyrose": [255, 228, 225], "moccasin": [255, 228, 181], "navajowhite": [255, 222, 173], "navy": [0, 0, 128], "oldlace": [253, 245, 230], "olive": [128, 128, 0], "olivedrab": [107, 142, 35], "orange": [255, 165, 0], "orangered": [255, 69, 0], "orchid": [218, 112, 214], "palegoldenrod": [238, 232, 170], "palegreen": [152, 251, 152], "paleturquoise": [175, 238, 238], "palevioletred": [219, 112, 147], "papayawhip": [255, 239, 213], "peachpuff": [255, 218, 185], "peru": [205, 133, 63], "pink": [255, 192, 203], "plum": [221, 160, 221], "powderblue": [176, 224, 230], "purple": [128, 0, 128], "red": [255, 0, 0], "rosybrown": [188, 143, 143], "royalblue": [65, 105, 225], "saddlebrown": [139, 69, 19], "salmon": [250, 128, 114], "sandybrown": [244, 164, 96], "seagreen": [46, 139, 87], "seashell": [255, 245, 238], "sienna": [160, 82, 45], "silver": [192, 192, 192], "skyblue": [135, 206, 235], "slateblue": [106, 90, 205], "slategray": [112, 128, 144], "slategrey": [112, 128, 144], "snow": [255, 250, 250], "springgreen": [0, 255, 127], "steelblue": [70, 130, 180], "tan": [210, 180, 140], "teal": [0, 128, 128], "thistle": [216, 191, 216], "tomato": [255, 99, 71], "turquoise": [64, 224, 208], "violet": [238, 130, 238], "wheat": [245, 222, 179], "white": [255, 255, 255], "whitesmoke": [245, 245, 245], "yellow": [255, 255, 0], "yellowgreen": [154, 205, 50], "transparent": [0, 0, 0, 0] }, "filter": { "value": [ "true", "false", "null", "point", "linestring", "polygon", "collection" ] } } mapnik-reference-8.10.0/CHANGELOG.md000066400000000000000000000246741342311331100166310ustar00rootroot00000000000000## CHANGELOG ### 8.10.0 * Added support for mapnik 3.0.22 * Added new options `line-pattern-type`, `line-pattern-alignment`, `line-pattern-width`, `line-pattern-cap`, `line-pattern-join`, `line-pattern-miterlimit`, `line-pattern-dasharray` * Fixed deprecation message of `shield-min-distance` ### 8.9.2 * Deprecated `minzoom` and `maxzoom` in favor of `minimum-scale-denominator` and `maximum-scale-denominator` * Added `text-offset` and `shield-offset` ### 8.9.1 * Fixed missing options in datasource template for GDAL ### 8.9.0 * Added support for mapnik 3.0.20 * Fixed default value for `polygon-fill` * Ramer douglas peucker algorithm added to the list of simplification algorithms * Better documentation for `wrap-character` * `shield-min-distance` marked deprecated, fixed description * Added new `text-placement` and `shield-placement` values `grid` and `alternating-grid` * Added `band`, `nodata`, `nodata_tolerance`, `shared` options of GDAL datasource ### 8.8.1 * Removed some wrong `auto` keywords on rules for the whole symbolizer where the symbolizer had required properties ### 8.8.0 * Removed * symbolizer and reference rules within `style` instead * Added rules that work on the whole symbolizer and allow to either suppress it or output it with default values ### 8.7.0 * Removed generating index.js on prepublish and postpublish and add index.js to version control instead * Added `cache-features` * Removed redundant type for `debug-mode` ### 8.6.1 * Fixed a problem with generating index.js on Git installs with NPM ### 8.6.0 * Support for running in the browser ### 8.5.6 * Changed wording on description for `marker-opacity` * Added `polygon-pattern-transform` and `line-pattern-transform` * Fixed datatype of `shield-line-spacing` and `text-line-spacing` * Fixed a typo ### 8.5.5 * Fix ref loading bug ### 8.5.4 * Add support for loading latest reference using sevmer (https://github.com/mapnik/mapnik-reference/issues/108) ### 8.5.3 * Added support for mapnik 3.0.10 ### 8.52 * Added support for mapnik 3.0.9 ### 8.5.1 * Added support for mapnik 3.0.7 ### 8.5.0 * Fixed missing support for `inline` and `filesize_max` options in some datasource refs. * Added support for mapnik 3.0.6 * Added `key_field_as_attribute` option for Postgis datasource ### 8.4.0 * Added support for mapnik 3.0.5 ### 8.3.0 * Added support for mapnik 3.0.4 ### 8.2.0 * Added support for mapnik 3.0.3 * Added new colorblind filters ### 8.0.0 * Added `miter-revert` to `stroke-linejoin` * Renamed `left-only` and `right-only` of `text-upright` to use hyphens rather than underscores (https://github.com/mapnik/mapnik/pull/2682) * Added `repeat-wrap-character` (unstable, https://github.com/mapnik/mapnik/issues/2333) * Added `largest-bbox-only` (experimental) * Added `rotate-displacement` * Added `status` key to symbolizer property scheme (https://github.com/mapnik/mapnik-reference/issues/101) ### 7.0.1 * Added `topojson` datasource * Added `text-upright:auto-down;` ### 7.0.0 * Added `text-transform:reverse` * Added `text-upright` * Added `marker-direction` (https://github.com/mapnik/mapnik/pull/2621) * Changed API to lazily load each reference (helps avoid `require` performance cost). Changes are: - Removed `mapnik-reference.version` object - Added `mapnik-reference.versions` array - Added `mapnik-reference.load()` function. Accepts ref version string, returns the reference instance ### 6.0.5 * Added `dots` symbolizer ### 6.0.4 * Doc improvements ### 6.0.3 * Fix a typo in text-opacity css name. ### 6.0.2 * Added `font-feature-settings` for v3.0.0 ref (@talaj) * Updated `text-character-spacing` and `text-dy` doc for v3.0.0 ref (@talaj) ### 6.0.1 * Now reporting Mapnik 3.0.0 ### 6.0.0 * Format change: now properties that are expressions report `expression:true` and their `type` represents the expected type post-evaluation. ### 5.1.1 * Added more docs and default value descriptions * Added `text-font-feature-settings` (https://github.com/mapnik/mapnik/pull/2416) * Added `adjust` option to `text-horizontal-alignment` (https://github.com/mapnik/mapnik/pull/2426) * Added `marker-avoid-edges`, `marker-simplify`, `marker-simplify-algorithm`, and `marker-offset` * Added `text-halo-opacity`, `text-halo-comp-op`, `shield-halo-opacity`, and `shield-halo-comp-op` ### 5.1.0 Tagged Sep 4, 2014 * Updated new default of `clip:false` for Mapnik >= 3.x * Added `shield-label-position-tolerance` * Added `vertex-first` and `vertex-last` `marker-placement` options (https://github.com/mapnik/mapnik/pull/2338) * Removed `bilinear8` option for `scaling` (https://github.com/mapnik/mapnik/issues/2076) * Added `line-pattern-opacity` * Removed `wrap-character` (https://github.com/mapnik/mapnik/issues/2333) * Added `linear-dodge`, `linear-burn`, and `divide` to `comp-op` * Added `text-halo-transform` and `shield-halo-transform` * Changed `polygon-pattern-alignment` default to `global` * Improved coverage of docs overall. ### 5.0.9 Tagged Apr 25, 2014 * Added `shield-halo-rasterizer` ### 5.0.8 Tagged Apr 10, 2014 * Added `v2.3.0` reference * Added `image-filters-inflate` * Re-enable colorize-alpha for 2.2.0 * Added experimental support for `text-placement-type:list` and `shield-placement-type:list` * Moved `fill`, `stroke-width`, and `opacity` on all symbolizers to expressions targeting Mapnik 3.x ### 5.0.7 Tagged Oct 25, 2013 * Added `v2.2.0` reference ### 5.0.6 Tagged Sept 26, 2013 Updated when Mapnik 2.3.x was at 68ff3ce. * Added `color-to-alpha` image filter ### 5.0.5 Tagged Sept 19, 2013 Updated when Mapnik master was at 2ebd3e9bf8. * Removed uneeded `description` properties. * Corrected the `text-min-padding` doc to note that it only relates to whether a label is within a given distance of the edge of a (meta)tile not other text. * Added Map `background-image-opacity` and `background-image-comp-op` * Added `line-pattern-offset` * Added `direct-image-filters` * Added `scale-hsla` `image-filter` * Added `raster-colorizer` * Added `text-halo-rasterizer` * Added `geometry-transform` * Added `shield-transform`, `shield-placements`, and `shield-placement-type` * Added `debug-mode` to visualize collision boxes * Moved experimental `latest/datasources.json` to `latest/datasources.template` so `datasources.json` now is fully baked ### 5.0.4 Tagged February 5th, 2013 Updated when Mapnik master was at 19e52c013639. * Exposed simplify and simplify-algorithm properties ### 5.0.3 Tagged January 2, 2013 Updated when Mapnik master was at fd089a228b7. * Added value keywords known by Mapnik for rhs filtering (#42) ### 5.0.2 Tagged November 29, 2012 Updated when Mapnik master was at 26889c4761e. * Added the obscure `shield-unlock-image` parameter, long supported by Mapnik. ### 5.0.1 Tagged November 26, 2012 Updated when Mapnik master was at c39c839452 and 2.1.x branch as at 0b2f2f8ee0. * Adds new reference for Mapnik 2.1.1 (upcoming) * Adds marker-multi-policy option for >= 2.1.1 ### 5.0.0 Tagged Sept 6, 2012 Updated when Mapnik master was at a513d3f97 * Updates the schema by introducing a `"unsigned"` type for integer values. Carto and other parsers will be backwards-compatible with values specified in floats by rounding them to integers. #### 4.0.5 Tagged Aug 30, 2012 Updated when Mapnik master was at 2e44e8c4 * Various docs fixes * Added `interior` option for `markers-placement` * Fixed required values for shields with Mapnik >= 2.1 * Added `map-maximum-extent` * Fixed up layer and style properties in all versions * Remove `font-set` which was uneeded * Fixed doc string for `marker-width`. #### 4.0.4 Tagged Aug 15, 2012 Updated when Mapnik master was at 4cf1484 * Removed experimental `colorize-alpha` comp-op to match Mapnik removal (https://github.com/mapnik/mapnik/issues/1371). #### 4.0.3 Tagged Aug 8, 2012 Updated when Mapnik master was at 7847af51e7 * Corrected internally reported versions for `latest` and `2.0.2` #### 4.0.2 Tagged Aug 8, 2012 Updated when Mapnik master was at 7847af51e7 * Made `point-file` optional * Added `marker-ignore-placement` to 2.0.1 as per backport (https://github.com/mapnik/mapnik/issues/1163) * Added new 2.0.2 reference - an exact copy of 2.0.1 as no changes were made in Mapnik between these releases #### 4.0.1 Tagged Aug 2, 2012 Updated when Mapnik master was at a22b31b0cc * Added `line-gamma-method` and `polygon-gamma-method` * Added `line-miterlimit` * Removed remaining `shield-no-text` from `latest/reference.json` #### 4.0.0 Tagged Aug 1, 2012 Updated when Mapnik master was at a22b31b0cc * Now `transform` properties are `functions` type * Added `fill-opacity` for markers * Exposed clip and smooth on all appropriate symbolizers * Declared `text-orientation` as expression type * Matched `transform` naming with Mapnik * Fixed default value for `raster-scaling` to `near` * Added more `raster-scaling` types: `near,spline36,hanning,hamming,hermite,kaiser,quadric,catrom,bessel,mitchell,sinc,blackman` * Removed `raster-mode`, use `raster-comp-op` instead * Added polygon-pattern-opacity - newly supported in Mapnik * Fixed up which symbolizers support `comp-op` (removed buildings, added line-pattern) * Removed `no-text` for shield symbolizer since Mapnik >= 2.1.x no longer uses this. * Fixed naming of `stroke-dashoffset` * Renamed all instances of `composite-operation` to `comp-op` to match mapnik/svg spec * Fixed `buffer-size` type in 2.0.1 reference (uri -> float) * Improved tests: run them with `make test` #### 3.1.0 * Add `shield-allow-overlap` * Add `shield-vertical-alignment` * Add `text-wrap-before` and `shield-wrap-before` * Made `marker-width`, `marker-height`, and `shield-name` expressions * Fixed default value for text/shield alignment properties #### 3.0.0 * Add `expression` type * Add `functions` type * Add transform function definitions for `point-transform` and, eventually, other transforms #### 2.2.2 * Fixed type definition of `font-directory` in reference targeting latest mapnik #### 2.2.1 * Fixed type definition of `font-directory`, ensuring it is interpreted as a uri #### 2.2.0 * Add `raster-comp-op` (temporarily named `raster-composite-operation`) #### 2.1.0 * Add `invert()` image filter function * Rename `color-spin` compositing to `colorize-alpha` #### 2.0.0 * The style-property `image-filters` becomes of the `functions` type and gains `[name, arity]` specs for each function. #### 1.0.0 * For the property `buffer-size` under the Map symbolizer, the CSS representation becomes `buffer-size`, not `buffer. #### 0.0.1 * Added symbolizer-specific `composite-operation` code. mapnik-reference-8.10.0/LICENSE.md000066400000000000000000000022731342311331100164130ustar00rootroot00000000000000This is free and unencumbered software released into the public domain. Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means. In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. For more information, please refer to mapnik-reference-8.10.0/Makefile000066400000000000000000000003271342311331100164450ustar00rootroot00000000000000all: build build: node scripts/make-datasource-ref.js check test: build python scripts/test.py node scripts/lint.js npm test testpack: rm -f ./*tgz npm pack tar -ztvf *tgz rm -f ./*tgz .PHONY: test buildmapnik-reference-8.10.0/README.md000066400000000000000000000057421342311331100162720ustar00rootroot00000000000000# mapnik-reference `mapnik-reference` is a spec of what Mapnik styling and datasource properties are supported for each version. It is useful for building parsers, tests, compilers, and syntax highlighting/checking for languages. [![Build Status](https://travis-ci.org/mapnik/mapnik-reference.svg)](https://travis-ci.org/mapnik/mapnik-reference) Default branch is `gh-pages` which is displayed at http://mapnik.org/mapnik-reference ## Versioning The version of this repository indicates the schema of the reference.json file. Schema changes of any type are expected to change the implementation requirements of a parser, so they will increment the major version of this repository in [semver style](http://semver.org/). The directories in this repository directly correspond to released versions of Mapnik and the next targeted release of Mapnik. ## Meaning The structure of the file is as such: * `version`: the version of Mapnik targeted. Same as the containing directory. * `style`: properties of the `Style` XML element * `layer`: properties of the `Layer` XML element * `symbolizers/*`: properties that apply to **all** symbolizers * `symbolizers/symbolizer`: properties that apply to **each** type of symbolizer * `colors`: named colors supported by Mapnik. see `include/mapnik/css_color_grammar.hpp` ### Property stability The `status` key may be used to define the stability of a property. When the key is not specified, then the `status` is `stable`. Possible values are: - **stable:** `property` is here to stay and its behavior is not anticipated to change - **unstable:** `property` is here to stay but its behavior/meaning of `property` may change - **deprecated:** `property` should not be used and will be removed in upcoming major version of Mapnik - **experimental:** `property` should not be used and may change, be re-named, or disappear at any time ## Using This is a valid [npm](http://npmjs.org/) module and therefore can easily be used with [node.js](http://nodejs.org/). npm install mapnik-reference Install it as a dependency of your application. Then use that API to get a reference instance for a specific version of Mapnik: ```javascript var mapnik_reference = require('mapnik-reference'); var ref = mapnik_reference.load('3.0.0'); ``` You can also get access to an array of all known versions: ```javascript var mapnik_reference = require('mapnik-reference'); mapnik_reference.versions; [ '2.0.0', '2.0.1', '2.0.2', '2.1.0', '2.1.1', '2.2.0', '2.3.0', '3.0.0' ] ``` Other implementations will want to simply copy the [JSON](http://www.json.org/) file from the desired implementation, like `2.0.1/reference.json`. The file can then be parsed with any of the many [json parsers](http://www.json.org/). ## Testing Tests require python and node.js: make test ## Users * [carto.js](https://github.com/mapbox/carto) * Mapnik itself (the util/validate-mapnik-instance.py is used to check binding consistency like in [#1427](https://github.com/mapnik/mapnik/issues/1427)) mapnik-reference-8.10.0/contributing.md000066400000000000000000000027171342311331100200430ustar00rootroot00000000000000## Contributing to Mapnik Reference We welcome contributions. Please provide pull requests and notify @springmeyer for review. ### Changing index.js Do not change index.js directly as it is generated. Modify index._ instead and run `node generate.js` instead. If the node binary is differently named on your operating system (e.g. nodejs) use that instead. ### Releasing 1) Create a milestone for the upcoming release - Assign tickets to it - Notify other contributors - Discuss, if needed, what the version # should be based on the types of changes anticipated 2) If the version in `package.json` is not already updated for the new release: - Update the version - Do a bump commit ```bash git commit -a -m "bump to v0.8.1" ``` Only bump the version when committing to master (not in pull requests). 3) Update the datasources: Run: ``` make ``` And commit the changes. This will edit the `datasources.json` based on the `datasources.template.json`. 4) Make sure all tests are passing on travis: [![Build Status](https://travis-ci.org/mapnik/mapnik-reference.svg?branch=master)](https://travis-ci.org/mapnik/mapnik-reference) 4) Ensure the changelog lists the upcoming version and details of what changed 5) Tag the new version and upload to github ```bash git tag -a v0.8.1 -m "tagging v0.8.1" git push --tags ``` 6) Publish to npm NOTE: make sure your git checkout is clean first: `git status` should show no changes or untracked files. ```bash npm publish ``` mapnik-reference-8.10.0/generate.js000066400000000000000000000013551342311331100171370ustar00rootroot00000000000000var fs = require('fs'), path = require('path'), semver = require('semver'), _ = require('lodash'); if (!fs.existsSync('index.js')) { var template = _.template(fs.readFileSync(path.join(__dirname, 'index._'), 'utf-8')); var getVersions = function () { var names = fs.readdirSync(__dirname); return names.filter(semver.valid); }; var versions = semver.sort(getVersions()); // These older versions don't have the datasource info var no_datasources = [ '2.0.0', '2.0.1', '2.0.2', '2.1.0', '2.1.1', '2.2.0' ]; fs.writeFileSync(path.join(__dirname, 'index.js'), template({ 'versions': versions, 'no_datasources': no_datasources })); } mapnik-reference-8.10.0/index._000066400000000000000000000050201342311331100162470ustar00rootroot00000000000000/* THIS FILE IS GENERATED PROGAMMATICALLY. DO NOT MODIFIY DIRECTLY. Modify index._ instead and run node generate.js */ var path = require('path'); var semver = require('semver'); var versions = [ <% _.forEach(versions, function (value, key) { print(" '" + value + "'"); if (key < versions.length - 1) { print(",\n"); } }); %> ]; // These older versions don't have the datasource info var no_datasources = [ <% _.forEach(no_datasources, function (value, key) { print(" '" + value + "'"); if (key < no_datasources.length - 1) { print(",\n"); } }); %> ]; module.exports.versions = versions; module.exports.latest = versions[versions.length - 1]; var getSatisfyingVersion = function (wanted) { var version = semver.maxSatisfying(versions, wanted), parsed; if (!version) { try { parsed = semver(wanted); parsed.patch = 'x'; version = semver.maxSatisfying(versions, parsed.format()); } catch (err) { version = null; } } return version; }; var loadBrowser = function (version) { var versionRefs = { <% _.forEach(versions, function (value, key) { print(" '" + value + "': {\n"); print(" 'ref': require('./" + value + "/reference.json'),\n"); print(" 'datasources': "); if (_.some(no_datasources, function (ds) { return value === ds; })) { print("null\n"); } else { print("require('./" + value + "/datasources.json').datasources\n"); } if (key < versions.length - 1) { print(" },\n"); } else { print(" }"); } }); %> }; var ref = versionRefs[version].ref; if (no_datasources.indexOf(version) <= -1) { ref.datasources = versionRefs[version].datasources; } return ref; }; var load = function (version) { var ref = require(path.join(__dirname, version, 'reference.json')); if (no_datasources.indexOf(version) <= -1) { ref.datasources = require(path.join(__dirname, version, 'datasources.json')).datasources; } return ref; }; module.exports.load = function(wanted) { var version = getSatisfyingVersion(wanted), ref; if (!version) { throw new Error("Unknown mapnik-reference version: '" + wanted + "'"); } if (process.browser) { ref = loadBrowser(version); } else { ref = load(version); } return ref; } mapnik-reference-8.10.0/index.html000066400000000000000000000053451342311331100170070ustar00rootroot00000000000000 Mapnik Reference

API Reference

Copyright © 2017 Artem Pavlenko | Downloads | License | Media
mapnik-reference-8.10.0/index.js000066400000000000000000000061511342311331100164530ustar00rootroot00000000000000/* THIS FILE IS GENERATED PROGAMMATICALLY. DO NOT MODIFIY DIRECTLY. Modify index._ instead and run node generate.js */ var path = require('path'); var semver = require('semver'); var versions = [ '2.0.0', '2.0.1', '2.0.2', '2.1.0', '2.1.1', '2.2.0', '2.3.0', '3.0.0', '3.0.3', '3.0.6', '3.0.20', '3.0.22', ]; // These older versions don't have the datasource info var no_datasources = [ '2.0.0', '2.0.1', '2.0.2', '2.1.0', '2.1.1', '2.2.0' ]; module.exports.versions = versions; module.exports.latest = versions[versions.length - 1]; var getSatisfyingVersion = function (wanted) { var version = semver.maxSatisfying(versions, wanted), parsed; if (!version) { try { parsed = semver(wanted); parsed.patch = 'x'; version = semver.maxSatisfying(versions, parsed.format()); } catch (err) { version = null; } } return version; }; var loadBrowser = function (version) { var versionRefs = { '2.0.0': { 'ref': require('./2.0.0/reference.json'), 'datasources': null }, '2.0.1': { 'ref': require('./2.0.1/reference.json'), 'datasources': null }, '2.0.2': { 'ref': require('./2.0.2/reference.json'), 'datasources': null }, '2.1.0': { 'ref': require('./2.1.0/reference.json'), 'datasources': null }, '2.1.1': { 'ref': require('./2.1.1/reference.json'), 'datasources': null }, '2.2.0': { 'ref': require('./2.2.0/reference.json'), 'datasources': null }, '2.3.0': { 'ref': require('./2.3.0/reference.json'), 'datasources': require('./2.3.0/datasources.json').datasources }, '3.0.0': { 'ref': require('./3.0.0/reference.json'), 'datasources': require('./3.0.0/datasources.json').datasources }, '3.0.3': { 'ref': require('./3.0.3/reference.json'), 'datasources': require('./3.0.3/datasources.json').datasources }, '3.0.6': { 'ref': require('./3.0.6/reference.json'), 'datasources': require('./3.0.6/datasources.json').datasources } }; var ref = versionRefs[version].ref; if (no_datasources.indexOf(version) <= -1) { ref.datasources = versionRefs[version].datasources; } return ref; }; var load = function (version) { var ref = require(path.join(__dirname, version, 'reference.json')); if (no_datasources.indexOf(version) <= -1) { ref.datasources = require(path.join(__dirname, version, 'datasources.json')).datasources; } return ref; }; module.exports.load = function(wanted) { var version = getSatisfyingVersion(wanted), ref; if (!version) { throw new Error("Unknown mapnik-reference version: '" + wanted + "'"); } if (process.browser) { ref = loadBrowser(version); } else { ref = load(version); } return ref; } mapnik-reference-8.10.0/package.json000066400000000000000000000007011342311331100172670ustar00rootroot00000000000000{ "author": "Mapnik Developers", "name": "mapnik-reference", "description": "Reference for Mapnik Styling Options", "version": "8.10.0", "repository": { "type": "git", "url": "git://github.com/mapnik/mapnik-reference.git" }, "scripts": { "test": "mocha -R spec --timeout 50000" }, "devDependencies": { "glob": "4.x", "mocha": "1.x" }, "dependencies": { "lodash": "^4.11.0", "semver": "^5.1.0" } } mapnik-reference-8.10.0/scripts/000077500000000000000000000000001342311331100164725ustar00rootroot00000000000000mapnik-reference-8.10.0/scripts/lint.js000066400000000000000000000043121342311331100177760ustar00rootroot00000000000000#!/usr/bin/env node var fs = require('fs'); var references = require(".."); var lint_ref = function(ver) { var ref = references.version[ver] var symbolizers = ref.symbolizers; for (var symbolizer in symbolizers) { //console.log(symbolizer); for (var prop in symbolizers[symbolizer]) { var sym = symbolizers[symbolizer][prop]; var group_name = symbolizer; if (group_name == "markers") { group_name = 'marker'; } if (group_name != 'map' && group_name != '*' && sym.css.indexOf(group_name) == -1) console.log('invalid prefix for property',sym.css,ver); if (!sym.type) { console.log('missing type for',sym.css,ver); } if (!sym.doc) { console.log('missing doc for',sym.css,ver); } // strictness with >= 3.x going forward if (+ver.split('.')[0] >= 3) { if (sym.doc && sym.doc.slice(-1) != '.') { console.log('missing ending period for doc of',sym.css); } if (sym['default-value'] === undefined) { console.log('missing default-value for',sym.css,ver); } if (sym['default-meaning'] === undefined) { console.log('missing default-meaning for',sym.css,sym['default-meaning']); } else { if (sym['default-meaning'] != "" && sym['default-meaning'].slice(-1) != '.') { console.log('missing ending period for doc of',sym.css,sym['default-meaning']); } } if (sym.required === true) { if (sym['default-value'] != "none") { console.log('expected default-value of none',sym.css,sym['default-value']); } if (sym['default-meaning'] != "") { console.log('expected default-meaning of ""',sym.css,sym['default-meaning']); } } } } } } for (var key in references.version) { lint_ref(key); }; mapnik-reference-8.10.0/scripts/make-datasource-ref.js000077500000000000000000000050331342311331100226530ustar00rootroot00000000000000var fs = require('fs'); var path = require('path'); var util = require('util'); var assert = require('assert'); var references = require(".."); var existsSync = require('fs').existsSync || require('path').existsSync; var options = { debug:false }; // TODO - add support for includes? js_numbers = { 'float':'number', 'unsigned':'number', 'string':'string', 'boolean':'boolean', } function validate_prop(types,prop_name,prop_value) { Object.keys(types).forEach(function(key) { var type_def = types[key]; if (type_def.required) { assert.ok(key in prop_value,key+' not defined for '+ prop_name); } if (type_def.values) { assert.ok(type_def.values.indexOf(prop_value.type) > -1,prop_value.type+' not found in '+ type_def.values); } if (prop_value['default-value']) { assert.ok(typeof(prop_value['default-value']) === js_numbers[prop_value.type],typeof(prop_value['default-value'])+' not === '+prop_value.type+ ' for '+prop_name) } }); } function process(data) { // expand gyp-like variables to build out entire file Object.keys(data.datasources).forEach(function(key) { var ds = data.datasources[key]; // handle commented sections if (key[0] == '#') { delete data.datasources[key]; } else { if (options.debug) console.warn('Handling '+key) Object.keys(ds).forEach(function(prop) { var match = ds[prop].match && ds[prop].match(/<@\((.+)\)/); if (match && match[1]) { ds[prop] = data.variables[prop]; if (options.debug) { console.warn(' handling variable for "'+prop+'"'); } } else { if (options.debug) { console.warn(' handling raw object for "'+prop+'"'); } } validate_prop(data.types,prop,ds[prop]); }); } }); } references.versions.forEach(function(key) { var template = path.join(__dirname,'..',key,'datasources.template.json'); if (existsSync(template)) { var data = JSON.parse(fs.readFileSync(template)); process(data); delete data.types; delete data.variables; var filepath = path.join(__dirname,'..',key,'datasources.json'); fs.writeFileSync(filepath,JSON.stringify(data,null," ")); } else { console.error('ref '+ key + ' missing datasources metadata') } }); mapnik-reference-8.10.0/scripts/test.py000077500000000000000000000006271342311331100200330ustar00rootroot00000000000000#!/usr/bin/env python import glob import os try: # <= python 2.5 import simplejson as json except ImportError: # >= python 2.6 import json versions = glob.glob('./*.*.*') for v in versions: ver = os.path.basename(v) reference = json.load(open('%s/reference.json' % v, 'r')) assert reference assert reference['version'] == ver,"%s not eq to %s" % (reference['version'],ver)mapnik-reference-8.10.0/scripts/validate-mapnik-instance.py000077500000000000000000000124171342311331100237240ustar00rootroot00000000000000#!/usr/bin/env python import os import sys import json import mapnik ##### WARNING: this script is out of date and does not yet work with Mapnik 3.x if not mapnik.mapnik_version() > 200100: print 'Error: this script is only designed to work with Mapnik 2.1 and above (you have %s)' % mapnik.mapnik_version_string() sys.exit(1) mapnik_version = mapnik.mapnik_version_string().replace('-pre','') reference_file = './%s/reference.json' % mapnik_version if not os.path.exists(reference_file): print 'Error: could not find file %s' % reference_file sys.exit(1) reference = json.load(open(reference_file, 'r')) type_mapping = { 'integer':'int', 'float':'float', 'unsigned':'int', 'boolean':'bool', 'uri':'str', 'string':'str', 'color':'mapnik.Color', 'expression':'mapnik.Expression', 'functions':'todo' } style = mapnik.Style() for prop in reference['style'].items(): key = prop[0].replace('-','_') assert hasattr(style,key), "'%s' not a valid property of Style" % key layer = mapnik.Layer('foo') for prop in reference['layer'].items(): key = prop[0].replace('-','_') assert hasattr(layer,key), "'%s' not a valid property of Layer" % key map_instance = mapnik.Map(256,256) for prop in reference['symbolizers']['map'].items(): key = prop[0].replace('-','_') # https://github.com/mapnik/mapnik/issues/1419 if not key in ['minimum_version','paths_from_xml','font_directory']: assert hasattr(map_instance,key), "'%s' not a valid property of Map" % key # https://github.com/mapnik/mapnik/issues/1427 text_fixups = { 'size':'text_size', 'opacity':'text_opacity', 'spacing':'label_spacing', 'max_char_angle_delta':'maximum_angle_char_delta', 'placement':'label_placement' } total_fails = 0 before = 0 for sym in reference['symbolizers'].items(): if sym[0] not in ['map','*']: #if sym[0] in ['raster']: sym_name = ''.join([s.title() for s in sym[0].split('-')]) sym_object = getattr(mapnik,sym_name+'Symbolizer') instance_var = None if sym_name in ['PolygonPattern','LinePattern']: instance_var = sym_object(mapnik.PathExpression('')) elif sym_name == 'Shield': instance_var = sym_object(mapnik.Expression('True'),'DejaVu Sans Book', 10, mapnik.Color('black'), mapnik.PathExpression('')) else: instance_var = sym_object() fails = [] for prop in sym[1]: key = prop.replace('-','_') if key == 'file': key = 'filename' if sym_name == 'Line' and 'stroke' in key: stroke_instance = instance_var.stroke if key == 'stroke': key = 'color' else: key = key.replace('stroke_','') if not hasattr(stroke_instance,key): fails.append("'%s' not a valid property of %s" % (key,'Stroke')) elif sym_name == 'Markers' and 'stroke' in key: stroke_instance = instance_var.stroke if not stroke_instance: # marker.stroke is boost::optional stroke_instance = mapnik.Stroke() if key == 'stroke': key = 'color' else: key = key.replace('stroke_','') if not hasattr(stroke_instance,key): fails.append("'%s' not a valid property of %s" % (key,'Stroke')) else: # temporary hotfix until: https://github.com/mapnik/mapnik/issues/1427 if sym_name in ['Text','Shield']: if key in text_fixups: key = text_fixups[key] if not hasattr(instance_var,key): fails.append("'%s' not a valid property of %s" % (key,sym_name)) else: attr_instance = getattr(instance_var,key) prop_type = sym[1][prop]['type'] if not isinstance(prop_type,list): mapnik_py_type = type_mapping[prop_type] # TODO - make mapnik.Expression ctor a proper class if attr_instance is None: continue if mapnik_py_type == 'mapnik.Expression': #expected_expr = "" expected_expr = "" if not str(type(attr_instance)) == expected_expr: print 'type error: %s for %s/%s is not %s (ex' % (type(attr_instance),sym_name,key) elif prop_type == 'functions': pass else: if not isinstance(attr_instance,eval(mapnik_py_type)): #print sym[1][prop] print 'type error: %s (actual) for %s/%s is not %s (expected)' % (type(attr_instance),sym_name,key,eval(mapnik_py_type)) if len(fails): print '\n\n%s -->\n' % (sym_name) for f in fails: print f #print '(' + '|'.join([i for i in dir(instance_var) if not '__' in i]) + ')' total_fails += len(fails); print '\n\nTotal issues: %s' % total_fails mapnik-reference-8.10.0/site/000077500000000000000000000000001342311331100157475ustar00rootroot00000000000000mapnik-reference-8.10.0/site/.eslintrc000066400000000000000000000004201342311331100175670ustar00rootroot00000000000000{ "env": { "browser": true }, "rules": { "quotes": [2, "single"], "curly": 0, "new-cap": 0, "strict": [2, "global"], "semi-spacing": 0 }, "globals": { "UI": true, "nanoajax": true } } mapnik-reference-8.10.0/site/main.css000066400000000000000000000025661342311331100174160ustar00rootroot00000000000000:link, :visited { color: #c7726b; } #menu { position: fixed; width: 170px; } #ref { margin-left: 170px; } #version:before { content: '—'; padding: 0 5px; } *:target { padding-top: 100px; } :target:link:hover { background-color: transparent; } .symbolizer { padding-bottom: 30px; } .symbolizer + .symbolizer { padding-top: 20px; border-top: 1px #ddd solid; } .status { float: right; border-radius: 1px; color: #fff; font-size: 0.7em; margin-left: 5px; padding: 2px 5px; vertical-align: middle; background-color: #EB974E; } .status.deprecated { background-color: #D64541; } .expressions-support { float: right; border-radius: 1px; color: #fff; font-size: 0.7em; margin-left: 5px; padding: 2px 5px; vertical-align: middle; background-color: #45C559; } p { margin-bottom: 5px; margin-top: 5px; } h2 { padding-top: 0; } h3 { margin-top: 20px; } .pad4y { text-align: right; } em, strong { font-size: 0.9em; } em { color: #aaa; } b { font-family: monospace; font-size: 0.9em; background-color: #eee; padding: 0 2px; } .versions a { color: #999; } .versions h5 { margin-top: 10px; } a.current:before { content: ' ✓ '; } a.current { color: #c7726b; } .headerBlock { margin-top: 10px; } .headerBlock a { display: block; } mapnik-reference-8.10.0/site/main.js000066400000000000000000000163111342311331100172330ustar00rootroot00000000000000'use strict'; (function (window) { var UI = function (version) { this.menu = document.querySelector('#menu .main'); this.container = document.querySelector('#symbolizers'); this.versionLabel = document.querySelector('#version'); this.fetchFromHash() || this.fetch(version); var self = this; window.addEventListener('hashchange', function () {self.fetchFromHash();}); }; UI.versions = ['3.0.22', '3.0.20', '3.0.6', '3.0.3', '3.0.0', '2.3.0', '2.2.0', '2.1.0', '2.0.0']; UI.prototype = { isArray: Array.isArray || function (obj) { return (Object.prototype.toString.call(obj) === '[object Array]'); }, inArray: function (array, el) { for (var i = 0; i < array.length; i++) if (array[i] === el) { return true; } return false; }, node: function (what, attrs, parent, content) { var el = document.createElement(what); for (var attr in attrs) el[attr] = attrs[attr]; if (parent) parent.appendChild(el); if (content) el.innerHTML = content; return el; }, fetch: function (version) { var self = this; this.version = version || window.UI.versions[0]; nanoajax.ajax('./' + this.version + '/reference.json', function (code, content) { self.build(JSON.parse(content)); }); return true; }, fetchFromHash: function () { var newVersion = window.location.hash.split('/')[0].replace('#', ''); if (newVersion !== this.version && this.inArray(UI.versions, newVersion)) return this.fetch(newVersion); }, build: function (ref) { this.container.innerHTML = ''; this.menu.innerHTML = ''; this.versionLabel.innerHTML = this.version; var hasStyleCss = false, hasLayerCss = false; for (var id in ref.style) { if (ref.style[id].hasOwnProperty('css')) { hasStyleCss = true; break; } } for (var id in ref.layer) { if (ref.layer[id].hasOwnProperty('css')) { hasLayerCss = true; break; } } if (hasStyleCss) { var styleMenu = this.node('h5', {className: 'headerBlock'}, this.menu); this.node('a', {href: '#' + this.version + '/style'}, styleMenu, 'Style'); } if (hasLayerCss) { var layerMenu = this.node('h5', {className: 'headerBlock'}, this.menu); this.node('a', {href: '#' + this.version + '/layer'}, layerMenu, 'Layer'); } var symbolizerMenu = this.node('h5', {className: 'headerBlock'}, this.menu); this.node('a', {href: '#' + this.version + '/symbolizers'}, symbolizerMenu, 'Symbolizers'); if (hasStyleCss) { var styleHeading = this.node('h2', {}, this.container); this.node('a', {id: this.version + '/style', href: '#' + this.version + '/style'}, styleHeading, 'Style'); var styleContainer = this.node('div', {className: 'symbolizer'}, this.container); for (var id in ref.style) { if (ref.style[id].hasOwnProperty('css')) { this.addRule(id, ref.style[id], styleContainer); } } } if (hasLayerCss) { var layerHeading = this.node('h2', {}, this.container); this.node('a', {id: this.version + '/layer', href: '#' + this.version + '/layer'}, layerHeading, 'Layer'); var layerContainer = this.node('div', {className: 'symbolizer'}, this.container); for (var id in ref.layer) { if (ref.layer[id].hasOwnProperty('css')) { this.addRule(id, ref.layer[id], layerContainer); } } } var symbolizerHeading = this.node('h2', {}, this.container); this.node('a', {id: this.version + '/symbolizers', href: '#' + this.version + '/symbolizers'}, symbolizerHeading, 'Symbolizers'); for (var id in ref.symbolizers) this.addSymbolizer(id, ref.symbolizers[id]); this.addVersions(); if (window.location.hash) window.location = window.location; // we have rebuild the DOM, help the browser find the North again. }, addVersions: function () { var container = this.node('div', {className: 'versions'}, this.menu); this.node('h5', {}, container, 'Versions'); for (var i = 0; i < UI.versions.length; i++) this.addVersionLink(UI.versions[i], container); }, addVersionLink: function (version, parent) { var current = version === this.version ? ' current' : ''; this.node('a', {className: 'block' + current, href: '#' + version + '/'}, parent, version); }, anchor: function (id) { return this.version + '/' + id; }, addSymbolizer: function (id, rules) { this.node('a', {className: 'block', href: '#' + this.anchor(id)}, this.menu, id); this.addSymbolizerBlock(id, rules); }, addSymbolizerBlock: function (id, rules) { var container = this.node('div', {className: 'symbolizer'}, this.container); var section = this.node('h2', {}, container); this.node('a', {href: '#' + this.anchor(id), id: this.anchor(id)}, section, id); for (var ruleId in rules) this.addRule(ruleId, rules[ruleId], container); }, addRule: function (id, props, parent) { var title = this.node('h3', {}, parent); id = props.css || id; this.node('a', {id: this.anchor(id), href: '#' + this.anchor(id)}, title, id); this.node('span', 'type', title, '=' + (this.isArray(props.type) ? 'list' : props.type)); if (props.expression) this.node('span', {className: 'expressions-support'}, title, 'expressions'); if (props.status && props.status !== 'stable') this.node('span', {className: 'status ' + props.status}, title, props.status); this.node('p', {}, parent, props.doc.replace(/`([^`]*)`/g, '$1')); var defaultValue = this.node('p', {}, parent, 'Default: ' + (props['default-value'] || 'none')); if (props['default-meaning']) this.node('em', {}, defaultValue, ' (' + props['default-meaning'] + ')'); if (this.isArray(props.type)) this.node('p', '', parent, 'Values: ' + props.type.join(', ')); if (props.functions) this.node('p', '', parent, 'Functions: ' + props.functions.join(', ')); if (props.range) this.node('p', '', parent, 'Range: ' + props.range); } }; UI.init = function (version) { // if (!version && window.location.hash && window.location.hash.indexOf('/') !== -1) { // version = window.location.hash.split('/')[0]; // } return new UI(version); }; window.UI = UI; })(window); mapnik-reference-8.10.0/site/nanoajax.min.js000066400000000000000000000012561342311331100206720ustar00rootroot00000000000000!function(e,t){function n(){if(t.XMLHttpRequest)return new t.XMLHttpRequest;try{return new t.ActiveXObject("MSXML2.XMLHTTP.3.0")}catch(e){}throw new Error("no xmlhttp request able to be created")}function r(e,t,n){e[t]=e[t]||n}t.nanoajax=e,e.ajax=function(e,t){"string"==typeof e&&(e={url:e});var a=e.headers||{},o=e.body,u=e.method||(o?"POST":"GET"),i=e.withCredentials||!1,s=n();s.onreadystatechange=function(){4==s.readyState&&t(s.status,s.responseText,s)},o&&(r(a,"X-Requested-With","XMLHttpRequest"),r(a,"Content-Type","application/x-www-form-urlencoded")),s.open(u,e.url,!0),s.withCredentials=i;for(var c in a)s.setRequestHeader(c,a[c]);s.send(o)}}({},function(){return this}()); mapnik-reference-8.10.0/test/000077500000000000000000000000001342311331100157625ustar00rootroot00000000000000mapnik-reference-8.10.0/test/test.js000066400000000000000000000060621342311331100173030ustar00rootroot00000000000000var assert = require('assert'); var mapnikref = require('../'); var glob = require('glob'); var path = require('path'); var semver = require('semver'); describe('datasources', function() { mapnikref.versions.forEach(function(key) { var spec = mapnikref.load(key); if (spec.datasources) { it('show provide metadata for '+key, function() { var ds_spec = spec.datasources['postgis']; assert.ok(ds_spec['table'].type,'string'); assert.equal(ds_spec['table'].required,true); }); } else { it.skip('show provide metadata for '+key, function() {}); } }); }); describe('styles', function() { mapnikref.versions.forEach(function(key) { (function(key) { it('report correct version for '+key, function() { assert.equal(mapnikref.load(key).version,key); }); })(key) }) it('reveal new property in Mapnik 2.3.0', function() { assert.ok(mapnikref.load('2.3.0').symbolizers.markers['geometry-transform']); assert.ok(!mapnikref.load('2.0.0').symbolizers.markers['geometry-transform']); }); }); describe('versions', function() { it('show report all versions', function() { var versions = glob.sync("./*.*.*"); versions = versions.map(function(e) { return path.basename(e) }) assert.deepEqual(semver.sort(versions),mapnikref.versions); }); }); describe('load', function() { it('should load requested version if exists', function() { var spec = mapnikref.load('2.0.2'); assert.equal(spec.version, '2.0.2'); }); it('should load closer patch version if requested patch does not exist', function() { var spec = mapnikref.load('2.0.12'); assert.equal(spec.version, '2.0.2'); }); it('should support x as patch', function() { var spec = mapnikref.load('2.0.x'); assert.equal(spec.version, '2.0.2'); }); it('should support x as minor', function() { var spec = mapnikref.load('2.x.x'); assert.equal(spec.version, '2.3.0'); }); it('should support missing patch', function() { var spec = mapnikref.load('2.3'); assert.equal(spec.version, '2.3.0'); }); it('should support major only', function() { var spec = mapnikref.load('2'); assert.equal(spec.version, '2.3.0'); }); it('should support range', function() { var spec = mapnikref.load('2.x < 3'); assert.equal(spec.version, '2.3.0'); }); it('should support *', function() { var spec = mapnikref.load('*'); assert.equal(spec.version, mapnikref.latest); }); it('should throw if requested minor does not exist', function() { assert.throws(function () { mapnikref.load('2.12.0'); }, /Unknown mapnik-reference version/); }); it('should throw for invalid version', function() { assert.throws(function () { mapnikref.load('invalid'); }, /Unknown mapnik-reference version/); }); });