PolylineAnnotationState

The state holder for PolylineAnnotation properties.

Constructors

Link copied to clipboard

Properties

Link copied to clipboard
Link copied to clipboard

Blur applied to the line, in pixels. Default value: 0. Minimum value: 0. The unit of lineBlur is in pixels.

Link copied to clipboard

The color of the line border. If line-border-width is greater than zero and the alpha value of this color is 0 (default), the color for the border will be selected automatically based on the line color. Default value: "rgba(0, 0, 0, 0)".

Link copied to clipboard

This property defines whether the lineBorderColor uses colorTheme from the style or not. By default it will use color defined by the root theme in the style.

Link copied to clipboard

The width of the line border. A value of zero means no border. Default value: 0. Minimum value: 0.

Link copied to clipboard

The color with which the line will be drawn. Default value: "#000000".

Link copied to clipboard

This property defines whether the lineColor uses colorTheme from the style or not. By default it will use color defined by the root theme in the style.

Link copied to clipboard

Controls how much the elevation of lines with line-elevation-reference set to sea scales with terrain exaggeration. A value of 0 keeps the line at a fixed altitude above sea level. A value of 1 scales the elevation proportionally with terrain exaggeration. Default value: 0. Value range: 0, 1

Link copied to clipboard

Controls the intensity of light emitted on the source features. Default value: 0. Minimum value: 0. The unit of lineEmissiveStrength is in intensity.

Link copied to clipboard

Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap. Default value: 0. Minimum value: 0. The unit of lineGapWidth is in pixels.

Link copied to clipboard

The display of lines when joining. Default value: "miter".

Link copied to clipboard

The line's offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset. Default value: 0. The unit of lineOffset is in pixels.

Link copied to clipboard

The opacity at which the line will be drawn. Default value: 1. Value range: 0, 1

Link copied to clipboard

Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.

Link copied to clipboard

Stroke thickness. Default value: 1. Minimum value: 0. The unit of lineWidth is in pixels.

Link copied to clipboard

Vertical offset from ground, in meters. Not supported for globe projection at the moment. Default value: 0.