Class BoxSelectInteraction

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

Constructors

constructor

Properties

callbackMap

Accessors

containerInstance currentOptions nvlInstance

Methods

addEventListener callCallbackIfRegistered destroy removeCallback removeEventListener updateCallback

Constructors

constructor

  • new BoxSelectInteraction(nvl, options?): BoxSelectInteraction

  • Creates a new instance of the multi-select interaction handler.

    Parameters

    • nvl: NVL

      The NVL instance to attach the interaction handler to

    • options: BoxSelectInteractionOptions = ...

      Options for the multi-select interaction handler to customize its behavior

    Returns BoxSelectInteraction

Properties

InternalcallbackMap

callbackMap: Map<keyof BoxSelectInteractionCallbacks,
    | undefined
    | boolean
    | ((event: MouseEvent) => void)
    | ((__namedParameters: {
        nodes: Node[];
        rels: Relationship[];
    }, event: MouseEvent) => void)>

Accessors

containerInstance

  • get containerInstance(): HTMLElement
  • Internal

    Returns HTMLElement

currentOptions

  • get currentOptions(): P

  • Returns P

nvlInstance

  • get nvlInstance(): NVL
  • Internal

    Returns NVL

Methods

addEventListener

  • addEventListener(type, listener, options?): void
  • Internal

    Parameters

    • type: keyof HTMLElementEventMap
    • listener: ((event: Event) => void)
        • (event): void

        • Parameters

          • event: Event

          Returns void

    • Optionaloptions: boolean | AddEventListenerOptions

    Returns void

callCallbackIfRegistered

  • callCallbackIfRegistered(name, ...args): void
  • Internal

    Parameters

    Returns void

destroy

  • destroy(): void

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

    Returns void

removeCallback

  • removeCallback(name): void

  • Remove a callback for a given event of type.

    Parameters

    • name: string

      The name of the event

    Returns void

removeEventListener

  • removeEventListener(type, listener, options?): void
  • Internal

    Parameters

    • type: keyof HTMLElementEventMap
    • listener: ((event: Event) => void)
        • (event): void

        • Parameters

          • event: Event

          Returns void

    • Optionaloptions: boolean | EventListenerOptions

    Returns void

updateCallback

  • updateCallback(name, callback): void

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

    Parameters

    • name: string

      The name of the event

    • callback:
          | undefined
          | boolean
          | ((event: MouseEvent) => void)
          | ((__namedParameters: {
              nodes: Node[];
              rels: Relationship[];
          }, event: MouseEvent) => void)

      The callback to be called when the event is triggered

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods