Skip to content

Commit

Permalink
[docs] Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
totallynotvaishnav committed Sep 8, 2022
1 parent 90b5aeb commit 518ea42
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,30 @@ NetJSON format used internally is based on [networkgraph](http://netjson.org/rfc

Whether to allow switching between graph and map render or not. You can also set it `true` to enable it.

- `clustering`

**Default**: `false`

Whether to enable clustering of nodes or not. You can also set it `true` to enable it.

- `clusteringThreshold`

**Default**: `100`

The threshold of clustering. When the number of nodes is greater than this value, the clustering will be enabled.

- `disableClusteringAtLevel`

**Default**: `8`

The zoom level at which clustering is disabled. When the zoom level is greater than this value, all the clusters will be expanded.

- `clusterRadius`

**Default**: `80`

The maximum radius that a cluster will cover. Decreasing will make more, smaller clusters and vice versa.

- `dealDataByWorker`

The url to the worker file if you want to deal the data by a worker.
Expand Down Expand Up @@ -505,6 +529,10 @@ Demo is [here](https://openwisp.github.io/netjsongraph.js/examples/netjson-dateP

Parse JSONParam (string|object), return Promise object.

- `makeCluster`

Accepts NetJSONGraph instance as parameter and returns an object containing the cluster nodes, other individual nodes and links.

- `isObject`

Check if the param is object.
Expand Down

0 comments on commit 518ea42

Please sign in to comment.