C

BiconnectedComponentClustering

Partitions the graph into clusters by analyzing its biconnected components.
Inheritance Hierarchy

Remarks

A biconnected component is a subgraph which is connected and non-separable, i.e. after removing one single node the component is still connected.

Nodes will be clustered such that the nodes within each cluster are biconnected. Nodes that belong to multiple biconnected components (articulation nodes) will be assigned to exactly one of these clusters.

Other Clustering Algorithms

yFiles for HTML supports a number of other clustering algorithms:

Complexity

O(|E| + |V|)

Examples

Calculating the biconnected component clusters of a graph
// prepare the biconnected components clustering algorithm
const algorithm = new BiconnectedComponentClustering()
// run the algorithm
const result = algorithm.run(graph)

// highlight the nodes of the clusters with different styles
for (const node of graph.nodes) {
  const componentId = result.nodeClusterIds.get(node)!
  graph.setStyle(node, clusterStyles.get(componentId)!)
}

See Also

Developer's Guide

API

biconnectedComponentClustering

Members

No filters for this type

Constructors

Parameters

Properties

Gets or sets the collection of edges which define a subset of the graph for the algorithms to work on.

If nothing is set, all edges of the graph will be processed.

If only the excludes are set, all edges in the graph except those provided in the excludes are processed.

Note that edges which start or end at nodes which are not in the subgraphNodes are automatically not considered by the algorithm.

ItemCollection<T> instances may be shared among algorithm instances and will be (re-)evaluated upon (re-)execution of the algorithm.

The edges provided here must be part of the graph which is passed to the run method.
conversionfinal

Examples

Calculating the biconnected component clusters on a subset of the graph
// prepare the biconnected components clustering algorithm
const algorithm = new BiconnectedComponentClustering({
  // Ignore edges without target arrow heads
  subgraphEdges: {
    excludes: (edge: IEdge): boolean =>
      edge.style instanceof PolylineEdgeStyle &&
      edge.style.targetArrow instanceof Arrow &&
      edge.style.targetArrow.type === ArrowType.NONE,
  },
})
// run the algorithm
const result = algorithm.run(graph)

// highlight the nodes of the clusters with different styles
for (const node of graph.nodes) {
  const componentId = result.nodeClusterIds.get(node)!
  graph.setStyle(node, clusterStyles.get(componentId)!)
}
Gets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.

If nothing is set, all nodes of the graph will be processed.

If only the excludes are set, all nodes in the graph except those provided in the excludes are processed.

ItemCollection<T> instances may be shared among algorithm instances and will be (re-)evaluated upon (re-)execution of the algorithm.

The nodes provided here must be part of the graph which is passed to the run method.
conversionfinal

Examples

Calculating the biconnected component clusters on a subset of the graph
// prepare the biconnected components clustering algorithm
const algorithm = new BiconnectedComponentClustering({
  subgraphNodes: {
    // only consider elliptical nodes in the graph
    includes: (node: INode): boolean =>
      node.style instanceof ShapeNodeStyle &&
      node.style.shape === ShapeNodeShape.ELLIPSE,
    // but ignore the first node, regardless of its shape
    excludes: graph.nodes.first()!,
  },
})
// run the algorithm
const result = algorithm.run(graph)

// highlight the nodes of the clusters with different styles
for (const node of graph.nodes) {
  const componentId = result.nodeClusterIds.get(node)!
  graph.setStyle(node, clusterStyles.get(componentId)!)
}

Methods

Partitions the graph into clusters based on its biconnected components.
The result obtained from this algorithm is a snapshot which is no longer valid once the graph has changed, e.g. by adding or removing nodes or edges.
final

Parameters

graph: IGraph
The input graph to run the algorithm on.

Return Value

BiconnectedComponentClusteringResult
A BiconnectedComponentClusteringResult of clusters in the graph.

Throws

Exception ({ name: 'InvalidOperationError' })
If the algorithm can't create a valid result due to an invalid graph structure or wrongly configured properties.

Complexity

O(|E| + |V|)