Mapbox Maps Android/com.mapbox.maps.extension.style.layers.generated/CircleLayer

CircleLayer

A filled circle.

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

See also

<a href="https://www.mapbox.com/mapbox-gl-style-spec/#layers-circle">The online documentation</a>

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

CircleLayer

the ID of the layer

fun CircleLayer(layerId: String, sourceId: String)

Types

Companion

Static variables and methods.

object Companion

Functions

bindTo

Bind the layer to the Style.

override fun bindTo(delegate: StyleManagerInterface)

Bind the layer to the map controller.

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

circleBlur

Set the CircleBlur property

open override fun circleBlur(circleBlur: Expression): CircleLayer

open override fun circleBlur(circleBlur: Double): CircleLayer

circleBlurTransition

Set the CircleBlur property transition options

open override fun circleBlurTransition(options: StyleTransition): CircleLayer

DSL for circleBlurTransition.

open override fun circleBlurTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer

circleColor

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

Set the CircleColor property transition options

open override fun circleColorTransition(options: StyleTransition): CircleLayer

DSL for circleColorTransition.

open override fun circleColorTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer

circleOpacity

Set the CircleOpacity property

open override fun circleOpacity(circleOpacity: Expression): CircleLayer

open override fun circleOpacity(circleOpacity: Double): CircleLayer

circleOpacityTransition

Set the CircleOpacity property transition options

open override fun circleOpacityTransition(options: StyleTransition): CircleLayer

DSL for circleOpacityTransition.

open override fun circleOpacityTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer

circlePitchAlignment

Set the CirclePitchAlignment property

open override fun circlePitchAlignment(circlePitchAlignment: Expression): CircleLayer

open override fun circlePitchAlignment(circlePitchAlignment: CirclePitchAlignment): CircleLayer

circlePitchScale

Set the CirclePitchScale property

open override fun circlePitchScale(circlePitchScale: Expression): CircleLayer

open override fun circlePitchScale(circlePitchScale: CirclePitchScale): CircleLayer

circleRadius

Set the CircleRadius property

open override fun circleRadius(circleRadius: Expression): CircleLayer

open override fun circleRadius(circleRadius: Double): CircleLayer

circleRadiusTransition

Set the CircleRadius property transition options

open override fun circleRadiusTransition(options: StyleTransition): CircleLayer

DSL for circleRadiusTransition.

open override fun circleRadiusTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer

circleSortKey

Set the CircleSortKey property

open override fun circleSortKey(circleSortKey: Expression): CircleLayer

open override fun circleSortKey(circleSortKey: Double): CircleLayer

circleStrokeColor

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

Set the CircleStrokeColor property transition options

open override fun circleStrokeColorTransition(options: StyleTransition): CircleLayer

DSL for circleStrokeColorTransition.

open override fun circleStrokeColorTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer

circleStrokeOpacity

Set the CircleStrokeOpacity property

open override fun circleStrokeOpacity(circleStrokeOpacity: Expression): CircleLayer

open override fun circleStrokeOpacity(circleStrokeOpacity: Double): CircleLayer

circleStrokeOpacityTransition

Set the CircleStrokeOpacity property transition options

open override fun circleStrokeOpacityTransition(options: StyleTransition): CircleLayer

DSL for circleStrokeOpacityTransition.

open override fun circleStrokeOpacityTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer

circleStrokeWidth

Set the CircleStrokeWidth property

open override fun circleStrokeWidth(circleStrokeWidth: Expression): CircleLayer

open override fun circleStrokeWidth(circleStrokeWidth: Double): CircleLayer

circleStrokeWidthTransition

Set the CircleStrokeWidth property transition options

open override fun circleStrokeWidthTransition(options: StyleTransition): CircleLayer

DSL for circleStrokeWidthTransition.

open override fun circleStrokeWidthTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer

circleTranslate

Set the CircleTranslate property

open override fun circleTranslate(circleTranslate: Expression): CircleLayer

open override fun circleTranslate(circleTranslate: List<Double>): CircleLayer

circleTranslateAnchor

Set the CircleTranslateAnchor property

open override fun circleTranslateAnchor(circleTranslateAnchor: Expression): CircleLayer

open override fun circleTranslateAnchor(circleTranslateAnchor: CircleTranslateAnchor): CircleLayer

circleTranslateTransition

