summaryrefslogtreecommitdiff
path: root/platform/darwin/src/MGLCircleStyleLayer.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/MGLCircleStyleLayer.h
parent938540b9192b55f2cc524db83fe7ff96504ac699 (diff)
downloadqtlocation-mapboxgl-14aeb107f3599d30acc56b223920d96cccf40610.tar.gz
[ios, macos] Document style attribute interdependencies
Diffstat (limited to 'platform/darwin/src/MGLCircleStyleLayer.h')
-rw-r--r--platform/darwin/src/MGLCircleStyleLayer.h16
1 files changed, 9 insertions, 7 deletions
diff --git a/platform/darwin/src/MGLCircleStyleLayer.h b/platform/darwin/src/MGLCircleStyleLayer.h
index a7391c43dc..af3ab3da6d 100644
--- a/platform/darwin/src/MGLCircleStyleLayer.h
+++ b/platform/darwin/src/MGLCircleStyleLayer.h
@@ -24,28 +24,28 @@ typedef NS_ENUM(NSUInteger, MGLCircleStyleLayerCirclePitchScale) {
Circle radius.
This property is measured in points.
-
+
The default value of this property is `5`. Set this property to `nil` to reset it to the default.
*/
@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> circleRadius;
/**
The color of the circle.
-
+
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.
*/
@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, 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, null_resettable) id <MGLStyleAttributeValue> circleOpacity;
@@ -54,21 +54,23 @@ typedef NS_ENUM(NSUInteger, MGLCircleStyleLayerCirclePitchScale) {
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> circleTranslate;
/**
Control whether the translation is relative to the map (north) or viewport (screen)
-
+
The default value of this property is `MGLCircleStyleLayerCircleTranslateAnchorMap`. Set this property to `nil` to reset it to the default.
+
+ This property is only applied to the style if `circleTranslate` is non-`nil`. Otherwise, it is ignored.
*/
@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> circleTranslateAnchor;
/**
Controls the scaling behavior of the circle when the map is pitched. The value `MGLCircleStyleLayerCirclePitchScaleMap` scales circles according to their apparent distance to the camera. The value `MGLCircleStyleLayerCirclePitchScaleViewport` results in no pitch-related scaling.
-
+
The default value of this property is `MGLCircleStyleLayerCirclePitchScaleMap`. Set this property to `nil` to reset it to the default.
*/
@property (nonatomic, null_resettable) id <MGLStyleAttributeValue> circlePitchScale;