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

backgroundColor

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.

backgroundColorTransition

abstract fun backgroundColorTransition(options: StyleTransition): BackgroundLayer

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

The color with which the background will be drawn.

backgroundOpacity

abstract fun backgroundOpacity(backgroundOpacity: Expression): BackgroundLayer

abstract fun backgroundOpacity(backgroundOpacity: Double = 1.0): BackgroundLayer

The opacity at which the background will be drawn.

backgroundOpacityTransition

abstract fun backgroundOpacityTransition(options: StyleTransition): BackgroundLayer

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

The opacity at which the background will be drawn.

backgroundPattern

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.

backgroundPatternTransition

abstract fun backgroundPatternTransition(options: StyleTransition): BackgroundLayer

abstract fun backgroundPatternTransition(block: StyleTransition.Builder.() -> Unit): 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.

maxZoom

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.

minZoom

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.

visibility

abstract fun visibility(visibility: Visibility): BackgroundLayer

Whether this layer is displayed.

Inheritors

BackgroundLayer