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)
the ID of the layer

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
Set the filter property
maxZoom
Link copied to clipboard
open override fun maxZoom(maxZoom: Double): SkyLayer
Set the maxzoom property
minZoom
Link copied to clipboard
open override fun minZoom(minZoom: Double): SkyLayer
Set the minzoom property
skyAtmosphereColor
Link copied to clipboard
open override fun skyAtmosphereColor(skyAtmosphereColor: Expression): SkyLayer
Set the SkyAtmosphereColor property
open override fun skyAtmosphereColor(@ColorInt() skyAtmosphereColor: Int): SkyLayer
Set the SkyAtmosphereColor property.
open override fun skyAtmosphereColor(skyAtmosphereColor: String): SkyLayer
Set the SkyAtmosphereColor property
skyAtmosphereHaloColor
Link copied to clipboard
open override fun skyAtmosphereHaloColor(skyAtmosphereHaloColor: Expression): SkyLayer
Set the SkyAtmosphereHaloColor property
open override fun skyAtmosphereHaloColor(@ColorInt() skyAtmosphereHaloColor: Int): SkyLayer
Set the SkyAtmosphereHaloColor property.
open override fun skyAtmosphereHaloColor(skyAtmosphereHaloColor: String): SkyLayer
Set the SkyAtmosphereHaloColor property
skyAtmosphereSun
Link copied to clipboard
open override fun skyAtmosphereSun(skyAtmosphereSun: Expression): SkyLayer
Set the SkyAtmosphereSun property
open override fun skyAtmosphereSun(skyAtmosphereSun: List<Double>): SkyLayer
Set the SkyAtmosphereSun property
skyAtmosphereSunIntensity
Link copied to clipboard
open override fun skyAtmosphereSunIntensity(skyAtmosphereSunIntensity: Expression): SkyLayer
Set the SkyAtmosphereSunIntensity property
open override fun skyAtmosphereSunIntensity(skyAtmosphereSunIntensity: Double): SkyLayer
Set the SkyAtmosphereSunIntensity property
skyGradient
Link copied to clipboard
open override fun skyGradient(skyGradient: Expression): SkyLayer
Set the SkyGradient property
skyGradientCenter
Link copied to clipboard
open override fun skyGradientCenter(skyGradientCenter: Expression): SkyLayer
Set the SkyGradientCenter property
open override fun skyGradientCenter(skyGradientCenter: List<Double>): SkyLayer
Set the SkyGradientCenter property
skyGradientRadius
Link copied to clipboard
open override fun skyGradientRadius(skyGradientRadius: Expression): SkyLayer
Set the SkyGradientRadius property
open override fun skyGradientRadius(skyGradientRadius: Double): SkyLayer
Set the SkyGradientRadius property
skyOpacity
Link copied to clipboard
open override fun skyOpacity(skyOpacity: Expression): SkyLayer
Set the SkyOpacity property
open override fun skyOpacity(skyOpacity: Double): SkyLayer
Set the SkyOpacity property
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
Set the SkyType property
open override fun skyType(skyType: SkyType): SkyLayer
Set the SkyType property
visibility
Link copied to clipboard
open override fun visibility(visibility: Visibility): SkyLayer
Set the Visibility property

Properties

filter
Link copied to clipboard
val filter: Expression?
A expression specifying conditions on source features.
layerId
Link copied to clipboard
open override val layerId: String
the ID of the layer
maxZoom
Link copied to clipboard
open override val maxZoom: Double?
The maximum zoom level for the layer.
minZoom
Link copied to clipboard
open override val minZoom: Double?
The minimum zoom level for the layer.
skyAtmosphereColor
Link copied to clipboard
val skyAtmosphereColor: String?
A color used to tweak the main atmospheric scattering coefficients.
skyAtmosphereColorAsColorInt
Link copied to clipboard
val skyAtmosphereColorAsColorInt: Int?
A color used to tweak the main atmospheric scattering coefficients.
skyAtmosphereColorAsExpression
Link copied to clipboard
val skyAtmosphereColorAsExpression: Expression?
This is an Expression representation of "sky-atmosphere-color".
skyAtmosphereHaloColor
Link copied to clipboard
val skyAtmosphereHaloColor: String?
A color applied to the atmosphere sun halo.
skyAtmosphereHaloColorAsColorInt
Link copied to clipboard
val skyAtmosphereHaloColorAsColorInt: Int?
A color applied to the atmosphere sun halo.
skyAtmosphereHaloColorAsExpression
Link copied to clipboard
val skyAtmosphereHaloColorAsExpression: Expression?
This is an Expression representation of "sky-atmosphere-halo-color".
skyAtmosphereSun
Link copied to clipboard
val skyAtmosphereSun: List<Double>?
Position of the sun center a azimuthal angle, p polar angle.
skyAtmosphereSunAsExpression
Link copied to clipboard
val skyAtmosphereSunAsExpression: Expression?
This is an Expression representation of "sky-atmosphere-sun".
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).
skyAtmosphereSunIntensityAsExpression
Link copied to clipboard
val skyAtmosphereSunIntensityAsExpression: Expression?
This is an Expression representation of "sky-atmosphere-sun-intensity".
skyGradient
Link copied to clipboard
val skyGradient: Expression?
Defines a radial color gradient with which to color the sky.
skyGradientCenter
Link copied to clipboard
val skyGradientCenter: List<Double>?
Position of the gradient center a azimuthal angle, p polar angle.
skyGradientCenterAsExpression
Link copied to clipboard
val skyGradientCenterAsExpression: Expression?
This is an Expression representation of "sky-gradient-center".
skyGradientRadius
Link copied to clipboard
val skyGradientRadius: Double?
The angular distance (measured in degrees) from sky-gradient-center up to which the gradient extends.
skyGradientRadiusAsExpression
Link copied to clipboard
val skyGradientRadiusAsExpression: Expression?
This is an Expression representation of "sky-gradient-radius".
skyOpacity
Link copied to clipboard
val skyOpacity: Double?
The opacity of the entire sky layer.
skyOpacityAsExpression
Link copied to clipboard
val skyOpacityAsExpression: Expression?
This is an Expression representation of "sky-opacity".
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?
This is an Expression representation of "sky-type".
visibility
Link copied to clipboard
open override val visibility: Visibility?
Visibility of the layer.