Skip to content

Commit

Permalink
[docs] Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
totallynotvaishnav committed Sep 9, 2022
1 parent 518ea42 commit 04a1c1a
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,9 @@ NetJSON format used internally is based on [networkgraph](http://netjson.org/rfc
// The style of the links
},
},
clusterConfig:{
// The configuration for the clusters
},
baseOptions:{
// The global configuration for Echarts specifically for the map.
}
Expand All @@ -195,6 +198,8 @@ NetJSON format used internally is based on [networkgraph](http://netjson.org/rfc

The `nodeSize` property is used to customize the size of the nodes.

The `clusterConfig` property is used to customize the clusters. You can pass any valid [Echarts options](https://echarts.apache.org/en/option.html#series-scatter.data) in `clusterConfig`.

`linkConfig` deals with the configuration of the links. You can pass any valid [Echarts options](https://echarts.apache.org/en/option.html#series-lines) in `linkConfig`.

The `linkStyle` property is used to customize the style of the links. The list of all available style properties can be found in the [Echarts documentation](https://echarts.apache.org/en/option.html#series-lines.lineStyle).
Expand Down Expand Up @@ -698,6 +703,9 @@ Using array files to append data step by step at start.
Similiar to the first method, but easier.
[ Append data using arrays demo](https://openwisp.github.io/netjsongraph.js/examples/netjsonmap-appendData2.html)

The demo shows the clustering of nodes.
[ Clustering demo](https://openwisp.github.io/netjsongraph.js/examples/netjson-clustering.html)

### Contributing

1. Fork it!
Expand Down

0 comments on commit 04a1c1a

Please sign in to comment.