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

BackgroundLayerDsl

interface BackgroundLayerDsl

This Interface contains all the functions that will be exposed to Koltin DSL.

Separated the DSL receiver class to this interface to avoid IDE code suggestion for property getters.

Functions

Link copied to clipboard
abstract fun backgroundColor(backgroundColor: Expression): BackgroundLayer
abstract fun backgroundColor(@ColorInt backgroundColor: Int): BackgroundLayer
abstract fun backgroundColor(backgroundColor: String = "#000000"): BackgroundLayer

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

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

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

Link copied to clipboard
abstract fun backgroundEmissiveStrength(backgroundEmissiveStrength: Expression): BackgroundLayer
abstract fun backgroundEmissiveStrength(backgroundEmissiveStrength: Double = 0.0): BackgroundLayer

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

Link copied to clipboard
abstract fun backgroundEmissiveStrengthTransition(options: StyleTransition): BackgroundLayer
abstract fun backgroundEmissiveStrengthTransition(block: StyleTransition.Builder.() -> Unit): BackgroundLayer

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

Link copied to clipboard
abstract fun backgroundOpacity(backgroundOpacity: Expression): BackgroundLayer
abstract fun backgroundOpacity(backgroundOpacity: Double = 1.0): BackgroundLayer

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

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

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

Link copied to clipboard
abstract fun backgroundPattern(backgroundPattern: Expression): BackgroundLayer
abstract 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.

Link copied to clipboard
abstract fun backgroundPitchAlignment(backgroundPitchAlignment: Expression): BackgroundLayer
abstract fun backgroundPitchAlignment(backgroundPitchAlignment: BackgroundPitchAlignment = BackgroundPitchAlignment.MAP): BackgroundLayer

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

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

Link copied to clipboard
abstract fun minZoom(minZoom: Double): BackgroundLayer

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

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

Link copied to clipboard
abstract fun visibility(visibility: Expression): BackgroundLayer
abstract fun visibility(visibility: Visibility): BackgroundLayer

Whether this layer is displayed.

Inheritors

Link copied to clipboard