BackgroundLayer

 
public struct BackgroundLayer : Layer

The background color or pattern of the map.

See also

Mapbox Style Specification

Conformance to `Layer` protocol
  • 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>

  • The color with which the background will be drawn.

    Declaration

    Swift

    public var backgroundColor: Value<StyleColor>?

  • Transition options for backgroundColor.

    Declaration

    Swift

    public var backgroundColorTransition: StyleTransition?

  • Controls the intensity of light emitted on the source features. This property works only with 3D light, i.e. when lights root property is defined.

    Declaration

    Swift

    public var backgroundEmissiveStrength: Value<Double>?

  • Transition options for backgroundEmissiveStrength.

    Declaration

    Swift

    public var backgroundEmissiveStrengthTransition: StyleTransition?

  • The opacity at which the background will be drawn.

    Declaration

    Swift

    public var backgroundOpacity: Value<Double>?

  • Transition options for backgroundOpacity.

    Declaration

    Swift

    public var backgroundOpacityTransition: StyleTransition?

  • Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, …, 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.

    Declaration

    Swift

    public var backgroundPattern: Value<ResolvedImage>?

  • Undocumented

    Declaration

    Swift

    public init(id: String)

  • Declaration

    Swift

    public func encode(to encoder: Encoder) throws

  • Declaration

    Swift

    public init(from decoder: Decoder) throws