CircleLayer

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

A filled circle.

See also

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

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

Types

Companion
Link copied to clipboard
object Companion

Static variables and methods.

Functions

bindTo
Link copied to clipboard
fun bindTo(delegate: StyleInterface)

Bind the layer to the Style.

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

Bind the layer to the map controller.

circleBlur
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.

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

Set the CircleBlur property transition options

open override fun circleBlurTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer
circleColor
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.

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

Set the CircleColor property transition options

open override fun circleColorTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer
circleOpacity
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.

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

Set the CircleOpacity property transition options

open override fun circleOpacityTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer
circlePitchAlignment
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.

circlePitchScale
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.

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

Circle radius.

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

Set the CircleRadius property transition options

open override fun circleRadiusTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer
circleSortKey
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.

circleStrokeColor
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.

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

Set the CircleStrokeColor property transition options

open override fun circleStrokeColorTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer
circleStrokeOpacity
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.

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

Set the CircleStrokeOpacity property transition options

open override fun circleStrokeOpacityTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer
circleStrokeWidth
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.

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

Set the CircleStrokeWidth property transition options

open override fun circleStrokeWidthTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer
circleTranslate
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.

circleTranslateAnchor
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.

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

Set the CircleTranslate property transition options

open override fun circleTranslateTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer
filter
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.

maxZoom
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.

minZoom
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.

sourceLayer
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.

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

Whether this layer is displayed.

Properties

circleBlur
Link copied to clipboard
val circleBlur: Double?

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

circleBlurAsExpression
Link copied to clipboard
val circleBlurAsExpression: Expression?

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

circleBlurTransition
Link copied to clipboard
val circleBlurTransition: StyleTransition?

Transition options for CircleBlur.

circleColor
Link copied to clipboard
val circleColor: String?

The fill color of the circle.

circleColorAsColorInt
Link copied to clipboard
val circleColorAsColorInt: Int?

The fill color of the circle.

circleColorAsExpression
Link copied to clipboard
val circleColorAsExpression: Expression?

The fill color of the circle.

circleColorTransition
Link copied to clipboard
val circleColorTransition: StyleTransition?

Transition options for CircleColor.

circleOpacity
Link copied to clipboard
val circleOpacity: Double?

The opacity at which the circle will be drawn.

circleOpacityAsExpression
Link copied to clipboard
val circleOpacityAsExpression: Expression?

The opacity at which the circle will be drawn.

circleOpacityTransition
Link copied to clipboard
val circleOpacityTransition: StyleTransition?

Transition options for CircleOpacity.

circlePitchAlignment
Link copied to clipboard
val circlePitchAlignment: CirclePitchAlignment?

Orientation of circle when map is pitched.

circlePitchAlignmentAsExpression
Link copied to clipboard
val circlePitchAlignmentAsExpression: Expression?

Orientation of circle when map is pitched.

circlePitchScale
Link copied to clipboard
val circlePitchScale: CirclePitchScale?

Controls the scaling behavior of the circle when the map is pitched.

circlePitchScaleAsExpression
Link copied to clipboard
val circlePitchScaleAsExpression: Expression?

Controls the scaling behavior of the circle when the map is pitched.

circleRadius
Link copied to clipboard
val circleRadius: Double?

Circle radius.

circleRadiusAsExpression
Link copied to clipboard
val circleRadiusAsExpression: Expression?

Circle radius.

circleRadiusTransition
Link copied to clipboard
val circleRadiusTransition: StyleTransition?

Transition options for CircleRadius.

circleSortKey
Link copied to clipboard
val circleSortKey: Double?

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

circleSortKeyAsExpression
Link copied to clipboard
val circleSortKeyAsExpression: Expression?

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
Link copied to clipboard
val circleStrokeColor: String?

The stroke color of the circle.

circleStrokeColorAsColorInt
Link copied to clipboard
val circleStrokeColorAsColorInt: Int?

The stroke color of the circle.

circleStrokeColorAsExpression
Link copied to clipboard
val circleStrokeColorAsExpression: Expression?

The stroke color of the circle.

circleStrokeColorTransition
Link copied to clipboard
val circleStrokeColorTransition: StyleTransition?

Transition options for CircleStrokeColor.

circleStrokeOpacity
Link copied to clipboard
val circleStrokeOpacity: Double?

The opacity of the circle's stroke.

circleStrokeOpacityAsExpression
Link copied to clipboard
val circleStrokeOpacityAsExpression: Expression?

The opacity of the circle's stroke.

circleStrokeOpacityTransition
Link copied to clipboard
val circleStrokeOpacityTransition: StyleTransition?

Transition options for CircleStrokeOpacity.

circleStrokeWidth
Link copied to clipboard
val circleStrokeWidth: Double?

The width of the circle's stroke. Strokes are placed outside of the circle-radius.

circleStrokeWidthAsExpression
Link copied to clipboard
val circleStrokeWidthAsExpression: Expression?

The width of the circle's stroke. Strokes are placed outside of the circle-radius.

circleStrokeWidthTransition
Link copied to clipboard
val circleStrokeWidthTransition: StyleTransition?

Transition options for CircleStrokeWidth.

circleTranslate
Link copied to clipboard
val circleTranslate: List<Double>?

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

circleTranslateAnchor
Link copied to clipboard
val circleTranslateAnchor: CircleTranslateAnchor?

Controls the frame of reference for circle-translate.

circleTranslateAnchorAsExpression
Link copied to clipboard
val circleTranslateAnchorAsExpression: Expression?

Controls the frame of reference for circle-translate.

circleTranslateAsExpression
Link copied to clipboard
val circleTranslateAsExpression: Expression?

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

circleTranslateTransition
Link copied to clipboard
val circleTranslateTransition: StyleTransition?

Transition options for CircleTranslate.

filter
Link copied to clipboard
val filter: Expression?

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

layerId
Link copied to clipboard
open override val layerId: String
maxZoom
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.

minZoom
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.

sourceId
Link copied to clipboard
val sourceId: String
sourceLayer
Link copied to clipboard
val sourceLayer: String?

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

visibility
Link copied to clipboard
open override val visibility: Visibility?

Whether this layer is displayed.