Neo4j Visualization Library
    Preparing search index...

    Interface NvlWindow

    Read-only debugging hooks that every NVL instance registers on window, for tests and tooling that cannot reach the NVL object. Hooks exist from the first instance's construction and stay on window after it is destroyed. instanceId is the NvlOptions.instanceId given to NVL (default 'default'); an unknown id falls back to the most recently created instance.

    interface NvlWindow {
        __Nvl_dumpNodes: (instanceId?: string) => NodeWithClientPosition[];
        __Nvl_dumpRelationships: (instanceId?: string) => Relationship[];
        __Nvl_getNodesOnScreen: (
            instanceId?: string,
        ) => { nodes: Node[]; rels: Relationship[] };
        __Nvl_getZoomLevel: (instanceId?: string) => number;
        __Nvl_registerDoneCallback: (cb: () => void, instanceId: string) => void;
    }
    Index
    __Nvl_dumpNodes __Nvl_dumpRelationships __Nvl_getNodesOnScreen __Nvl_getZoomLevel __Nvl_registerDoneCallback

    __Nvl_dumpNodes

    __Nvl_dumpNodes: (instanceId?: string) => NodeWithClientPosition[]

    Same as NVL.getNodes: all nodes with layout coordinates and clientPosition.

    __Nvl_dumpRelationships

    __Nvl_dumpRelationships: (instanceId?: string) => Relationship[]

    Same as NVL.getRelationships.

    __Nvl_getNodesOnScreen

    __Nvl_getNodesOnScreen: (
        instanceId?: string,
    ) => { nodes: Node[]; rels: Relationship[] }

    Same as NVL.getNodesOnScreen: nodes inside the viewport; rels is always empty.

    __Nvl_getZoomLevel

    __Nvl_getZoomLevel: (instanceId?: string) => number

    Same as NVL.getScale.

    __Nvl_registerDoneCallback

    __Nvl_registerDoneCallback: (cb: () => void, instanceId: string) => void

    Adds a listener for ExternalCallbacks.onLayoutDone. Called on every layout completion, not just the first; listeners cannot be removed.

    Settings

    On This Page
    Properties