From 564ec9ccd7f43bbd25ef6b5fb104edb0058ed1aa Mon Sep 17 00:00:00 2001 From: Alex de Mulder Date: Mon, 13 Oct 2014 16:28:07 +0200 Subject: [PATCH] improved docs on storePositions --- docs/network.html | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/network.html b/docs/network.html index 931c8793..d4fd6b89 100644 --- a/docs/network.html +++ b/docs/network.html @@ -2285,8 +2285,11 @@ var options: { storePositions() none - This will put the X and Y positions of all nodes in the dataset. It will also include allowedToMoveX and allowedToMoveY with the correct values. - You can use this to stablize your network once, then save the positions in a database so the next time you load the nodes, stabilization will be near instantaneous. + When using the vis.DataSet to load your nodes into the network, this method will put the X and Y positions of all nodes into that dataset. It will also include allowedToMoveX and allowedToMoveY with the correct values. + If you're loading your nodes from a database and have this dynamically coupled with the DataSet, you can use this + to stablize your network once, then save the positions in that database through the DataSet so the next time you load the nodes, stabilization will be near instantaneous. + If the nodes are still moving and you're using dynamic smooth edges (which is on by default), you can use the option freezeForStabilization to improve initialization time. +

NOTE:This method does not work with the hierarchical layout because the hierarchical algorithm is assigning X Y positions on load, regardless of the ones you supply it with.