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)
the ID of the layer

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
Set the CircleBlur property
open override fun circleBlur(circleBlur: Double): CircleLayer
Set the CircleBlur property
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
Set the CircleColor property
open override fun circleColor(@ColorInt() circleColor: Int): CircleLayer
Set the CircleColor property.
open override fun circleColor(circleColor: String): CircleLayer
Set the CircleColor property
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
Set the CircleOpacity property
open override fun circleOpacity(circleOpacity: Double): CircleLayer
Set the CircleOpacity property
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
Set the CirclePitchAlignment property
open override fun circlePitchAlignment(circlePitchAlignment: CirclePitchAlignment): CircleLayer
Set the CirclePitchAlignment property
circlePitchScale
Link copied to clipboard
open override fun circlePitchScale(circlePitchScale: Expression): CircleLayer
Set the CirclePitchScale property
open override fun circlePitchScale(circlePitchScale: CirclePitchScale): CircleLayer
Set the CirclePitchScale property
circleRadius
Link copied to clipboard
open override fun circleRadius(circleRadius: Expression): CircleLayer
Set the CircleRadius property
open override fun circleRadius(circleRadius: Double): CircleLayer
Set the CircleRadius property
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
Set the CircleSortKey property
open override fun circleSortKey(circleSortKey: Double): CircleLayer
Set the CircleSortKey property
circleStrokeColor
Link copied to clipboard
open override fun circleStrokeColor(circleStrokeColor: Expression): CircleLayer
Set the CircleStrokeColor property
open override fun circleStrokeColor(@ColorInt() circleStrokeColor: Int): CircleLayer
Set the CircleStrokeColor property.
open override fun circleStrokeColor(circleStrokeColor: String): CircleLayer
Set the CircleStrokeColor property
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
Set the CircleStrokeOpacity property
open override fun circleStrokeOpacity(circleStrokeOpacity: Double): CircleLayer
Set the CircleStrokeOpacity property
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
Set the CircleStrokeWidth property
open override fun circleStrokeWidth(circleStrokeWidth: Double): CircleLayer
Set the CircleStrokeWidth property
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
Set the CircleTranslate property
open override fun circleTranslate(circleTranslate: List<Double>): CircleLayer
Set the CircleTranslate property
circleTranslateAnchor
Link copied to clipboard
open override fun circleTranslateAnchor(circleTranslateAnchor: Expression): CircleLayer
Set the CircleTranslateAnchor property
open override fun circleTranslateAnchor(circleTranslateAnchor: CircleTranslateAnchor): CircleLayer
Set the CircleTranslateAnchor property
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
Set the filter property
maxZoom
Link copied to clipboard
open override fun maxZoom(maxZoom: Double): CircleLayer
Set the maxzoom property
minZoom
Link copied to clipboard
open override fun minZoom(minZoom: Double): CircleLayer
Set the minzoom property
sourceLayer
Link copied to clipboard
open override fun sourceLayer(sourceLayer: String): CircleLayer
Set the sourceLayer property
visibility
Link copied to clipboard
open override fun visibility(visibility: Visibility): CircleLayer
Set the Visibility property

Properties

circleBlur
Link copied to clipboard
val circleBlur: Double?
Amount to blur the circle.
circleBlurAsExpression
Link copied to clipboard
val circleBlurAsExpression: Expression?
This is an Expression representation of "circle-blur".
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?
This is an Expression representation of "circle-color".
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?
This is an Expression representation of "circle-opacity".
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?
This is an Expression representation of "circle-pitch-alignment".
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?
This is an Expression representation of "circle-pitch-scale".
circleRadius
Link copied to clipboard
val circleRadius: Double?
Circle radius.
circleRadiusAsExpression
Link copied to clipboard
val circleRadiusAsExpression: Expression?
This is an Expression representation of "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.
circleSortKeyAsExpression
Link copied to clipboard
val circleSortKeyAsExpression: Expression?
This is an Expression representation of "circle-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?
This is an Expression representation of "circle-stroke-color".
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?
This is an Expression representation of "circle-stroke-opacity".
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.
circleStrokeWidthAsExpression
Link copied to clipboard
val circleStrokeWidthAsExpression: Expression?
This is an Expression representation of "circle-stroke-width".
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.
circleTranslateAnchor
Link copied to clipboard
val circleTranslateAnchor: CircleTranslateAnchor?
Controls the frame of reference for circle-translate.
circleTranslateAnchorAsExpression
Link copied to clipboard
val circleTranslateAnchorAsExpression: Expression?
This is an Expression representation of "circle-translate-anchor".
circleTranslateAsExpression
Link copied to clipboard
val circleTranslateAsExpression: Expression?
This is an Expression representation of "circle-translate".
circleTranslateTransition
Link copied to clipboard
val circleTranslateTransition: StyleTransition?
Transition options for CircleTranslate.
filter
Link copied to clipboard
val filter: Expression?
A expression specifying conditions on source features.
layerId
Link copied to clipboard
open override val layerId: String
the ID of the layer
maxZoom
Link copied to clipboard
open override val maxZoom: Double?
The maximum zoom level for the layer.
minZoom
Link copied to clipboard
open override val minZoom: Double?
The minimum zoom level for the layer.
sourceId
Link copied to clipboard
val sourceId: String
the ID of the source
sourceLayer
Link copied to clipboard
val sourceLayer: String?
Source layer.
visibility
Link copied to clipboard
open override val visibility: Visibility?
Visibility of the layer.