Set the CircleTranslate property transition options

open override fun circleTranslateTransition(options: StyleTransition): CircleLayer

DSL for circleTranslateTransition.

open override fun circleTranslateTransition(block: StyleTransition.Builder.() -> Unit): CircleLayer

equals

open operator override fun equals(other: Any?): Boolean

filter

Set the filter property

open override fun filter(filter: Expression): CircleLayer

getCachedLayerProperties

override fun getCachedLayerProperties(): Value

hashCode

open override fun hashCode(): Int

maxZoom

Set the maxzoom property

open override fun maxZoom(maxZoom: Double): CircleLayer

minZoom

Set the minzoom property

open override fun minZoom(minZoom: Double): CircleLayer

sourceLayer

Set the sourceLayer property

open override fun sourceLayer(sourceLayer: String): CircleLayer

toString

open override fun toString(): String

updateProperty

override fun updateProperty(property: PropertyValue<*>)

visibility

Set the Visibility property

open override fun visibility(visibility: Visibility): CircleLayer

Properties

circleBlur

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

val circleBlur: Double?

circleBlurAsExpression

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

Transition options for CircleBlur.

val circleBlurTransition: StyleTransition?

circleColor

The fill color of the circle.

val circleColor: String?

circleColorAsColorInt

The fill color of the circle.

val circleColorAsColorInt: Int?

circleColorAsExpression

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

The fill color of the circle.

val circleColorAsExpression: Expression?

circleColorTransition

Transition options for CircleColor.

val circleColorTransition: StyleTransition?

circleOpacity

The opacity at which the circle will be drawn.

val circleOpacity: Double?

circleOpacityAsExpression

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

The opacity at which the circle will be drawn.

val circleOpacityAsExpression: Expression?

circleOpacityTransition

Transition options for CircleOpacity.

val circleOpacityTransition: StyleTransition?

circlePitchAlignment

Orientation of circle when map is pitched.

val circlePitchAlignment: CirclePitchAlignment?

circlePitchAlignmentAsExpression

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

Orientation of circle when map is pitched.

val circlePitchAlignmentAsExpression: Expression?

circlePitchScale

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

val circlePitchScale: CirclePitchScale?

circlePitchScaleAsExpression

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

Circle radius.

val circleRadius: Double?

circleRadiusAsExpression

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

Circle radius.

val circleRadiusAsExpression: Expression?

circleRadiusTransition

Transition options for CircleRadius.

val circleRadiusTransition: StyleTransition?

circleSortKey

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

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

The stroke color of the circle.

val circleStrokeColor: String?

circleStrokeColorAsColorInt

The stroke color of the circle.

val circleStrokeColorAsColorInt: Int?

circleStrokeColorAsExpression

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

The stroke color of the circle.

val circleStrokeColorAsExpression: Expression?

circleStrokeColorTransition

Transition options for CircleStrokeColor.

val circleStrokeColorTransition: StyleTransition?

circleStrokeOpacity

The opacity of the circle's stroke.

val circleStrokeOpacity: Double?

circleStrokeOpacityAsExpression

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

The opacity of the circle's stroke.

val circleStrokeOpacityAsExpression: Expression?

circleStrokeOpacityTransition

Transition options for CircleStrokeOpacity.

val circleStrokeOpacityTransition: StyleTransition?

circleStrokeWidth

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

val circleStrokeWidth: Double?

circleStrokeWidthAsExpression

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

Transition options for CircleStrokeWidth.

val circleStrokeWidthTransition: StyleTransition?

circleTranslate

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

val circleTranslate: List<Double>?

circleTranslateAnchor

Controls the frame of reference for circle-translate.

val circleTranslateAnchor: CircleTranslateAnchor?

circleTranslateAnchorAsExpression

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

Controls the frame of reference for circle-translate.

val circleTranslateAnchorAsExpression: Expression?

circleTranslateAsExpression

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

Transition options for CircleTranslate.

val circleTranslateTransition: StyleTransition?

filter

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

the ID of the layer

open override val layerId: String

layerProperties

Properties of this layer.

override val layerProperties: HashMap<String, PropertyValue<*>>

maxZoom

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

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

the ID of the source

val sourceId: String

sourceLayer

Source layer.

val sourceLayer: String?

visibility

Visibility of the layer.

open override val visibility: Visibility?