Property listing

This page lists the supported rendering properties. See CSS value types for more information about the value types for each.

Point symbology

Property	Type	Meaning	Accepts Expression?
mark	url, symbol	The image or well-known shape to render for points	yes
mark-composite	string	The composite mode to be used and the optional opacity separated with a comma. See the full list of available modes.	no
mark-mime	string (MIME Type)	The type of the image referenced by a url()	No, defaults to 'image/jpeg'
mark-geometry	expression	An expression to use for the geometry when rendering features	yes
mark-size	length	The width to assume for the provided image. The height will be adjusted to preserve the source aspect ratio.	yes
mark-rotation	angle	A rotation to be applied (clockwise) to the mark image.	yes
z-index	integer	Controls the z ordering of output	no
mark-label-obstacle	boolean	If true the point symbol will be considered an obstacle for labels, no label will overlap it	no
mark-anchor	expression	The part of the mark to place over the point or middle of the polygon. This takes 2 values - x y where x=0 is the left edge of the label, x=1 is the right edge. y=0 is the bottom edge of the label, y=1 is the top edge. Specify 0.5 0.5 to centre a label.	yes
mark-offset	expression	This is for fine-tuning mark-anchor. x and y values specify pixel offsets to adjust the mark position.	yes

Line symbology

Property	Type	Meaning	Accepts Expression?
stroke	color, url, symbol	The color, graphic, or well-known shape to use to stroke lines or outlines	yes
stroke-composite	string	The composite mode to be used and the optional opacity separated with a comma. See the full list of available modes.	no
stroke-geometry	expression	An expression to use for the geometry when rendering features.	yes
stroke-offset	expression	Draws a parallel line using the specified distance, positive values offset left, negative right.	yes
stroke-mime	string (MIME Type)	The type of the image referenced by a url()	No, defaults to 'image/jpeg'
stroke-opacity	percentage	A value in the range of 0 (fully transparent) to 1.0 (fully opaque)	yes
stroke-width	length	The width to use for stroking the line.	yes
stroke-size	length	An image or symbol used for the stroke pattern will be stretched or squashed to this size before rendering. If this value differs from the stroke-width, the graphic will be repeated or clipped as needed.	yes
stroke-rotation	angle	A rotation to be applied (clockwise) to the stroke image. See also the stroke- repeat property.	yes
stroke-linecap	keyword: butt, square, round	The style to apply to the ends of lines drawn	yes
stroke-linejoin	keyword: miter, round, bevel	The style to apply to the "elbows" where segments of multi-line features meet.	yes
stroke-dasharray	list of lengths	The lengths of segments to use in a dashed line.	no
stroke-dashoffset	length	How far to offset the dash pattern from the ends of the lines.	yes
stroke-repeat	keyword: repeat, stipple	How to use the provided graphic to paint the line. If repeat, then the graphic is repeatedly painted along the length of the line (rotated appropriately to match the line's direction). If stipple, then the line is treated as a polygon to be filled.	yes
z-index	integer	Controls the z ordering of output	no
stroke-label-obstacle	boolean	If true the line will be considered an obstacle for labels, no label will overlap it	no

Polygon symbology

Property	Type	Meaning	Accepts Expression?
fill	color, url, symbol	The color, graphic, or well-known shape to use to stroke lines or outlines	yes
fill-composite	string	The composite mode to be used and the optional opacity separated with a comma. See the full list of available modes.	no
fill-geometry	expression	An expression to use for the geometry when rendering features.	yes
fill-mime	string (MIME Type)	The type of the image referenced by a url()	No, defaults to 'image/jpeg'
fill-opacity	percentage	A value in the range of 0 (fully transparent) to 1.0 (fully opaque)	yes
fill-size	length	The width to assume for the image or graphic provided.	yes
fill-rotation	angle	A rotation to be applied (clockwise) to the fill image.	yes
z-index	integer	Controls the z ordering of output	no
fill-label-obstacle	boolean	If true the polygon will be considered an obstacle for labels, no label will overlap it	no
graphic-margin	List of lengths	A list of 1 to 4 values, specifying the space between repeated graphics in a texture paint. One value is uniform spacing in all directions, two values are considered top/bottom and right/left, three values are considered top, right/left, bottom, four values are read as top,right,bottom,left.	no
random	none,grid,free	Activates random distribution of symbols in a texture fill tile. See Fills with randomized symbols for details. Defaults to "none"	no
random-seed	integer number	The seed for the random generator. Defaults to 0	no
random-rotation	none/free	When set to "free" activates random rotation of the symbol in addition to random distribution. Defaults to "none"	no
random-symbol-count	positive integer number	Number of symbols to be placed in the texture fill tile. May not be respected due to location conflicts (no two symbols are allowed to overlap). Defaults to 16.	no
random-tile-size	positive integer number	Size of the texture paint tile that will be filled with the random symbols. Defaults to 256.	no

Text symbology (labelling) - part 1

Property	Type	Meaning	Accepts Expression?
label	string	The text to display as labels for features	yes
label-geometry	expression	An expression to use for the geometry when rendering features.	yes
label-anchor	expression	The part of the label to place over the point or middle of the polygon. This takes 2 values - x y where x=0 is the left edge of the label, x=1 is the right edge. y=0 is the bottom edge of the label, y=1 is the top edge. Specify 0.5 0.5 to centre a label.	yes
label-offset	expression	This is for fine-tuning label-anchor. x and y values specify pixels to adjust the label position. For lines, a single value will make the label be parallel to the line, at the given distance, while two values will force a point style placement, with the label painted horizontally at the center of the line (plus the given offsets)	yes
label-rotation	expression	Clockwise rotation of label in degrees.	yes
label-z-index	expression	Used to determine which labels are drawn on top of other labels. Lower z-indexes are drawn on top.	yes
shield	mark, symbol	A graphic to display behind the label, such as a highway shield.	yes
shield-mime	string (MIME Type)	The type of the image referenced by a url()	No, defaults to 'image/jpeg'
shield-placement	one of label, independent, defaults to label	Placement of the shield relative to the label. The default is label, meaning the shield will move along with the label and be centered with it (classic road shield). independent places the shield independently instead, using its own anchor and offset properties. The latter is useful to build "point and label" compositions (e.g., city labels) so that the point won't show up if the label does not (as an alternative to a mark and label setup, where the mark will always show up).	no
shield-anchor	expression	The part of the shield to place over the point or middle of the polygon. This takes 2 values - x y where x=0 is the left edge of the label, x=1 is the right edge. y=0 is the bottom edge of the label, y=1 is the top edge. Specify 0.5 0.5 to centre a label. This property activates only if the shield-placement one is set to independent, otherwise the shield will be centered with the label.	yes
shield-offset	expression	This is for fine-tuning shield-anchor. x and y values specify pixels to adjust the shield position. This property activates only if the shield-placement one is set to independent, otherwise the shield will be centered with the label.	yes
font-family	string	The name of the font or font family to use for labels	yes
font-fill	fill	The fill to use when rendering fonts	yes
font-style	keyword: normal, italic, oblique	The style for the lettering	yes
font-weight	keyword: normal, bold	The weight for the lettering	yes
font-size	length	The size for the font to display.	yes
font-opacity	percentage	The opacity of the text, from 0 (fully transparent) to 1.0 (fully opaque).	yes
halo-radius	length	The size of a halo to display around the lettering (to enhance readability). This is required to activate the halo feature.	yes
halo-color	color	The color for the halo	yes
halo-opacity	percentage	The opacity of the halo, from 0 (fully transparent) to 1.0 (fully opaque).	yes
label-padding	length	The amount of 'padding' space to provide around labels. Labels will not be rendered closer together than this threshold. This is equivalent to the spaceAround<labeling_space_around> vendor parameter.	no
label-group	one of: true or false	If true, the render will treat features with the same label text as a single feature for the purpose of labelling. This is equivalent to the group<labeling_group> vendor parameter.	no
label-max-displacement	length	If set, this is the maximum displacement that the renderer will apply to a label. Labels that need larger displacements to avoid collisions will simply be omitted. This is equivalent to the maxDisplacement<labeling_max_displacement> vendor parameter.	no

Text symbology (labelling) - part 2

Property	Type	Meaning	Accepts Expression?
label-min-group-distance	length	This is equivalent to the minGroupDistance vendor parameter in SLD.	no
label-repeat	length	If set, the renderer will repeat labels at this interval along a line. This is equivalent to the repeat<labeling_repeat> vendor parameter.	no
label-all-group	one of true or false	when using grouping, whether to label only the longest line that could be built by merging the lines forming the group, or also the other ones. This is equivalent to the allGroup<labeling_all_group> vendor parameter.	no
label-remove-overlaps	one of true or false	If enabled, the renderer will remove overlapping lines within a group to avoid duplicate labels. This is equivalent to the removeOverlaps vendor parameter.	no
label-allow-overruns	one of true or false	Determines whether the renderer will show labels that are longer than the lines being labelled. This is equivalent to the allowOverrun vendor parameter.	no
label-follow-line	one of true or false	If enabled, the render will curve labels to follow the lines being labelled. This is equivalent to the followLine<labeling_follow_line> vendor parameter.	no
label-max-angle-delta	one of true or false	The maximum amount of curve allowed between two characters of a label; only applies when 'follow-line: true' is set. This is equivalent to the maxAngleDelta<labeling_max_angle_delta> vendor parameter.	no
label-auto-wrap	length	Labels will be wrapped to multiple lines if they exceed this length in pixels. This is equivalent to the autoWrap<labeling_autowrap> vendor parameter.	no
label-force-ltr	one of true or false	By default, the renderer will flip labels whose normal orientation would cause them to be upside-down. Set this parameter to false if you are using some icon character label like an arrow to show a line's direction. This is equivalent to the forceLeftToRight<labeling_force_left_to_right> vendor parameter.	no
label-conflict-resolution	one of true or false	Set this to false to disable label conflict resolution, allowing overlapping labels to be rendered. This is equivalent to the conflictResolution<labeling_conflict_resolution> vendor parameter.	no
label-fit-goodness	scale	The renderer will omit labels that fall below this "match quality" score. The scoring rules differ for each geometry type. This is equivalent to the goodnessOfFit<labeling_goodness_of_fit> vendor parameter.	no
label-priority	expression	Specifies an expression to use in determining which features to prefer if there are labelling conflicts. This is equivalent to the Priority<labeling_priority> SLD extension.	yes

Text symbology (labelling) - part 3

Property	Type	Meaning	Accepts Expression?
shield-resize	string, one of none, stretch, or proportional	Specifies a mode for resizing label graphics (such as highway shields) to fit the text of the label. The default mode, 'none', never modifies the label graphic. In stretch mode, GeoServer will resize the graphic to exactly surround the label text, possibly modifying the image's aspect ratio. In proportional mode, GeoServer will expand the image to be large enough to surround the text while preserving its original aspect ratio.	none
shield-margin	list of lengths, one to four elements long.	Specifies an extra margin (in pixels) to be applied to the label text when calculating label dimensions for use with the shield-resize option. Similar to the margin shorthand property in CSS for HTML, its interpretation varies depending on how many margin values are provided: 1 = use that margin length on all sides of the label 2 = use the first for top & bottom margins and the second for left & right margins. 3 = use the first for the top margin, second for left & right margins, third for the bottom margin. 4 = use the first for the top margin, second for the right margin, third for the bottom margin, and fourth for the left margin.	none
label-underline-text	one of true or false	If enabled, the renderer will underline labels. This is equivalent to the underlineText vendor parameter.	no
label-strikethrough-text	one of true or false	If enabled, the renderer will strikethrough labels. This is equivalent to the strikethroughText vendor parameter.	no
label-char-spacing	an amount of pixels, can be negative	If present, expands or shrinks the space between subsequent characters in a label according to the value specified	no
label-word-spacing	an amount of pixels, must be zero or positive	If present, expands the space between subsequent words in a label according to the value specified	no

Raster symbology

Property	Type	Meaning	Accepts Expression?
raster-channels	string	The list of raster channels to be used in the output. It can be "auto" to make the renderer choose the best course of action, or a list of band numbers, a single one will generate a gray image, three will generate an RGB one, four will generate a RGBA one. E.g., "1 3 7" to choose the first, third and seventh band of the input raster to make an RGB image	no
raster-composite	string	The composite mode to be used and the optional opacity separated with a comma. See the full list of available modes.	no
raster-geometry	expression	The attribute containing the raster to be painted. Normally not needed, but it would work if you had a custom vector data source that contains a GridCoverage attribute, in order to select it	yes
raster-opacity	floating point	A value comprised between 0 and 1, 0 meaning completely transparent, 1 meaning completely opaque. This controls the whole raster transparency.	no
raster-contrast-enhancement	string	Allows to stretch the range of data/colors in order to enhance tiny differences. Possible values are 'normalize', 'histogram' and 'none'	no
raster-gamma	floating point	Gamma adjustment for the output raster	no
raster-z-index	integer	Controls the z ordering of the raster output	no
raster-color-map	string	Applies a color map to single banded input. The contents are a space separate list of color-map-entry(color, value) (opacity assumed to be 1 and label will have a null value), or color-map-entry(color, value, opacity, label). The values must be provided in increasing order.	no
raster-color-map-type	string	Controls how the color map entries are interpreted, the possible values are "ramp", "intervals" and "values", with ramp being the default if no "raster-color-map-type" is provided. The default "ramp" behavior is to linearly interpolate color between the provided values, and assign the lowest color to all values below the lowest value, and the highest color to all values above the highest value. The "intervals" behavior instead assigns solid colors between values, whilst "values" only assigns colors to the specified values, every other value in the raster is not painted at all	no
raster-color-map-extended	string	Enables "extended color map" mode, which makes the color map use 65536 entries instead of 256, and thus allows for a more precise color mapping. The default is "false", which means the color map is limited to 256 entries (if more than 256 colors are used, the extended color map mode is enabled automatically). This property is ignored if the "raster-color-map" property is not provided.	no
raster-label-fi	string	Controls if and how color map entry labels are included, as attributes, in the GetFeatureInfo output. Valid values are add, adding the labels as extra attributes, replace, using the labels in place of the actual value, or none (the default) which does not include the labels in the output.	no
raster-label-name	string	If color map entry labels are included in the GetFeatureInfo output, this property controls then name of the attribute that will contain them.	no

Shared

Property	Type	Meaning	Accepts Expression?
composite	string	The composite mode to be used and the optional opacity separated with a comma. See the full list of available modes.	no
composite-base	one of true or false	This will tell the rendering engine to use that FeatureTypeStyle as the destination, and will compose all subsequent FeatureTypeStyle/Layers on top of it, until another base is found.	no
geometry	expression	An expression to use for the geometry when rendering features. This provides a geometry for all types of symbology, but can be overridden by the symbol-specific geometry properties.	yes
sort-by	string	A comma separated list of sorting directives, att1 A|D, att2 A|D, ... where att? are attribute names, and A or D are an optional direction specification, A is ascending, D is descending. Determines the loading, and thus painting, order of the features	no
sort-by-group	string	Rules with the different z-index but same sort-by-group id have their features sorted as a single group. Useful to z-order across layers or across different feature groups, like roads and rails, especially when using z-index to support casing	no
transform	function	Applies a rendering transformation on the current level. The function syntax is txName(key1:value1,key1:value2). Values can be single ones, or space separated lists.	no

Symbol properties

These properties are applied only when styling built-in symbols. See Styled marks for details.

Property	Type	Meaning	Accepts Expression?
size	length	The size at which to render the symbol.	yes
rotation	angle	An angle through which to rotate the symbol.	yes