summaryrefslogtreecommitdiff
path: root/platform/darwin/src/MGLFillStyleLayer.h
diff options
context:
space:
mode:
authorMinh Nguyễn <mxn@1ec5.org>2016-08-18 03:27:38 -0700
committerMinh Nguyễn <mxn@1ec5.org>2016-08-19 14:20:27 -0700
commit14aeb107f3599d30acc56b223920d96cccf40610 (patch)
treebc002936fb446325e039778892106c6c9bd8c783 /platform/darwin/src/MGLFillStyleLayer.h
parent938540b9192b55f2cc524db83fe7ff96504ac699 (diff)
downloadqtlocation-mapboxgl-14aeb107f3599d30acc56b223920d96cccf40610.tar.gz
[ios, macos] Document style attribute interdependencies
Diffstat (limited to 'platform/darwin/src/MGLFillStyleLayer.h')
-rw-r--r--platform/darwin/src/MGLFillStyleLayer.h16
1 files changed, 11 insertions, 5 deletions
diff --git a/platform/darwin/src/MGLFillStyleLayer.h b/platform/darwin/src/MGLFillStyleLayer.h
index f5030a9dc6..26a438af30 100644
--- a/platform/darwin/src/MGLFillStyleLayer.h
+++ b/platform/darwin/src/MGLFillStyleLayer.h
@@ -17,27 +17,31 @@ typedef NS_ENUM(NSUInteger, MGLFillStyleLayerFillTranslateAnchor) {
/**
Whether or not the fill should be antialiased.
-
+
The default value of this property is `YES`. Set this property to `nil` to reset it to the default.
*/
@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 1pt 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, 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 1pt stroke, if it is used.
-
+
The default value of this property is an `NSColor` or `UIColor`object whose RGB value is 0, 0, 0 and whose alpha value is 1. Set this property to `nil` to reset it to the default.
+
+ This property is only applied to the style if `fillPattern` is set to `nil`. Otherwise, it is ignored.
*/
@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> fillColor;
/**
The outline color of the fill. Matches the value of `fillColor` if unspecified.
+
+ This property is only applied to the style if `fillPattern` is set to `nil`, and `fillAntialias` is set to `YES`. Otherwise, it is ignored.
*/
@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> fillOutlineColor;
@@ -45,15 +49,17 @@ typedef NS_ENUM(NSUInteger, MGLFillStyleLayerFillTranslateAnchor) {
The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
This property is measured in points.
-
+
The default value of this property is 0 points from the left and 0 points from the top. Set this property to `nil` to reset it to the default.
*/
@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 `MGLFillStyleLayerFillTranslateAnchorMap`. Set this property to `nil` to reset it to the default.
+
+ This property is only applied to the style if `fillTranslate` is non-`nil`. Otherwise, it is ignored.
*/
@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> fillTranslateAnchor;