Skip to content

Commit

Permalink
add documentation for cluster properties (#7000)
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewharvey authored and mourner committed Jul 23, 2018
1 parent 692126e commit a3f316c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/style-spec/reference/v8.json
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@
"cluster": {
"type": "boolean",
"default": false,
"doc": "If the data is a collection of point features, setting this to true clusters the points by radius into groups."
"doc": "If the data is a collection of point features, setting this to true clusters the points by radius into groups. Cluster groups become new `Point` features in the source with additional properties:\n * `cluster` Is `true` if the point is a cluster \n * `cluster_id` A unqiue id for the cluster to be used in conjunction with the [cluster inspection methods](https://www.mapbox.com/mapbox-gl-js/api/#geojsonsource#getclusterexpansionzoom)\n * `point_count` Number of original points grouped into this cluster\n * `point_count_abbreviated` An abbreviated point count"
},
"clusterRadius": {
"type": "number",
Expand Down

0 comments on commit a3f316c

Please sign in to comment.