summaryrefslogtreecommitdiff
path: root/platform/darwin/src/MGLLineStyleLayer.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/MGLLineStyleLayer.h
parenta383edaae8ec05a3b385b19576c7a9358672662b (diff)
downloadqtlocation-mapboxgl-0e803186272f9febc84ea9c9e0fdc1b44d637d03.tar.gz
[ios, macos] Add more bullets to style property docs
Diffstat (limited to 'platform/darwin/src/MGLLineStyleLayer.h')
-rw-r--r--platform/darwin/src/MGLLineStyleLayer.h199
1 files changed, 114 insertions, 85 deletions
diff --git a/platform/darwin/src/MGLLineStyleLayer.h b/platform/darwin/src/MGLLineStyleLayer.h
index 436f0ee0d0..e1b621a215 100644
--- a/platform/darwin/src/MGLLineStyleLayer.h
+++ b/platform/darwin/src/MGLLineStyleLayer.h
@@ -8,7 +8,7 @@
NS_ASSUME_NONNULL_BEGIN
/**
- The display of line endings.`
+ The display of line endings.
This property can be set to one of the following values:
@@ -22,7 +22,7 @@ NS_ASSUME_NONNULL_BEGIN
typedef NS_ENUM(NSUInteger, MGLLineCap) {
/**
A cap with a squared-off end which is drawn to the exact endpoint of the
- line.`
+ line.
This property can be set to one of the following values:
@@ -34,7 +34,7 @@ typedef NS_ENUM(NSUInteger, MGLLineCap) {
/**
A cap with a rounded end which is drawn beyond the endpoint of the line at
a radius of one-half of the line's width and centered on the endpoint of
- the line.`
+ the line.
This property can be set to one of the following values:
@@ -45,7 +45,7 @@ typedef NS_ENUM(NSUInteger, MGLLineCap) {
MGLLineCapRound,
/**
A cap with a squared-off end which is drawn beyond the endpoint of the line
- at a distance of one-half of the line's width.`
+ at a distance of one-half of the line's width.
This property can be set to one of the following values:
@@ -57,7 +57,7 @@ typedef NS_ENUM(NSUInteger, MGLLineCap) {
};
/**
- The display of lines when joining.`
+ The display of lines when joining.
This property can be set to one of the following values:
@@ -71,7 +71,7 @@ typedef NS_ENUM(NSUInteger, MGLLineCap) {
typedef NS_ENUM(NSUInteger, MGLLineJoin) {
/**
A join with a squared-off end which is drawn beyond the endpoint of the
- line at a distance of one-half of the line's width.`
+ line at a distance of one-half of the line's width.
This property can be set to one of the following values:
@@ -83,7 +83,7 @@ typedef NS_ENUM(NSUInteger, MGLLineJoin) {
/**
A join with a rounded end which is drawn beyond the endpoint of the line at
a radius of one-half of the line's width and centered on the endpoint of
- the line.`
+ the line.
This property can be set to one of the following values:
@@ -94,7 +94,7 @@ typedef NS_ENUM(NSUInteger, MGLLineJoin) {
MGLLineJoinRound,
/**
A join with a sharp, angled corner which is drawn with the outer sides
- beyond the endpoint of the path until they meet.`
+ beyond the endpoint of the path until they meet.
This property can be set to one of the following values:
@@ -106,7 +106,7 @@ typedef NS_ENUM(NSUInteger, MGLLineJoin) {
};
/**
- Controls the translation reference point.`
+ Controls the translation reference point.
This property can be set to one of the following values:
@@ -119,7 +119,7 @@ typedef NS_ENUM(NSUInteger, MGLLineJoin) {
*/
typedef NS_ENUM(NSUInteger, MGLLineTranslationAnchor) {
/**
- The line is translated relative to the map.`
+ The line is translated relative to the map.
This property can be set to one of the following values:
@@ -129,7 +129,7 @@ typedef NS_ENUM(NSUInteger, MGLLineTranslationAnchor) {
*/
MGLLineTranslationAnchorMap,
/**
- The line is translated relative to the viewport.`
+ The line is translated relative to the viewport.
This property can be set to one of the following values:
@@ -180,7 +180,7 @@ MGL_EXPORT
The default value of this property is an `MGLStyleValue` object containing an
`NSValue` object containing `MGLLineCapButt`. Set this property to `nil` to
- reset it to the default value.`
+ reset it to the default value.
This property can be set to one of the following values:
@@ -195,7 +195,7 @@ MGL_EXPORT
The default value of this property is an `MGLStyleValue` object containing an
`NSValue` object containing `MGLLineJoinMiter`. Set this property to `nil` to
- reset it to the default value.`
+ reset it to the default value.
This property can be set to one of the following values:
@@ -214,13 +214,14 @@ MGL_EXPORT
This property is only applied to the style if `lineJoin` is set to an
`MGLStyleValue` object containing an `NSValue` object containing
- `MGLLineJoinMiter`. Otherwise, it is ignored.`
+ `MGLLineJoinMiter`. Otherwise, it is ignored.
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<NSNumber *> *lineMiterLimit;
@@ -233,13 +234,14 @@ MGL_EXPORT
This property is only applied to the style if `lineJoin` is set to an
`MGLStyleValue` object containing an `NSValue` object containing
- `MGLLineJoinRound`. Otherwise, it is ignored.`
+ `MGLLineJoinRound`. Otherwise, it is ignored.
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<NSNumber *> *lineRoundLimit;
@@ -252,19 +254,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 *> *lineBlur;
@@ -277,19 +283,23 @@ MGL_EXPORT
value.
This property is only applied to the style if `linePattern` is set to `nil`.
- Otherwise, it is ignored.`
+ Otherwise, it is ignored.
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 *> *lineColor;
#else
@@ -301,19 +311,23 @@ MGL_EXPORT
value.
This property is only applied to the style if `linePattern` is set to `nil`.
- Otherwise, it is ignored.`
+ Otherwise, it is ignored.
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 *> *lineColor;
#endif
@@ -330,7 +344,7 @@ MGL_EXPORT
This attribute corresponds to the <a
href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-line-dasharray"><code>line-dasharray</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:
@@ -350,19 +364,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 *> *lineGapWidth;
@@ -376,19 +394,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 *> *lineOffset;
@@ -397,25 +419,29 @@ 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 *> *lineOpacity;
/**
Name of image in style images to use for drawing image lines. For seamless
- patterns, image width must be a factor of two (2, 4, 8, ..., 512).`
+ patterns, image width must be a factor of two (2, 4, 8, ..., 512).
This property can be set to one of the following values:
@@ -437,13 +463,14 @@ MGL_EXPORT
This attribute corresponds to the <a
href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-line-translate"><code>line-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 *> *lineTranslation;
#else
@@ -458,13 +485,14 @@ MGL_EXPORT
This attribute corresponds to the <a
href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-line-translate"><code>line-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 *> *lineTranslation;
#endif
@@ -483,7 +511,7 @@ MGL_EXPORT
This attribute corresponds to the <a
href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-line-translate-anchor"><code>line-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:
@@ -502,13 +530,14 @@ 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`
+ - `MGLCameraStyleFunction` with an interpolation mode of:
+ - `MGLInterpolationModeExponential`
+ - `MGLInterpolationModeInterval`
*/
@property (nonatomic, null_resettable) MGLStyleValue<NSNumber *> *lineWidth;