"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":"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":{
"*":{
"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"
}
},
"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.",
"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 both the fill and 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",
"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",
"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",
"doc":"The size of the shield text in pixels"
},
"fill":{
"css":"shield-fill",
"type":"color",
"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",
"doc":"Vertical spacing between lines of multiline labels (in pixels)",
"type":"unsigned"
},
"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",
"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",
"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":"unsigned",
"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.",
"type":"float"
},
"minimum-padding":{
"css":"text-min-padding",
"doc":"Determines the minimum amount of padding that a text symbolizer gets relative to other text",
"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",
"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":{
"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.",
