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

CircleLayerState

class CircleLayerState

The state holder for CircleLayer's layer properties.

See also

The online documentation

Constructors

CircleLayerState

fun CircleLayerState()

Construct an default CircleLayerState.

Properties

var circleBlur: DoubleValue

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

circleBlurTransition

var circleBlurTransition: Transition

Defines the transition of circleBlur. Default value: 0.

var circleColor: ColorValue

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

circleColorTransition

var circleColorTransition: Transition

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

circleEmissiveStrength

var circleEmissiveStrength: DoubleValue

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

circleEmissiveStrengthTransition

var circleEmissiveStrengthTransition: Transition

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

var circleOpacity: DoubleValue

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

circleOpacityTransition

var circleOpacityTransition: Transition

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

circlePitchAlignment

var circlePitchAlignment: CirclePitchAlignmentValue

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

circlePitchScale

var circlePitchScale: CirclePitchScaleValue

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

var circleRadius: DoubleValue

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

circleRadiusTransition

var circleRadiusTransition: Transition

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

var circleSortKey: DoubleValue

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

circleStrokeColor

var circleStrokeColor: ColorValue

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

circleStrokeColorTransition

var circleStrokeColorTransition: Transition

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

circleStrokeOpacity

var circleStrokeOpacity: DoubleValue

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

circleStrokeOpacityTransition

var circleStrokeOpacityTransition: Transition

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

circleStrokeWidth

var circleStrokeWidth: DoubleValue

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

circleStrokeWidthTransition

var circleStrokeWidthTransition: Transition

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

circleTranslate

var circleTranslate: DoubleListValue

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

circleTranslateAnchor

var circleTranslateAnchor: CircleTranslateAnchorValue

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

circleTranslateTransition

var circleTranslateTransition: Transition

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

var filter: 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.

var maxZoom: LongValue

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

var minZoom: LongValue

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

var sourceLayer: StringValue

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

var visibility: VisibilityValue

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