E

OrganicLayoutClusteringPolicy

Enum constants to define the clustering algorithm applied by the OrganicLayout

Members

No filters for this type

Constants

A clustering policy that clusters the nodes using edge betweenness centrality.
This clustering can give very good results, but compared to the other policies it likely yields worse performance. To influence the quality and performance of it, the property qualityTimeRatio can be adjusted.
static

See Also

API
clusteringPolicy, qualityTimeRatio, edgeBetweennessClustering, edgeBetweennessClustering
A clustering policy that clusters the nodes using the label propagation algorithm.

This algorithm iteratively assigns a so-called label to each node. The label of a node is set to the most frequent label among its neighbors. If there are multiple candidates the algorithm randomly chooses one of them. In the end, all nodes with the same label belong to the same community.

Compared to the other clustering policies, the label propagation often offers very good performance. However, the results are rather unstable, i.e., small changes in the input may lead to significantly different node clusters. If stable results are important, it is recommended to select another policy.

static

See Also

API
clusteringPolicy, labelPropagation
A clustering policy that clusters the nodes using the louvain modularity method.

The Louvain algorithm starts by assigning each node to its own community. Then, it iteratively tries to construct clusters by moving nodes from their current community to another until the modularity is locally optimized.

As a clustering policy, Louvain modularity offers a good trade-off between quality and performance.

static

See Also

API
clusteringPolicy, louvainModularity
A policy that indicates that no automatic clustering is applied to the input graph.
static

See Also

API
clusteringPolicy

Static Methods

Converts the given argument to an enum constant of this enum type.
Most notably, this method can convert an enum constant's name into the enum constant itself.
static

Parameters

value: OrganicLayoutClusteringPolicy
The value to convert to an enum constant.

Return Value

OrganicLayoutClusteringPolicy
The enum constant that corresponds to the given argument.
Returns the name of the given enum constant.
static

Parameters

value: OrganicLayoutClusteringPolicy
The numeric value of an enum constant.

Return Value

string
The name of the enum constant.

Throws

Exception ({ name: 'Error' })
If this type is a flags enums, and the provided value doesn't correspond to a single enum constant, or if this enum type contains no constant of the given numeric value.