g6/plugins/template.maxSpanningForest/README.md

43 lines
1.4 KiB
Markdown
Raw Normal View History

## maxSpanningForest
template.maxSpanningForest for jiuselu graph analyzer, which is a plugin for graph. This is a collection of fundamental functions, including:
- the style of the nodes and graphs,
- extracting max spanning forest,
- Force Atlas 2 layout algorithm( with webworker ),
- interactions
- extracting subgraph
- highlight subgraph
- fisheye lens
- onclick
- menu operations
parameter for this plugin:
- layoutCfg: the configuration for layout.
- max_iteration: the number of iteration for terminating the layout algorithm
- kg: the gravity parameter for layout. The larger kg, more compact the graph, expecialy for the isolated subgraphs.
- prev_overlapping: whether preventing the node overlapping
- onLayoutComplete: a listener for layout completement. When the layout is complete, the loading div and img disappear.
## use
simple use.
```js
const MaxSpanningForestPlugin = G6.Plugins['template.maxSpanningForest'];
//the instances of plugins
const maxSpanningForest = new MaxSpanningForestPlugin({
layoutCfg: {
max_iteration: 600,
kg: 10,
prev_overlapping: true,
onLayoutComplete: function () {
const minimap = document.getElementById('minimap');
const legend = document.getElementById('legend');
if (minimap !== undefined) minimap.style.display = 'block';
if (legend !== undefined) legend.style.display = 'block';
}
}
});
```