CircleLayer

A filled circle.

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

See also

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

CircleLayer
Link copied to clipboard

the ID of the layer

fun CircleLayer(layerId: String, sourceId: String)

Types

Companion
Link copied to clipboard

Static variables and methods.

object Companion

Functions

bindTo
Link copied to clipboard

Bind the layer to the Style.

override fun bindTo(delegate: StyleInterface)

Bind the layer to the map controller.

open override fun bindTo(delegate: StyleInterface, position: LayerPosition?)
circleBlur
Link copied to clipboard

Set the CircleBlur property

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

Set the CircleBlur property transition options

open override fun circleBlurTransition(options: StyleTransition): CircleLayer
open override fun circleBlurTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer
circleColor
Link copied to clipboard

Set the CircleColor property

open override fun circleColor(circleColor: Expression): CircleLayer
open override fun circleColor(circleColor: String): CircleLayer

Set the CircleColor property.

open override fun circleColor(circleColor: Int): CircleLayer
circleColorTransition
Link copied to clipboard

Set the CircleColor property transition options

open override fun circleColorTransition(options: StyleTransition): CircleLayer
open override fun circleColorTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer
circleOpacity
Link copied to clipboard

Set the CircleOpacity property

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

Set the CircleOpacity property transition options

open override fun circleOpacityTransition(options: StyleTransition): CircleLayer
open override fun circleOpacityTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer
circlePitchAlignment
Link copied to clipboard

Set the CirclePitchAlignment property

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

Set the CirclePitchScale property

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

Set the CircleRadius property

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

Set the CircleRadius property transition options

open override fun circleRadiusTransition(options: StyleTransition): CircleLayer
open override fun circleRadiusTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer
circleSortKey
Link copied to clipboard

Set the CircleSortKey property

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

Set the CircleStrokeColor property

open override fun circleStrokeColor(circleStrokeColor: Expression): CircleLayer
open override fun circleStrokeColor(circleStrokeColor: String): CircleLayer

Set the CircleStrokeColor property.

open override fun circleStrokeColor(circleStrokeColor: Int): CircleLayer
circleStrokeColorTransition
Link copied to clipboard

Set the CircleStrokeColor property transition options

open override fun circleStrokeColorTransition(options: StyleTransition): CircleLayer
open override fun circleStrokeColorTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer
circleStrokeOpacity
Link copied to clipboard

Set the CircleStrokeOpacity property

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

Set the CircleStrokeOpacity property transition options

open override fun circleStrokeOpacityTransition(options: StyleTransition): CircleLayer
open override fun circleStrokeOpacityTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer
circleStrokeWidth
Link copied to clipboard

Set the CircleStrokeWidth property

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

Set the CircleStrokeWidth property transition options

open override fun circleStrokeWidthTransition(options: StyleTransition): CircleLayer
open override fun circleStrokeWidthTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer
circleTranslate
Link copied to clipboard

Set the CircleTranslate property

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

Set the CircleTranslateAnchor property

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

Set the CircleTranslate property transition options

open override fun circleTranslateTransition(options: StyleTransition): CircleLayer
open override fun circleTranslateTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
filter
Link copied to clipboard

Set the filter property

open override fun filter(filter: Expression): CircleLayer
getCachedLayerProperties
Link copied to clipboard
override fun getCachedLayerProperties(): Value
hashCode
Link copied to clipboard
open override fun hashCode(): Int
maxZoom
Link copied to clipboard

Set the maxzoom property

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

Set the minzoom property

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

Set the sourceLayer property

open override fun sourceLayer(sourceLayer: String): CircleLayer
toString
Link copied to clipboard
open override fun toString(): String
updateProperty
Link copied to clipboard
override fun updateProperty(property: PropertyValue<*>)
visibility
Link copied to clipboard

Set the Visibility property

open override fun visibility(visibility: Visibility): CircleLayer

Properties

circleBlur
Link copied to clipboard

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

val circleBlur: Double?
circleBlurAsExpression
Link copied to clipboard

This is an Expression representation of "circle-blur".

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

val circleBlurAsExpression: Expression?
circleBlurTransition
Link copied to clipboard

Transition options for CircleBlur.

val circleBlurTransition: StyleTransition?
circleColor
Link copied to clipboard

The fill color of the circle.

val circleColor: String?
circleColorAsColorInt
Link copied to clipboard

The fill color of the circle.

val circleColorAsColorInt: Int?
circleColorAsExpression
Link copied to clipboard

This is an Expression representation of "circle-color".

The fill color of the circle.

val circleColorAsExpression: Expression?
circleColorTransition
Link copied to clipboard

Transition options for CircleColor.

