SkyLayer

public struct SkyLayer : Layer

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.

  • id

    Unique layer name

    Declaration

    Swift

    public var id: String
  • Rendering type of this layer.

    Declaration

    Swift

    public let type: LayerType
  • 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.

    Declaration

    Swift

    public var slot: String?
  • The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

    Declaration

    Swift

    public var minZoom: Double?
  • The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.

    Declaration

    Swift

    public var maxZoom: Double?
  • Whether this layer is displayed.

    Declaration

    Swift

    public var visibility: Value<Visibility>
  • 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.

    Declaration

    Swift

    public var skyAtmosphereColor: Value<StyleColor>?
  • A color applied to the atmosphere sun halo. The alpha channel describes how strongly the sun halo is represented in an atmosphere sky layer.

    Declaration

    Swift

    public var skyAtmosphereHaloColor: Value<StyleColor>?
  • 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.

    Declaration

    Swift

    public var skyAtmosphereSun: Value<[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.

    Declaration

    Swift

    public var skyAtmosphereSunIntensity: Value<Double>?
  • 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.

    Declaration

    Swift

    public var skyGradient: Value<StyleColor>?
  • 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.

    Declaration

    Swift

    public var skyGradientCenter: Value<[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.

    Declaration

    Swift

    public var skyGradientRadius: Value<Double>?
  • The opacity of the entire sky layer.

    Declaration

    Swift

    public var skyOpacity: Value<Double>?
  • Transition options for skyOpacity.

    Declaration

    Swift

    public var skyOpacityTransition: StyleTransition?
  • The type of the sky

    Declaration

    Swift

    public var skyType: Value<SkyType>?
  • Undocumented

    Declaration

    Swift

    public init(id: String)
  • Declaration

    Swift

    public func encode(to encoder: Encoder) throws
  • Declaration

    Swift

    public init(from decoder: Decoder) throws