Skip to content

Commit

Permalink
Update ClusteredCircleViz parameters table in docs to match class's c…
Browse files Browse the repository at this point in the history
…haracteristics; closes #53 (#55)
  • Loading branch information
akacarlyann authored and ryanbaumann committed Feb 27, 2018
1 parent e5346c0 commit 630f3a7
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs-markdown/viz.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,18 +104,18 @@ viz.show()

## class ClusteredCircleViz

The `ClusteredCircleViz` object handles the creation of a clustered circle map and is built on top of the `MapViz` class.
The `ClusteredCircleViz` object handles the creation of a clustered circle map and is built on top of the `MapViz` class. Cluster radius and color are keyed on point density.

### Params
**ClusteredCircleViz**(_data, color_stops=None, radius_stops=None, cluster_radius=30, cluster_maxzoom=14, *args, **kwargs_)

Parameter | Description
--|--
data | name of GeoJson file or object
color_property | property to determine circle color
color_stops | property to determine circle color
radius_property | property to determine circle radius
radius_stops | property to determine circle radius
cluster_radius | property to determine radius of each cluster when clustering points
cluster_maxzoom | property to determine the max zoom to use for clustering points

[View options](https://github.com/mapbox/mapboxgl-jupyter/blob/master/docs-markdown/viz.md#params)

Expand Down

0 comments on commit 630f3a7

Please sign in to comment.