BackgroundLayer

The background color or pattern of the map.

class BackgroundLayer(layerId: String) : Layer, BackgroundLayerDsl

See also

Parameters

layerId

the ID of the layer

Constructors

BackgroundLayer
Link copied to clipboard

the ID of the layer

fun BackgroundLayer(layerId: String)

Types

Companion
Link copied to clipboard

Static variables and methods.

object Companion

Functions

backgroundColor
Link copied to clipboard

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
Link copied to clipboard

Set the BackgroundColor property transition options

open override fun backgroundColorTransition(options: StyleTransition): BackgroundLayer
open override fun backgroundColorTransition(block: StyleTransition.Builder.() -> Unit): BackgroundLayer
backgroundOpacity
Link copied to clipboard

Set the BackgroundOpacity property

open override fun backgroundOpacity(backgroundOpacity: Expression): BackgroundLayer
open override fun backgroundOpacity(backgroundOpacity: Double): BackgroundLayer
backgroundOpacityTransition
Link copied to clipboard

Set the BackgroundOpacity property transition options

open override fun backgroundOpacityTransition(options: StyleTransition): BackgroundLayer
open override fun backgroundOpacityTransition(block: StyleTransition.Builder.() -> Unit): BackgroundLayer
backgroundPattern
Link copied to clipboard

Set the BackgroundPattern property

open override fun backgroundPattern(backgroundPattern: Expression): BackgroundLayer
open override fun backgroundPattern(backgroundPattern: String): BackgroundLayer
backgroundPatternTransition
Link copied to clipboard

Set the BackgroundPattern property transition options

open override fun backgroundPatternTransition(options: StyleTransition): BackgroundLayer
open override fun backgroundPatternTransition(block: StyleTransition.Builder.() -> Unit): BackgroundLayer
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?)
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
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): BackgroundLayer
minZoom
Link copied to clipboard

Set the minzoom property

open override fun minZoom(minZoom: Double): BackgroundLayer
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): BackgroundLayer

Properties

backgroundColor
Link copied to clipboard

The color with which the background will be drawn.

val backgroundColor: String?
backgroundColorAsColorInt
Link copied to clipboard

The color with which the background will be drawn.

val backgroundColorAsColorInt: Int?
backgroundColorAsExpression
Link copied to clipboard

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

The color with which the background will be drawn.

val backgroundColorAsExpression: Expression?
backgroundColorTransition
Link copied to clipboard

Transition options for BackgroundColor.

val backgroundColorTransition: StyleTransition?
backgroundOpacity
Link copied to clipboard

The opacity at which the background will be drawn.

val backgroundOpacity: Double?
backgroundOpacityAsExpression
Link copied to clipboard

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

The opacity at which the background will be drawn.

val backgroundOpacityAsExpression: Expression?
backgroundOpacityTransition
Link copied to clipboard

Transition options for BackgroundOpacity.

val backgroundOpacityTransition: StyleTransition?
backgroundPattern
Link copied to clipboard

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
Link copied to clipboard

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
Link copied to clipboard

Transition options for BackgroundPattern.

val backgroundPatternTransition: StyleTransition?
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?
visibility
Link copied to clipboard

Visibility of the layer.

open override val visibility: Visibility?