Interface ClusteringOptions

Options that control physical clustering and cluster decorations for the force-directed layout.

interface ClusteringOptions {
    clusterBy?: ClusterByFn;
    crossClusterRelationshipMultiplier?: number;
    drawHalo?: boolean;
    drawOutline?: boolean;
}

Properties

clusterBy? crossClusterRelationshipMultiplier? drawHalo? drawOutline?

Properties

OptionalclusterBy

clusterBy?: ClusterByFn

Optional function to group nodes into physical clusters based on a custom identifier. Nodes returning the same string or number will be grouped together in the layout. Nodes returning undefined will be treated as independent.

Note

Ensure this function has a stable reference to avoid evaluation on every render.

Optional ExperimentalcrossClusterRelationshipMultiplier

crossClusterRelationshipMultiplier?: number

Spring force multiplier for relationships that cross a ClusteringOptions.clusterBy cluster boundary. Capped between 0 and 1. 0 disables cross-cluster spring pull. 1 is full strength. Intra-cluster edges are always full strength. Only applies when ClusteringOptions.clusterBy is set.

Default Value

0
@experimental

Note

Can cause unstable layouts when set to close to 1 in highly connected graphs.

OptionaldrawHalo

drawHalo?: boolean

Fills a soft glowing halo around each cluster.

Note

Halo color is the same as the nodes in the cluster. If the nodes in the cluster have different colors, the halo won't be shown.

Default Value

false

OptionaldrawOutline

drawOutline?: boolean

Draws a convex-hull outline around each cluster.

Note

Outline color is the same as the nodes in the cluster. If the nodes in the cluster have different colors, the outline uses NvlOptions.styling.overlayLineColor.

Default Value

false

Settings

On This Page

Properties