Interface GraphNode<NodeDatum, LinkDatum>

a node in a graph

Nodes provide all the same interfaces that Graphs do in terms of node properties and iteration. When called on a node, the nodes behaves as a graph of just its connected component. Therefore new nodes will always be acyclic, connected, and not multi.

In addition, nodes also expose properties of their immediate neighborhoods, iterators and counts of nodes they directly touch.

This is the immutable version of MutGraphNode.

interface GraphNode<out NodeDatum = unknown, out LinkDatum = unknown> {
    data: NodeDatum;
    ux?: number;
    uy?: number;
    x: number;
    y: number;
    acyclic(): boolean;
    ancestors(): IterableIterator<GraphNode<NodeDatum, LinkDatum>, any, any>;
    childCounts(): IterableIterator<
        [GraphNode<NodeDatum, LinkDatum>, number],
        any,
        any,
    >;
    childLinks(): IterableIterator<GraphLink<NodeDatum, LinkDatum>, any, any>;
    childLinksTo(
        node: GraphNode<NodeDatum, LinkDatum>,
    ): IterableIterator<GraphLink<NodeDatum, LinkDatum>, any, any>;
    children(): IterableIterator<GraphNode<NodeDatum, LinkDatum>, any, any>;
    connected(): boolean;
    descendants(): IterableIterator<GraphNode<NodeDatum, LinkDatum>, any, any>;
    leaves(): IterableIterator<GraphNode<NodeDatum, LinkDatum>, any, any>;
    links(): IterableIterator<GraphLink<NodeDatum, LinkDatum>, any, any>;
    multi(): boolean;
    nchildLinks(): number;
    nchildLinksTo(node: GraphNode<NodeDatum, LinkDatum>): number;
    nchildren(): number;
    nlinks(): number;
    nnodes(): number;
    nodes(): IterableIterator<GraphNode<NodeDatum, LinkDatum>, any, any>;
    nparentLinks(): number;
    nparentLinksTo(node: GraphNode<NodeDatum, LinkDatum>): number;
    nparents(): number;
    parentCounts(): IterableIterator<
        [GraphNode<NodeDatum, LinkDatum>, number],
        any,
        any,
    >;
    parentLinks(): IterableIterator<GraphLink<NodeDatum, LinkDatum>, any, any>;
    parentLinksTo(
        node: GraphNode<NodeDatum, LinkDatum>,
    ): IterableIterator<GraphLink<NodeDatum, LinkDatum>, any, any>;
    parents(): IterableIterator<GraphNode<NodeDatum, LinkDatum>, any, any>;
    roots(): IterableIterator<GraphNode<NodeDatum, LinkDatum>, any, any>;
    split(): IterableIterator<GraphNode<NodeDatum, LinkDatum>, any, any>;
    toJSON(): unknown;
    topological(
        rank?: Rank<NodeDatum, LinkDatum>,
    ): GraphNode<NodeDatum, LinkDatum>[];
}

Type Parameters

  • out NodeDatum = unknown
  • out LinkDatum = unknown

Hierarchy (View Summary)

Properties

data ux? uy? x y

Methods

acyclic ancestors childCounts childLinks childLinksTo children connected descendants leaves links multi nchildLinks nchildLinksTo nchildren nlinks nnodes nodes nparentLinks nparentLinksTo nparents parentCounts parentLinks parentLinksTo parents roots split toJSON topological

Properties

data

data: NodeDatum

user data for this node

Optionalux

ux?: number

raw (possibly undefined) x coordinate for a node

Optionaluy

uy?: number

raw (possibly undefined) y coordinate for a node

x

x: number

view of ux that throws if ux is undefined

y

y: number

view of uy that throws if uy is undefined

Methods

acyclic

ancestors

childCounts

childLinks

childLinksTo

children

connected

descendants

leaves

  • leaves(): IterableIterator<GraphNode<NodeDatum, LinkDatum>, any, any>

  • an iterator over the leaves of the graph

    The leaves are defined as a set of nodes such that every node in the graph is an ancestor of one of the leaves, an no leaf is an ancestor of any other leaf. It is guaranteed to include every node with no children, but one node in a cycle may be chosen if there is no unique leaf for that cycle.

    Returns IterableIterator<GraphNode<NodeDatum, LinkDatum>, any, any>

    Remarks

    the current implementation will return a minimal leaf set as long as target cycles contain a node with a single child.

links

multi

  • multi(): boolean

  • true if at least one node in this graph has multiple links to the same child

    Returns boolean

nchildLinks

  • nchildLinks(): number

  • the number of child links

    Returns number

nchildLinksTo

nchildren

  • nchildren(): number

  • the number of unique child nodes

    Returns number

nlinks

nnodes

nodes

  • nodes(): IterableIterator<GraphNode<NodeDatum, LinkDatum>, any, any>

  • an iterator over every node in the graph

    Returns IterableIterator<GraphNode<NodeDatum, LinkDatum>, any, any>

    Remarks

    Be careful not to modify the graph structure while iterating as any modification, including adding or removing links, can change the behavior of iteration giving unexpected results. If you want to guarantee consistent iteration, allocating an array first with [...graph.nodes()] will ensure consistent iteration.

nparentLinks

  • nparentLinks(): number

  • the number of parent links

    Returns number

nparentLinksTo

nparents

  • nparents(): number

  • the number of unique parent nodes

    Returns number

parentCounts

parentLinks

parentLinksTo

parents

roots

  • roots(): IterableIterator<GraphNode<NodeDatum, LinkDatum>, any, any>

  • an iterator over the roots of the graph

    The roots are defined as a set of nodes such that every node in the graph is a descendant of one of the roots, an no root is a descendant of any other root. It is guaranteed to include every node with no parents, but one node in a cycle may be chosen if there is no unique root for that cycle.

    Returns IterableIterator<GraphNode<NodeDatum, LinkDatum>, any, any>

    Remarks

    the current implementation will return a minimal root set as long as source cycles contain a node with a single parent.

split

  • split(): IterableIterator<GraphNode<NodeDatum, LinkDatum>, any, any>

  • split a graph into connected components

    Returns IterableIterator<GraphNode<NodeDatum, LinkDatum>, any, any>

    splits an iterable over a single node in each connected component

    Remarks

    Since each node behaves like a graph of its connected component, this is equivalent with returning a graph of each connected component.

toJSON

  • toJSON(): unknown

  • serialize the graph

    Returns unknown

    Remarks

    this is intended to be called automatically by JSON.stringify.

topological

  • topological(
        rank?: Rank<NodeDatum, LinkDatum>,
    ): GraphNode<NodeDatum, LinkDatum>[]

  • compute a topological order of the graph

    If the graph can't be represented in topological order, this will try to minimize the number of edge inversions. Optimally minimizing inversions is np-complete, so this will only be approximate.

    You can optionally specify a Rank accessor that defines a numerical rank for every node. Nodes with a lower rank will come before nodes of a higher rank even if that requires more edge inversions. Nodes without a rank are unconstrained.

    Parameters

    Returns GraphNode<NodeDatum, LinkDatum>[]

Settings

Member Visibility

On This Page

Properties
Methods