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

CircleAnnotation

@Composable
@MapboxExperimental
fun CircleAnnotation(point: Point, circleBlur: Double? = null, circleColorInt: Int? = null, circleColorString: String? = null, circleOpacity: Double? = null, circleRadius: Double? = null, circleStrokeColorInt: Int? = null, circleStrokeColorString: String? = null, circleStrokeOpacity: Double? = null, circleStrokeWidth: Double? = null, onClick: (CircleAnnotation) -> Boolean = { false })

Composable function to add a CircleAnnotation to the Map.

Parameters

point

The Point of the circleAnnotation, which represents the location of the circleAnnotation on the map.

circleBlur

Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.

circleColorInt

The fill color of the circle. The property is set as Color Int.

circleColorString

The fill color of the circle. The property is set as Color String.

circleOpacity

The opacity at which the circle will be drawn.

circleRadius

Circle radius. The unit of circleRadius is in density-independent pixels.

circleStrokeColorInt

The stroke color of the circle. The property is set as Color Int.

circleStrokeColorString

The stroke color of the circle. The property is set as Color String.

circleStrokeOpacity

The opacity of the circle's stroke.

circleStrokeWidth

The width of the circle's stroke. Strokes are placed outside of the {@link PropertyFactory#circleRadius}. The unit of circleStrokeWidth is in density-independent pixels.

onClick

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