g3-toolkit API Reference
    Preparing search index...

    Interface CollapseByClusterOptions

    interface CollapseByClusterOptions {
        clusterProperty?: string;
        maxSupernodes?: number;
        resolution?: number;
        rng?: () => number;
        threshold?: number;
    }
    Index

    Properties

    clusterProperty? maxSupernodes? resolution? rng? threshold?

    Properties

    clusterProperty?: string

    Read community membership from this node property instead of running detection (the design's pre-computed path; values are grouped by string identity).

    maxSupernodes?: number

    Ceiling on supernodes; smallest communities pool into one "other" supernode. Default 200.

    resolution?: number

    Louvain resolution (community granularity).

    rng?: () => number

    RNG for deterministic Louvain runs.

    threshold?: number

    Node count at or below which the input is returned uncollapsed. Default 2000.

    Settings

    Member Visibility

    On This Page

    Properties