Skip to content

Commit 4aa1dc8

Browse files
committed
Polishing FA2 doc
1 parent 971b9d6 commit 4aa1dc8

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

plugins/sigma.layout.forceAtlas2/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ sigma.layout.forceAtlas2
22
========================
33

44
Algorithm by [Mathieu Jacomy](https://github.com/jacomyma).
5+
56
Plugin by [Guillaume Plique](https://github.com/Yomguithereal).
67

78
---
@@ -13,27 +14,31 @@ For optimization purposes, the algorithm's computations are delegated to a web w
1314
## Methods
1415

1516
**sigma.startForceAtlas2**
17+
1618
Start or unpause the layout. It is possible to pass a configuration if this is the first time you start the layout.
1719

1820
```js
1921
sigmaInstance.startForceAtlas2(config);
2022
```
2123

2224
**sigma.stopForceAtlas2**
25+
2326
Pause the layout.
2427

2528
```js
2629
sigmaInstance.stopForceAtlas2();
2730
```
2831

2932
**sigma.configForceAtlas2**
33+
3034
Change the layout's configuration after this one has started or is paused.
3135

3236
```js
3337
sigmaInstance.configForceAtlas2(config);
3438
```
3539

3640
**sigma.killForceAtlas2**
41+
3742
Completely stop the layout and terminate the assiociated worker. You can still restart it later, but a new worker will have to initialize.
3843

3944
```js

0 commit comments

Comments
 (0)