summaryrefslogtreecommitdiff
path: root/platform/darwin/src/MGLCircleStyleLayer.h
diff options
context:
space:
mode:
authorJason Wray <jason@mapbox.com>2017-02-08 18:00:23 -0500
committerJesse Bounds <jesse@rebounds.net>2017-02-08 21:11:43 -0800
commit0e803186272f9febc84ea9c9e0fdc1b44d637d03 (patch)
tree26fb8dd14416319b3c5cde11c465d23aad6ead42 /platform/darwin/src/MGLCircleStyleLayer.h
parenta383edaae8ec05a3b385b19576c7a9358672662b (diff)
downloadqtlocation-mapboxgl-0e803186272f9febc84ea9c9e0fdc1b44d637d03.tar.gz
[ios, macos] Add more bullets to style property docs
Diffstat (limited to 'platform/darwin/src/MGLCircleStyleLayer.h')
-rw-r--r--platform/darwin/src/MGLCircleStyleLayer.h228
1 files changed, 133 insertions, 95 deletions
diff --git a/platform/darwin/src/MGLCircleStyleLayer.h b/platform/darwin/src/MGLCircleStyleLayer.h
index f6cb05e110..c59f1e0e2d 100644
--- a/platform/darwin/src/MGLCircleStyleLayer.h
+++ b/platform/darwin/src/MGLCircleStyleLayer.h
@@ -8,7 +8,7 @@
NS_ASSUME_NONNULL_BEGIN
/**
- Controls the scaling behavior of the circle when the map is pitched.`
+ Controls the scaling behavior of the circle when the map is pitched.
This property can be set to one of the following values:
@@ -21,7 +21,7 @@ NS_ASSUME_NONNULL_BEGIN
*/
typedef NS_ENUM(NSUInteger, MGLCircleScaleAlignment) {
/**
- Circles are scaled according to their apparent distance to the camera.`
+ Circles are scaled according to their apparent distance to the camera.
This property can be set to one of the following values:
@@ -31,7 +31,7 @@ typedef NS_ENUM(NSUInteger, MGLCircleScaleAlignment) {
*/
MGLCircleScaleAlignmentMap,
/**
- Circles are not scaled.`
+ Circles are not scaled.
This property can be set to one of the following values:
@@ -43,7 +43,7 @@ typedef NS_ENUM(NSUInteger, MGLCircleScaleAlignment) {
};
/**
- Controls the translation reference point.`
+ Controls the translation reference point.
This property can be set to one of the following values:
@@ -56,7 +56,7 @@ typedef NS_ENUM(NSUInteger, MGLCircleScaleAlignment) {
*/
typedef NS_ENUM(NSUInteger, MGLCircleTranslationAnchor) {
/**
- The circle is translated relative to the map.`
+ The circle is translated relative to the map.
This property can be set to one of the following values:
@@ -66,7 +66,7 @@ typedef NS_ENUM(NSUInteger, MGLCircleTranslationAnchor) {
*/
MGLCircleTranslationAnchorMap,
/**
- The circle is translated relative to the viewport.`
+ The circle is translated relative to the viewport.
This property can be set to one of the following values:
@@ -123,19 +123,23 @@ MGL_EXPORT
The default value of this property is an `MGLStyleValue` object containing an
`NSNumber` object containing the float `0`. Set this property to `nil` to reset
- it to the default value.`
+ it to the default value.
This property can be set to one of the following values:
- `MGLStyleConstantValue`
- - `MGLCameraStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential` or `MGLInterpolationModeInterval`
- - `MGLSourceStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval`,
- `MGLInterpolationModeCategorical`, or `MGLInterpolationModeIdentity`
- - `MGLCompositeStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval` or
- `MGLInterpolationModeCategorical`
+ - `MGLCameraStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLSourceStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLInterpolationModeCategorical`
+ - `MGLInterpolationModeIdentity`
+ - `MGLCompositeStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLInterpolationModeCategorical`
*/
@property (nonatomic, null_resettable) MGLStyleValue<NSNumber *> *circleBlur;
@@ -145,19 +149,23 @@ MGL_EXPORT
The default value of this property is an `MGLStyleValue` object containing
`UIColor.blackColor`. Set this property to `nil` to reset it to the default
- value.`
+ value.
This property can be set to one of the following values:
- `MGLStyleConstantValue`
- - `MGLCameraStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential` or `MGLInterpolationModeInterval`
- - `MGLSourceStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval`,
- `MGLInterpolationModeCategorical`, or `MGLInterpolationModeIdentity`
- - `MGLCompositeStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval` or
- `MGLInterpolationModeCategorical`
+ - `MGLCameraStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLSourceStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLInterpolationModeCategorical`
+ - `MGLInterpolationModeIdentity`
+ - `MGLCompositeStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLInterpolationModeCategorical`
*/
@property (nonatomic, null_resettable) MGLStyleValue<UIColor *> *circleColor;
#else
@@ -166,19 +174,23 @@ MGL_EXPORT
The default value of this property is an `MGLStyleValue` object containing
`NSColor.blackColor`. Set this property to `nil` to reset it to the default
- value.`
+ value.
This property can be set to one of the following values:
- `MGLStyleConstantValue`
- - `MGLCameraStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential` or `MGLInterpolationModeInterval`
- - `MGLSourceStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval`,
- `MGLInterpolationModeCategorical`, or `MGLInterpolationModeIdentity`
- - `MGLCompositeStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval` or
- `MGLInterpolationModeCategorical`
+ - `MGLCameraStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLSourceStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLInterpolationModeCategorical`
+ - `MGLInterpolationModeIdentity`
+ - `MGLCompositeStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLInterpolationModeCategorical`
*/
@property (nonatomic, null_resettable) MGLStyleValue<NSColor *> *circleColor;
#endif
@@ -188,19 +200,23 @@ MGL_EXPORT
The default value of this property is an `MGLStyleValue` object containing an
`NSNumber` object containing the float `1`. Set this property to `nil` to reset
- it to the default value.`
+ it to the default value.
This property can be set to one of the following values:
- `MGLStyleConstantValue`
- - `MGLCameraStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential` or `MGLInterpolationModeInterval`
- - `MGLSourceStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval`,
- `MGLInterpolationModeCategorical`, or `MGLInterpolationModeIdentity`
- - `MGLCompositeStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval` or
- `MGLInterpolationModeCategorical`
+ - `MGLCameraStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLSourceStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLInterpolationModeCategorical`
+ - `MGLInterpolationModeIdentity`
+ - `MGLCompositeStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLInterpolationModeCategorical`
*/
@property (nonatomic, null_resettable) MGLStyleValue<NSNumber *> *circleOpacity;
@@ -211,19 +227,23 @@ MGL_EXPORT
The default value of this property is an `MGLStyleValue` object containing an
`NSNumber` object containing the float `5`. Set this property to `nil` to reset
- it to the default value.`
+ it to the default value.
This property can be set to one of the following values:
- `MGLStyleConstantValue`
- - `MGLCameraStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential` or `MGLInterpolationModeInterval`
- - `MGLSourceStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval`,
- `MGLInterpolationModeCategorical`, or `MGLInterpolationModeIdentity`
- - `MGLCompositeStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval` or
- `MGLInterpolationModeCategorical`
+ - `MGLCameraStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLSourceStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLInterpolationModeCategorical`
+ - `MGLInterpolationModeIdentity`
+ - `MGLCompositeStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLInterpolationModeCategorical`
*/
@property (nonatomic, null_resettable) MGLStyleValue<NSNumber *> *circleRadius;
@@ -236,7 +256,7 @@ MGL_EXPORT
This attribute corresponds to the <a
href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-circle-pitch-scale"><code>circle-pitch-scale</code></a>
- layout property in the Mapbox Style Specification.`
+ layout property in the Mapbox Style Specification.
This property can be set to one of the following values:
@@ -254,19 +274,23 @@ MGL_EXPORT
The default value of this property is an `MGLStyleValue` object containing
`UIColor.blackColor`. Set this property to `nil` to reset it to the default
- value.`
+ value.
This property can be set to one of the following values:
- `MGLStyleConstantValue`
- - `MGLCameraStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential` or `MGLInterpolationModeInterval`
- - `MGLSourceStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval`,
- `MGLInterpolationModeCategorical`, or `MGLInterpolationModeIdentity`
- - `MGLCompositeStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval` or
- `MGLInterpolationModeCategorical`
+ - `MGLCameraStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLSourceStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLInterpolationModeCategorical`
+ - `MGLInterpolationModeIdentity`
+ - `MGLCompositeStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLInterpolationModeCategorical`
*/
@property (nonatomic, null_resettable) MGLStyleValue<UIColor *> *circleStrokeColor;
#else
@@ -275,19 +299,23 @@ MGL_EXPORT
The default value of this property is an `MGLStyleValue` object containing
`NSColor.blackColor`. Set this property to `nil` to reset it to the default
- value.`
+ value.
This property can be set to one of the following values:
- `MGLStyleConstantValue`
- - `MGLCameraStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential` or `MGLInterpolationModeInterval`
- - `MGLSourceStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval`,
- `MGLInterpolationModeCategorical`, or `MGLInterpolationModeIdentity`
- - `MGLCompositeStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval` or
- `MGLInterpolationModeCategorical`
+ - `MGLCameraStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLSourceStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLInterpolationModeCategorical`
+ - `MGLInterpolationModeIdentity`
+ - `MGLCompositeStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLInterpolationModeCategorical`
*/
@property (nonatomic, null_resettable) MGLStyleValue<NSColor *> *circleStrokeColor;
#endif
@@ -297,19 +325,23 @@ MGL_EXPORT
The default value of this property is an `MGLStyleValue` object containing an
`NSNumber` object containing the float `1`. Set this property to `nil` to reset
- it to the default value.`
+ it to the default value.
This property can be set to one of the following values:
- `MGLStyleConstantValue`
- - `MGLCameraStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential` or `MGLInterpolationModeInterval`
- - `MGLSourceStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval`,
- `MGLInterpolationModeCategorical`, or `MGLInterpolationModeIdentity`
- - `MGLCompositeStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval` or
- `MGLInterpolationModeCategorical`
+ - `MGLCameraStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLSourceStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLInterpolationModeCategorical`
+ - `MGLInterpolationModeIdentity`
+ - `MGLCompositeStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLInterpolationModeCategorical`
*/
@property (nonatomic, null_resettable) MGLStyleValue<NSNumber *> *circleStrokeOpacity;
@@ -321,19 +353,23 @@ MGL_EXPORT
The default value of this property is an `MGLStyleValue` object containing an
`NSNumber` object containing the float `0`. Set this property to `nil` to reset
- it to the default value.`
+ it to the default value.
This property can be set to one of the following values:
- `MGLStyleConstantValue`
- - `MGLCameraStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential` or `MGLInterpolationModeInterval`
- - `MGLSourceStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval`,
- `MGLInterpolationModeCategorical`, or `MGLInterpolationModeIdentity`
- - `MGLCompositeStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential`, `MGLInterpolationModeInterval` or
- `MGLInterpolationModeCategorical`
+ - `MGLCameraStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLSourceStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLInterpolationModeCategorical`
+ - `MGLInterpolationModeIdentity`
+ - `MGLCompositeStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
+ - `MGLInterpolationModeCategorical`
*/
@property (nonatomic, null_resettable) MGLStyleValue<NSNumber *> *circleStrokeWidth;
@@ -349,13 +385,14 @@ MGL_EXPORT
This attribute corresponds to the <a
href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-circle-translate"><code>circle-translate</code></a>
- layout property in the Mapbox Style Specification.`
+ layout property in the Mapbox Style Specification.
This property can be set to one of the following values:
- `MGLStyleConstantValue`
- - `MGLCameraStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential` or `MGLInterpolationModeInterval`
+ - `MGLCameraStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
*/
@property (nonatomic, null_resettable) MGLStyleValue<NSValue *> *circleTranslation;
#else
@@ -370,13 +407,14 @@ MGL_EXPORT
This attribute corresponds to the <a
href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-circle-translate"><code>circle-translate</code></a>
- layout property in the Mapbox Style Specification.`
+ layout property in the Mapbox Style Specification.
This property can be set to one of the following values:
- `MGLStyleConstantValue`
- - `MGLCameraStyleFunction` with an interpolation mode of
- `MGLInterpolationModeExponential` or `MGLInterpolationModeInterval`
+ - `MGLCameraStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
*/
@property (nonatomic, null_resettable) MGLStyleValue<NSValue *> *circleTranslation;
#endif
@@ -395,7 +433,7 @@ MGL_EXPORT
This attribute corresponds to the <a
href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-circle-translate-anchor"><code>circle-translate-anchor</code></a>
- layout property in the Mapbox Style Specification.`
+ layout property in the Mapbox Style Specification.
This property can be set to one of the following values: