Network - clustering

Handles the HTML part of the canvas.

Options

Clustering has no options, everything is done with methods.

Methods

This is a list of all the methods in the public API. Options can be set directly to the module or you can use the setOptions method of the network itself and use the module name as an object name.

namereturnsdescription
isCluster() none
openCluster() none
clusterByConnection() none
clusterByConnectionCount() none
clusterByNodeData() none
clusterOutliers() none

Events

This is a list of all the events in the public API. They are collected here from all individual modules.

namepropertiesdescription
startStabilizingnoneFired when stabilization starts. This is also the case when you drag a node and the physics simulation restarts to stabilize again. Stabilization does not neccesarily imply 'without showing'.
stabilizationProgress
{
  iterations: Number // iterations so far,
  total: Number // total iterations in options
}
Fired when a multiple of the updateInterval number of iterations is reached. This only occurs in the 'hidden' stabilization.
stabilizationIterationsDonenoneFired when the 'hidden' stabilization finishes. This does not necessarily mean the network is stabilized; it could also mean that the amount of iterations defined in the options has been reached.
stabilized
{
  iterations: Number // iterations it took
}
Fired when the network has stabilized or when the stopSimulation() has been called. The amount of iterations it took could be used to tweak the maximum amount of iterations needed to stabilize the network.