SkyLayer

class SkyLayer(layerId: String) : Layer, SkyLayerDsl

A spherical dome around the map that is always rendered behind all other layers.

See also

Parameters

layerId

the ID of the layer

Constructors

SkyLayer
Link copied to clipboard
fun SkyLayer(layerId: String)

Types

Companion
Link copied to clipboard
object Companion

Static variables and methods.

Functions

bindTo
Link copied to clipboard
fun bindTo(delegate: StyleInterface)

Bind the layer to the Style.

open override fun bindTo(delegate: StyleInterface, position: LayerPosition?)

Bind the layer to the map controller.

filter
Link copied to clipboard
open override fun filter(filter: Expression): SkyLayer

A filter is a property at the layer level that determines which features should be rendered in a style layer.

maxZoom
Link copied to clipboard
open override fun maxZoom(maxZoom: Double): SkyLayer

The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.

minZoom
Link copied to clipboard
open override fun minZoom(minZoom: Double): SkyLayer

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

skyAtmosphereColor
Link copied to clipboard
open override fun skyAtmosphereColor(skyAtmosphereColor: Expression): SkyLayer
open override fun skyAtmosphereColor(@ColorInt skyAtmosphereColor: Int): SkyLayer
open override fun skyAtmosphereColor(skyAtmosphereColor: String): SkyLayer

A color used to tweak the main atmospheric scattering coefficients. Using white applies the default coefficients giving the natural blue color to the atmosphere. This color affects how heavily the corresponding wavelength is represented during scattering. The alpha channel describes the density of the atmosphere, with 1 maximum density and 0 no density.

skyAtmosphereHaloColor
Link copied to clipboard
open override fun skyAtmosphereHaloColor(skyAtmosphereHaloColor: Expression): SkyLayer
open override fun skyAtmosphereHaloColor(@ColorInt skyAtmosphereHaloColor: Int): SkyLayer
open override fun skyAtmosphereHaloColor(skyAtmosphereHaloColor: String): SkyLayer

A color applied to the atmosphere sun halo. The alpha channel describes how strongly the sun halo is represented in an atmosphere sky layer.

skyAtmosphereSun
Link copied to clipboard
open override fun skyAtmosphereSun(skyAtmosphereSun: Expression): SkyLayer
open override fun skyAtmosphereSun(skyAtmosphereSun: List<Double>): SkyLayer

Position of the sun center a azimuthal angle, p polar angle. The azimuthal angle indicates the position of the sun relative to 0 degree north, where degrees proceed clockwise. The polar angle indicates the height of the sun, where 0 degree is directly above, at zenith, and 90 degree at the horizon. When this property is ommitted, the sun center is directly inherited from the light position.

skyAtmosphereSunIntensity
Link copied to clipboard
open override fun skyAtmosphereSunIntensity(skyAtmosphereSunIntensity: Expression): SkyLayer
open override fun skyAtmosphereSunIntensity(skyAtmosphereSunIntensity: Double): SkyLayer

Intensity of the sun as a light source in the atmosphere (on a scale from 0 to a 100). Setting higher values will brighten up the sky.

skyGradient
Link copied to clipboard
open override fun skyGradient(skyGradient: Expression): SkyLayer

Defines a radial color gradient with which to color the sky. The color values can be interpolated with an expression using sky-radial-progress. The range 0, 1 for the interpolant covers a radial distance (in degrees) of 0, `sky-gradient-radius` centered at the position specified by sky-gradient-center.

skyGradientCenter
Link copied to clipboard
open override fun skyGradientCenter(skyGradientCenter: Expression): SkyLayer
open override fun skyGradientCenter(skyGradientCenter: List<Double>): SkyLayer

Position of the gradient center a azimuthal angle, p polar angle. The azimuthal angle indicates the position of the gradient center relative to 0 degree north, where degrees proceed clockwise. The polar angle indicates the height of the gradient center, where 0 degree is directly above, at zenith, and 90 degree at the horizon.

skyGradientRadius
Link copied to clipboard
open override fun skyGradientRadius(skyGradientRadius: Expression): SkyLayer
open override fun skyGradientRadius(skyGradientRadius: Double): SkyLayer

The angular distance (measured in degrees) from sky-gradient-center up to which the gradient extends. A value of 180 causes the gradient to wrap around to the opposite direction from sky-gradient-center.

skyOpacity
Link copied to clipboard
open override fun skyOpacity(skyOpacity: Expression): SkyLayer
open override fun skyOpacity(skyOpacity: Double): SkyLayer

The opacity of the entire sky layer.

skyOpacityTransition
Link copied to clipboard
open override fun skyOpacityTransition(options: StyleTransition): SkyLayer

Set the SkyOpacity property transition options

open override fun skyOpacityTransition(block: StyleTransition.Builder.() -> Unit): SkyLayer
skyType
Link copied to clipboard
open override fun skyType(skyType: Expression): SkyLayer
open override fun skyType(skyType: SkyType): SkyLayer

The type of the sky

visibility
Link copied to clipboard
open override fun visibility(visibility: Visibility): SkyLayer

Whether this layer is displayed.

Properties

filter
Link copied to clipboard
val filter: Expression?

A filter is a property at the layer level that determines which features should be rendered in a style layer.

layerId
Link copied to clipboard
open override val layerId: String
maxZoom
Link copied to clipboard
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
Link copied to clipboard
open override val minZoom: Double?

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

skyAtmosphereColor
Link copied to clipboard
val skyAtmosphereColor: String?

