Optional allowIf true, the text will be visible even if it collides with other previously drawn symbols.
Optional anchorThe anchor position of the label referred to the center of the geometry.
Optional avoidThis is a property relevant if using tiled datasets. If true, the symbols will not cross tile edges to avoid mutual collisions.
Optional colorA color defined as a hex-color string.
Optional fontAn Array of fonts. Comparable to https://www.w3schools.com/cssref/pr_font_font-family.asp
Optional fontSpecifies whether a font should be styled with a normal, italic, or oblique face from its font-family.
Optional fontSpecifies the weight (or boldness) of the font. The weights available depend on the font-family you are using.
Optional haloThe halo's fadeout distance towards the outside.
Optional haloThe color of the text's halo, which helps it stand out from backgrounds represented as a hex-color string.
Optional haloThe opacity of the halo. A value between 0 and 1. 0 means no opacity (i.e. transparent) and 1 is fully opaque.
Optional haloDistance of halo to the font outline (pixels if haloWidthUnit is not defined).
Optional haloUnit to use for the haloWidth.
Optional justifyText justification option to align the text.
Optional keepIf true, the text will be kept upright.
Describes the type of the kind of the Symbolizer.
Optional labelTemplate string where {{PROPERTYNAME}} can be used to be replaced by values from the dataset. e.g.: "Name {{country_name}}"
Optional letterSets the spacing between text characters (pixels if letterSpacingUnit is not defined).
Optional letterUnit to use for the letterSpacing.
Optional lineSets the line height (pixels if lineHeightUnit is not defined). 'em' -> fontsize
Optional lineUnit to use for the lineHeight. 'em' -> fontsize
Optional maxMaximum angle change between adjacent characters in degrees.
Optional maxThe maximum line width for text wrapping.
Optional offsetThe offset of the Symbolizer as [x, y] coordinates. Positive values indicate right and down, while negative values indicate left and up.
Optional offsetProperty relevant for mapbox-styles. Compare https://docs.mapbox.com/mapbox-gl-js/style-spec/#paint-symbol-icon-translate-anchor
Optional opacityDetermines the total opacity for the Symbolizer. A value between 0 and 1. 0 is none opaque and 1 is full opaque.
Optional optionalProperty relevant for mapbox-styles. If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.
Optional paddingSize of the additional area around the text bounding box used for detecting symbol collisions.
Optional pitchProperty relevant for mapbox-styles. Compare https://docs.mapbox.com/mapbox-gl-js/style-spec/#layout-symbol-text-pitch-alignment
Optional placementSpecifies label placement relative to its geometry.
Optional rotateThe rotation of the Symbolizer in degrees. Value should be between 0 and 360.
Optional rotationProperty relevant for mapbox-styles. Compare https://docs.mapbox.com/mapbox-gl-js/style-spec/#layout-symbol-text-rotation-alignment
Optional sizeThe fontsize in pixels.
Optional transformSpecifies how to capitalize text, similar to the CSS text-transform property.
Optional visibilityDefines whether the Symbolizer should be visibile or not.
Generated using TypeDoc
The TextSymbolizer describes the style representation of point data, if styled with a text.