summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMinh Nguyễn <mxn@1ec5.org>2016-08-18 00:36:02 -0700
committerMinh Nguyễn <mxn@1ec5.org>2016-08-19 14:20:26 -0700
commit99fc6dfce810b5894b9039c5aabb4fbfd5af0751 (patch)
tree28f312b021590106e1678213ec0ab10bf06c462f
parenta4fcea412239f6936ab0dd0d21abda912e22bd47 (diff)
downloadqtlocation-mapboxgl-99fc6dfce810b5894b9039c5aabb4fbfd5af0751.tar.gz
[ios, macos] Audited generated source/layer headers
Properties representing optional attributes are qualified with null_resettable. The default value is documented.
-rw-r--r--platform/darwin/src/MGLBackgroundStyleLayer.h14
-rw-r--r--platform/darwin/src/MGLBaseStyleLayer.h6
-rw-r--r--platform/darwin/src/MGLCircleStyleLayer.h32
-rw-r--r--platform/darwin/src/MGLFillStyleLayer.h28
-rw-r--r--platform/darwin/src/MGLLineStyleLayer.h56
-rw-r--r--platform/darwin/src/MGLRasterStyleLayer.h32
-rw-r--r--platform/darwin/src/MGLStyleLayer.h.ejs16
-rw-r--r--platform/darwin/src/MGLSymbolStyleLayer.h192
8 files changed, 286 insertions, 90 deletions
diff --git a/platform/darwin/src/MGLBackgroundStyleLayer.h b/platform/darwin/src/MGLBackgroundStyleLayer.h
index 8fa9abddec..3412cde971 100644
--- a/platform/darwin/src/MGLBackgroundStyleLayer.h
+++ b/platform/darwin/src/MGLBackgroundStyleLayer.h
@@ -4,23 +4,31 @@
#import "MGLStyleAttributeValue.h"
#import "MGLBaseStyleLayer.h"
+NS_ASSUME_NONNULL_BEGIN
+
@interface MGLBackgroundStyleLayer : MGLBaseStyleLayer <MGLStyleLayer>
#pragma mark - Accessing the Paint Attributes
/**
The color with which the background will be drawn.
+
+ The default value of this property is `#000000`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> backgroundColor;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> backgroundColor;
/**
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).
*/
-@property (nonatomic) id <MGLStyleAttributeValue> backgroundPattern;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> backgroundPattern;
/**
The opacity at which the background will be drawn.
+
+ The default value of this property is `1`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> backgroundOpacity;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> backgroundOpacity;
@end
+
+NS_ASSUME_NONNULL_END
diff --git a/platform/darwin/src/MGLBaseStyleLayer.h b/platform/darwin/src/MGLBaseStyleLayer.h
index d7d4e70a51..e561af5c68 100644
--- a/platform/darwin/src/MGLBaseStyleLayer.h
+++ b/platform/darwin/src/MGLBaseStyleLayer.h
@@ -1,5 +1,9 @@
#import <Foundation/Foundation.h>
+#import "MGLTypes.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
@interface MGLBaseStyleLayer : NSObject
@property (nonatomic, assign, getter=isVisible) BOOL visible;
@@ -15,3 +19,5 @@
@property (nonatomic, assign) float minimumZoomLevel;
@end
+
+NS_ASSUME_NONNULL_END
diff --git a/platform/darwin/src/MGLCircleStyleLayer.h b/platform/darwin/src/MGLCircleStyleLayer.h
index c5a344d419..2503595fd1 100644
--- a/platform/darwin/src/MGLCircleStyleLayer.h
+++ b/platform/darwin/src/MGLCircleStyleLayer.h
@@ -4,6 +4,8 @@
#import "MGLStyleAttributeValue.h"
#import "MGLBaseStyleLayer.h"
+NS_ASSUME_NONNULL_BEGIN
+
typedef NS_ENUM(NSUInteger, MGLCircleStyleLayerCircleTranslateAnchor) {
MGLCircleStyleLayerCircleTranslateAnchorMap,
MGLCircleStyleLayerCircleTranslateAnchorViewport,
@@ -20,37 +22,53 @@ typedef NS_ENUM(NSUInteger, MGLCircleStyleLayerCirclePitchScale) {
/**
Circle radius.
+
+ The default value of this property is `5`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> circleRadius;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> circleRadius;
/**
The color of the circle.
+
+ The default value of this property is `#000000`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> circleColor;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> circleColor;
/**
Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.
+
+ The default value of this property is `0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> circleBlur;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> circleBlur;
/**
The opacity at which the circle will be drawn.
+
+ The default value of this property is `1`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> circleOpacity;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> circleOpacity;
/**
The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
+
+ The default value of this property is `0,0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> circleTranslate;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> circleTranslate;
/**
Control whether the translation is relative to the map (north) or viewport (screen)
+
+ The default value of this property is `map`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> circleTranslateAnchor;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> circleTranslateAnchor;
/**
Controls the scaling behavior of the circle when the map is pitched. The value `map` scales circles according to their apparent distance to the camera. The value `viewport` results in no pitch-related scaling.
+
+ The default value of this property is `map`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> circlePitchScale;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> circlePitchScale;
@end
+
+NS_ASSUME_NONNULL_END
diff --git a/platform/darwin/src/MGLFillStyleLayer.h b/platform/darwin/src/MGLFillStyleLayer.h
index c3e6d63d1e..e5b0e7ffe0 100644
--- a/platform/darwin/src/MGLFillStyleLayer.h
+++ b/platform/darwin/src/MGLFillStyleLayer.h
@@ -4,6 +4,8 @@
#import "MGLStyleAttributeValue.h"
#import "MGLBaseStyleLayer.h"
+NS_ASSUME_NONNULL_BEGIN
+
typedef NS_ENUM(NSUInteger, MGLFillStyleLayerFillTranslateAnchor) {
MGLFillStyleLayerFillTranslateAnchorMap,
MGLFillStyleLayerFillTranslateAnchorViewport,
@@ -15,37 +17,49 @@ typedef NS_ENUM(NSUInteger, MGLFillStyleLayerFillTranslateAnchor) {
/**
Whether or not the fill should be antialiased.
+
+ The default value of this property is `true`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> fillAntialias;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> fillAntialias;
/**
The opacity of the entire fill layer. In contrast to the fill-color, this value will also affect the 1px stroke around the fill, if the stroke is used.
+
+ The default value of this property is `1`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> fillOpacity;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> fillOpacity;
/**
The color of the filled part of this layer. This color can be specified as rgba with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used.
+
+ The default value of this property is `#000000`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> fillColor;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> fillColor;
/**
The outline color of the fill. Matches the value of `fillColor` if unspecified.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> fillOutlineColor;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> fillOutlineColor;
/**
The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
+
+ The default value of this property is `0,0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> fillTranslate;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> fillTranslate;
/**
Control whether the translation is relative to the map (north) or viewport (screen)
+
+ The default value of this property is `map`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> fillTranslateAnchor;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> fillTranslateAnchor;
/**
Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512).
*/
-@property (nonatomic) id <MGLStyleAttributeValue> fillPattern;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> fillPattern;
@end
+
+NS_ASSUME_NONNULL_END
diff --git a/platform/darwin/src/MGLLineStyleLayer.h b/platform/darwin/src/MGLLineStyleLayer.h
index 812e759ebc..b772fcc778 100644
--- a/platform/darwin/src/MGLLineStyleLayer.h
+++ b/platform/darwin/src/MGLLineStyleLayer.h
@@ -4,6 +4,8 @@
#import "MGLStyleAttributeValue.h"
#import "MGLBaseStyleLayer.h"
+NS_ASSUME_NONNULL_BEGIN
+
typedef NS_ENUM(NSUInteger, MGLLineStyleLayerLineCap) {
MGLLineStyleLayerLineCapButt,
MGLLineStyleLayerLineCapRound,
@@ -27,74 +29,100 @@ typedef NS_ENUM(NSUInteger, MGLLineStyleLayerLineTranslateAnchor) {
/**
The display of line endings.
+
+ The default value of this property is `butt`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> lineCap;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> lineCap;
/**
The display of lines when joining.
+
+ The default value of this property is `miter`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> lineJoin;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> lineJoin;
/**
Used to automatically convert miter joins to bevel joins for sharp angles.
+
+ The default value of this property is `2`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> lineMiterLimit;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> lineMiterLimit;
/**
Used to automatically convert round joins to miter joins for shallow angles.
+
+ The default value of this property is `1.05`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> lineRoundLimit;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> lineRoundLimit;
#pragma mark - Accessing the Paint Attributes
/**
The opacity at which the line will be drawn.
+
+ The default value of this property is `1`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> lineOpacity;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> lineOpacity;
/**
The color with which the line will be drawn.
+
+ The default value of this property is `#000000`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> lineColor;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> lineColor;
/**
The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
+
+ The default value of this property is `0,0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> lineTranslate;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> lineTranslate;
/**
Control whether the translation is relative to the map (north) or viewport (screen)
+
+ The default value of this property is `map`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> lineTranslateAnchor;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> lineTranslateAnchor;
/**
Stroke thickness.
+
+ The default value of this property is `1`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> lineWidth;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> lineWidth;
/**
Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.
+
+ The default value of this property is `0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> lineGapWidth;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> lineGapWidth;
/**
The line's offset perpendicular to its direction. Values may be positive or negative, where positive indicates "rightwards" (if you were moving in the direction of the line) and negative indicates "leftwards."
+
+ The default value of this property is `0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> lineOffset;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> lineOffset;
/**
Blur applied to the line, in pixels.
+
+ The default value of this property is `0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> lineBlur;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> lineBlur;
/**
Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to pixels, multiply the length by the current line width.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> lineDasharray;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> lineDasharray;
/**
Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, ..., 512).
*/
-@property (nonatomic) id <MGLStyleAttributeValue> linePattern;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> linePattern;
@end
+
+NS_ASSUME_NONNULL_END
diff --git a/platform/darwin/src/MGLRasterStyleLayer.h b/platform/darwin/src/MGLRasterStyleLayer.h
index b9deed8ff4..7304130384 100644
--- a/platform/darwin/src/MGLRasterStyleLayer.h
+++ b/platform/darwin/src/MGLRasterStyleLayer.h
@@ -4,43 +4,61 @@
#import "MGLStyleAttributeValue.h"
#import "MGLBaseStyleLayer.h"
+NS_ASSUME_NONNULL_BEGIN
+
@interface MGLRasterStyleLayer : MGLBaseStyleLayer <MGLStyleLayer>
#pragma mark - Accessing the Paint Attributes
/**
The opacity at which the image will be drawn.
+
+ The default value of this property is `1`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> rasterOpacity;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> rasterOpacity;
/**
Rotates hues around the color wheel.
+
+ The default value of this property is `0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> rasterHueRotate;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> rasterHueRotate;
/**
Increase or reduce the brightness of the image. The value is the minimum brightness.
+
+ The default value of this property is `0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> rasterBrightnessMin;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> rasterBrightnessMin;
/**
Increase or reduce the brightness of the image. The value is the maximum brightness.
+
+ The default value of this property is `1`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> rasterBrightnessMax;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> rasterBrightnessMax;
/**
Increase or reduce the saturation of the image.
+
+ The default value of this property is `0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> rasterSaturation;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> rasterSaturation;
/**
Increase or reduce the contrast of the image.
+
+ The default value of this property is `0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> rasterContrast;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> rasterContrast;
/**
Fade duration when a new tile is added.
+
+ The default value of this property is `300`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> rasterFadeDuration;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> rasterFadeDuration;
@end
+
+NS_ASSUME_NONNULL_END
diff --git a/platform/darwin/src/MGLStyleLayer.h.ejs b/platform/darwin/src/MGLStyleLayer.h.ejs
index bf6721e41f..a11ad573d2 100644
--- a/platform/darwin/src/MGLStyleLayer.h.ejs
+++ b/platform/darwin/src/MGLStyleLayer.h.ejs
@@ -9,6 +9,8 @@
#import "MGLStyleAttributeValue.h"
#import "MGLBaseStyleLayer.h"
+NS_ASSUME_NONNULL_BEGIN
+
<% for (const property of layoutProperties) { -%>
<% if (property.type == "enum") { -%>
typedef NS_ENUM(NSUInteger, MGL<%- camelize(type) %>StyleLayer<%- camelize(property.name) %>) {
@@ -36,9 +38,11 @@ typedef NS_ENUM(NSUInteger, MGL<%- camelize(type) %>StyleLayer<%- camelize(prope
<% for (const property of layoutProperties) { -%>
/**
- <%- propertyDoc(property, type) %>
+ <%- propertyDoc(property, type) %><% if ('default' in property) { %>
+
+ The default value of this property is `<%= property.default %>`.<% if (!property.required) { %> Set this property to `nil` to reset it to the default.<% } %><% } %>
*/
-@property (nonatomic) <%- propertyType(property, false, type) %> <%- camelizeWithLeadingLowercase(property.name) %>;
+@property (nonatomic<% if (!property.required) { %>, null_resettable<% } %>) <%- propertyType(property, false, type) %> <%- camelizeWithLeadingLowercase(property.name) %>;
<% } -%>
<% } -%>
@@ -46,9 +50,13 @@ typedef NS_ENUM(NSUInteger, MGL<%- camelize(type) %>StyleLayer<%- camelize(prope
<% for (const property of paintProperties) { -%>
/**
- <%- propertyDoc(property, type) %>
+ <%- propertyDoc(property, type) %><% if ('default' in property) { %>
+
+ The default value of this property is `<%= property.default %>`.<% if (!property.required) { %> Set this property to `nil` to reset it to the default.<% } %><% } %>
*/
-@property (nonatomic) <%- propertyType(property, false, type) %> <%- camelizeWithLeadingLowercase(property.name) %>;
+@property (nonatomic<% if (!property.required) { %>, null_resettable<% } %>) <%- propertyType(property, false, type) %> <%- camelizeWithLeadingLowercase(property.name) %>;
<% } -%>
@end
+
+NS_ASSUME_NONNULL_END
diff --git a/platform/darwin/src/MGLSymbolStyleLayer.h b/platform/darwin/src/MGLSymbolStyleLayer.h
index a4d6c2b5b0..28a96b6bd3 100644
--- a/platform/darwin/src/MGLSymbolStyleLayer.h
+++ b/platform/darwin/src/MGLSymbolStyleLayer.h
@@ -4,6 +4,8 @@
#import "MGLStyleAttributeValue.h"
#import "MGLBaseStyleLayer.h"
+NS_ASSUME_NONNULL_BEGIN
+
typedef NS_ENUM(NSUInteger, MGLSymbolStyleLayerSymbolPlacement) {
MGLSymbolStyleLayerSymbolPlacementPoint,
MGLSymbolStyleLayerSymbolPlacementLine,
@@ -71,244 +73,338 @@ typedef NS_ENUM(NSUInteger, MGLSymbolStyleLayerTextTranslateAnchor) {
/**
Label placement relative to its geometry. `line` can only be used on LineStrings and Polygons.
+
+ The default value of this property is `point`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> symbolPlacement;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> symbolPlacement;
/**
Distance between two symbol anchors.
+
+ The default value of this property is `250`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> symbolSpacing;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> symbolSpacing;
/**
If true, the symbols will not cross tile edges to avoid mutual collisions. Recommended in layers that don't have enough padding in the vector tile to prevent collisions, or if it is a point symbol layer placed after a line symbol layer.
+
+ The default value of this property is `false`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> symbolAvoidEdges;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> symbolAvoidEdges;
/**
If true, the icon will be visible even if it collides with other previously drawn symbols.
+
+ The default value of this property is `false`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> iconAllowOverlap;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> iconAllowOverlap;
/**
If true, other symbols can be visible even if they collide with the icon.
+
+ The default value of this property is `false`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> iconIgnorePlacement;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> iconIgnorePlacement;
/**
If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.
+
+ The default value of this property is `false`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> iconOptional;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> iconOptional;
/**
Orientation of icon when map is rotated.
+
+ The default value of this property is `viewport`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> iconRotationAlignment;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> iconRotationAlignment;
/**
Scale factor for icon. 1 is original size, 3 triples the size.
+
+ The default value of this property is `1`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> iconSize;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> iconSize;
/**
Position and scale an icon by the its corresponding text.
+
+ The default value of this property is `none`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> iconTextFit;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> iconTextFit;
/**
Size of padding area around the text-fit size in clockwise order: top, right, bottom, left.
+
+ The default value of this property is `0,0,0,0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> iconTextFitPadding;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> iconTextFitPadding;
/**
A string with {tokens} replaced, referencing the data property to pull from.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> iconImage;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> iconImage;
/**
Rotates the icon clockwise.
+
+ The default value of this property is `0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> iconRotate;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> iconRotate;
/**
Size of the additional area around the icon bounding box used for detecting symbol collisions.
+
+ The default value of this property is `2`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> iconPadding;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> iconPadding;
/**
If true, the icon may be flipped to prevent it from being rendered upside-down.
+
+ The default value of this property is `false`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> iconKeepUpright;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> iconKeepUpright;
/**
Offset distance of icon from its anchor. Positive values indicate right and down, while negative values indicate left and up.
+
+ The default value of this property is `0,0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> iconOffset;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> iconOffset;
/**
Aligns text to the plane of the `viewport` or the `map` when the map is pitched. Matches `textRotationAlignment` if unspecified.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textPitchAlignment;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textPitchAlignment;
/**
Orientation of text when map is rotated.
+
+ The default value of this property is `viewport`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textRotationAlignment;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textRotationAlignment;
/**
Value to use for a text label. Feature properties are specified using tokens like {field_name}.
+
+ The default value of this property is ``. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textField;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textField;
/**
Font stack to use for displaying text.
+
+ The default value of this property is `Open Sans Regular,Arial Unicode MS Regular`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textFont;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textFont;
/**
Font size.
+
+ The default value of this property is `16`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textSize;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textSize;
/**
The maximum line width for text wrapping.
+
+ The default value of this property is `10`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textMaxWidth;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textMaxWidth;
/**
Text leading value for multi-line text.
+
+ The default value of this property is `1.2`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textLineHeight;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textLineHeight;
/**
Text tracking amount.
+
+ The default value of this property is `0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textLetterSpacing;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textLetterSpacing;
/**
Text justification options.
+
+ The default value of this property is `center`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textJustify;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textJustify;
/**
Part of the text placed closest to the anchor.
+
+ The default value of this property is `center`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textAnchor;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textAnchor;
/**
Maximum angle change between adjacent characters.
+
+ The default value of this property is `45`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textMaxAngle;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textMaxAngle;
/**
Rotates the text clockwise.
+
+ The default value of this property is `0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textRotate;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textRotate;
/**
Size of the additional area around the text bounding box used for detecting symbol collisions.
+
+ The default value of this property is `2`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textPadding;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textPadding;
/**
If true, the text may be flipped vertically to prevent it from being rendered upside-down.
+
+ The default value of this property is `true`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textKeepUpright;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textKeepUpright;
/**
Specifies how to capitalize text, similar to the CSS `text-transform` property.
+
+ The default value of this property is `none`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textTransform;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textTransform;
/**
Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up.
+
+ The default value of this property is `0,0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textOffset;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textOffset;
/**
If true, the text will be visible even if it collides with other previously drawn symbols.
+
+ The default value of this property is `false`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textAllowOverlap;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textAllowOverlap;
/**
If true, other symbols can be visible even if they collide with the text.
+
+ The default value of this property is `false`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textIgnorePlacement;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textIgnorePlacement;
/**
If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.
+
+ The default value of this property is `false`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textOptional;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textOptional;
#pragma mark - Accessing the Paint Attributes
/**
The opacity at which the icon will be drawn.
+
+ The default value of this property is `1`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> iconOpacity;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> iconOpacity;
/**
The color of the icon. This can only be used with sdf icons.
+
+ The default value of this property is `#000000`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> iconColor;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> iconColor;
/**
The color of the icon's halo. Icon halos can only be used with sdf icons.
+
+ The default value of this property is `rgba(0, 0, 0, 0)`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> iconHaloColor;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> iconHaloColor;
/**
Distance of halo to the icon outline.
+
+ The default value of this property is `0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> iconHaloWidth;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> iconHaloWidth;
/**
Fade out the halo towards the outside.
+
+ The default value of this property is `0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> iconHaloBlur;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> iconHaloBlur;
/**
Distance that the icon's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.
+
+ The default value of this property is `0,0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> iconTranslate;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> iconTranslate;
/**
Control whether the translation is relative to the map (north) or viewport (screen).
+
+ The default value of this property is `map`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> iconTranslateAnchor;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> iconTranslateAnchor;
/**
The opacity at which the text will be drawn.
+
+ The default value of this property is `1`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textOpacity;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textOpacity;
/**
The color with which the text will be drawn.
+
+ The default value of this property is `#000000`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textColor;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textColor;
/**
The color of the text's halo, which helps it stand out from backgrounds.
+
+ The default value of this property is `rgba(0, 0, 0, 0)`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textHaloColor;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textHaloColor;
/**
Distance of halo to the font outline. Max text halo width is 1/4 of the font-size.
+
+ The default value of this property is `0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textHaloWidth;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textHaloWidth;
/**
The halo's fadeout distance towards the outside.
+
+ The default value of this property is `0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textHaloBlur;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textHaloBlur;
/**
Distance that the text's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.
+
+ The default value of this property is `0,0`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textTranslate;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textTranslate;
/**
Control whether the translation is relative to the map (north) or viewport (screen).
+
+ The default value of this property is `map`. Set this property to `nil` to reset it to the default.
*/
-@property (nonatomic) id <MGLStyleAttributeValue> textTranslateAnchor;
+@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> textTranslateAnchor;
@end
+
+NS_ASSUME_NONNULL_END