Neo4j Visualization Library
    Preparing search index...

    Interface ExternalCallbacks

    An object specifying the required callback functions for certain actions

    interface ExternalCallbacks {
        onError?: (error: Error) => void;
        onInitialization?: () => void;
        onLayoutComputing?: (isComputing: boolean) => void;
        onLayoutDone?: () => void;
        onLayoutStep?: (p: NodeWithClientPosition[]) => void;
        onWebGLContextLost?: (webGLContextEvent: WebGLContextEvent) => void;
        onZoomTransitionDone?: () => void;
        restart?: () => void;
    }
    Index
    onError? onInitialization? onLayoutComputing? onLayoutDone? onLayoutStep? onWebGLContextLost? onZoomTransitionDone? restart?
    onError?: (error: Error) => void

    Triggered when NVL throws an error after initialization.

    Constructor errors are thrown, not reported here.

    onInitialization?: () => void

    Triggered when NVL is initialized.

    onLayoutComputing?: (isComputing: boolean) => void

    Triggered when an asynchronous layout calculation starts (true) and stops (false). Not triggered by iterative layouts (e.g. force-directed).

    onLayoutDone?: () => void

    Triggered when a layout is done moving. Fires again after every change that re-runs the layout (added or removed elements, layout switch).

    onLayoutStep?: (p: NodeWithClientPosition[]) => void

    Triggered on each step of a layout with the current node positions.

    Can have a large performance footprint. Prefer onLayoutDone and NVL.getNodes unless per-frame positions are needed.

    onWebGLContextLost?: (webGLContextEvent: WebGLContextEvent) => void

    Triggered when the WebGL context is lost. https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/webglcontextlost_event

    onZoomTransitionDone?: () => void

    Triggered when a zoom transition (e.g. NVL.fit or NVL.resetZoom) function is done.

    restart?: () => void

    Triggered when NVL is restarted.

    Settings

    On This Page
    Properties