Neo4j Visualization Library
    Preparing search index...

    An interaction handler for multi-selecting nodes and relationships. When dragging the cursor, it draws a box on the scene and all nodes and relationships inside the box are selected.

    For examples, head to the Box Select Interaction documentation page.

    Hierarchy

    Index
    • get currentOptions(): P

      Returns the current options of the interaction.

      Returns P

      The current options of the interaction.

    • Removes all related event listeners and the overlay renderer for the box.

      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