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

BackgroundLayer

The background color or pattern of the map.

class BackgroundLayer(layerId: String) : Layer, BackgroundLayerDsl

See also

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

Parameters

layerId

the ID of the layer

Constructors

BackgroundLayer

the ID of the layer

fun BackgroundLayer(layerId: String)

Types

Companion

Static variables and methods.

object Companion

Functions

backgroundColor

Set the BackgroundColor property

open override fun backgroundColor(backgroundColor: Expression): BackgroundLayer

open override fun backgroundColor(backgroundColor: String): BackgroundLayer

Set the BackgroundColor property.

open override fun backgroundColor(backgroundColor: Int): BackgroundLayer

backgroundColorTransition

Set the BackgroundColor property transition options

open override fun backgroundColorTransition(options: StyleTransition): BackgroundLayer

DSL for backgroundColorTransition.

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

backgroundOpacity

Set the BackgroundOpacity property

open override fun backgroundOpacity(backgroundOpacity: Expression): BackgroundLayer

open override fun backgroundOpacity(backgroundOpacity: Double): BackgroundLayer

backgroundOpacityTransition

Set the BackgroundOpacity property transition options

open override fun backgroundOpacityTransition(options: StyleTransition): BackgroundLayer

DSL for backgroundOpacityTransition.

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

backgroundPattern

Set the BackgroundPattern property

open override fun backgroundPattern(backgroundPattern: Expression): BackgroundLayer

open override fun backgroundPattern(backgroundPattern: String): BackgroundLayer

backgroundPatternTransition

Set the BackgroundPattern property transition options

open override fun backgroundPatternTransition(options: StyleTransition): BackgroundLayer

DSL for backgroundPatternTransition.

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

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?)

equals

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

getCachedLayerProperties

override fun getCachedLayerProperties(): Value

hashCode

open override fun hashCode(): Int

maxZoom

Set the maxzoom property

open override fun maxZoom(maxZoom: Double): BackgroundLayer

minZoom

Set the minzoom property

open override fun minZoom(minZoom: Double): BackgroundLayer

toString

open override fun toString(): String

updateProperty

override fun updateProperty(property: PropertyValue<*>)

visibility

Set the Visibility property

open override fun visibility(visibility: Visibility): BackgroundLayer

Properties

backgroundColor

The color with which the background will be drawn.

val backgroundColor: String?

backgroundColorAsColorInt

The color with which the background will be drawn.

val backgroundColorAsColorInt: Int?

backgroundColorAsExpression

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

The color with which the background will be drawn.

val backgroundColorAsExpression: Expression?

backgroundColorTransition

Transition options for BackgroundColor.

val backgroundColorTransition: StyleTransition?

backgroundOpacity

The opacity at which the background will be drawn.

val backgroundOpacity: Double?

backgroundOpacityAsExpression

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

The opacity at which the background will be drawn.

val backgroundOpacityAsExpression: Expression?

backgroundOpacityTransition

Transition options for BackgroundOpacity.

val backgroundOpacityTransition: StyleTransition?

backgroundPattern

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.

val backgroundPattern: String?

backgroundPatternAsExpression

This is an Expression representation of "background-pattern".

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.

val backgroundPatternAsExpression: Expression?

backgroundPatternTransition

Transition options for BackgroundPattern.

val backgroundPatternTransition: StyleTransition?

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?

visibility

Visibility of the layer.

open override val visibility: Visibility?