Interface TextStyle

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.

defaultvalue

false

experimental

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.

defaultvalue

For Polygon geometry the default is "Center". For Line geometry the default for styles of type "Text" is "Line".

defaultvalue

true

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

defaultvalue

false

see

Color for a detailed list of possible supported formats.

defaultvalue

“normal 12px Arial”

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

defaultvalue

14

example

// offset Text by 1m to the left
{ type: "Text", zIndex: 0, fill:'blue', offsetX: "-1m", text: 'XYZ'}

example

// offset Text by 1m to the left
{ type: "Text", zIndex: 0, fill:'blue', offsetY: "-1m", text: 'XYZ'}

example

// offset Text by 1m to the top
{ type: "Text", zIndex: 0, fill:'blue', text: 'XYZ', offsetZ: "1m"}

defaultvalue

1

defaultvalue

256 (pixels)

defaultvalue

false (pixels), true (meters)

experimental

see

Color for a detailed list of possible supported formats.

example

// define a Text style with a strokeWidth of 8px
{
    zIndex: 0,
    type: "Text",
    text: "doc",
    fill: "white",
    stroke: "black,
    strokeWidth: 8
}

example

// display the name property of a feature in uppercase
...
text: function(feature){
  return feature.properties.name.toUpperCase();
}

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.

defaultvalue

"Center"

example

// display the property "name" of the feature's properties
...
textRef: "properties.name"

example

// display the id of the feature
...
textRef: "id"

example

{...zLayer: 2, zIndex: 5} will be rendered on top of {...zLayer: 1, zIndex: 10}