summaryrefslogtreecommitdiff
path: root/platform/darwin/src/MGLBackgroundStyleLayer.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/MGLBackgroundStyleLayer.h
parent938540b9192b55f2cc524db83fe7ff96504ac699 (diff)
downloadqtlocation-mapboxgl-14aeb107f3599d30acc56b223920d96cccf40610.tar.gz
[ios, macos] Document style attribute interdependencies
Diffstat (limited to 'platform/darwin/src/MGLBackgroundStyleLayer.h')
-rw-r--r--platform/darwin/src/MGLBackgroundStyleLayer.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/platform/darwin/src/MGLBackgroundStyleLayer.h b/platform/darwin/src/MGLBackgroundStyleLayer.h
index ecf4f995e9..544354d978 100644
--- a/platform/darwin/src/MGLBackgroundStyleLayer.h
+++ b/platform/darwin/src/MGLBackgroundStyleLayer.h
@@ -12,8 +12,10 @@ NS_ASSUME_NONNULL_BEGIN
/**
The color with which the background will be drawn.
-
+
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 `backgroundPattern` is set to `nil`. Otherwise, it is ignored.
*/
@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> backgroundColor;
@@ -24,7 +26,7 @@ NS_ASSUME_NONNULL_BEGIN
/**
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, null_resettable) id <MGLStyleAttributeValue> backgroundOpacity;