PolylineAnnotationGroupState

The state holder for PolylineAnnotationGroup properties.

Constructors

Properties

Link copied to clipboard

Blur applied to the line, in density-independent pixels. 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.

Link copied to clipboard

The width of the line border. A value of zero means no border.

Link copied to clipboard

The display of line endings.

Link copied to clipboard

The color with which the line will be drawn.

Link copied to clipboard

Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to density-independent pixels, multiply the length by the current line width. Note that GeoJSON sources with lineMetrics: true specified won't render dashed lines to the expected scale. Also note that zoom-dependent expressions will be evaluated only at integer zoom levels. The unit of lineDasharray is in line widths.

Link copied to clipboard

Decrease line layer opacity based on occlusion from 3D objects. Value 0 disables occlusion, value 1 means fully occluded.

Link copied to clipboard

Controls the intensity of light emitted on the source features. 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. The unit of lineGapWidth is in density-independent pixels.

Link copied to clipboard

The display of lines when joining.

Link copied to clipboard

Used to automatically convert miter joins to bevel joins for sharp angles.

Link copied to clipboard

Opacity multiplier (multiplies line-opacity value) of the line part that is occluded by 3D objects. Value 0 hides occluded part, value 1 means the same opacity as non-occluded part. The property is not supported when {@link PropertyFactory#lineOpacity} has data-driven styling.

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. The unit of lineOffset is in density-independent pixels.

Link copied to clipboard

The opacity at which the line will be drawn.

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

Used to automatically convert round joins to miter joins for shallow angles.

Link copied to clipboard

Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.

Link copied to clipboard

The geometry's offset. Values are x, y where negatives indicate left and up, respectively. The unit of lineTranslate is in density-independent pixels.

Link copied to clipboard

Controls the frame of reference for {@link PropertyFactory#lineTranslate}.

Link copied to clipboard

The color to be used for rendering the trimmed line section that is defined by the {@link PropertyFactory#lineTrimOffset} property.

Link copied to clipboard

The fade range for the trim-start and trim-end points is defined by the {@link PropertyFactory#lineTrimOffset} property. The first element of the array represents the fade range from the trim-start point toward the end of the line, while the second element defines the fade range from the trim-end point toward the beginning of the line. The fade result is achieved by interpolating between {@link PropertyFactory#lineTrimColor} and the color specified by the {@link PropertyFactory#lineColor} or the {@link PropertyFactory#lineGradient} property.

Link copied to clipboard

The line part between trim-start, trim-end will be painted using line-trim-color, which is transparent by default to produce a route vanishing effect. The line trim-off offset is based on the whole line range 0.0, 1.0.

Link copied to clipboard

Stroke thickness. The unit of lineWidth is in density-independent pixels.

Link copied to clipboard

Vertical offset from ground, in meters. Defaults to 0. Not supported for globe projection at the moment.