mapbox-maps-android/com.mapbox.maps.extension.compose.style.layers.generated/CircleLayer

CircleLayer

@MapboxExperimental
@Composable
fun CircleLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("circle") }, circleSortKey: DoubleValue = DoubleValue.INITIAL, circleBlur: DoubleValue = DoubleValue.INITIAL, circleBlurTransition: Transition = Transition.INITIAL, circleColor: ColorValue = ColorValue.INITIAL, circleColorTransition: Transition = Transition.INITIAL, circleEmissiveStrength: DoubleValue = DoubleValue.INITIAL, circleEmissiveStrengthTransition: Transition = Transition.INITIAL, circleOpacity: DoubleValue = DoubleValue.INITIAL, circleOpacityTransition: Transition = Transition.INITIAL, circlePitchAlignment: CirclePitchAlignmentValue = CirclePitchAlignmentValue.INITIAL, circlePitchScale: CirclePitchScaleValue = CirclePitchScaleValue.INITIAL, circleRadius: DoubleValue = DoubleValue.INITIAL, circleRadiusTransition: Transition = Transition.INITIAL, circleStrokeColor: ColorValue = ColorValue.INITIAL, circleStrokeColorTransition: Transition = Transition.INITIAL, circleStrokeOpacity: DoubleValue = DoubleValue.INITIAL, circleStrokeOpacityTransition: Transition = Transition.INITIAL, circleStrokeWidth: DoubleValue = DoubleValue.INITIAL, circleStrokeWidthTransition: Transition = Transition.INITIAL, circleTranslate: DoubleListValue = DoubleListValue.INITIAL, circleTranslateTransition: Transition = Transition.INITIAL, circleTranslateAnchor: CircleTranslateAnchorValue = CircleTranslateAnchorValue.INITIAL, visibility: VisibilityValue = VisibilityValue.INITIAL, minZoom: LongValue = LongValue.INITIAL, maxZoom: LongValue = LongValue.INITIAL, sourceLayer: StringValue = StringValue.INITIAL, filter: Filter = Filter.INITIAL)

A filled circle.

See also

Parameters

sourceState

the source that drives this layer.

layerId

the ID of the layer, by default, a random id will be generated with UUID.

circleSortKey

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

circleBlur

Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity. Default value: 0.

circleBlurTransition

Defines the transition of circleBlur. Default value: 0.

circleColor

The fill color of the circle. Default value: "#000000".

circleColorTransition

Defines the transition of circleColor. Default value: "#000000".

circleEmissiveStrength

Controls the intensity of light emitted on the source features. Default value: 0. Minimum value: 0.

circleEmissiveStrengthTransition

Defines the transition of circleEmissiveStrength. Default value: 0. Minimum value: 0.

circleOpacity

The opacity at which the circle will be drawn. Default value: 1. Value range: 0, 1

circleOpacityTransition

Defines the transition of circleOpacity. Default value: 1. Value range: 0, 1

circlePitchAlignment

Orientation of circle when map is pitched. Default value: "viewport".

circlePitchScale

Controls the scaling behavior of the circle when the map is pitched. Default value: "map".

circleRadius

Circle radius. Default value: 5. Minimum value: 0.

circleRadiusTransition

Defines the transition of circleRadius. Default value: 5. Minimum value: 0.

circleStrokeColor

The stroke color of the circle. Default value: "#000000".

circleStrokeColorTransition

Defines the transition of circleStrokeColor. Default value: "#000000".

circleStrokeOpacity

The opacity of the circle's stroke. Default value: 1. Value range: 0, 1

circleStrokeOpacityTransition

Defines the transition of circleStrokeOpacity. Default value: 1. Value range: 0, 1

circleStrokeWidth

The width of the circle's stroke. Strokes are placed outside of the circle-radius. Default value: 0. Minimum value: 0.

circleStrokeWidthTransition

Defines the transition of circleStrokeWidth. Default value: 0. Minimum value: 0.

circleTranslate

The geometry's offset. Values are x, y where negatives indicate left and up, respectively. Default value: 0,0.

circleTranslateTransition

Defines the transition of circleTranslate. Default value: 0,0.

circleTranslateAnchor

Controls the frame of reference for circle-translate. Default value: "map".

visibility

Whether this layer is displayed. Default value: "visible".

minZoom

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden. Value range: 0, 24

maxZoom

The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden. Value range: 0, 24

sourceLayer

Layer to use from a vector tile source. Required for vector tile sources; prohibited for all other source types, including GeoJSON sources.

filter

An expression specifying conditions on source features. Only features that match the filter are displayed. Zoom expressions in filters are only evaluated at integer zoom levels. The ["feature-state", ...] expression is not supported in filter expressions. The ["pitch"] and ["distance-from-center"] expressions are supported only for filter expressions on the symbol layer.