summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJulian Rex <julian.rex@mapbox.com>2019-01-12 18:23:52 -0500
committerJulian Rex <julian.rex@mapbox.com>2019-01-12 18:23:52 -0500
commit015ec9c0fed7574c574ff962da6574ba4a3dae2f (patch)
tree44255bcdfd6b17584441af1599bb43a4374d4521
parentc7baac829feddac6295b060ddb1edf00a3d36b89 (diff)
downloadqtlocation-mapboxgl-upstream/jrex/12442-get-leaves.tar.gz
Update predicates/expressions guide with the other cluster attributes.upstream/jrex/12442-get-leaves
-rw-r--r--platform/darwin/docs/guides/Predicates and Expressions.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/platform/darwin/docs/guides/Predicates and Expressions.md b/platform/darwin/docs/guides/Predicates and Expressions.md
index 71c869f7fe..0bb26b3bfd 100644
--- a/platform/darwin/docs/guides/Predicates and Expressions.md
+++ b/platform/darwin/docs/guides/Predicates and Expressions.md
@@ -120,7 +120,7 @@ dictionary contains the `floorCount` key, then the key path `floorCount` refers
to the value of the `floorCount` attribute when evaluating that particular
polygon.
-The following special attribute is also available on features that are produced
+The following special attributes are also available on features that are produced
as a result of clustering multiple point features together in a shape source:
<table>
@@ -129,6 +129,16 @@ as a result of clustering multiple point features together in a shape source:
</thead>
<tbody>
<tr>
+ <td><code>cluster</code></td>
+ <td>Bool</td>
+ <td>True if the feature is a point cluster. If the attribute is false (or not present) then the feature should not be considered a cluster.</td>
+</tr>
+<tr>
+ <td><code>cluster_id</code></td>
+ <td>Number</td>
+ <td>Identifier for the point cluster.</td>
+</tr>
+<tr>
<td><code>point_count</code></td>
<td>Number</td>
<td>The number of point features in a given cluster.</td>