LouvainModularityClusteringResult

Show usages

Represents clusters in the graph as computed by LouvainModularityClustering.

Inheritance Hierarchy

LouvainModularityClusteringResult

Type Details

yfiles module: view-layout-bridge
yfiles-umd modules: view-layout-bridge
Legacy UMD name: yfiles.analysis.LouvainModularityClusteringResult

Properties

clusters

: ResultItemCollection<Cluster>

Gets a collection of all clusters in the graph.

modularity

: number

Gets a value which estimates the quality of the partition of the nodes into the clusters.

Remarks

The modularity value estimates the quality of the partition of the nodes into the given communities and is a value between [-1/2,1]. High modularity values denote that nodes with dense connections are placed in the same community, while nodes with sparse connections are assigned to different communities.

nodeClusterIds

: ResultItemMapping<INode,number>

Gets a mapping from each node to its cluster ID.

Remarks

The value corresponds to the index of the associated cluster in clusters. For nodes which are not associated with a cluster the index is -1. Also, if a subgraph is specified, all nodes that are not part of the subgraph have the ID -1.

nodeClusters

: ResultItemMapping<INode,Cluster>

Gets a mapping from each node to its cluster.