SkyLayer

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

class SkyLayer(layerId: String) : Layer, SkyLayerDsl

See also

Parameters

layerId

the ID of the layer

Constructors

SkyLayer
Link copied to clipboard

the ID of the layer

fun SkyLayer(layerId: String)

Types

Companion
Link copied to clipboard

Static variables and methods.

object Companion

Functions

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

Set the filter property

open override fun filter(filter: Expression): SkyLayer
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): SkyLayer
minZoom
Link copied to clipboard

Set the minzoom property

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

Set the SkyAtmosphereColor property

open override fun skyAtmosphereColor(skyAtmosphereColor: Expression): SkyLayer
open override fun skyAtmosphereColor(skyAtmosphereColor: String): SkyLayer

Set the SkyAtmosphereColor property.

open override fun skyAtmosphereColor(skyAtmosphereColor: Int): SkyLayer
skyAtmosphereHaloColor
Link copied to clipboard

Set the SkyAtmosphereHaloColor property

open override fun skyAtmosphereHaloColor(skyAtmosphereHaloColor: Expression): SkyLayer
open override fun skyAtmosphereHaloColor(skyAtmosphereHaloColor: String): SkyLayer

Set the SkyAtmosphereHaloColor property.

open override fun skyAtmosphereHaloColor(skyAtmosphereHaloColor: Int): SkyLayer
skyAtmosphereSun
Link copied to clipboard

Set the SkyAtmosphereSun property

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

Set the SkyAtmosphereSunIntensity property

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

Set the SkyGradient property

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

Set the SkyGradientCenter property

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

Set the SkyGradientRadius property

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

Set the SkyOpacity property

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

Set the SkyOpacity property transition options

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

Set the SkyType property

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

Properties

filter
Link copied to clipboard

A expression specifying conditions on source features. Only features that match the filter are displayed. Zoom expressions in filters are only evaluated at integer zoom levels. The feature-state expression is not supported in filter expressions.

val filter: Expression?
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?
skyAtmosphereColor
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.

val skyAtmosphereColor: String?
skyAtmosphereColorAsColorInt
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.

val skyAtmosphereColorAsColorInt: Int?
skyAtmosphereColorAsExpression
Link copied to clipboard

This is an Expression representation of "sky-atmosphere-color".

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.

val skyAtmosphereColorAsExpression: Expression?
skyAtmosphereHaloColor
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.

val skyAtmosphereHaloColor: String?
skyAtmosphereHaloColorAsColorInt
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.

val skyAtmosphereHaloColorAsColorInt: Int?
skyAtmosphereHaloColorAsExpression
Link copied to clipboard

This is an Expression representation of "sky-atmosphere-halo-color".

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

val skyAtmosphereHaloColorAsExpression: Expression?
skyAtmosphereSun
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.

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

This is an Expression representation of "sky-atmosphere-sun".

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.

val skyAtmosphereSunAsExpression: Expression?
skyAtmosphereSunIntensity
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.

val skyAtmosphereSunIntensity: Double?
skyAtmosphereSunIntensityAsExpression
Link copied to clipboard

This is an Expression representation of "sky-atmosphere-sun-intensity".

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.

val skyAtmosphereSunIntensityAsExpression: Expression?
skyGradient
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.

val skyGradient: Expression?
skyGradientCenter
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.

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

This is an Expression representation of "sky-gradient-center".

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.

val skyGradientCenterAsExpression: Expression?
skyGradientRadius
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.

val skyGradientRadius: Double?
skyGradientRadiusAsExpression
Link copied to clipboard

This is an Expression representation of "sky-gradient-radius".

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.

val skyGradientRadiusAsExpression: Expression?
skyOpacity
Link copied to clipboard

The opacity of the entire sky layer.

val skyOpacity: Double?
skyOpacityAsExpression
Link copied to clipboard

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

The opacity of the entire sky layer.

val skyOpacityAsExpression: Expression?
skyOpacityTransition
Link copied to clipboard

Transition options for SkyOpacity.

val skyOpacityTransition: StyleTransition?
skyType
Link copied to clipboard

The type of the sky

val skyType: SkyType?
skyTypeAsExpression
Link copied to clipboard

This is an Expression representation of "sky-type".

The type of the sky

val skyTypeAsExpression: Expression?
visibility
Link copied to clipboard

Visibility of the layer.

open override val visibility: Visibility?