PolylineAnnotationGroup

fun PolylineAnnotationGroup(annotations: List<PolylineAnnotationOptions>, annotationConfig: AnnotationConfig? = null, lineCap: LineCap? = null, lineMiterLimit: Double? = null, lineRoundLimit: Double? = null, lineDasharray: List<Double>? = null, lineDepthOcclusionFactor: Double? = null, lineEmissiveStrength: Double? = null, lineTranslate: List<Double>? = null, lineTranslateAnchor: LineTranslateAnchor? = null, lineTrimOffset: List<Double>? = null, onClick: (PolylineAnnotation) -> Boolean = { false })

Composable function to add a PolylineAnnotationGroup to the Map.

The PolylineAnnotationGroup is more performant than adding multiple PolylineAnnotation individually, because the PolylineAnnotationGroup is added to the map as a single layer.

PointAnnotationGroup and CircleAnnotationGroup can also be clustered based on the configuration, see AnnotationConfig.annotationSourceOptions and ClusterOptions for more details.

Parameters

annotations

List of PolylineAnnotationOptions to be added to the group.

annotationConfig

Configuration for PolylineAnnotationCluster.

lineCap

The display of line endings.

lineMiterLimit

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

lineRoundLimit

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

lineDasharray

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.

lineDepthOcclusionFactor

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

lineEmissiveStrength

Controls the intensity of light emitted on the source features. This property works only with 3D light, i.e. when lights root property is defined. The unit of lineEmissiveStrength is in intensity.

lineTranslate

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

lineTranslateAnchor

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

lineTrimOffset

The line part between trim-start, trim-end will be marked as transparent to make a route vanishing effect. The line trim-off offset is based on the whole line range 0.0, 1.0.

onClick

Callback to be invoked when one of the PolylineAnnotation in the cluster is clicked. The clicked PolylineAnnotation will be passed as parameter.