MGLBackgroundStyleLayer

 
@interface MGLBackgroundStyleLayer : MGLStyleLayer

An MGLBackgroundStyleLayer is a style layer that covers the entire map. Use a background style layer to configure a color or pattern to show below all other map content. If the style’s other layers use the Mapbox Streets source, the background style layer is responsible for drawing land, whereas the oceans and other bodies of water are drawn by MGLFillStyleLayer objects.

A background style layer is typically the bottommost layer in a style, because it covers the entire map and can occlude any layers below it. You can therefore access it by getting the last item in the MGLStyle.layers array.

If the background style layer is transparent or omitted from the style, any portion of the map view that does not show another style layer is transparent.

Accessing the Paint Attributes

  • The color with which the background will be drawn.

    The default value of this property is an MGLStyleValue object containing NSColor.blackColor. Set this property to nil to reset it to the default value.

    This property is only applied to the style if backgroundPattern is set to nil. Otherwise, it is ignored.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic, null_resettable)
    MGLStyleValue<NSColor *> *backgroundColor;

    Swift

    var backgroundColor: MGLStyleValue
    View Source on GitHub

  • The opacity at which the background will be drawn.

    The default value of this property is an MGLStyleValue object containing an NSNumber object containing the float 1. Set this property to nil to reset it to the default value.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic, null_resettable)
    MGLStyleValue<NSNumber *> *backgroundOpacity;

    Swift

    var backgroundOpacity: MGLStyleValue
    View Source on GitHub

  • Name of image in style images to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, …, 512).

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic, null_resettable)
    MGLStyleValue<NSString *> *backgroundPattern;

    Swift

    var backgroundPattern: MGLStyleValue
    View Source on GitHub