Interface TextStyle

Alignment for styles of type "Text". Possible values are: "map" and "viewport". "map" aligns to the plane of the map and "viewport" aligns to the plane of the viewport/screen. Default alignment for Text based on point geometries is "viewport" while "map" is the default for line geometries.

Altitude of the Text center in meters.

Describes the vertical distance from the global ground plane (0m) to the Text.

Supported values:

• false (default): place at 0m.
• true: use the altitude (z) from the feature geometry if present, else 0. Not re-aligned to the rendered terrain. If the geometry altitude source differs from the TerrainTileLayer source/resolution, the Text can appear slightly above or below the visible terrain surface.
• number: fixed absolute altitude in meters. Also not adjusted when terrain tiles load; may not perfectly sit on the terrain unless both use exactly the same elevation source, datum and resolution.
• 'terrain': sample (clamp to) the current terrain surface height. While the terrain tile is not yet loaded (or no terrain layer exists) the altitude is 0 and updates once data becomes available.

Notes:

• Use 'terrain' to keep the Text visually seated on the rendered terrain.
• Use a numeric value for a constant absolute elevation independent of terrain updates.
• To position something N meters above terrain: use 'terrain' plus offsetZ (e.g. offsetZ: '5m').
• Expect mismatches (floating / sinking) when using true or a fixed number with a different terrain data source.

Sets the anchor point for styles of type "Text" used with Line or Polygon geometry.

Possible values for Line geometry are "Coordinate" and "Line".

• "Coordinate": the respective style is displayed at each coordinate of the polyline.
• "Line": the respective style is displayed on the shape of the polyline when there is enough space. See checkLineSpace to disable the space check.

Possible values for Polygon geometry are "Center" and "Centroid".

• "Center": the center of the bounding box of the polygon.
• "Centroid": the geometric centroid of the polygon geometry.

Enable or disable the space check for point styles on line geometries. Only applies to "Text" styles with anchor set to "Line". If check checkLineSpace is enabled the respective style is only displayed if there is enough space on the line, otherwise it is not displayed.

Enable or disable collision detection. If the collision detection is enabled for multiple Styles within the same StyleGroup, the respective Styles are handled as a single Object ("CollisionGroup") where the combined bounding-box is determined automatically.

• true: collision are allowed, Collision detection is disabled.
• false: avoid collisions, Collision detection is enabled.

Enables collision detection and combines all styles of a StyleGroup with the same "CollisionGroup" into a single logical object for collision detection.

Sets the color to fill the text.

CSS font string for texts. It is only valid for Text.

Enable oder Disable line wrapping for styles of type "Text". The line wrapping for text on (Multi)Linestring geometry with anchor set to "Line" is disabled by default, otherwise it's 14 characters.

• number: Maximum number of characters per line [Default 14 characters]
• false: disable line wrapping
• true: enable line wrapping [Default 14 characters]

Offset the text in pixels on x-axis. A positive value offsets to the right, a negative value to the left. The default unit is pixels.

Offset the text in pixels on y-axis. A positive value offsetY offsets downwards, a negative value upwards. The default unit is pixels.

Offset the text in pixels on z-axis. A positive value offsets up, a negative value down. The default unit is pixels.

Defines the opacity of the style. The value must be between 0.0 (fully transparent) and 1.0 (fully opaque). It is valid for all style types.

In case of label collision, Text with a higher priority (lower value) will be drawn before lower priorities (higher value). If the collision detection is enabled for multiple Styles within the same StyleGroup, the highest priority (lowest value) is used.

Minimum distance in pixels between repeated style-groups on line geometries. Applies per tile only.

Rotate text around it's center in degrees.

Controls perspective scaling of map-aligned Text labels based on their feature's altitude. When disabled, a label is scaled as if its feature were at ground level. This applies only when alignment is "map"; viewport-aligned labels are unaffected.

Text font sizes are pixel-based, so scaling is disabled by default and enabled by default when altitude resolves to "terrain".

Sets the stroke color of the text (outline).

Sets the width of the stroke (outline) to display the text with. The unit of strokeWidth is defined in pixels.

Text is either a string or a function that generates the string that should be displayed. It is valid for Text style only.

The "textAnchor" attribute is used to align the text relative to the anchor point.

Possible values:

• "Left": The text is aligned left to the anchor.
• "Right": The text is aligned right to the anchor.
• "Center": The center of the Text is placed at the anchor point.
• "Top": The top of the Text is placed closest the anchor point.
• "TopLeft": The top left side of the Text is placed closest the anchor point.
• "TopRight": The top right side of the Text is placed closest the anchor point.
• "Bottom": The bottom of the Text is placed closest to the anchor point.
• "BottomLeft": The bottom left side of the Text is placed closest the anchor point.
• "BottomRight": The bottom right side of the Text is placed closest the anchor point.

"textRef" Reference to an attribute of an feature that's value should be displayed as text. If both "text" and "textRef" are set, "text" prevails. It is only required by Text.

Specifies the type of style to render.

Indicates the drawing order within a layer. Styles with larger zIndex value are rendered above those with smaller values. The zIndex is defined relative to the "zLayer" property. If "zLayer" is defined all zIndex values are relative to the "zLayer" value.

Indicates drawing order across multiple layers. Styles using zLayer with a high value are rendered on top of zLayers with a low value. If no zLayer is defined, it will fall back to the LayerStyle.zLayer or depend on the display layer order. The first (lowest) layer has a zLayer value of 1.