PolylineAnnotationGroup

fun PolylineAnnotationGroup(annotations: List<PolylineAnnotationOptions>, annotationConfig: AnnotationConfig? = null, onClick: (PolylineAnnotation) -> Boolean = { false }, polylineAnnotationGroupState: PolylineAnnotationGroupState = remember { PolylineAnnotationGroupState() })

Composable function to add a PolylineAnnotationGroup to the Map. For convenience, if there's no need to hoist the polylineAnnotationGroupState, use PolylineAnnotationGroup(annotations, annotationConfig, onClick, init) with trailing lambda instead.

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 PolylineAnnotationGroup.

onClick

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

polylineAnnotationGroupState

The state holder for PolylineAnnotationGroup properties.


inline fun PolylineAnnotationGroup(annotations: List<PolylineAnnotationOptions>, annotationConfig: AnnotationConfig? = null, noinline onClick: (PolylineAnnotation) -> Boolean = { false }, crossinline init: PolylineAnnotationGroupState.() -> Unit)

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 PolylineAnnotationGroup.

onClick

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

init

the lambda that will be applied to the remembered PolylineAnnotationGroupState.