Install in Dash
MGLBackgroundStyleLayer Class Reference
MGLBackgroundStyleLayer
@interface MGLBackgroundStyleLayer : MGLStyleLayerAn 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.
-
Returns a background style layer initialized with an identifier.
After initializing and configuring the style layer, add it to a map view’s style using the
-[MGLStyle addLayer:]or-[MGLStyle insertLayer:belowLayer:]method.Declaration
Objective-C
- (nonnull instancetype)initWithIdentifier:(nonnull NSString *)identifier;Swift
init(identifier: String)Parameters
identifierA string that uniquely identifies the source in the style to which it is added.
View Source on GitHub
-
The color with which the background will be drawn.
The default value of this property is an
MGLStyleValueobject containingNSColor.blackColor. Set this property tonilto reset it to the default value.This property is only applied to the style if
backgroundPatternis set tonil. Otherwise, it is ignored.You can set this property to an instance of:
MGLConstantStyleValueMGLCameraStyleFunctionwith an interpolation mode of:MGLInterpolationModeExponentialMGLInterpolationModeInterval
Declaration
Objective-C
@property (assign, readwrite, nonatomic, null_resettable) MGLStyleValue<NSColor *> *backgroundColor;Swift
var backgroundColor: MGLStyleValue -
The transition affecting any changes to this layer’s
backgroundColorproperty.This property corresponds to the
background-color-transitionproperty in the style JSON file format.Declaration
Objective-C
@property (assign, readwrite, nonatomic) MGLTransition backgroundColorTransition;Swift
var backgroundColorTransition: MGLTransition { get set } -
The opacity at which the background will be drawn.
The default value of this property is an
MGLStyleValueobject containing anNSNumberobject containing the float1. Set this property tonilto reset it to the default value.You can set this property to an instance of:
MGLConstantStyleValueMGLCameraStyleFunctionwith an interpolation mode of:MGLInterpolationModeExponentialMGLInterpolationModeInterval
Declaration
Objective-C
@property (assign, readwrite, nonatomic, null_resettable) MGLStyleValue<NSNumber *> *backgroundOpacity;Swift
var backgroundOpacity: MGLStyleValue -
The transition affecting any changes to this layer’s
backgroundOpacityproperty.This property corresponds to the
background-opacity-transitionproperty in the style JSON file format.Declaration
Objective-C
@property (assign, readwrite, nonatomic) MGLTransition backgroundOpacityTransition;Swift
var backgroundOpacityTransition: MGLTransition { get set } -
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).
You can set this property to an instance of:
MGLConstantStyleValueMGLCameraStyleFunctionwith an interpolation mode ofMGLInterpolationModeInterval
Declaration
Objective-C
@property (assign, readwrite, nonatomic, null_resettable) MGLStyleValue<NSString *> *backgroundPattern;Swift
var backgroundPattern: MGLStyleValue -
The transition affecting any changes to this layer’s
backgroundPatternproperty.This property corresponds to the
background-pattern-transitionproperty in the style JSON file format.Declaration
Objective-C
@property (assign, readwrite, nonatomic) MGLTransition backgroundPatternTransition;Swift
var backgroundPatternTransition: MGLTransition { get set }