CircleLayer

class CircleLayer(val layerId: String, val sourceId: String) : Layer, CircleLayerDsl

A filled circle.

See also

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

Link copied to clipboard
fun CircleLayer(layerId: String, sourceId: String)

Types

Link copied to clipboard
object Companion

Static variables and methods.

Functions

Link copied to clipboard
fun bindTo(delegate: MapboxStyleManager)

Bind the layer to the Style.

open override fun bindTo(delegate: MapboxStyleManager, position: LayerPosition?)

Bind the layer to the map controller.

Link copied to clipboard
open override fun circleBlur(circleBlur: Expression): CircleLayer
open override fun circleBlur(circleBlur: Double): CircleLayer

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

Link copied to clipboard
open override fun circleBlurTransition(options: StyleTransition): CircleLayer

Set the CircleBlur property transition options

Link copied to clipboard
open override fun circleColor(circleColor: Expression): CircleLayer
open override fun circleColor(@ColorInt circleColor: Int): CircleLayer
open override fun circleColor(circleColor: String): CircleLayer

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

Link copied to clipboard

Set the CircleColor property transition options

Link copied to clipboard
open override fun circleEmissiveStrength(circleEmissiveStrength: Expression): CircleLayer
open override fun circleEmissiveStrength(circleEmissiveStrength: Double): CircleLayer

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

Link copied to clipboard

Set the CircleEmissiveStrength property transition options

Link copied to clipboard
open override fun circleOpacity(circleOpacity: Expression): CircleLayer
open override fun circleOpacity(circleOpacity: Double): CircleLayer

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

Link copied to clipboard

Set the CircleOpacity property transition options

Link copied to clipboard
open override fun circlePitchAlignment(circlePitchAlignment: Expression): CircleLayer
open override fun circlePitchAlignment(circlePitchAlignment: CirclePitchAlignment): CircleLayer

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

Link copied to clipboard
open override fun circlePitchScale(circlePitchScale: Expression): CircleLayer
open override fun circlePitchScale(circlePitchScale: CirclePitchScale): CircleLayer

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

Link copied to clipboard
open override fun circleRadius(circleRadius: Expression): CircleLayer
open override fun circleRadius(circleRadius: Double): CircleLayer

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

Link copied to clipboard

Set the CircleRadius property transition options

Link copied to clipboard
open override fun circleSortKey(circleSortKey: Expression): CircleLayer
open override fun circleSortKey(circleSortKey: Double): CircleLayer

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

Link copied to clipboard
open override fun circleStrokeColor(circleStrokeColor: Expression): CircleLayer
open override fun circleStrokeColor(@ColorInt circleStrokeColor: Int): CircleLayer
open override fun circleStrokeColor(circleStrokeColor: String): CircleLayer

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

Link copied to clipboard

Set the CircleStrokeColor property transition options

Link copied to clipboard
open override fun circleStrokeOpacity(circleStrokeOpacity: Expression): CircleLayer
open override fun circleStrokeOpacity(circleStrokeOpacity: Double): CircleLayer

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

Link copied to clipboard

Set the CircleStrokeOpacity property transition options

Link copied to clipboard
open override fun circleStrokeWidth(circleStrokeWidth: Expression): CircleLayer
open override fun circleStrokeWidth(circleStrokeWidth: Double): CircleLayer

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

Link copied to clipboard

Set the CircleStrokeWidth property transition options

Link copied to clipboard
open override fun circleTranslate(circleTranslate: Expression): CircleLayer
open override fun circleTranslate(circleTranslate: List<Double>): CircleLayer

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

Link copied to clipboard
open override fun circleTranslateAnchor(circleTranslateAnchor: Expression): CircleLayer
open override fun circleTranslateAnchor(circleTranslateAnchor: CircleTranslateAnchor): CircleLayer

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

Link copied to clipboard

Set the CircleTranslate property transition options

Link copied to clipboard
open override fun filter(filter: Expression): CircleLayer

A filter is a property at the layer level that determines which features should be rendered in a style layer.

Link copied to clipboard
open override fun maxZoom(maxZoom: Double): CircleLayer

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

Link copied to clipboard
open override fun minZoom(minZoom: Double): CircleLayer

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

Link copied to clipboard
open override fun slot(slot: String): CircleLayer

The slot this layer is assigned to. If specified, and a slot with that name exists, it will be placed at that position in the layer order.

Link copied to clipboard
open override fun sourceLayer(sourceLayer: String): CircleLayer

A source layer is an individual layer of data within a vector source. A vector source can have multiple source layers.

Link copied to clipboard
open override fun visibility(visibility: Expression): CircleLayer
open override fun visibility(visibility: Visibility): CircleLayer

Whether this layer is displayed.

Properties

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Transition options for CircleBlur.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Transition options for CircleColor.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Transition options for CircleEmissiveStrength.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Transition options for CircleOpacity.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Transition options for CircleRadius.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Transition options for CircleStrokeColor.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Transition options for CircleStrokeOpacity.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Transition options for CircleStrokeWidth.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Transition options for CircleTranslate.

Link copied to clipboard

A filter is a property at the layer level that determines which features should be rendered in a style layer.

Link copied to clipboard
open override val layerId: String
Link copied to clipboard
open override val maxZoom: Double?

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

Link copied to clipboard
open override val minZoom: Double?

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

Link copied to clipboard
open override val slot: String?

The slot this layer is assigned to. If specified, and a slot with that name exists, it will be placed at that position in the layer order.

Link copied to clipboard
Link copied to clipboard

A source layer is an individual layer of data within a vector source. A vector source can have multiple source layers.

Link copied to clipboard
open override val visibility: Visibility?

Whether this layer is displayed.

Link copied to clipboard

Whether this layer is displayed.

Extensions

Link copied to clipboard

Get the persistent property as Boolean.