better rules
This commit is contained in:
samanpwbb
parent
08ca40d3f7
commit
cbd4c0250d
@ -1,5 +1,4 @@
|
||||
<% _(symbolizers).each(function(symbolizer, name) { %>
|
||||
* * *
|
||||
<% if (name == '*') { %>## All elements<% } else { %>## <%= name %><% } %>
|
||||
<% _(symbolizer).chain().filter(function(p) { return p.css; }).each(function(p) { %>
|
||||
#### <%= p.css.replace(/\s/g, '') %> <% if (_.isArray(p.type)) { %>`keyword`<% } else { %>`<%= p.type %>`<% } %>
|
||||
@ -9,5 +8,6 @@
|
||||
<% if (p['default-meaning']) { %>_(<%- p['default-meaning'] %>)_<% } %>
|
||||
<% if (typeof p['range'] !== 'undefined') { %>Range: <%= '' + p['range'] %><% } %>
|
||||
<% if (p.doc) { %><%- p.doc%><% } %>
|
||||
* * *
|
||||
<% }); %>
|
||||
<% }); %>
|
||||
140
docs/2.0.0.md
140
docs/2.0.0.md
@ -2,7 +2,6 @@
|
||||
|
||||
The following is a list of properties provided in CartoCSS that you can apply to map elements.
|
||||
|
||||
* * *
|
||||
## map
|
||||
|
||||
#### background-color `color`
|
||||
@ -12,6 +11,7 @@ Default Value: none
|
||||
_(transparent)_
|
||||
|
||||
Map Background color
|
||||
* * *
|
||||
|
||||
#### background-image `uri`
|
||||
|
||||
@ -20,6 +20,7 @@ Default Value:
|
||||
_(transparent)_
|
||||
|
||||
An image that is repeated below all features on a map as a background.
|
||||
* * *
|
||||
|
||||
#### srs `string`
|
||||
|
||||
@ -28,6 +29,7 @@ Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs
|
||||
_(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space)_
|
||||
|
||||
Map spatial reference (proj4 string)
|
||||
* * *
|
||||
|
||||
#### buffer-size `float`
|
||||
|
||||
@ -36,6 +38,7 @@ Default Value: 0
|
||||
_(No buffer will be used)_
|
||||
|
||||
Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges".
|
||||
* * *
|
||||
|
||||
#### base `string`
|
||||
|
||||
@ -44,6 +47,7 @@ Default Value:
|
||||
_(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)_
|
||||
|
||||
Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet.
|
||||
* * *
|
||||
|
||||
#### font-directory `uri`
|
||||
|
||||
@ -52,9 +56,9 @@ Default Value: none
|
||||
_(No map-specific fonts will be registered)_
|
||||
|
||||
Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered).
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## polygon
|
||||
|
||||
#### polygon-fill `color`
|
||||
@ -64,6 +68,7 @@ Default Value: rgba(128,128,128,1)
|
||||
_(gray and fully opaque (alpha = 1), same as rgb(128,128,128))_
|
||||
|
||||
Fill color to assign to a polygon
|
||||
* * *
|
||||
|
||||
#### polygon-gamma `float`
|
||||
|
||||
@ -72,6 +77,7 @@ Default Value: 1
|
||||
_(fully antialiased)_
|
||||
Range: 0-1
|
||||
Level of antialiasing of polygon edges
|
||||
* * *
|
||||
|
||||
#### polygon-opacity `float`
|
||||
|
||||
@ -80,6 +86,7 @@ Default Value: 1
|
||||
_(opaque)_
|
||||
|
||||
The opacity of the polygon
|
||||
* * *
|
||||
|
||||
#### polygon-smooth `float`
|
||||
|
||||
@ -88,9 +95,9 @@ Default Value: 0
|
||||
_(no smoothing)_
|
||||
Range: 0-1
|
||||
Amount of smoothing applied
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## line
|
||||
|
||||
#### line-color `color`
|
||||
@ -100,6 +107,7 @@ Default Value: rgba(0,0,0,1)
|
||||
_(black and fully opaque (alpha = 1), same as rgb(0,0,0))_
|
||||
|
||||
The color of a drawn line
|
||||
* * *
|
||||
|
||||
#### line-width `float`
|
||||
|
||||
@ -108,6 +116,7 @@ Default Value: 1
|
||||
|
||||
|
||||
The width of a line in pixels
|
||||
* * *
|
||||
|
||||
#### line-opacity `float`
|
||||
|
||||
@ -116,6 +125,7 @@ Default Value: 1
|
||||
_(opaque)_
|
||||
|
||||
The opacity of a line
|
||||
* * *
|
||||
|
||||
#### line-join `keyword`
|
||||
`miter``round``bevel`
|
||||
@ -124,6 +134,7 @@ Default Value: miter
|
||||
|
||||
|
||||
The behavior of lines when joining
|
||||
* * *
|
||||
|
||||
#### line-cap `keyword`
|
||||
`butt``round``square`
|
||||
@ -132,6 +143,7 @@ Default Value: butt
|
||||
|
||||
|
||||
The display of line endings
|
||||
* * *
|
||||
|
||||
#### line-gamma `float`
|
||||
|
||||
@ -140,6 +152,7 @@ Default Value: 1
|
||||
_(fully antialiased)_
|
||||
Range: 0-1
|
||||
Level of antialiasing of stroke line
|
||||
* * *
|
||||
|
||||
#### line-dasharray `numbers`
|
||||
|
||||
@ -148,6 +161,7 @@ Default Value: none
|
||||
_(solid line)_
|
||||
|
||||
A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns.
|
||||
* * *
|
||||
|
||||
#### line-dash-offset `numbers`
|
||||
|
||||
@ -156,6 +170,7 @@ Default Value: none
|
||||
_(solid line)_
|
||||
|
||||
valid parameter but not currently used in renderers
|
||||
* * *
|
||||
|
||||
#### line-rasterizer `keyword`
|
||||
`full``fast`
|
||||
@ -164,9 +179,9 @@ Default Value: full
|
||||
|
||||
|
||||
Exposes an alternate AGG rendering method that sacrifices some accuracy for speed.
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## markers
|
||||
|
||||
#### marker-file `uri`
|
||||
@ -176,6 +191,7 @@ Default Value:
|
||||
_(An ellipse or circle, if width equals height)_
|
||||
|
||||
An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse.
|
||||
* * *
|
||||
|
||||
#### marker-opacity `float`
|
||||
|
||||
@ -184,6 +200,7 @@ Default Value: 1
|
||||
_(opaque)_
|
||||
|
||||
The overall opacity of the marker
|
||||
* * *
|
||||
|
||||
#### marker-line-color `color`
|
||||
|
||||
@ -192,6 +209,7 @@ Default Value: black
|
||||
|
||||
|
||||
The color of the stroke around a marker shape.
|
||||
* * *
|
||||
|
||||
#### marker-line-width `float`
|
||||
|
||||
@ -200,6 +218,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
The width of the stroke around a marker shape, in pixels. This is positioned on the boundary, so high values can cover the area itself.
|
||||
* * *
|
||||
|
||||
#### marker-line-opacity `float`
|
||||
|
||||
@ -208,6 +227,7 @@ Default Value: 1
|
||||
_(opaque)_
|
||||
|
||||
The opacity of a line
|
||||
* * *
|
||||
|
||||
#### marker-placement `keyword`
|
||||
`point``line`
|
||||
@ -216,6 +236,7 @@ Default Value: line
|
||||
|
||||
|
||||
Attempt to place markers on a point once or on a line repeatedly
|
||||
* * *
|
||||
|
||||
#### marker-type `keyword`
|
||||
`arrow``ellipse`
|
||||
@ -224,6 +245,7 @@ Default Value: ellipse
|
||||
|
||||
|
||||
The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width)
|
||||
* * *
|
||||
|
||||
#### marker-width `float`
|
||||
|
||||
@ -232,6 +254,7 @@ Default Value: 10
|
||||
|
||||
|
||||
The width of the marker, if using one of the default types.
|
||||
* * *
|
||||
|
||||
#### marker-height `float`
|
||||
|
||||
@ -240,6 +263,7 @@ Default Value: 10
|
||||
|
||||
|
||||
The height of the marker, if using one of the default types.
|
||||
* * *
|
||||
|
||||
#### marker-fill `color`
|
||||
|
||||
@ -248,6 +272,7 @@ Default Value: blue
|
||||
|
||||
|
||||
The color of the area of the marker.
|
||||
* * *
|
||||
|
||||
#### marker-allow-overlap `boolean`
|
||||
|
||||
@ -256,6 +281,7 @@ Default Value: false
|
||||
_(Do not allow makers to overlap with each other - overlapping markers will not be shown.)_
|
||||
|
||||
Control whether overlapping markers are shown or hidden.
|
||||
* * *
|
||||
|
||||
#### marker-ignore-placement `boolean`
|
||||
|
||||
@ -264,6 +290,7 @@ Default Value: false
|
||||
_(do not store the bbox of this geometry in the collision detector cache)_
|
||||
|
||||
value to control whether the placement of the feature will prevent the placement of other features
|
||||
* * *
|
||||
|
||||
#### marker-spacing `float`
|
||||
|
||||
@ -272,6 +299,7 @@ Default Value: 100
|
||||
|
||||
|
||||
Space between repeated labels
|
||||
* * *
|
||||
|
||||
#### marker-max-error `float`
|
||||
|
||||
@ -280,6 +308,7 @@ Default Value: 0.2
|
||||
|
||||
|
||||
The maximum difference between actual marker placement and the marker-spacing parameter. Setting a high value can allow the renderer to try to resolve placement conflicts with other symbolizers.
|
||||
* * *
|
||||
|
||||
#### marker-transform `string`
|
||||
|
||||
@ -288,9 +317,9 @@ Default Value:
|
||||
_(no transformation)_
|
||||
|
||||
An SVG transformation definition
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## shield
|
||||
|
||||
#### shield-name `string`
|
||||
@ -300,6 +329,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Value to use for a shield"s text label. Data columns are specified using brackets like [column_name]
|
||||
* * *
|
||||
|
||||
#### shield-face-name `string`
|
||||
|
||||
@ -308,6 +338,7 @@ Default Value:
|
||||
|
||||
|
||||
Font name and style to use for the shield text
|
||||
* * *
|
||||
|
||||
#### shield-unlock-image `boolean`
|
||||
|
||||
@ -316,6 +347,7 @@ Default Value: false
|
||||
_(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)_
|
||||
|
||||
This parameter should be set to true if you are trying to position text beside rather than on top of the shield image
|
||||
* * *
|
||||
|
||||
#### shield-size `float`
|
||||
|
||||
@ -324,6 +356,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
The size of the shield text in pixels
|
||||
* * *
|
||||
|
||||
#### shield-fill `color`
|
||||
|
||||
@ -332,6 +365,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
The color of the shield text
|
||||
* * *
|
||||
|
||||
#### shield-placement `keyword`
|
||||
`point``line``vertex``interior`
|
||||
@ -340,6 +374,7 @@ Default Value: point
|
||||
|
||||
|
||||
How this shield should be placed. Point placement attempts to place it on top of points, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of polygons.
|
||||
* * *
|
||||
|
||||
#### shield-avoid-edges `boolean`
|
||||
|
||||
@ -348,6 +383,7 @@ Default Value: false
|
||||
|
||||
|
||||
Tell positioning algorithm to avoid labeling near intersection edges.
|
||||
* * *
|
||||
|
||||
#### shield-min-distance `float`
|
||||
|
||||
@ -356,6 +392,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Minimum distance to the next shield symbol, not necessarily the same shield.
|
||||
* * *
|
||||
|
||||
#### shield-spacing `float`
|
||||
|
||||
@ -364,6 +401,7 @@ Default Value: 0
|
||||
|
||||
|
||||
The spacing between repeated occurrences of the same shield on a line
|
||||
* * *
|
||||
|
||||
#### shield-min-padding `float`
|
||||
|
||||
@ -372,6 +410,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Determines the minimum amount of padding that a shield gets relative to other shields
|
||||
* * *
|
||||
|
||||
#### shield-wrap-width `float`
|
||||
|
||||
@ -380,6 +419,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Length before wrapping long names.
|
||||
* * *
|
||||
|
||||
#### shield-wrap-character `string`
|
||||
|
||||
@ -388,6 +428,7 @@ Default Value:
|
||||
|
||||
|
||||
Use this character instead of a space to wrap long names.
|
||||
* * *
|
||||
|
||||
#### shield-halo-fill `color`
|
||||
|
||||
@ -396,6 +437,7 @@ Default Value: #FFFFFF
|
||||
_(white)_
|
||||
|
||||
Specifies the color of the halo around the text.
|
||||
* * *
|
||||
|
||||
#### shield-halo-radius `float`
|
||||
|
||||
@ -404,6 +446,7 @@ Default Value: 0
|
||||
_(no halo)_
|
||||
|
||||
Specify the radius of the halo in pixels
|
||||
* * *
|
||||
|
||||
#### shield-character-spacing `float`
|
||||
|
||||
@ -412,6 +455,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement.
|
||||
* * *
|
||||
|
||||
#### shield-line-spacing `float`
|
||||
|
||||
@ -420,6 +464,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Vertical spacing between lines of multiline labels (in pixels)
|
||||
* * *
|
||||
|
||||
#### shield-file `uri`
|
||||
|
||||
@ -428,6 +473,7 @@ Default Value: none
|
||||
|
||||
|
||||
Image file to render behind the shield text
|
||||
* * *
|
||||
|
||||
#### shield-text-dx `float`
|
||||
|
||||
@ -436,6 +482,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right
|
||||
* * *
|
||||
|
||||
#### shield-text-dy `float`
|
||||
|
||||
@ -444,6 +491,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down
|
||||
* * *
|
||||
|
||||
#### shield-dx `float`
|
||||
|
||||
@ -452,6 +500,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right
|
||||
* * *
|
||||
|
||||
#### shield-dy `float`
|
||||
|
||||
@ -460,6 +509,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down
|
||||
* * *
|
||||
|
||||
#### shield-opacity `float`
|
||||
|
||||
@ -468,6 +518,7 @@ Default Value: 1
|
||||
|
||||
|
||||
(Default 1.0) - opacity of the image used for the shield
|
||||
* * *
|
||||
|
||||
#### shield-text-opacity `float`
|
||||
|
||||
@ -476,6 +527,7 @@ Default Value: 1
|
||||
|
||||
|
||||
(Default 1.0) - opacity of the text placed on top of the shield
|
||||
* * *
|
||||
|
||||
#### shield-horizontal-alignment `keyword`
|
||||
`left``middle``right``auto`
|
||||
@ -484,6 +536,7 @@ Default Value: middle
|
||||
|
||||
|
||||
The shield's horizontal alignment from its centerpoint
|
||||
* * *
|
||||
|
||||
#### shield-text-transform `keyword`
|
||||
`none``uppercase``lowercase``capitalize`
|
||||
@ -492,6 +545,7 @@ Default Value: none
|
||||
|
||||
|
||||
Transform the case of the characters
|
||||
* * *
|
||||
|
||||
#### shield-no-text `boolean`
|
||||
|
||||
@ -500,6 +554,7 @@ Default Value: false
|
||||
|
||||
|
||||
Whether the shield should make room for a text label.
|
||||
* * *
|
||||
|
||||
#### shield-justify-alignment `string`
|
||||
|
||||
@ -508,9 +563,9 @@ Default Value: middle
|
||||
|
||||
|
||||
Define how text in a shield's label is justified
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## line-pattern
|
||||
|
||||
#### line-pattern-file `uri`
|
||||
@ -520,9 +575,9 @@ Default Value: none
|
||||
|
||||
|
||||
An image file to be repeated and warped along a line
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## polygon-pattern
|
||||
|
||||
#### polygon-pattern-file `uri`
|
||||
@ -532,6 +587,7 @@ Default Value: none
|
||||
|
||||
|
||||
Image to use as a repeated pattern fill within a polygon
|
||||
* * *
|
||||
|
||||
#### polygon-pattern-alignment `keyword`
|
||||
`local``global`
|
||||
@ -540,6 +596,7 @@ Default Value: local
|
||||
|
||||
|
||||
Specify whether to align pattern fills to the layer or to the map.
|
||||
* * *
|
||||
|
||||
#### polygon-pattern-gamma `float`
|
||||
|
||||
@ -548,9 +605,9 @@ Default Value: 1
|
||||
_(fully antialiased)_
|
||||
Range: 0-1
|
||||
Level of antialiasing of polygon pattern edges
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## raster
|
||||
|
||||
#### raster-opacity `float`
|
||||
@ -560,6 +617,7 @@ Default Value: 1
|
||||
_(opaque)_
|
||||
|
||||
The opacity of the raster symbolizer on top of other symbolizers.
|
||||
* * *
|
||||
|
||||
#### raster-mode `keyword`
|
||||
`normal``grain_merge``grain_merge2``multiply``multiply2``divide``divide2``screen``hard_light`
|
||||
@ -568,6 +626,7 @@ Default Value: normal
|
||||
|
||||
|
||||
The blending technique used to overlay this raster image on the layer below. Normal simply covers the layer. Grain merge adds the two layers together and subtracts 128 from the value, making the resulting area sometimes high-contrast. Screen often gives a lighter, washed-out appearance. Multiply multiplies the pixels, giving a high-contrast result. Divide divides the upper layer by the lower layer, making a lighter version.
|
||||
* * *
|
||||
|
||||
#### raster-filter-factor `float`
|
||||
|
||||
@ -576,6 +635,7 @@ Default Value: -1
|
||||
_(Allow the datasource to choose appropriate downscaling.)_
|
||||
|
||||
This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed.
|
||||
* * *
|
||||
|
||||
#### raster-scaling `keyword`
|
||||
`fast``bilinear``bilinear8``bicubic``spline16``gaussian``lanczos`
|
||||
@ -584,6 +644,7 @@ Default Value: fast
|
||||
|
||||
|
||||
The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality.
|
||||
* * *
|
||||
|
||||
#### raster-mesh-size `integer`
|
||||
|
||||
@ -592,9 +653,9 @@ Default Value: 16
|
||||
_(Reprojection mesh will be 1/16 of the resolution of the source image)_
|
||||
|
||||
A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion.
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## point
|
||||
|
||||
#### point-file `uri`
|
||||
@ -604,6 +665,7 @@ Default Value: none
|
||||
|
||||
|
||||
Image file to represent a point
|
||||
* * *
|
||||
|
||||
#### point-allow-overlap `boolean`
|
||||
|
||||
@ -612,6 +674,7 @@ Default Value: false
|
||||
_(Do not allow points to overlap with each other - overlapping markers will not be shown.)_
|
||||
|
||||
Control whether overlapping points are shown or hidden.
|
||||
* * *
|
||||
|
||||
#### point-ignore-placement `boolean`
|
||||
|
||||
@ -620,6 +683,7 @@ Default Value: false
|
||||
_(do not store the bbox of this geometry in the collision detector cache)_
|
||||
|
||||
value to control whether the placement of the feature will prevent the placement of other features
|
||||
* * *
|
||||
|
||||
#### point-opacity `float`
|
||||
|
||||
@ -628,6 +692,7 @@ Default Value: 1
|
||||
_(Fully opaque)_
|
||||
|
||||
A value from 0 to 1 to control the opacity of the point
|
||||
* * *
|
||||
|
||||
#### point-placement `keyword`
|
||||
`centroid``interior`
|
||||
@ -636,6 +701,7 @@ Default Value: centroid
|
||||
|
||||
|
||||
How this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon.
|
||||
* * *
|
||||
|
||||
#### point-transform `string`
|
||||
|
||||
@ -644,9 +710,9 @@ Default Value:
|
||||
_(No transformation)_
|
||||
|
||||
SVG transformation definition
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## text
|
||||
|
||||
#### text-name `string`
|
||||
@ -656,6 +722,7 @@ Default Value:
|
||||
|
||||
|
||||
Value to use for a text label. Data columns are specified using brackets like [column_name]
|
||||
* * *
|
||||
|
||||
#### text-face-name `string`
|
||||
|
||||
@ -664,6 +731,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Font name and style to render a label in
|
||||
* * *
|
||||
|
||||
#### text-size `float`
|
||||
|
||||
@ -672,6 +740,7 @@ Default Value: 10
|
||||
|
||||
|
||||
Text size in pixels
|
||||
* * *
|
||||
|
||||
#### text-ratio `float`
|
||||
|
||||
@ -680,6 +749,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Define the amount of text (of the total) present on successive lines when wrapping occurs
|
||||
* * *
|
||||
|
||||
#### text-wrap-width `float`
|
||||
|
||||
@ -688,6 +758,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Length of a chunk of text in characters before wrapping text
|
||||
* * *
|
||||
|
||||
#### text-wrap-character `string`
|
||||
|
||||
@ -696,6 +767,7 @@ Default Value:
|
||||
|
||||
|
||||
Use this character instead of a space to wrap long text.
|
||||
* * *
|
||||
|
||||
#### text-spacing `float`
|
||||
|
||||
@ -704,6 +776,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Distance between repeated text labels on a line
|
||||
* * *
|
||||
|
||||
#### text-character-spacing `float`
|
||||
|
||||
@ -712,6 +785,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Horizontal spacing adjustment between characters in pixels
|
||||
* * *
|
||||
|
||||
#### text-line-spacing `float`
|
||||
|
||||
@ -720,6 +794,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Vertical spacing adjustment between lines in pixels
|
||||
* * *
|
||||
|
||||
#### text-label-position-tolerance `float`
|
||||
|
||||
@ -728,6 +803,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Allows the label to be displaced from its ideal position by a number of pixels
|
||||
* * *
|
||||
|
||||
#### text-max-char-angle-delta `float`
|
||||
|
||||
@ -736,6 +812,7 @@ Default Value: none
|
||||
|
||||
|
||||
If present, the maximum angle change, in degrees, allowed between adjacent characters in a label. This will stop label placement around sharp corners.
|
||||
* * *
|
||||
|
||||
#### text-fill `color`
|
||||
|
||||
@ -744,6 +821,7 @@ Default Value: #000000
|
||||
|
||||
|
||||
Specifies the color for the text
|
||||
* * *
|
||||
|
||||
#### text-opacity `float`
|
||||
|
||||
@ -752,6 +830,7 @@ Default Value: 1
|
||||
_(Fully opaque)_
|
||||
|
||||
A number from 0 to 1 specifying the opacity for the text
|
||||
* * *
|
||||
|
||||
#### text-halo-fill `color`
|
||||
|
||||
@ -760,6 +839,7 @@ Default Value: #FFFFFF
|
||||
_(white)_
|
||||
|
||||
Specifies the color of the halo around the text.
|
||||
* * *
|
||||
|
||||
#### text-halo-radius `float`
|
||||
|
||||
@ -768,6 +848,7 @@ Default Value: 0
|
||||
_(no halo)_
|
||||
|
||||
Specify the radius of the halo in pixels
|
||||
* * *
|
||||
|
||||
#### text-dx `float`
|
||||
|
||||
@ -776,6 +857,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right
|
||||
* * *
|
||||
|
||||
#### text-dy `float`
|
||||
|
||||
@ -784,6 +866,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down
|
||||
* * *
|
||||
|
||||
#### text-vertical-alignment `keyword`
|
||||
`top``middle``bottom`
|
||||
@ -792,6 +875,7 @@ Default Value: middle
|
||||
_(Default affected by value of dy; "bottom" for dy>0, "top" for dy<0.)_
|
||||
|
||||
Position of label relative to point position.
|
||||
* * *
|
||||
|
||||
#### text-avoid-edges `boolean`
|
||||
|
||||
@ -800,6 +884,7 @@ Default Value: false
|
||||
|
||||
|
||||
Tell positioning algorithm to avoid labeling near intersection edges.
|
||||
* * *
|
||||
|
||||
#### text-min-distance `float`
|
||||
|
||||
@ -808,6 +893,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Minimum permitted distance to the next text symbolizer.
|
||||
* * *
|
||||
|
||||
#### text-min-padding `float`
|
||||
|
||||
@ -816,6 +902,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Determines the minimum amount of padding that a text symbolizer gets relative to other text
|
||||
* * *
|
||||
|
||||
#### text-min-path-length `float`
|
||||
|
||||
@ -824,6 +911,7 @@ Default Value: 0
|
||||
_(place labels on all paths)_
|
||||
|
||||
Place labels only on paths longer than this value.
|
||||
* * *
|
||||
|
||||
#### text-allow-overlap `boolean`
|
||||
|
||||
@ -832,6 +920,7 @@ Default Value: false
|
||||
_(Do not allow text to overlap with other text - overlapping markers will not be shown.)_
|
||||
|
||||
Control whether overlapping text is shown or hidden.
|
||||
* * *
|
||||
|
||||
#### text-orientation `float`
|
||||
|
||||
@ -840,6 +929,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Rotate the text.
|
||||
* * *
|
||||
|
||||
#### text-placement `keyword`
|
||||
`point``line``vertex``interior`
|
||||
@ -848,6 +938,7 @@ Default Value: point
|
||||
|
||||
|
||||
Control the style of placement of a point versus the geometry it is attached to.
|
||||
* * *
|
||||
|
||||
#### text-placement-type `keyword`
|
||||
`dummy``simple`
|
||||
@ -856,6 +947,7 @@ Default Value: dummy
|
||||
|
||||
|
||||
Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off.
|
||||
* * *
|
||||
|
||||
#### text-placements `string`
|
||||
|
||||
@ -864,6 +956,7 @@ Default Value:
|
||||
|
||||
|
||||
If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. See TextSymbolizer docs for format.
|
||||
* * *
|
||||
|
||||
#### text-transform `keyword`
|
||||
`none``uppercase``lowercase``capitalize`
|
||||
@ -872,6 +965,7 @@ Default Value: none
|
||||
|
||||
|
||||
Transform the case of the characters
|
||||
* * *
|
||||
|
||||
#### text-horizontal-alignment `keyword`
|
||||
`left``middle``right``auto`
|
||||
@ -880,6 +974,7 @@ Default Value: middle
|
||||
|
||||
|
||||
The text's horizontal alignment from its centerpoint
|
||||
* * *
|
||||
|
||||
#### text-align `keyword`
|
||||
`left``right``center`
|
||||
@ -888,9 +983,9 @@ Default Value: center
|
||||
|
||||
|
||||
Set the text alignment.
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## building
|
||||
|
||||
#### building-fill `color`
|
||||
@ -900,6 +995,7 @@ Default Value: #FFFFFF
|
||||
|
||||
|
||||
The color of the buildings walls.
|
||||
* * *
|
||||
|
||||
#### building-fill-opacity `float`
|
||||
|
||||
@ -908,6 +1004,7 @@ Default Value: 1
|
||||
|
||||
|
||||
The opacity of the building as a whole, including all walls.
|
||||
* * *
|
||||
|
||||
#### building-height `float`
|
||||
|
||||
@ -916,6 +1013,7 @@ Default Value: 0
|
||||
|
||||
|
||||
The height of the building in pixels.
|
||||
* * *
|
||||
|
||||
|
||||
|
||||
|
||||
140
docs/2.0.1.md
140
docs/2.0.1.md
@ -2,7 +2,6 @@
|
||||
|
||||
The following is a list of properties provided in CartoCSS that you can apply to map elements.
|
||||
|
||||
* * *
|
||||
## map
|
||||
|
||||
#### background-color `color`
|
||||
@ -12,6 +11,7 @@ Default Value: none
|
||||
_(transparent)_
|
||||
|
||||
Map Background color
|
||||
* * *
|
||||
|
||||
#### background-image `uri`
|
||||
|
||||
@ -20,6 +20,7 @@ Default Value:
|
||||
_(transparent)_
|
||||
|
||||
An image that is repeated below all features on a map as a background.
|
||||
* * *
|
||||
|
||||
#### srs `string`
|
||||
|
||||
@ -28,6 +29,7 @@ Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs
|
||||
_(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space)_
|
||||
|
||||
Map spatial reference (proj4 string)
|
||||
* * *
|
||||
|
||||
#### buffer-size `float`
|
||||
|
||||
@ -36,6 +38,7 @@ Default Value: 0
|
||||
_(No buffer will be used)_
|
||||
|
||||
Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges".
|
||||
* * *
|
||||
|
||||
#### base `string`
|
||||
|
||||
@ -44,6 +47,7 @@ Default Value:
|
||||
_(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)_
|
||||
|
||||
Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet.
|
||||
* * *
|
||||
|
||||
#### font-directory `uri`
|
||||
|
||||
@ -52,9 +56,9 @@ Default Value: none
|
||||
_(No map-specific fonts will be registered)_
|
||||
|
||||
Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered).
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## polygon
|
||||
|
||||
#### polygon-fill `color`
|
||||
@ -64,6 +68,7 @@ Default Value: rgba(128,128,128,1)
|
||||
_(gray and fully opaque (alpha = 1), same as rgb(128,128,128))_
|
||||
|
||||
Fill color to assign to a polygon
|
||||
* * *
|
||||
|
||||
#### polygon-gamma `float`
|
||||
|
||||
@ -72,6 +77,7 @@ Default Value: 1
|
||||
_(fully antialiased)_
|
||||
Range: 0-1
|
||||
Level of antialiasing of polygon edges
|
||||
* * *
|
||||
|
||||
#### polygon-opacity `float`
|
||||
|
||||
@ -80,6 +86,7 @@ Default Value: 1
|
||||
_(opaque)_
|
||||
|
||||
The opacity of the polygon
|
||||
* * *
|
||||
|
||||
#### polygon-smooth `float`
|
||||
|
||||
@ -88,9 +95,9 @@ Default Value: 0
|
||||
_(no smoothing)_
|
||||
Range: 0-1
|
||||
Amount of smoothing applied
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## line
|
||||
|
||||
#### line-color `color`
|
||||
@ -100,6 +107,7 @@ Default Value: rgba(0,0,0,1)
|
||||
_(black and fully opaque (alpha = 1), same as rgb(0,0,0))_
|
||||
|
||||
The color of a drawn line
|
||||
* * *
|
||||
|
||||
#### line-width `float`
|
||||
|
||||
@ -108,6 +116,7 @@ Default Value: 1
|
||||
|
||||
|
||||
The width of a line in pixels
|
||||
* * *
|
||||
|
||||
#### line-opacity `float`
|
||||
|
||||
@ -116,6 +125,7 @@ Default Value: 1
|
||||
_(opaque)_
|
||||
|
||||
The opacity of a line
|
||||
* * *
|
||||
|
||||
#### line-join `keyword`
|
||||
`miter``round``bevel`
|
||||
@ -124,6 +134,7 @@ Default Value: miter
|
||||
|
||||
|
||||
The behavior of lines when joining
|
||||
* * *
|
||||
|
||||
#### line-cap `keyword`
|
||||
`butt``round``square`
|
||||
@ -132,6 +143,7 @@ Default Value: butt
|
||||
|
||||
|
||||
The display of line endings
|
||||
* * *
|
||||
|
||||
#### line-gamma `float`
|
||||
|
||||
@ -140,6 +152,7 @@ Default Value: 1
|
||||
_(fully antialiased)_
|
||||
Range: 0-1
|
||||
Level of antialiasing of stroke line
|
||||
* * *
|
||||
|
||||
#### line-dasharray `numbers`
|
||||
|
||||
@ -148,6 +161,7 @@ Default Value: none
|
||||
_(solid line)_
|
||||
|
||||
A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns.
|
||||
* * *
|
||||
|
||||
#### line-dash-offset `numbers`
|
||||
|
||||
@ -156,6 +170,7 @@ Default Value: none
|
||||
_(solid line)_
|
||||
|
||||
valid parameter but not currently used in renderers
|
||||
* * *
|
||||
|
||||
#### line-rasterizer `keyword`
|
||||
`full``fast`
|
||||
@ -164,9 +179,9 @@ Default Value: full
|
||||
|
||||
|
||||
Exposes an alternate AGG rendering method that sacrifices some accuracy for speed.
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## markers
|
||||
|
||||
#### marker-file `uri`
|
||||
@ -176,6 +191,7 @@ Default Value:
|
||||
_(An ellipse or circle, if width equals height)_
|
||||
|
||||
An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse.
|
||||
* * *
|
||||
|
||||
#### marker-opacity `float`
|
||||
|
||||
@ -184,6 +200,7 @@ Default Value: 1
|
||||
_(opaque)_
|
||||
|
||||
The overall opacity of the marker
|
||||
* * *
|
||||
|
||||
#### marker-line-color `color`
|
||||
|
||||
@ -192,6 +209,7 @@ Default Value: black
|
||||
|
||||
|
||||
The color of the stroke around a marker shape.
|
||||
* * *
|
||||
|
||||
#### marker-line-width `float`
|
||||
|
||||
@ -200,6 +218,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
The width of the stroke around a marker shape, in pixels. This is positioned on the boundary, so high values can cover the area itself.
|
||||
* * *
|
||||
|
||||
#### marker-line-opacity `float`
|
||||
|
||||
@ -208,6 +227,7 @@ Default Value: 1
|
||||
_(opaque)_
|
||||
|
||||
The opacity of a line
|
||||
* * *
|
||||
|
||||
#### marker-placement `keyword`
|
||||
`point``line`
|
||||
@ -216,6 +236,7 @@ Default Value: line
|
||||
|
||||
|
||||
Attempt to place markers on a point once or on a line repeatedly
|
||||
* * *
|
||||
|
||||
#### marker-type `keyword`
|
||||
`arrow``ellipse`
|
||||
@ -224,6 +245,7 @@ Default Value: ellipse
|
||||
|
||||
|
||||
The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width)
|
||||
* * *
|
||||
|
||||
#### marker-width `float`
|
||||
|
||||
@ -232,6 +254,7 @@ Default Value: 10
|
||||
|
||||
|
||||
The width of the marker, if using one of the default types.
|
||||
* * *
|
||||
|
||||
#### marker-height `float`
|
||||
|
||||
@ -240,6 +263,7 @@ Default Value: 10
|
||||
|
||||
|
||||
The height of the marker, if using one of the default types.
|
||||
* * *
|
||||
|
||||
#### marker-fill `color`
|
||||
|
||||
@ -248,6 +272,7 @@ Default Value: blue
|
||||
|
||||
|
||||
The color of the area of the marker.
|
||||
* * *
|
||||
|
||||
#### marker-allow-overlap `boolean`
|
||||
|
||||
@ -256,6 +281,7 @@ Default Value: false
|
||||
_(Do not allow makers to overlap with each other - overlapping markers will not be shown.)_
|
||||
|
||||
Control whether overlapping markers are shown or hidden.
|
||||
* * *
|
||||
|
||||
#### marker-ignore-placement `boolean`
|
||||
|
||||
@ -264,6 +290,7 @@ Default Value: false
|
||||
_(do not store the bbox of this geometry in the collision detector cache)_
|
||||
|
||||
value to control whether the placement of the feature will prevent the placement of other features
|
||||
* * *
|
||||
|
||||
#### marker-spacing `float`
|
||||
|
||||
@ -272,6 +299,7 @@ Default Value: 100
|
||||
|
||||
|
||||
Space between repeated labels
|
||||
* * *
|
||||
|
||||
#### marker-max-error `float`
|
||||
|
||||
@ -280,6 +308,7 @@ Default Value: 0.2
|
||||
|
||||
|
||||
The maximum difference between actual marker placement and the marker-spacing parameter. Setting a high value can allow the renderer to try to resolve placement conflicts with other symbolizers.
|
||||
* * *
|
||||
|
||||
#### marker-transform `string`
|
||||
|
||||
@ -288,9 +317,9 @@ Default Value:
|
||||
_(no transformation)_
|
||||
|
||||
An SVG transformation definition
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## shield
|
||||
|
||||
#### shield-name `string`
|
||||
@ -300,6 +329,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Value to use for a shield"s text label. Data columns are specified using brackets like [column_name]
|
||||
* * *
|
||||
|
||||
#### shield-face-name `string`
|
||||
|
||||
@ -308,6 +338,7 @@ Default Value:
|
||||
|
||||
|
||||
Font name and style to use for the shield text
|
||||
* * *
|
||||
|
||||
#### shield-unlock-image `boolean`
|
||||
|
||||
@ -316,6 +347,7 @@ Default Value: false
|
||||
_(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)_
|
||||
|
||||
This parameter should be set to true if you are trying to position text beside rather than on top of the shield image
|
||||
* * *
|
||||
|
||||
#### shield-size `float`
|
||||
|
||||
@ -324,6 +356,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
The size of the shield text in pixels
|
||||
* * *
|
||||
|
||||
#### shield-fill `color`
|
||||
|
||||
@ -332,6 +365,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
The color of the shield text
|
||||
* * *
|
||||
|
||||
#### shield-placement `keyword`
|
||||
`point``line``vertex``interior`
|
||||
@ -340,6 +374,7 @@ Default Value: point
|
||||
|
||||
|
||||
How this shield should be placed. Point placement attempts to place it on top of points, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of polygons.
|
||||
* * *
|
||||
|
||||
#### shield-avoid-edges `boolean`
|
||||
|
||||
@ -348,6 +383,7 @@ Default Value: false
|
||||
|
||||
|
||||
Tell positioning algorithm to avoid labeling near intersection edges.
|
||||
* * *
|
||||
|
||||
#### shield-min-distance `float`
|
||||
|
||||
@ -356,6 +392,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Minimum distance to the next shield symbol, not necessarily the same shield.
|
||||
* * *
|
||||
|
||||
#### shield-spacing `float`
|
||||
|
||||
@ -364,6 +401,7 @@ Default Value: 0
|
||||
|
||||
|
||||
The spacing between repeated occurrences of the same shield on a line
|
||||
* * *
|
||||
|
||||
#### shield-min-padding `float`
|
||||
|
||||
@ -372,6 +410,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Determines the minimum amount of padding that a shield gets relative to other shields
|
||||
* * *
|
||||
|
||||
#### shield-wrap-width `float`
|
||||
|
||||
@ -380,6 +419,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Length before wrapping long names.
|
||||
* * *
|
||||
|
||||
#### shield-wrap-character `string`
|
||||
|
||||
@ -388,6 +428,7 @@ Default Value:
|
||||
|
||||
|
||||
Use this character instead of a space to wrap long names.
|
||||
* * *
|
||||
|
||||
#### shield-halo-fill `color`
|
||||
|
||||
@ -396,6 +437,7 @@ Default Value: #FFFFFF
|
||||
_(white)_
|
||||
|
||||
Specifies the color of the halo around the text.
|
||||
* * *
|
||||
|
||||
#### shield-halo-radius `float`
|
||||
|
||||
@ -404,6 +446,7 @@ Default Value: 0
|
||||
_(no halo)_
|
||||
|
||||
Specify the radius of the halo in pixels
|
||||
* * *
|
||||
|
||||
#### shield-character-spacing `float`
|
||||
|
||||
@ -412,6 +455,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement.
|
||||
* * *
|
||||
|
||||
#### shield-line-spacing `float`
|
||||
|
||||
@ -420,6 +464,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Vertical spacing between lines of multiline labels (in pixels)
|
||||
* * *
|
||||
|
||||
#### shield-file `uri`
|
||||
|
||||
@ -428,6 +473,7 @@ Default Value: none
|
||||
|
||||
|
||||
Image file to render behind the shield text
|
||||
* * *
|
||||
|
||||
#### shield-text-dx `float`
|
||||
|
||||
@ -436,6 +482,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right
|
||||
* * *
|
||||
|
||||
#### shield-text-dy `float`
|
||||
|
||||
@ -444,6 +491,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down
|
||||
* * *
|
||||
|
||||
#### shield-dx `float`
|
||||
|
||||
@ -452,6 +500,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right
|
||||
* * *
|
||||
|
||||
#### shield-dy `float`
|
||||
|
||||
@ -460,6 +509,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down
|
||||
* * *
|
||||
|
||||
#### shield-opacity `float`
|
||||
|
||||
@ -468,6 +518,7 @@ Default Value: 1
|
||||
|
||||
|
||||
(Default 1.0) - opacity of the image used for the shield
|
||||
* * *
|
||||
|
||||
#### shield-text-opacity `float`
|
||||
|
||||
@ -476,6 +527,7 @@ Default Value: 1
|
||||
|
||||
|
||||
(Default 1.0) - opacity of the text placed on top of the shield
|
||||
* * *
|
||||
|
||||
#### shield-horizontal-alignment `keyword`
|
||||
`left``middle``right``auto`
|
||||
@ -484,6 +536,7 @@ Default Value: middle
|
||||
|
||||
|
||||
The shield's horizontal alignment from its centerpoint
|
||||
* * *
|
||||
|
||||
#### shield-text-transform `keyword`
|
||||
`none``uppercase``lowercase``capitalize`
|
||||
@ -492,6 +545,7 @@ Default Value: none
|
||||
|
||||
|
||||
Transform the case of the characters
|
||||
* * *
|
||||
|
||||
#### shield-no-text `boolean`
|
||||
|
||||
@ -500,6 +554,7 @@ Default Value: false
|
||||
|
||||
|
||||
Whether the shield should make room for a text label.
|
||||
* * *
|
||||
|
||||
#### shield-justify-alignment `string`
|
||||
|
||||
@ -508,9 +563,9 @@ Default Value: middle
|
||||
|
||||
|
||||
Define how text in a shield's label is justified
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## line-pattern
|
||||
|
||||
#### line-pattern-file `uri`
|
||||
@ -520,9 +575,9 @@ Default Value: none
|
||||
|
||||
|
||||
An image file to be repeated and warped along a line
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## polygon-pattern
|
||||
|
||||
#### polygon-pattern-file `uri`
|
||||
@ -532,6 +587,7 @@ Default Value: none
|
||||
|
||||
|
||||
Image to use as a repeated pattern fill within a polygon
|
||||
* * *
|
||||
|
||||
#### polygon-pattern-alignment `keyword`
|
||||
`local``global`
|
||||
@ -540,6 +596,7 @@ Default Value: local
|
||||
|
||||
|
||||
Specify whether to align pattern fills to the layer or to the map.
|
||||
* * *
|
||||
|
||||
#### polygon-pattern-gamma `float`
|
||||
|
||||
@ -548,9 +605,9 @@ Default Value: 1
|
||||
_(fully antialiased)_
|
||||
Range: 0-1
|
||||
Level of antialiasing of polygon pattern edges
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## raster
|
||||
|
||||
#### raster-opacity `float`
|
||||
@ -560,6 +617,7 @@ Default Value: 1
|
||||
_(opaque)_
|
||||
|
||||
The opacity of the raster symbolizer on top of other symbolizers.
|
||||
* * *
|
||||
|
||||
#### raster-mode `keyword`
|
||||
`normal``grain_merge``grain_merge2``multiply``multiply2``divide``divide2``screen``hard_light`
|
||||
@ -568,6 +626,7 @@ Default Value: normal
|
||||
|
||||
|
||||
The blending technique used to overlay this raster image on the layer below. Normal simply covers the layer. Grain merge adds the two layers together and subtracts 128 from the value, making the resulting area sometimes high-contrast. Screen often gives a lighter, washed-out appearance. Multiply multiplies the pixels, giving a high-contrast result. Divide divides the upper layer by the lower layer, making a lighter version.
|
||||
* * *
|
||||
|
||||
#### raster-filter-factor `float`
|
||||
|
||||
@ -576,6 +635,7 @@ Default Value: -1
|
||||
_(Allow the datasource to choose appropriate downscaling.)_
|
||||
|
||||
This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed.
|
||||
* * *
|
||||
|
||||
#### raster-scaling `keyword`
|
||||
`fast``bilinear``bilinear8``bicubic``spline16``gaussian``lanczos`
|
||||
@ -584,6 +644,7 @@ Default Value: fast
|
||||
|
||||
|
||||
The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality.
|
||||
* * *
|
||||
|
||||
#### raster-mesh-size `integer`
|
||||
|
||||
@ -592,9 +653,9 @@ Default Value: 16
|
||||
_(Reprojection mesh will be 1/16 of the resolution of the source image)_
|
||||
|
||||
A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion.
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## point
|
||||
|
||||
#### point-file `uri`
|
||||
@ -604,6 +665,7 @@ Default Value: none
|
||||
|
||||
|
||||
Image file to represent a point
|
||||
* * *
|
||||
|
||||
#### point-allow-overlap `boolean`
|
||||
|
||||
@ -612,6 +674,7 @@ Default Value: false
|
||||
_(Do not allow points to overlap with each other - overlapping markers will not be shown.)_
|
||||
|
||||
Control whether overlapping points are shown or hidden.
|
||||
* * *
|
||||
|
||||
#### point-ignore-placement `boolean`
|
||||
|
||||
@ -620,6 +683,7 @@ Default Value: false
|
||||
_(do not store the bbox of this geometry in the collision detector cache)_
|
||||
|
||||
value to control whether the placement of the feature will prevent the placement of other features
|
||||
* * *
|
||||
|
||||
#### point-opacity `float`
|
||||
|
||||
@ -628,6 +692,7 @@ Default Value: 1
|
||||
_(Fully opaque)_
|
||||
|
||||
A value from 0 to 1 to control the opacity of the point
|
||||
* * *
|
||||
|
||||
#### point-placement `keyword`
|
||||
`centroid``interior`
|
||||
@ -636,6 +701,7 @@ Default Value: centroid
|
||||
|
||||
|
||||
How this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon.
|
||||
* * *
|
||||
|
||||
#### point-transform `string`
|
||||
|
||||
@ -644,9 +710,9 @@ Default Value:
|
||||
_(No transformation)_
|
||||
|
||||
SVG transformation definition
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## text
|
||||
|
||||
#### text-name `string`
|
||||
@ -656,6 +722,7 @@ Default Value:
|
||||
|
||||
|
||||
Value to use for a text label. Data columns are specified using brackets like [column_name]
|
||||
* * *
|
||||
|
||||
#### text-face-name `string`
|
||||
|
||||
@ -664,6 +731,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Font name and style to render a label in
|
||||
* * *
|
||||
|
||||
#### text-size `float`
|
||||
|
||||
@ -672,6 +740,7 @@ Default Value: 10
|
||||
|
||||
|
||||
Text size in pixels
|
||||
* * *
|
||||
|
||||
#### text-ratio `float`
|
||||
|
||||
@ -680,6 +749,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Define the amount of text (of the total) present on successive lines when wrapping occurs
|
||||
* * *
|
||||
|
||||
#### text-wrap-width `float`
|
||||
|
||||
@ -688,6 +758,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Length of a chunk of text in characters before wrapping text
|
||||
* * *
|
||||
|
||||
#### text-wrap-character `string`
|
||||
|
||||
@ -696,6 +767,7 @@ Default Value:
|
||||
|
||||
|
||||
Use this character instead of a space to wrap long text.
|
||||
* * *
|
||||
|
||||
#### text-spacing `float`
|
||||
|
||||
@ -704,6 +776,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Distance between repeated text labels on a line
|
||||
* * *
|
||||
|
||||
#### text-character-spacing `float`
|
||||
|
||||
@ -712,6 +785,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Horizontal spacing adjustment between characters in pixels
|
||||
* * *
|
||||
|
||||
#### text-line-spacing `float`
|
||||
|
||||
@ -720,6 +794,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Vertical spacing adjustment between lines in pixels
|
||||
* * *
|
||||
|
||||
#### text-label-position-tolerance `float`
|
||||
|
||||
@ -728,6 +803,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Allows the label to be displaced from its ideal position by a number of pixels
|
||||
* * *
|
||||
|
||||
#### text-max-char-angle-delta `float`
|
||||
|
||||
@ -736,6 +812,7 @@ Default Value: none
|
||||
|
||||
|
||||
If present, the maximum angle change, in degrees, allowed between adjacent characters in a label. This will stop label placement around sharp corners.
|
||||
* * *
|
||||
|
||||
#### text-fill `color`
|
||||
|
||||
@ -744,6 +821,7 @@ Default Value: #000000
|
||||
|
||||
|
||||
Specifies the color for the text
|
||||
* * *
|
||||
|
||||
#### text-opacity `float`
|
||||
|
||||
@ -752,6 +830,7 @@ Default Value: 1
|
||||
_(Fully opaque)_
|
||||
|
||||
A number from 0 to 1 specifying the opacity for the text
|
||||
* * *
|
||||
|
||||
#### text-halo-fill `color`
|
||||
|
||||
@ -760,6 +839,7 @@ Default Value: #FFFFFF
|
||||
_(white)_
|
||||
|
||||
Specifies the color of the halo around the text.
|
||||
* * *
|
||||
|
||||
#### text-halo-radius `float`
|
||||
|
||||
@ -768,6 +848,7 @@ Default Value: 0
|
||||
_(no halo)_
|
||||
|
||||
Specify the radius of the halo in pixels
|
||||
* * *
|
||||
|
||||
#### text-dx `float`
|
||||
|
||||
@ -776,6 +857,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right
|
||||
* * *
|
||||
|
||||
#### text-dy `float`
|
||||
|
||||
@ -784,6 +866,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down
|
||||
* * *
|
||||
|
||||
#### text-vertical-alignment `keyword`
|
||||
`top``middle``bottom`
|
||||
@ -792,6 +875,7 @@ Default Value: middle
|
||||
_(Default affected by value of dy; "bottom" for dy>0, "top" for dy<0.)_
|
||||
|
||||
Position of label relative to point position.
|
||||
* * *
|
||||
|
||||
#### text-avoid-edges `boolean`
|
||||
|
||||
@ -800,6 +884,7 @@ Default Value: false
|
||||
|
||||
|
||||
Tell positioning algorithm to avoid labeling near intersection edges.
|
||||
* * *
|
||||
|
||||
#### text-min-distance `float`
|
||||
|
||||
@ -808,6 +893,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Minimum permitted distance to the next text symbolizer.
|
||||
* * *
|
||||
|
||||
#### text-min-padding `float`
|
||||
|
||||
@ -816,6 +902,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Determines the minimum amount of padding that a text symbolizer gets relative to other text
|
||||
* * *
|
||||
|
||||
#### text-min-path-length `float`
|
||||
|
||||
@ -824,6 +911,7 @@ Default Value: 0
|
||||
_(place labels on all paths)_
|
||||
|
||||
Place labels only on paths longer than this value.
|
||||
* * *
|
||||
|
||||
#### text-allow-overlap `boolean`
|
||||
|
||||
@ -832,6 +920,7 @@ Default Value: false
|
||||
_(Do not allow text to overlap with other text - overlapping markers will not be shown.)_
|
||||
|
||||
Control whether overlapping text is shown or hidden.
|
||||
* * *
|
||||
|
||||
#### text-orientation `float`
|
||||
|
||||
@ -840,6 +929,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Rotate the text.
|
||||
* * *
|
||||
|
||||
#### text-placement `keyword`
|
||||
`point``line``vertex``interior`
|
||||
@ -848,6 +938,7 @@ Default Value: point
|
||||
|
||||
|
||||
Control the style of placement of a point versus the geometry it is attached to.
|
||||
* * *
|
||||
|
||||
#### text-placement-type `keyword`
|
||||
`dummy``simple`
|
||||
@ -856,6 +947,7 @@ Default Value: dummy
|
||||
|
||||
|
||||
Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off.
|
||||
* * *
|
||||
|
||||
#### text-placements `string`
|
||||
|
||||
@ -864,6 +956,7 @@ Default Value:
|
||||
|
||||
|
||||
If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. See TextSymbolizer docs for format.
|
||||
* * *
|
||||
|
||||
#### text-transform `keyword`
|
||||
`none``uppercase``lowercase``capitalize`
|
||||
@ -872,6 +965,7 @@ Default Value: none
|
||||
|
||||
|
||||
Transform the case of the characters
|
||||
* * *
|
||||
|
||||
#### text-horizontal-alignment `keyword`
|
||||
`left``middle``right``auto`
|
||||
@ -880,6 +974,7 @@ Default Value: middle
|
||||
|
||||
|
||||
The text's horizontal alignment from its centerpoint
|
||||
* * *
|
||||
|
||||
#### text-align `keyword`
|
||||
`left``right``center`
|
||||
@ -888,9 +983,9 @@ Default Value: center
|
||||
|
||||
|
||||
Set the text alignment.
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## building
|
||||
|
||||
#### building-fill `color`
|
||||
@ -900,6 +995,7 @@ Default Value: #FFFFFF
|
||||
|
||||
|
||||
The color of the buildings walls.
|
||||
* * *
|
||||
|
||||
#### building-fill-opacity `float`
|
||||
|
||||
@ -908,6 +1004,7 @@ Default Value: 1
|
||||
|
||||
|
||||
The opacity of the building as a whole, including all walls.
|
||||
* * *
|
||||
|
||||
#### building-height `float`
|
||||
|
||||
@ -916,6 +1013,7 @@ Default Value: 0
|
||||
|
||||
|
||||
The height of the building in pixels.
|
||||
* * *
|
||||
|
||||
|
||||
|
||||
|
||||
140
docs/2.0.2.md
140
docs/2.0.2.md
@ -2,7 +2,6 @@
|
||||
|
||||
The following is a list of properties provided in CartoCSS that you can apply to map elements.
|
||||
|
||||
* * *
|
||||
## map
|
||||
|
||||
#### background-color `color`
|
||||
@ -12,6 +11,7 @@ Default Value: none
|
||||
_(transparent)_
|
||||
|
||||
Map Background color
|
||||
* * *
|
||||
|
||||
#### background-image `uri`
|
||||
|
||||
@ -20,6 +20,7 @@ Default Value:
|
||||
_(transparent)_
|
||||
|
||||
An image that is repeated below all features on a map as a background.
|
||||
* * *
|
||||
|
||||
#### srs `string`
|
||||
|
||||
@ -28,6 +29,7 @@ Default Value: +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs
|
||||
_(The proj4 literal of EPSG:4326 is assumed to be the Map's spatial reference and all data from layers within this map will be plotted using this coordinate system. If any layers do not declare an srs value then they will be assumed to be in the same srs as the Map and not transformations will be needed to plot them in the Map's coordinate space)_
|
||||
|
||||
Map spatial reference (proj4 string)
|
||||
* * *
|
||||
|
||||
#### buffer-size `float`
|
||||
|
||||
@ -36,6 +38,7 @@ Default Value: 0
|
||||
_(No buffer will be used)_
|
||||
|
||||
Extra tolerance around the map (in pixels) used to ensure labels crossing tile boundaries are equally rendered in each tile (e.g. cut in each tile). Not intended to be used in combination with "avoid-edges".
|
||||
* * *
|
||||
|
||||
#### base `string`
|
||||
|
||||
@ -44,6 +47,7 @@ Default Value:
|
||||
_(This base path defaults to an empty string meaning that any relative paths to files referenced in styles or layers will be interpreted relative to the application process.)_
|
||||
|
||||
Any relative paths used to reference files will be understood as relative to this directory path if the map is loaded from an in memory object rather than from the filesystem. If the map is loaded from the filesystem and this option is not provided it will be set to the directory of the stylesheet.
|
||||
* * *
|
||||
|
||||
#### font-directory `uri`
|
||||
|
||||
@ -52,9 +56,9 @@ Default Value: none
|
||||
_(No map-specific fonts will be registered)_
|
||||
|
||||
Path to a directory which holds fonts which should be registered when the Map is loaded (in addition to any fonts that may be automatically registered).
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## polygon
|
||||
|
||||
#### polygon-fill `color`
|
||||
@ -64,6 +68,7 @@ Default Value: rgba(128,128,128,1)
|
||||
_(gray and fully opaque (alpha = 1), same as rgb(128,128,128))_
|
||||
|
||||
Fill color to assign to a polygon
|
||||
* * *
|
||||
|
||||
#### polygon-gamma `float`
|
||||
|
||||
@ -72,6 +77,7 @@ Default Value: 1
|
||||
_(fully antialiased)_
|
||||
Range: 0-1
|
||||
Level of antialiasing of polygon edges
|
||||
* * *
|
||||
|
||||
#### polygon-opacity `float`
|
||||
|
||||
@ -80,6 +86,7 @@ Default Value: 1
|
||||
_(opaque)_
|
||||
|
||||
The opacity of the polygon
|
||||
* * *
|
||||
|
||||
#### polygon-smooth `float`
|
||||
|
||||
@ -88,9 +95,9 @@ Default Value: 0
|
||||
_(no smoothing)_
|
||||
Range: 0-1
|
||||
Amount of smoothing applied
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## line
|
||||
|
||||
#### line-color `color`
|
||||
@ -100,6 +107,7 @@ Default Value: rgba(0,0,0,1)
|
||||
_(black and fully opaque (alpha = 1), same as rgb(0,0,0))_
|
||||
|
||||
The color of a drawn line
|
||||
* * *
|
||||
|
||||
#### line-width `float`
|
||||
|
||||
@ -108,6 +116,7 @@ Default Value: 1
|
||||
|
||||
|
||||
The width of a line in pixels
|
||||
* * *
|
||||
|
||||
#### line-opacity `float`
|
||||
|
||||
@ -116,6 +125,7 @@ Default Value: 1
|
||||
_(opaque)_
|
||||
|
||||
The opacity of a line
|
||||
* * *
|
||||
|
||||
#### line-join `keyword`
|
||||
`miter``round``bevel`
|
||||
@ -124,6 +134,7 @@ Default Value: miter
|
||||
|
||||
|
||||
The behavior of lines when joining
|
||||
* * *
|
||||
|
||||
#### line-cap `keyword`
|
||||
`butt``round``square`
|
||||
@ -132,6 +143,7 @@ Default Value: butt
|
||||
|
||||
|
||||
The display of line endings
|
||||
* * *
|
||||
|
||||
#### line-gamma `float`
|
||||
|
||||
@ -140,6 +152,7 @@ Default Value: 1
|
||||
_(fully antialiased)_
|
||||
Range: 0-1
|
||||
Level of antialiasing of stroke line
|
||||
* * *
|
||||
|
||||
#### line-dasharray `numbers`
|
||||
|
||||
@ -148,6 +161,7 @@ Default Value: none
|
||||
_(solid line)_
|
||||
|
||||
A pair of length values [a,b], where (a) is the dash length and (b) is the gap length respectively. More than two values are supported for more complex patterns.
|
||||
* * *
|
||||
|
||||
#### line-dash-offset `numbers`
|
||||
|
||||
@ -156,6 +170,7 @@ Default Value: none
|
||||
_(solid line)_
|
||||
|
||||
valid parameter but not currently used in renderers
|
||||
* * *
|
||||
|
||||
#### line-rasterizer `keyword`
|
||||
`full``fast`
|
||||
@ -164,9 +179,9 @@ Default Value: full
|
||||
|
||||
|
||||
Exposes an alternate AGG rendering method that sacrifices some accuracy for speed.
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## markers
|
||||
|
||||
#### marker-file `uri`
|
||||
@ -176,6 +191,7 @@ Default Value:
|
||||
_(An ellipse or circle, if width equals height)_
|
||||
|
||||
An SVG file that this marker shows at each placement. If no file is given, the marker will show an ellipse.
|
||||
* * *
|
||||
|
||||
#### marker-opacity `float`
|
||||
|
||||
@ -184,6 +200,7 @@ Default Value: 1
|
||||
_(opaque)_
|
||||
|
||||
The overall opacity of the marker
|
||||
* * *
|
||||
|
||||
#### marker-line-color `color`
|
||||
|
||||
@ -192,6 +209,7 @@ Default Value: black
|
||||
|
||||
|
||||
The color of the stroke around a marker shape.
|
||||
* * *
|
||||
|
||||
#### marker-line-width `float`
|
||||
|
||||
@ -200,6 +218,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
The width of the stroke around a marker shape, in pixels. This is positioned on the boundary, so high values can cover the area itself.
|
||||
* * *
|
||||
|
||||
#### marker-line-opacity `float`
|
||||
|
||||
@ -208,6 +227,7 @@ Default Value: 1
|
||||
_(opaque)_
|
||||
|
||||
The opacity of a line
|
||||
* * *
|
||||
|
||||
#### marker-placement `keyword`
|
||||
`point``line`
|
||||
@ -216,6 +236,7 @@ Default Value: line
|
||||
|
||||
|
||||
Attempt to place markers on a point once or on a line repeatedly
|
||||
* * *
|
||||
|
||||
#### marker-type `keyword`
|
||||
`arrow``ellipse`
|
||||
@ -224,6 +245,7 @@ Default Value: ellipse
|
||||
|
||||
|
||||
The default marker-type. If a SVG file is not given as the marker-file parameter, the renderer provides either an arrow or an ellipse (a circle if height is equal to width)
|
||||
* * *
|
||||
|
||||
#### marker-width `float`
|
||||
|
||||
@ -232,6 +254,7 @@ Default Value: 10
|
||||
|
||||
|
||||
The width of the marker, if using one of the default types.
|
||||
* * *
|
||||
|
||||
#### marker-height `float`
|
||||
|
||||
@ -240,6 +263,7 @@ Default Value: 10
|
||||
|
||||
|
||||
The height of the marker, if using one of the default types.
|
||||
* * *
|
||||
|
||||
#### marker-fill `color`
|
||||
|
||||
@ -248,6 +272,7 @@ Default Value: blue
|
||||
|
||||
|
||||
The color of the area of the marker.
|
||||
* * *
|
||||
|
||||
#### marker-allow-overlap `boolean`
|
||||
|
||||
@ -256,6 +281,7 @@ Default Value: false
|
||||
_(Do not allow makers to overlap with each other - overlapping markers will not be shown.)_
|
||||
|
||||
Control whether overlapping markers are shown or hidden.
|
||||
* * *
|
||||
|
||||
#### marker-ignore-placement `boolean`
|
||||
|
||||
@ -264,6 +290,7 @@ Default Value: false
|
||||
_(do not store the bbox of this geometry in the collision detector cache)_
|
||||
|
||||
value to control whether the placement of the feature will prevent the placement of other features
|
||||
* * *
|
||||
|
||||
#### marker-spacing `float`
|
||||
|
||||
@ -272,6 +299,7 @@ Default Value: 100
|
||||
|
||||
|
||||
Space between repeated labels
|
||||
* * *
|
||||
|
||||
#### marker-max-error `float`
|
||||
|
||||
@ -280,6 +308,7 @@ Default Value: 0.2
|
||||
|
||||
|
||||
The maximum difference between actual marker placement and the marker-spacing parameter. Setting a high value can allow the renderer to try to resolve placement conflicts with other symbolizers.
|
||||
* * *
|
||||
|
||||
#### marker-transform `string`
|
||||
|
||||
@ -288,9 +317,9 @@ Default Value:
|
||||
_(no transformation)_
|
||||
|
||||
An SVG transformation definition
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## shield
|
||||
|
||||
#### shield-name `string`
|
||||
@ -300,6 +329,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Value to use for a shield"s text label. Data columns are specified using brackets like [column_name]
|
||||
* * *
|
||||
|
||||
#### shield-face-name `string`
|
||||
|
||||
@ -308,6 +338,7 @@ Default Value:
|
||||
|
||||
|
||||
Font name and style to use for the shield text
|
||||
* * *
|
||||
|
||||
#### shield-unlock-image `boolean`
|
||||
|
||||
@ -316,6 +347,7 @@ Default Value: false
|
||||
_(text alignment relative to the shield image uses the center of the image as the anchor for text positioning.)_
|
||||
|
||||
This parameter should be set to true if you are trying to position text beside rather than on top of the shield image
|
||||
* * *
|
||||
|
||||
#### shield-size `float`
|
||||
|
||||
@ -324,6 +356,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
The size of the shield text in pixels
|
||||
* * *
|
||||
|
||||
#### shield-fill `color`
|
||||
|
||||
@ -332,6 +365,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
The color of the shield text
|
||||
* * *
|
||||
|
||||
#### shield-placement `keyword`
|
||||
`point``line``vertex``interior`
|
||||
@ -340,6 +374,7 @@ Default Value: point
|
||||
|
||||
|
||||
How this shield should be placed. Point placement attempts to place it on top of points, line places along lines multiple times per feature, vertex places on the vertexes of polygons, and interior attempts to place inside of polygons.
|
||||
* * *
|
||||
|
||||
#### shield-avoid-edges `boolean`
|
||||
|
||||
@ -348,6 +383,7 @@ Default Value: false
|
||||
|
||||
|
||||
Tell positioning algorithm to avoid labeling near intersection edges.
|
||||
* * *
|
||||
|
||||
#### shield-min-distance `float`
|
||||
|
||||
@ -356,6 +392,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Minimum distance to the next shield symbol, not necessarily the same shield.
|
||||
* * *
|
||||
|
||||
#### shield-spacing `float`
|
||||
|
||||
@ -364,6 +401,7 @@ Default Value: 0
|
||||
|
||||
|
||||
The spacing between repeated occurrences of the same shield on a line
|
||||
* * *
|
||||
|
||||
#### shield-min-padding `float`
|
||||
|
||||
@ -372,6 +410,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Determines the minimum amount of padding that a shield gets relative to other shields
|
||||
* * *
|
||||
|
||||
#### shield-wrap-width `float`
|
||||
|
||||
@ -380,6 +419,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Length before wrapping long names.
|
||||
* * *
|
||||
|
||||
#### shield-wrap-character `string`
|
||||
|
||||
@ -388,6 +428,7 @@ Default Value:
|
||||
|
||||
|
||||
Use this character instead of a space to wrap long names.
|
||||
* * *
|
||||
|
||||
#### shield-halo-fill `color`
|
||||
|
||||
@ -396,6 +437,7 @@ Default Value: #FFFFFF
|
||||
_(white)_
|
||||
|
||||
Specifies the color of the halo around the text.
|
||||
* * *
|
||||
|
||||
#### shield-halo-radius `float`
|
||||
|
||||
@ -404,6 +446,7 @@ Default Value: 0
|
||||
_(no halo)_
|
||||
|
||||
Specify the radius of the halo in pixels
|
||||
* * *
|
||||
|
||||
#### shield-character-spacing `float`
|
||||
|
||||
@ -412,6 +455,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Horizontal spacing between characters (in pixels). Currently works for point placement only, not line placement.
|
||||
* * *
|
||||
|
||||
#### shield-line-spacing `float`
|
||||
|
||||
@ -420,6 +464,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Vertical spacing between lines of multiline labels (in pixels)
|
||||
* * *
|
||||
|
||||
#### shield-file `uri`
|
||||
|
||||
@ -428,6 +473,7 @@ Default Value: none
|
||||
|
||||
|
||||
Image file to render behind the shield text
|
||||
* * *
|
||||
|
||||
#### shield-text-dx `float`
|
||||
|
||||
@ -436,6 +482,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Displace text within shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right
|
||||
* * *
|
||||
|
||||
#### shield-text-dy `float`
|
||||
|
||||
@ -444,6 +491,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Displace text within shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down
|
||||
* * *
|
||||
|
||||
#### shield-dx `float`
|
||||
|
||||
@ -452,6 +500,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Displace shield by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right
|
||||
* * *
|
||||
|
||||
#### shield-dy `float`
|
||||
|
||||
@ -460,6 +509,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Displace shield by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down
|
||||
* * *
|
||||
|
||||
#### shield-opacity `float`
|
||||
|
||||
@ -468,6 +518,7 @@ Default Value: 1
|
||||
|
||||
|
||||
(Default 1.0) - opacity of the image used for the shield
|
||||
* * *
|
||||
|
||||
#### shield-text-opacity `float`
|
||||
|
||||
@ -476,6 +527,7 @@ Default Value: 1
|
||||
|
||||
|
||||
(Default 1.0) - opacity of the text placed on top of the shield
|
||||
* * *
|
||||
|
||||
#### shield-horizontal-alignment `keyword`
|
||||
`left``middle``right``auto`
|
||||
@ -484,6 +536,7 @@ Default Value: middle
|
||||
|
||||
|
||||
The shield's horizontal alignment from its centerpoint
|
||||
* * *
|
||||
|
||||
#### shield-text-transform `keyword`
|
||||
`none``uppercase``lowercase``capitalize`
|
||||
@ -492,6 +545,7 @@ Default Value: none
|
||||
|
||||
|
||||
Transform the case of the characters
|
||||
* * *
|
||||
|
||||
#### shield-no-text `boolean`
|
||||
|
||||
@ -500,6 +554,7 @@ Default Value: false
|
||||
|
||||
|
||||
Whether the shield should make room for a text label.
|
||||
* * *
|
||||
|
||||
#### shield-justify-alignment `string`
|
||||
|
||||
@ -508,9 +563,9 @@ Default Value: middle
|
||||
|
||||
|
||||
Define how text in a shield's label is justified
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## line-pattern
|
||||
|
||||
#### line-pattern-file `uri`
|
||||
@ -520,9 +575,9 @@ Default Value: none
|
||||
|
||||
|
||||
An image file to be repeated and warped along a line
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## polygon-pattern
|
||||
|
||||
#### polygon-pattern-file `uri`
|
||||
@ -532,6 +587,7 @@ Default Value: none
|
||||
|
||||
|
||||
Image to use as a repeated pattern fill within a polygon
|
||||
* * *
|
||||
|
||||
#### polygon-pattern-alignment `keyword`
|
||||
`local``global`
|
||||
@ -540,6 +596,7 @@ Default Value: local
|
||||
|
||||
|
||||
Specify whether to align pattern fills to the layer or to the map.
|
||||
* * *
|
||||
|
||||
#### polygon-pattern-gamma `float`
|
||||
|
||||
@ -548,9 +605,9 @@ Default Value: 1
|
||||
_(fully antialiased)_
|
||||
Range: 0-1
|
||||
Level of antialiasing of polygon pattern edges
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## raster
|
||||
|
||||
#### raster-opacity `float`
|
||||
@ -560,6 +617,7 @@ Default Value: 1
|
||||
_(opaque)_
|
||||
|
||||
The opacity of the raster symbolizer on top of other symbolizers.
|
||||
* * *
|
||||
|
||||
#### raster-mode `keyword`
|
||||
`normal``grain_merge``grain_merge2``multiply``multiply2``divide``divide2``screen``hard_light`
|
||||
@ -568,6 +626,7 @@ Default Value: normal
|
||||
|
||||
|
||||
The blending technique used to overlay this raster image on the layer below. Normal simply covers the layer. Grain merge adds the two layers together and subtracts 128 from the value, making the resulting area sometimes high-contrast. Screen often gives a lighter, washed-out appearance. Multiply multiplies the pixels, giving a high-contrast result. Divide divides the upper layer by the lower layer, making a lighter version.
|
||||
* * *
|
||||
|
||||
#### raster-filter-factor `float`
|
||||
|
||||
@ -576,6 +635,7 @@ Default Value: -1
|
||||
_(Allow the datasource to choose appropriate downscaling.)_
|
||||
|
||||
This is used by the Raster or Gdal datasources to pre-downscale images using overviews. Higher numbers can sometimes cause much better scaled image output, at the cost of speed.
|
||||
* * *
|
||||
|
||||
#### raster-scaling `keyword`
|
||||
`fast``bilinear``bilinear8``bicubic``spline16``gaussian``lanczos`
|
||||
@ -584,6 +644,7 @@ Default Value: fast
|
||||
|
||||
|
||||
The scaling algorithm used to making different resolution versions of this raster layer. Bilinear is a good compromise between speed and accuracy, while lanczos gives the highest quality.
|
||||
* * *
|
||||
|
||||
#### raster-mesh-size `integer`
|
||||
|
||||
@ -592,9 +653,9 @@ Default Value: 16
|
||||
_(Reprojection mesh will be 1/16 of the resolution of the source image)_
|
||||
|
||||
A reduced resolution mesh is used for raster reprojection, and the total image size is divided by the mesh-size to determine the quality of that mesh. Values for mesh-size larger than the default will result in faster reprojection but might lead to distortion.
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## point
|
||||
|
||||
#### point-file `uri`
|
||||
@ -604,6 +665,7 @@ Default Value: none
|
||||
|
||||
|
||||
Image file to represent a point
|
||||
* * *
|
||||
|
||||
#### point-allow-overlap `boolean`
|
||||
|
||||
@ -612,6 +674,7 @@ Default Value: false
|
||||
_(Do not allow points to overlap with each other - overlapping markers will not be shown.)_
|
||||
|
||||
Control whether overlapping points are shown or hidden.
|
||||
* * *
|
||||
|
||||
#### point-ignore-placement `boolean`
|
||||
|
||||
@ -620,6 +683,7 @@ Default Value: false
|
||||
_(do not store the bbox of this geometry in the collision detector cache)_
|
||||
|
||||
value to control whether the placement of the feature will prevent the placement of other features
|
||||
* * *
|
||||
|
||||
#### point-opacity `float`
|
||||
|
||||
@ -628,6 +692,7 @@ Default Value: 1
|
||||
_(Fully opaque)_
|
||||
|
||||
A value from 0 to 1 to control the opacity of the point
|
||||
* * *
|
||||
|
||||
#### point-placement `keyword`
|
||||
`centroid``interior`
|
||||
@ -636,6 +701,7 @@ Default Value: centroid
|
||||
|
||||
|
||||
How this point should be placed. Centroid calculates the geometric center of a polygon, which can be outside of it, while interior always places inside of a polygon.
|
||||
* * *
|
||||
|
||||
#### point-transform `string`
|
||||
|
||||
@ -644,9 +710,9 @@ Default Value:
|
||||
_(No transformation)_
|
||||
|
||||
SVG transformation definition
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## text
|
||||
|
||||
#### text-name `string`
|
||||
@ -656,6 +722,7 @@ Default Value:
|
||||
|
||||
|
||||
Value to use for a text label. Data columns are specified using brackets like [column_name]
|
||||
* * *
|
||||
|
||||
#### text-face-name `string`
|
||||
|
||||
@ -664,6 +731,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Font name and style to render a label in
|
||||
* * *
|
||||
|
||||
#### text-size `float`
|
||||
|
||||
@ -672,6 +740,7 @@ Default Value: 10
|
||||
|
||||
|
||||
Text size in pixels
|
||||
* * *
|
||||
|
||||
#### text-ratio `float`
|
||||
|
||||
@ -680,6 +749,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Define the amount of text (of the total) present on successive lines when wrapping occurs
|
||||
* * *
|
||||
|
||||
#### text-wrap-width `float`
|
||||
|
||||
@ -688,6 +758,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Length of a chunk of text in characters before wrapping text
|
||||
* * *
|
||||
|
||||
#### text-wrap-character `string`
|
||||
|
||||
@ -696,6 +767,7 @@ Default Value:
|
||||
|
||||
|
||||
Use this character instead of a space to wrap long text.
|
||||
* * *
|
||||
|
||||
#### text-spacing `float`
|
||||
|
||||
@ -704,6 +776,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Distance between repeated text labels on a line
|
||||
* * *
|
||||
|
||||
#### text-character-spacing `float`
|
||||
|
||||
@ -712,6 +785,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Horizontal spacing adjustment between characters in pixels
|
||||
* * *
|
||||
|
||||
#### text-line-spacing `float`
|
||||
|
||||
@ -720,6 +794,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Vertical spacing adjustment between lines in pixels
|
||||
* * *
|
||||
|
||||
#### text-label-position-tolerance `float`
|
||||
|
||||
@ -728,6 +803,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Allows the label to be displaced from its ideal position by a number of pixels
|
||||
* * *
|
||||
|
||||
#### text-max-char-angle-delta `float`
|
||||
|
||||
@ -736,6 +812,7 @@ Default Value: none
|
||||
|
||||
|
||||
If present, the maximum angle change, in degrees, allowed between adjacent characters in a label. This will stop label placement around sharp corners.
|
||||
* * *
|
||||
|
||||
#### text-fill `color`
|
||||
|
||||
@ -744,6 +821,7 @@ Default Value: #000000
|
||||
|
||||
|
||||
Specifies the color for the text
|
||||
* * *
|
||||
|
||||
#### text-opacity `float`
|
||||
|
||||
@ -752,6 +830,7 @@ Default Value: 1
|
||||
_(Fully opaque)_
|
||||
|
||||
A number from 0 to 1 specifying the opacity for the text
|
||||
* * *
|
||||
|
||||
#### text-halo-fill `color`
|
||||
|
||||
@ -760,6 +839,7 @@ Default Value: #FFFFFF
|
||||
_(white)_
|
||||
|
||||
Specifies the color of the halo around the text.
|
||||
* * *
|
||||
|
||||
#### text-halo-radius `float`
|
||||
|
||||
@ -768,6 +848,7 @@ Default Value: 0
|
||||
_(no halo)_
|
||||
|
||||
Specify the radius of the halo in pixels
|
||||
* * *
|
||||
|
||||
#### text-dx `float`
|
||||
|
||||
@ -776,6 +857,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Displace text by fixed amount, in pixels, +/- along the X axis. A positive value will shift the text right
|
||||
* * *
|
||||
|
||||
#### text-dy `float`
|
||||
|
||||
@ -784,6 +866,7 @@ Default Value: 0
|
||||
|
||||
|
||||
Displace text by fixed amount, in pixels, +/- along the Y axis. A positive value will shift the text down
|
||||
* * *
|
||||
|
||||
#### text-vertical-alignment `keyword`
|
||||
`top``middle``bottom`
|
||||
@ -792,6 +875,7 @@ Default Value: middle
|
||||
_(Default affected by value of dy; "bottom" for dy>0, "top" for dy<0.)_
|
||||
|
||||
Position of label relative to point position.
|
||||
* * *
|
||||
|
||||
#### text-avoid-edges `boolean`
|
||||
|
||||
@ -800,6 +884,7 @@ Default Value: false
|
||||
|
||||
|
||||
Tell positioning algorithm to avoid labeling near intersection edges.
|
||||
* * *
|
||||
|
||||
#### text-min-distance `float`
|
||||
|
||||
@ -808,6 +893,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Minimum permitted distance to the next text symbolizer.
|
||||
* * *
|
||||
|
||||
#### text-min-padding `float`
|
||||
|
||||
@ -816,6 +902,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Determines the minimum amount of padding that a text symbolizer gets relative to other text
|
||||
* * *
|
||||
|
||||
#### text-min-path-length `float`
|
||||
|
||||
@ -824,6 +911,7 @@ Default Value: 0
|
||||
_(place labels on all paths)_
|
||||
|
||||
Place labels only on paths longer than this value.
|
||||
* * *
|
||||
|
||||
#### text-allow-overlap `boolean`
|
||||
|
||||
@ -832,6 +920,7 @@ Default Value: false
|
||||
_(Do not allow text to overlap with other text - overlapping markers will not be shown.)_
|
||||
|
||||
Control whether overlapping text is shown or hidden.
|
||||
* * *
|
||||
|
||||
#### text-orientation `float`
|
||||
|
||||
@ -840,6 +929,7 @@ Default Value: undefined
|
||||
|
||||
|
||||
Rotate the text.
|
||||
* * *
|
||||
|
||||
#### text-placement `keyword`
|
||||
`point``line``vertex``interior`
|
||||
@ -848,6 +938,7 @@ Default Value: point
|
||||
|
||||
|
||||
Control the style of placement of a point versus the geometry it is attached to.
|
||||
* * *
|
||||
|
||||
#### text-placement-type `keyword`
|
||||
`dummy``simple`
|
||||
@ -856,6 +947,7 @@ Default Value: dummy
|
||||
|
||||
|
||||
Re-position and/or re-size text to avoid overlaps. "simple" for basic algorithm (using text-placements string,) "dummy" to turn this feature off.
|
||||
* * *
|
||||
|
||||
#### text-placements `string`
|
||||
|
||||
@ -864,6 +956,7 @@ Default Value:
|
||||
|
||||
|
||||
If "placement-type" is set to "simple", use this "POSITIONS,[SIZES]" string. See TextSymbolizer docs for format.
|
||||
* * *
|
||||
|
||||
#### text-transform `keyword`
|
||||
`none``uppercase``lowercase``capitalize`
|
||||
@ -872,6 +965,7 @@ Default Value: none
|
||||
|
||||
|
||||
Transform the case of the characters
|
||||
* * *
|
||||
|
||||
#### text-horizontal-alignment `keyword`
|
||||
`left``middle``right``auto`
|
||||
@ -880,6 +974,7 @@ Default Value: middle
|
||||
|
||||
|
||||
The text's horizontal alignment from its centerpoint
|
||||
* * *
|
||||
|
||||
#### text-align `keyword`
|
||||
`left``right``center`
|
||||
@ -888,9 +983,9 @@ Default Value: center
|
||||
|
||||
|
||||
Set the text alignment.
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
|
||||
## building
|
||||
|
||||
#### building-fill `color`
|
||||
@ -900,6 +995,7 @@ Default Value: #FFFFFF
|
||||
|
||||
|
||||
The color of the buildings walls.
|
||||
* * *
|
||||
|
||||
#### building-fill-opacity `float`
|
||||
|
||||
@ -908,6 +1004,7 @@ Default Value: 1
|
||||
|
||||
|
||||
The opacity of the building as a whole, including all walls.
|
||||
* * *
|
||||
|
||||
#### building-height `float`
|
||||
|
||||
@ -916,6 +1013,7 @@ Default Value: 0
|
||||
|
||||
|
||||
The height of the building in pixels.
|
||||
* * *
|
||||
|
||||
|
||||
|
||||
|
||||
179
docs/2.1.0.md
179
docs/2.1.0.md
File diff suppressed because it is too large
Load Diff
180
docs/2.1.1.md
180
docs/2.1.1.md
File diff suppressed because it is too large
Load Diff
204
docs/latest.md
204
docs/latest.md
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user