ComponentAssignmentStrategy

Enum representing various strategies for assigning nodes to subgraph components.

Remarks

To define custom components instead of using the predefined strategies, utilize the following properties: componentIds, componentIds, or componentIds.

Type Details

yFiles module: algorithms

Constants

CLUSTERING

: number

A strategy where subgraph components are defined by clusters determined by a clustering algorithm based on edge betweenness centrality.

CONNECTED

: number

A strategy where subgraph components correspond to the graph's connected components.

SINGLE

: number

A strategy that assigns each node to a distinct subgraph component.

Static Methods

from

(value: ComponentAssignmentStrategy) : ComponentAssignmentStrategy

Converts the given argument to an enum constant of this enum type.

Remarks

Most notably, this method can convert an enum constant's name into the enum constant itself.

Parameters

options - Object
A map of options to pass to the method.

value - ComponentAssignmentStrategy: The value to convert to an enum constant.

Returns

↪ComponentAssignmentStrategy: The enum constant that corresponds to the given argument.

getName

(value: ComponentAssignmentStrategy) : string

Returns the name of the given enum constant.

Parameters

options - Object
A map of options to pass to the method.

value - ComponentAssignmentStrategy: The numeric value of an enum constant.

Returns

↪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.