BackgroundLayer

fun BackgroundLayer(layerId: String)

Companion

object Companion

Static variables and methods.

backgroundColor

open override fun backgroundColor(backgroundColor: Expression): BackgroundLayer

open override fun backgroundColor(@ColorInt backgroundColor: Int): BackgroundLayer

open override fun backgroundColor(backgroundColor: String): BackgroundLayer

The color with which the background will be drawn. Default value: "#000000".

backgroundColorTransition

open override fun backgroundColorTransition(options: StyleTransition): BackgroundLayer

Set the BackgroundColor property transition options

open override fun backgroundColorTransition(block: StyleTransition.Builder.() -> Unit): BackgroundLayer

DSL for backgroundColorTransition.

backgroundEmissiveStrength

open override fun backgroundEmissiveStrength(backgroundEmissiveStrength: Expression): BackgroundLayer

open override fun backgroundEmissiveStrength(backgroundEmissiveStrength: Double): BackgroundLayer

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

backgroundEmissiveStrengthTransition

open override fun backgroundEmissiveStrengthTransition(options: StyleTransition): BackgroundLayer

Set the BackgroundEmissiveStrength property transition options

open override fun backgroundEmissiveStrengthTransition(block: StyleTransition.Builder.() -> Unit): BackgroundLayer

DSL for backgroundEmissiveStrengthTransition.

backgroundOpacity

open override fun backgroundOpacity(backgroundOpacity: Expression): BackgroundLayer

open override fun backgroundOpacity(backgroundOpacity: Double): BackgroundLayer

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

backgroundOpacityTransition

open override fun backgroundOpacityTransition(options: StyleTransition): BackgroundLayer

Set the BackgroundOpacity property transition options

open override fun backgroundOpacityTransition(block: StyleTransition.Builder.() -> Unit): BackgroundLayer

DSL for backgroundOpacityTransition.

backgroundPattern

open override fun backgroundPattern(backgroundPattern: Expression): BackgroundLayer

open override fun backgroundPattern(backgroundPattern: String): BackgroundLayer

Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.

backgroundPitchAlignment

open override fun backgroundPitchAlignment(backgroundPitchAlignment: Expression): BackgroundLayer

open override fun backgroundPitchAlignment(backgroundPitchAlignment: BackgroundPitchAlignment): BackgroundLayer

Orientation of background layer. Default value: "map".

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.

maxZoom

open override fun maxZoom(maxZoom: Double): BackgroundLayer

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): BackgroundLayer

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): BackgroundLayer

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.

visibility

open override fun visibility(visibility: Expression): BackgroundLayer

open override fun visibility(visibility: Visibility): BackgroundLayer

Whether this layer is displayed.

backgroundColor

val backgroundColor: String?

The color with which the background will be drawn. Default value: "#000000".

backgroundColorAsColorInt

@get:ColorInt

val backgroundColorAsColorInt: Int?

The color with which the background will be drawn. Default value: "#000000".

backgroundColorAsExpression

val backgroundColorAsExpression: Expression?

The color with which the background will be drawn. Default value: "#000000".

backgroundColorTransition

val backgroundColorTransition: StyleTransition?

Transition options for BackgroundColor.

backgroundEmissiveStrength

val backgroundEmissiveStrength: Double?

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

backgroundEmissiveStrengthAsExpression

val backgroundEmissiveStrengthAsExpression: Expression?

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

backgroundEmissiveStrengthTransition

val backgroundEmissiveStrengthTransition: StyleTransition?

Transition options for BackgroundEmissiveStrength.

backgroundOpacity

val backgroundOpacity: Double?

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

backgroundOpacityAsExpression

val backgroundOpacityAsExpression: Expression?

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

backgroundOpacityTransition

val backgroundOpacityTransition: StyleTransition?

Transition options for BackgroundOpacity.

backgroundPattern

val backgroundPattern: String?

Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.

backgroundPatternAsExpression

val backgroundPatternAsExpression: Expression?

Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.

backgroundPitchAlignment

val backgroundPitchAlignment: BackgroundPitchAlignment?

Orientation of background layer. Default value: "map".

backgroundPitchAlignmentAsExpression

val backgroundPitchAlignmentAsExpression: Expression?

Orientation of background layer. Default value: "map".

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