mapbox-maps-android/com.mapbox.maps.extension.style.layers.generated/CircleLayer

CircleLayer

@UiThread

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

A filled circle.

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

CircleLayer

fun CircleLayer(layerId: String, sourceId: String)

Types

Companion

object Companion

Static variables and methods.

Functions

bindTo

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.

circleBlur

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.

circleBlurTransition

open override fun circleBlurTransition(options: StyleTransition): CircleLayer

Set the CircleBlur property transition options

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

DSL for circleBlurTransition.

circleColor

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

circleColorTransition

open override fun circleColorTransition(options: StyleTransition): CircleLayer

Set the CircleColor property transition options

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

DSL for circleColorTransition.

circleEmissiveStrength

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.

circleEmissiveStrengthTransition

open override fun circleEmissiveStrengthTransition(options: StyleTransition): CircleLayer

Set the CircleEmissiveStrength property transition options

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

DSL for circleEmissiveStrengthTransition.

circleOpacity

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

circleOpacityTransition

open override fun circleOpacityTransition(options: StyleTransition): CircleLayer

Set the CircleOpacity property transition options

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

DSL for circleOpacityTransition.

circlePitchAlignment

open override fun circlePitchAlignment(circlePitchAlignment: Expression): CircleLayer

open override fun circlePitchAlignment(circlePitchAlignment: CirclePitchAlignment): CircleLayer

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

circlePitchScale

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

circleRadius

open override fun circleRadius(circleRadius: Expression): CircleLayer

open override fun circleRadius(circleRadius: Double): CircleLayer

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

circleRadiusTransition

open override fun circleRadiusTransition(options: StyleTransition): CircleLayer

Set the CircleRadius property transition options

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

DSL for circleRadiusTransition.

circleSortKey

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

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

circleStrokeColorTransition

open override fun circleStrokeColorTransition(options: StyleTransition): CircleLayer

Set the CircleStrokeColor property transition options

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

DSL for circleStrokeColorTransition.

circleStrokeOpacity

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

circleStrokeOpacityTransition

open override fun circleStrokeOpacityTransition(options: StyleTransition): CircleLayer

Set the CircleStrokeOpacity property transition options

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

DSL for circleStrokeOpacityTransition.

circleStrokeWidth

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.

circleStrokeWidthTransition

open override fun circleStrokeWidthTransition(options: StyleTransition): CircleLayer

Set the CircleStrokeWidth property transition options

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

DSL for circleStrokeWidthTransition.

circleTranslate

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.

circleTranslateAnchor

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

circleTranslateTransition

open override fun circleTranslateTransition(options: StyleTransition): CircleLayer

Set the CircleTranslate property transition options

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

DSL for circleTranslateTransition.

filter

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

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

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.

slot

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.

sourceLayer

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

open override fun visibility(visibility: Expression): CircleLayer

open override fun visibility(visibility: Visibility): CircleLayer

Whether this layer is displayed.

Properties

circleBlur

val circleBlur: Double?

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

circleBlurAsExpression

val circleBlurAsExpression: Expression?

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

circleBlurTransition

val circleBlurTransition: StyleTransition?

Transition options for CircleBlur.

circleColor

val circleColor: String?

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

circleColorAsColorInt

@get:ColorInt

val circleColorAsColorInt: Int?

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

circleColorAsExpression

val circleColorAsExpression: Expression?

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

circleColorTransition

val circleColorTransition: StyleTransition?

Transition options for CircleColor.

circleEmissiveStrength

val circleEmissiveStrength: Double?

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

circleEmissiveStrengthAsExpression

val circleEmissiveStrengthAsExpression: Expression?

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

circleEmissiveStrengthTransition

val circleEmissiveStrengthTransition: StyleTransition?

Transition options for CircleEmissiveStrength.

circleOpacity

val circleOpacity: Double?

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

circleOpacityAsExpression

val circleOpacityAsExpression: Expression?

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

circleOpacityTransition

val circleOpacityTransition: StyleTransition?

Transition options for CircleOpacity.

circlePitchAlignment

val circlePitchAlignment: CirclePitchAlignment?

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

circlePitchAlignmentAsExpression

val circlePitchAlignmentAsExpression: Expression?

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

circlePitchScale

val circlePitchScale: CirclePitchScale?

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

circlePitchScaleAsExpression

val circlePitchScaleAsExpression: Expression?

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

circleRadius

val circleRadius: Double?

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

circleRadiusAsExpression

val circleRadiusAsExpression: Expression?

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

circleRadiusTransition

val circleRadiusTransition: StyleTransition?

Transition options for CircleRadius.

circleSortKey

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

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

val circleStrokeColor: String?

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

circleStrokeColorAsColorInt

@get:ColorInt

val circleStrokeColorAsColorInt: Int?

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

circleStrokeColorAsExpression

val circleStrokeColorAsExpression: Expression?

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

circleStrokeColorTransition

val circleStrokeColorTransition: StyleTransition?

Transition options for CircleStrokeColor.

circleStrokeOpacity

val circleStrokeOpacity: Double?

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

circleStrokeOpacityAsExpression

val circleStrokeOpacityAsExpression: Expression?

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

circleStrokeOpacityTransition

val circleStrokeOpacityTransition: StyleTransition?

Transition options for CircleStrokeOpacity.

circleStrokeWidth

val circleStrokeWidth: Double?

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

circleStrokeWidthAsExpression

val circleStrokeWidthAsExpression: Expression?

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

circleStrokeWidthTransition

val circleStrokeWidthTransition: StyleTransition?

Transition options for CircleStrokeWidth.

circleTranslate

val circleTranslate: List<Double>?

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

circleTranslateAnchor

val circleTranslateAnchor: CircleTranslateAnchor?

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

circleTranslateAnchorAsExpression

val circleTranslateAnchorAsExpression: Expression?

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

circleTranslateAsExpression

val circleTranslateAsExpression: Expression?

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

circleTranslateTransition

val circleTranslateTransition: StyleTransition?

Transition options for CircleTranslate.

filter

val filter: Expression?

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

layerId

open override val layerId: String

maxZoom

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

open override val minZoom: Double?

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

slot

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.

sourceId

val sourceId: String

sourceLayer

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

open override val visibility: Visibility?

Whether this layer is displayed.

visibilityAsExpression

open override val visibilityAsExpression: Expression?

Whether this layer is displayed.

Extensions

isPersistent

fun Layer.isPersistent(): Boolean?

Get the persistent property as Boolean.

CircleLayer

See also

Parameters

Constructors

Types

Functions

Properties

Extensions