val circleColorTransition: StyleTransition?
circleOpacity
Link copied to clipboard

The opacity at which the circle will be drawn.

val circleOpacity: Double?
circleOpacityAsExpression
Link copied to clipboard

This is an Expression representation of "circle-opacity".

The opacity at which the circle will be drawn.

val circleOpacityAsExpression: Expression?
circleOpacityTransition
Link copied to clipboard

Transition options for CircleOpacity.

val circleOpacityTransition: StyleTransition?
circlePitchAlignment
Link copied to clipboard

Orientation of circle when map is pitched.

val circlePitchAlignment: CirclePitchAlignment?
circlePitchAlignmentAsExpression
Link copied to clipboard

This is an Expression representation of "circle-pitch-alignment".

Orientation of circle when map is pitched.

val circlePitchAlignmentAsExpression: Expression?
circlePitchScale
Link copied to clipboard

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

val circlePitchScale: CirclePitchScale?
circlePitchScaleAsExpression
Link copied to clipboard

This is an Expression representation of "circle-pitch-scale".

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

val circlePitchScaleAsExpression: Expression?
circleRadius
Link copied to clipboard

Circle radius.

val circleRadius: Double?
circleRadiusAsExpression
Link copied to clipboard

This is an Expression representation of "circle-radius".

Circle radius.

val circleRadiusAsExpression: Expression?
circleRadiusTransition
Link copied to clipboard

Transition options for CircleRadius.

val circleRadiusTransition: StyleTransition?
circleSortKey
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.

val circleSortKey: Double?
circleSortKeyAsExpression
Link copied to clipboard

This is an Expression representation of "circle-sort-key".

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

val circleSortKeyAsExpression: Expression?
circleStrokeColor
Link copied to clipboard

The stroke color of the circle.

val circleStrokeColor: String?
circleStrokeColorAsColorInt
Link copied to clipboard

The stroke color of the circle.

val circleStrokeColorAsColorInt: Int?
circleStrokeColorAsExpression
Link copied to clipboard

This is an Expression representation of "circle-stroke-color".

The stroke color of the circle.

val circleStrokeColorAsExpression: Expression?
circleStrokeColorTransition
Link copied to clipboard

Transition options for CircleStrokeColor.

val circleStrokeColorTransition: StyleTransition?
circleStrokeOpacity
Link copied to clipboard

The opacity of the circle's stroke.

val circleStrokeOpacity: Double?
circleStrokeOpacityAsExpression
Link copied to clipboard

This is an Expression representation of "circle-stroke-opacity".

The opacity of the circle's stroke.

val circleStrokeOpacityAsExpression: Expression?
circleStrokeOpacityTransition
Link copied to clipboard

Transition options for CircleStrokeOpacity.

val circleStrokeOpacityTransition: StyleTransition?
circleStrokeWidth
Link copied to clipboard

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

val circleStrokeWidth: Double?
circleStrokeWidthAsExpression
Link copied to clipboard

This is an Expression representation of "circle-stroke-width".

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

val circleStrokeWidthAsExpression: Expression?
circleStrokeWidthTransition
Link copied to clipboard

Transition options for CircleStrokeWidth.

val circleStrokeWidthTransition: StyleTransition?
circleTranslate
Link copied to clipboard

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

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

Controls the frame of reference for circle-translate.

val circleTranslateAnchor: CircleTranslateAnchor?
circleTranslateAnchorAsExpression
Link copied to clipboard

This is an Expression representation of "circle-translate-anchor".

Controls the frame of reference for circle-translate.

val circleTranslateAnchorAsExpression: Expression?
circleTranslateAsExpression
Link copied to clipboard

This is an Expression representation of "circle-translate".

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

val circleTranslateAsExpression: Expression?
circleTranslateTransition
Link copied to clipboard

Transition options for CircleTranslate.

val circleTranslateTransition: StyleTransition?
filter
Link copied to clipboard

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

val filter: Expression?
layerId
Link copied to clipboard

the ID of the layer

open override val layerId: String
layerProperties
Link copied to clipboard

Properties of this layer.

override val layerProperties: HashMap<String, PropertyValue<*>>
maxZoom
Link copied to clipboard

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

Range: minimum: 0 maximum: 24

open override val maxZoom: Double?
minZoom
Link copied to clipboard

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

Range: minimum: 0 maximum: 24

open override val minZoom: Double?
sourceId
Link copied to clipboard

the ID of the source

val sourceId: String
sourceLayer
Link copied to clipboard

Source layer.

val sourceLayer: String?
visibility
Link copied to clipboard

Visibility of the layer.

open override val visibility: Visibility?