pivotick - v3.0.0
    Preparing search index...

    Interface GroupInfo

    A group drawn by simplification: nodes folded into one dot on the canvas. View state only — graph.getNodes(), the table, export and history see the members, never the group.

    interface GroupInfo {
        anchors: Node[];
        id: string;
        landing?: { pivotId: string; pivotLabel: string; runId: string };
        level?: number;
        members: Node[];
        open: boolean;
        rule: string;
        title?: string;
        typeCounts: Record<string, number>;
    }
    Index

    Properties

    anchors: Node[]

    The drawn neighbours that define it.

    id: string

    Stable while the group keeps its key or most of its members.

    landing?: { pivotId: string; pivotLabel: string; runId: string }

    A landings group's run: its id and the pivot that ran it.

    level?: number

    The Communities level it was found at.

    members: Node[]

    The real nodes it stands for.

    open: boolean

    Whether its members are back on the canvas.

    rule: string

    The id of the rule that made it: 'neighbours', 'chains', 'degree', 'kcore', 'communities', 'landings', 'manual', or a custom rule's own id.

    title?: string

    A hand-made group's title, shown in place of its type breakdown.

    typeCounts: Record<string, number>

    How many members of each type; the key is '' for nodes with no type.