A color used to tweak the main atmospheric scattering coefficients. Using white applies the default coefficients giving the natural blue color to the atmosphere. This color affects how heavily the corresponding wavelength is represented during scattering. The alpha channel describes the density of the atmosphere, with 1 maximum density and 0 no density.

skyAtmosphereColorAsColorInt
Link copied to clipboard
val skyAtmosphereColorAsColorInt: Int?

A color used to tweak the main atmospheric scattering coefficients. Using white applies the default coefficients giving the natural blue color to the atmosphere. This color affects how heavily the corresponding wavelength is represented during scattering. The alpha channel describes the density of the atmosphere, with 1 maximum density and 0 no density.

skyAtmosphereColorAsExpression
Link copied to clipboard
val skyAtmosphereColorAsExpression: Expression?

A color used to tweak the main atmospheric scattering coefficients. Using white applies the default coefficients giving the natural blue color to the atmosphere. This color affects how heavily the corresponding wavelength is represented during scattering. The alpha channel describes the density of the atmosphere, with 1 maximum density and 0 no density.

skyAtmosphereHaloColor
Link copied to clipboard
val skyAtmosphereHaloColor: String?

A color applied to the atmosphere sun halo. The alpha channel describes how strongly the sun halo is represented in an atmosphere sky layer.

skyAtmosphereHaloColorAsColorInt
Link copied to clipboard
val skyAtmosphereHaloColorAsColorInt: Int?

A color applied to the atmosphere sun halo. The alpha channel describes how strongly the sun halo is represented in an atmosphere sky layer.

skyAtmosphereHaloColorAsExpression
Link copied to clipboard
val skyAtmosphereHaloColorAsExpression: Expression?

A color applied to the atmosphere sun halo. The alpha channel describes how strongly the sun halo is represented in an atmosphere sky layer.

skyAtmosphereSun
Link copied to clipboard
val skyAtmosphereSun: List<Double>?

Position of the sun center a azimuthal angle, p polar angle. The azimuthal angle indicates the position of the sun relative to 0 degree north, where degrees proceed clockwise. The polar angle indicates the height of the sun, where 0 degree is directly above, at zenith, and 90 degree at the horizon. When this property is ommitted, the sun center is directly inherited from the light position.

skyAtmosphereSunAsExpression
Link copied to clipboard
val skyAtmosphereSunAsExpression: Expression?

Position of the sun center a azimuthal angle, p polar angle. The azimuthal angle indicates the position of the sun relative to 0 degree north, where degrees proceed clockwise. The polar angle indicates the height of the sun, where 0 degree is directly above, at zenith, and 90 degree at the horizon. When this property is ommitted, the sun center is directly inherited from the light position.

skyAtmosphereSunIntensity
Link copied to clipboard
val skyAtmosphereSunIntensity: Double?

Intensity of the sun as a light source in the atmosphere (on a scale from 0 to a 100). Setting higher values will brighten up the sky.

skyAtmosphereSunIntensityAsExpression
Link copied to clipboard
val skyAtmosphereSunIntensityAsExpression: Expression?

Intensity of the sun as a light source in the atmosphere (on a scale from 0 to a 100). Setting higher values will brighten up the sky.

skyGradient
Link copied to clipboard
val skyGradient: Expression?

Defines a radial color gradient with which to color the sky. The color values can be interpolated with an expression using sky-radial-progress. The range 0, 1 for the interpolant covers a radial distance (in degrees) of 0, `sky-gradient-radius` centered at the position specified by sky-gradient-center.

skyGradientCenter
Link copied to clipboard
val skyGradientCenter: List<Double>?

Position of the gradient center a azimuthal angle, p polar angle. The azimuthal angle indicates the position of the gradient center relative to 0 degree north, where degrees proceed clockwise. The polar angle indicates the height of the gradient center, where 0 degree is directly above, at zenith, and 90 degree at the horizon.

skyGradientCenterAsExpression
Link copied to clipboard
val skyGradientCenterAsExpression: Expression?

Position of the gradient center a azimuthal angle, p polar angle. The azimuthal angle indicates the position of the gradient center relative to 0 degree north, where degrees proceed clockwise. The polar angle indicates the height of the gradient center, where 0 degree is directly above, at zenith, and 90 degree at the horizon.

skyGradientRadius
Link copied to clipboard
val skyGradientRadius: Double?

The angular distance (measured in degrees) from sky-gradient-center up to which the gradient extends. A value of 180 causes the gradient to wrap around to the opposite direction from sky-gradient-center.

skyGradientRadiusAsExpression
Link copied to clipboard
val skyGradientRadiusAsExpression: Expression?

The angular distance (measured in degrees) from sky-gradient-center up to which the gradient extends. A value of 180 causes the gradient to wrap around to the opposite direction from sky-gradient-center.

skyOpacity
Link copied to clipboard
val skyOpacity: Double?

The opacity of the entire sky layer.

skyOpacityAsExpression
Link copied to clipboard
val skyOpacityAsExpression: Expression?

The opacity of the entire sky layer.

skyOpacityTransition
Link copied to clipboard
val skyOpacityTransition: StyleTransition?

Transition options for SkyOpacity.

skyType
Link copied to clipboard
val skyType: SkyType?

The type of the sky

skyTypeAsExpression
Link copied to clipboard
val skyTypeAsExpression: Expression?

The type of the sky

visibility
Link copied to clipboard
open override val visibility: Visibility?

Whether this layer is displayed.