E

NodeAggregationPolicy

Specifies how the nodes are aggregated by the node aggregation algorithm.

Remarks

The available policies are according to the graph structure and according to their GEOMETRIC position.

Members

No filters for this type

Constants

An aggregation policy that specifies that nodes are aggregated according to their geometric position.
More precisely, nodes that are placed close to each other are more likely to be contained in the same cluster.
Using this policy, the edges are completely ignored during the aggregation.
If working directly on the LayoutGraph API, it is important to use a graph instance containing coordinates for the nodes. A structure-only graph instance will not yield useful results.
static
An aggregation policy that specifies that nodes are aggregated according to their structure, that is, the connectivity.

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: NodeAggregationPolicy
The value to convert to an enum constant.

Return Value

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

Parameters

value: NodeAggregationPolicy
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.