mapbox-maps-android/com.mapbox.maps.extension.compose.annotation.generated/PolylineAnnotation

PolylineAnnotation

@Composable
fun PolylineAnnotation(points: List<Point>, polylineAnnotationState: PolylineAnnotationState = remember { PolylineAnnotationState() })

Composable function to add a PolylineAnnotation to the Map. For convenience, if there's no need to hoist the polylineAnnotationState, use PolylineAnnotation(points, init) with trailing lambda instead.

Parameters

points

A list of Point for the line, which represents the locations of the line on the map.

polylineAnnotationState

The state holder for PolylineAnnotation properties.

@Composable
inline fun PolylineAnnotation(points: List<Point>, crossinline init: PolylineAnnotationState.() -> Unit)

Composable function to add a PolylineAnnotation to the Map.

Parameters

points

A list of Point for the line, which represents the locations of the line on the map.

init

the lambda that will be applied to the remembered PolylineAnnotationState.

@Composable
fun PolylineAnnotation(points: List<Point>, onClick: (PolylineAnnotation) -> Boolean = { false }, polylineAnnotationState: PolylineAnnotationState = remember { PolylineAnnotationState() })

Deprecated

This method is deprecated, and will be removed in next major release.

Replace with

PolylineAnnotation(point, polylineAnnotationState)
Content copied to clipboard

Composable function to add a PolylineAnnotation to the Map. For convenience, if there's no need to hoist the polylineAnnotationState, use PolylineAnnotation(points, onClick, init) with trailing lambda instead.

Parameters

points

A list of Point for the line, which represents the locations of the line on the map.

onClick

Callback to be invoked when the PolylineAnnotation is clicked. The clicked PolylineAnnotation will be passed as parameter.

polylineAnnotationState

The state holder for PolylineAnnotation properties.

@Composable
inline fun PolylineAnnotation(points: List<Point>, noinline onClick: (PolylineAnnotation) -> Boolean = { false }, crossinline init: PolylineAnnotationState.() -> Unit)

Deprecated

This method is deprecated, and will be removed in next major release.

Replace with

PolylineAnnotation(point, init)
Content copied to clipboard

Composable function to add a PolylineAnnotation to the Map.

Parameters

points

A list of Point for the line, which represents the locations of the line on the map.

onClick

Callback to be invoked when the PolylineAnnotation is clicked. The clicked PolylineAnnotation will be passed as parameter.

init

the lambda that will be applied to the remembered PolylineAnnotationState.