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: Node[]) => void);
    onWebGLContextLost?: ((webGLContextEvent: WebGLContextEvent) => void);
    onZoomTransitionDone?: (() => void);
    restart?: (() => void);
}

Properties

onError? onInitialization? onLayoutComputing? onLayoutDone? onLayoutStep? onWebGLContextLost? onZoomTransitionDone? restart?

Properties

OptionalonError

onError?: ((error: Error) => void)

Triggered when NVL throws an error after initialization.

OptionalonInitialization

onInitialization?: (() => void)

Triggered when NVL is initialized.

OptionalonLayoutComputing

onLayoutComputing?: ((isComputing: boolean) => void)

Triggered when a asynchronous layout calculation starts/stops.

OptionalonLayoutDone

onLayoutDone?: (() => void)

Triggered when a layout is done moving.

OptionalonLayoutStep

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

Triggered on each step of a layout.

OptionalonWebGLContextLost

onWebGLContextLost?: ((webGLContextEvent: WebGLContextEvent) => void)

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

OptionalonZoomTransitionDone

onZoomTransitionDone?: (() => void)

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

Optionalrestart

restart?: (() => void)

Triggered when NVL is restarted.

Settings

On This Page

Properties