SkyLayer

class SkyLayer(val layerId: String) : Layer, SkyLayerDsl

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

Warning: As of v10.6.0, Atmosphere is the preferred method for atmospheric styling. Sky layer is not supported by the globe projection, and will be phased out in future major release.

See also

Parameters

layerId

the ID of the layer

Constructors

Link copied to clipboard
fun SkyLayer(layerId: String)

Types

Link copied to clipboard
object Companion

Static variables and methods.

Functions

Link copied to clipboard
fun bindTo(delegate: MapboxStyleManager)

Bind the layer to the Style.

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

Bind the layer to the map controller.

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.

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.

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.

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. Default value: "white".

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. Default value: "white".

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. Minimum value: 0,0. Maximum value: 360,180.

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. Default value: 10. Value range: 0, 100

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. Default value: ["interpolate","linear","sky-radial-progress",0.8,"#87ceeb",1,"white"].

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. Default value: 0,0. Minimum value: 0,0. Maximum value: 360,180.

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. Default value: 90. Value range: 0, 180

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. Default value: 1. Value range: 0, 1

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

Set the SkyOpacity property transition options

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

The type of the sky Default value: "atmosphere".

Link copied to clipboard
open override fun slot(slot: String): SkyLayer

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
open override fun visibility(visibility: Expression): SkyLayer
open override fun visibility(visibility: Visibility): SkyLayer

Whether this layer is displayed.

Properties

Link copied to clipboard

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

Link copied to clipboard
open override val layerId: String
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.

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.

Link copied to clipboard

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. Default value: "white".

Link copied to clipboard

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. Default value: "white".

Link copied to clipboard

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. Default value: "white".

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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. Minimum value: 0,0. Maximum value: 360,180.

Link copied to clipboard

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. Minimum value: 0,0. Maximum value: 360,180.

Link copied to clipboard

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. Default value: 10. Value range: 0, 100

Link copied to clipboard

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. Default value: 10. Value range: 0, 100

Link copied to clipboard

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. Default value: ["interpolate","linear","sky-radial-progress",0.8,"#87ceeb",1,"white"].

Link copied to clipboard

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. Default value: 0,0. Minimum value: 0,0. Maximum value: 360,180.

Link copied to clipboard

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. Default value: 0,0. Minimum value: 0,0. Maximum value: 360,180.

Link copied to clipboard

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. Default value: 90. Value range: 0, 180

Link copied to clipboard

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. Default value: 90. Value range: 0, 180

Link copied to clipboard

The opacity of the entire sky layer. Default value: 1. Value range: 0, 1

Link copied to clipboard

The opacity of the entire sky layer. Default value: 1. Value range: 0, 1

Link copied to clipboard

Transition options for SkyOpacity.

Link copied to clipboard

The type of the sky Default value: "atmosphere".

Link copied to clipboard

The type of the sky Default value: "atmosphere".

Link copied to clipboard
open override val slot: String?

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
open override val visibility: Visibility?

Whether this layer is displayed.

Link copied to clipboard

Whether this layer is displayed.

Extensions

Link copied to clipboard

Get the persistent property as Boolean.