diff options
Diffstat (limited to 'platform/darwin/src/MGLBackgroundStyleLayer.h')
-rw-r--r-- | platform/darwin/src/MGLBackgroundStyleLayer.h | 149 |
1 files changed, 0 insertions, 149 deletions
diff --git a/platform/darwin/src/MGLBackgroundStyleLayer.h b/platform/darwin/src/MGLBackgroundStyleLayer.h deleted file mode 100644 index 31755c8bad..0000000000 --- a/platform/darwin/src/MGLBackgroundStyleLayer.h +++ /dev/null @@ -1,149 +0,0 @@ -// This file is generated. -// Edit platform/darwin/scripts/generate-style-code.js, then run `make darwin-style-code`. - -#import "MGLFoundation.h" -#import "MGLStyleLayer.h" - -NS_ASSUME_NONNULL_BEGIN - -/** - 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. - */ -MGL_EXPORT -@interface MGLBackgroundStyleLayer : MGLStyleLayer - -/** -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. - -@param identifier A string that uniquely identifies the source in the style to -which it is added. -*/ -- (instancetype)initWithIdentifier:(NSString *)identifier; - -#pragma mark - Accessing the Paint Attributes - -#if TARGET_OS_IPHONE -/** - The color with which the background will be drawn. - - The default value of this property is an expression that evaluates to - `UIColor.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. - - You can set this property to an expression containing any of the following: - - * Constant `UIColor` values - * Predefined functions, including mathematical and string operators - * Conditional expressions - * Variable assignments and references to assigned variables - * Interpolation and step functions applied to the `$zoomLevel` variable - - This property does not support applying interpolation or step functions to - feature attributes. - */ -@property (nonatomic, null_resettable) NSExpression *backgroundColor; -#else -/** - The color with which the background will be drawn. - - The default value of this property is an expression that evaluates to - `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. - - You can set this property to an expression containing any of the following: - - * Constant `NSColor` values - * Predefined functions, including mathematical and string operators - * Conditional expressions - * Variable assignments and references to assigned variables - * Interpolation and step functions applied to the `$zoomLevel` variable - - This property does not support applying interpolation or step functions to - feature attributes. - */ -@property (nonatomic, null_resettable) NSExpression *backgroundColor; -#endif - -/** - The transition affecting any changes to this layer’s `backgroundColor` property. - - This property corresponds to the `background-color-transition` property in the style JSON file format. -*/ -@property (nonatomic) MGLTransition backgroundColorTransition; - -/** - The opacity at which the background will be drawn. - - The default value of this property is an expression that evaluates to the float - `1`. Set this property to `nil` to reset it to the default value. - - You can set this property to an expression containing any of the following: - - * Constant numeric values between 0 and 1 inclusive - * Predefined functions, including mathematical and string operators - * Conditional expressions - * Variable assignments and references to assigned variables - * Interpolation and step functions applied to the `$zoomLevel` variable - - This property does not support applying interpolation or step functions to - feature attributes. - */ -@property (nonatomic, null_resettable) NSExpression *backgroundOpacity; - -/** - The transition affecting any changes to this layer’s `backgroundOpacity` property. - - This property corresponds to the `background-opacity-transition` property in the style JSON file format. -*/ -@property (nonatomic) MGLTransition backgroundOpacityTransition; - -/** - 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 expression containing any of the following: - - * Constant string values - * Predefined functions, including mathematical and string operators - * Conditional expressions - * Variable assignments and references to assigned variables - * Step functions applied to the `$zoomLevel` variable - - This property does not support applying interpolation functions to the - `$zoomLevel` variable or applying interpolation or step functions to feature - attributes. - */ -@property (nonatomic, null_resettable) NSExpression *backgroundPattern; - -/** - The transition affecting any changes to this layer’s `backgroundPattern` property. - - This property corresponds to the `background-pattern-transition` property in the style JSON file format. -*/ -@property (nonatomic) MGLTransition backgroundPatternTransition; - -@end - -NS_ASSUME_NONNULL_END |