Interface VerticalLineStyle

Altitude of the VerticalLine, in meters.

Defines the reference height used together with VerticalLineStyle.altitudeReference to determine the vertical placement of the line.

Supported values:

• number – Fixed altitude in meters, relative to the global ground plane.
• true – Use the altitude (z) from the feature geometry if present; otherwise 0 m.
• false – Ignore any z-value from the feature geometry and use 0 m.
• 'terrain' – Clamp to the sampled terrain height.

Notes:

• When altitudeReference = 'top', the altitude defines the top of the line; the base is fixed at 0 m.
• When altitudeReference = 'base', the altitude defines the base of the line; the top must be specified using VerticalLineStyle.offsetZ.
• VerticalLineStyle.offsetZ extends the line upward from the reference altitude. With 'terrain', it defines how far above the terrain the line extends.
• If the feature contains a Z coordinate and altitude is 'terrain', the line ends at that feature altitude; offsetZ is applied as an additional upward offset.
• If no feature Z coordinate is available, offsetZ defines the line height above terrain.

Examples:

// Top = 100 m, Base = 0 m
{ type: "VerticalLine", altitudeReference: "top", altitude: 100 }

// Base = terrain, Top = terrain + 2 m
{ type: "VerticalLine", altitudeReference: "base", altitude: "terrain", offsetZ: "2m" }

// Base = 0, Top = feature Z (if available)
{ type: "VerticalLine", altitudeReference: "top", altitude: true }
Copy

Defines how the altitude value is interpreted for the VerticalLine.

By default, the meaning of altitude depends on the style type:

• For most flat styles (Circle, Rect, Icon, etc.), altitude defines the center position.
• For VerticalLine, VerticalLineStyle.altitude defines a vertical reference — either the top or the base.

Supported values:

• 'top': the altitude specifies the top of the line; the base is fixed at 0 m (global ground).
• 'base': the altitude specifies the base (bottom) of the line; the top must be defined via VerticalLineStyle.offsetZ.

Notes:

• This property only affects VerticalLine styles; other style types ignore it.
• When VerticalLineStyle.altitude is 'terrain' and altitudeReference is not specified, 'base' is automatically assumed (the line stands on the terrain surface).

Vertical offset of the shape along the z-axis.

Shifts or extends the line relative to its reference altitude.

• Positive values move the line upward.
• Negative values move the line downward.

Units:

• Default is pixels.
• Can also be a string with units (e.g., "1m" for meters).

Special notes for VerticalLine:

• altitudeReference defines which point the altitude value refers to (top or base).
• offsetZ always extends the line upward from the reference point, regardless of whether altitudeReference is 'base' or 'top'.
• With altitude: 'terrain', offsetZ shifts the line relative to the terrain surface.

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.

Sets the stroke color of the shape.

Indicates type of the shape 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.