summaryrefslogtreecommitdiff
path: root/platform/darwin/src/MGLLineStyleLayer.h
diff options
context:
space:
mode:
authorMinh Nguyễn <mxn@1ec5.org>2018-10-24 11:04:56 -0700
committerMinh Nguyễn <mxn@1ec5.org>2018-10-25 09:23:59 +0000
commit8e2214129eb30e278c2d8fc39801f6570b6f02e9 (patch)
tree387f8389fdcda03b566a9b1d511041a2d4c0f6e0 /platform/darwin/src/MGLLineStyleLayer.h
parent3ec0231bb7ed923e82c08ac37950c1fdc366620d (diff)
downloadqtlocation-mapboxgl-8e2214129eb30e278c2d8fc39801f6570b6f02e9.tar.gz
[ios, macos] Refined MGLLineStyleLayer.lineGradient documentation
Diffstat (limited to 'platform/darwin/src/MGLLineStyleLayer.h')
-rw-r--r--platform/darwin/src/MGLLineStyleLayer.h10
1 files changed, 6 insertions, 4 deletions
diff --git a/platform/darwin/src/MGLLineStyleLayer.h b/platform/darwin/src/MGLLineStyleLayer.h
index 28bb286049..ac30ff5f86 100644
--- a/platform/darwin/src/MGLLineStyleLayer.h
+++ b/platform/darwin/src/MGLLineStyleLayer.h
@@ -368,8 +368,9 @@ MGL_EXPORT
#if TARGET_OS_IPHONE
/**
- Defines a gradient with which to color a line feature. Can only be used with
- GeoJSON sources that specify `"lineMetrics": true`.
+ The color gradient with which the line will be drawn. This property only has an
+ effect on lines defined by an `MGLShapeSource` whose
+ `MGLShapeSourceOptionLineDistanceMetrics` option is set to `YES`.
This property is only applied to the style if `lineDasharray` is set to `nil`,
and `linePattern` is set to `nil`, and the data source requirements are met.
@@ -389,8 +390,9 @@ MGL_EXPORT
@property (nonatomic, null_resettable) NSExpression *lineGradient;
#else
/**
- Defines a gradient with which to color a line feature. Can only be used with
- GeoJSON sources that specify `"lineMetrics": true`.
+ The color gradient with which the line will be drawn. This property only has an
+ effect on lines defined by an `MGLShapeSource` whose
+ `MGLShapeSourceOptionLineDistanceMetrics` option is set to `YES`.
This property is only applied to the style if `lineDasharray` is set to `nil`,
and `linePattern` is set to `nil`, and the data source requirements are met.