Neo4j Visualization Library
    Preparing search index...

    Class ZoomInteraction

    Interaction handler for zooming the canvas, which is achieved by:

    • Scrolling the mouse wheel on the canvas
    • Using trackpad pinch gestures (equivalent to Ctrl/Cmd + scroll)

    ZoomInteractionCallbacks.onZoomAndPan is the only callback. Zooming also changes the pan so the point under the pointer stays fixed. Zoom limits come from NVL.getZoomLimits.

    For examples, head to the Zoom Interaction documentation page.

    Hierarchy

    Index
    constructor
    currentOptions
    destroy removeCallback toggleGlobalTextSelection updateCallback

    • Creates a new instance of the zoom interaction handler.

      Parameters

      • nvl: NVL

        The NVL instance to attach the interaction handler to.

      • options: ZoomInteractionOptions = {}

        Options to customize the zoom interaction behavior.

      Returns ZoomInteraction

    • get currentOptions(): P

      Returns the current options of the interaction.

      Returns P

      The current options of the interaction.

    • Removes the relevant event listeners from the canvas.

      Returns void

    • Remove a callback for a given event of type.

      Parameters

      • name: string

        The name of the event.

      Returns void

    • Enables or disables global text selection during a drag or pan operation.

      Parameters

      • enable: boolean

        Whether to enable or disable global text selection.

      • OptionaleventFunction: (this: HTMLElement, ev: MouseEvent) => void

        The event function to be added/removed when text selection is disabled/enabled.

      Returns void

    • Add or update a callback for a given event of type.

      Parameters

      • name: string

        The name of the event.

      • callback: boolean | ((...args: unknown[]) => void)

        The callback to be called when the event is triggered.

      Returns void

    Settings

    On This Page
    Constructors
    Accessors
    Methods