summaryrefslogtreecommitdiff
path: root/platform/darwin/docs
diff options
context:
space:
mode:
authorMinh Nguyễn <mxn@1ec5.org>2018-10-25 04:57:08 -0700
committerMinh Nguyễn <mxn@1ec5.org>2018-10-30 14:26:59 -0700
commit3f314682fa2f2701c0d1c7e863013ce254a23afd (patch)
treeea1a88fa8aad86a42372c65d17b6472de8f3f071 /platform/darwin/docs
parenta0ebd61929bbfc16572b10fa9facb65384ce78ed (diff)
downloadqtlocation-mapboxgl-3f314682fa2f2701c0d1c7e863013ce254a23afd.tar.gz
[ios, macos] Added $lineProgress expression variable
Diffstat (limited to 'platform/darwin/docs')
-rw-r--r--platform/darwin/docs/guides/For Style Authors.md.ejs1
-rw-r--r--platform/darwin/docs/guides/Predicates and Expressions.md11
2 files changed, 12 insertions, 0 deletions
diff --git a/platform/darwin/docs/guides/For Style Authors.md.ejs b/platform/darwin/docs/guides/For Style Authors.md.ejs
index 51fc10d874..ead3b81ce6 100644
--- a/platform/darwin/docs/guides/For Style Authors.md.ejs
+++ b/platform/darwin/docs/guides/For Style Authors.md.ejs
@@ -402,6 +402,7 @@ In style specification | Method, function, or predicate type | Format string syn
`tan` | `mgl_tan:` | `mgl_tan(0)`
`zoom` | `NSExpression.zoomLevelVariableExpression` | `$zoomLevel`
`heatmap-density` | `NSExpression.heatmapDensityVariableExpression` | `$heatmapDensity`
+`line-progress` | `NSExpression.lineProgressVariableExpression` | `$lineProgress`
For operators that have no corresponding `NSExpression` symbol, use the
`MGL_FUNCTION()` format string syntax.
diff --git a/platform/darwin/docs/guides/Predicates and Expressions.md b/platform/darwin/docs/guides/Predicates and Expressions.md
index 90f010e954..c70d76b581 100644
--- a/platform/darwin/docs/guides/Predicates and Expressions.md
+++ b/platform/darwin/docs/guides/Predicates and Expressions.md
@@ -290,6 +290,17 @@ The following variables are defined by this SDK for use with style layers:
<code>NSExpression.zoomLevelVariableExpression</code> property.
</td>
</tr>
+<tr>
+ <td><code>$lineProgress</code></td>
+ <td>Number</td>
+ <td>
+ A number that indicates the relative distance along a line at a given
+ point along the line. This variable evaluates to 0 at the beginning of the
+ line and 1 at the end of the line. It can only be used with the
+ `MGLLineStyleLayer.lineGradient` property. It corresponds to the
+ <code>NSExpression.lineProgressVariableExpression</code> property.
+ </td>
+</tr>
</tbody>
</table>