Interaction handler for dragging nodes, which is achieved by clicking and moving the node. When multiple nodes are selected, they are all dragged.

For examples, head to the Drag Node Interaction documentation page.

Hierarchy

Constructors

  • Creates a new instance of the drag node interaction handler.

    Parameters

    • nvl: NVL

      The NVL instance to attach the interaction handler to

    • options: {} = {}

      Returns DragNodeInteraction

    Properties

    callbackMap: Map<keyof DragNodeInteractionCallbacks,
        | undefined
        | boolean
        | ((nodes: Node[], evt: MouseEvent) => void)
        | ((nodes: Node[], evt: MouseEvent) => void)
        | ((nodes: Node[], evt: MouseEvent) => void)>

    Accessors

    • get containerInstance(): HTMLElement
    • Internal

      Returns HTMLElement

    • get currentOptions(): P
    • Returns P

    • get nvlInstance(): NVL
    • Internal

      Returns NVL

    Methods

    • Internal

      Parameters

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

            • event: Event

            Returns void

      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • Internal

      Parameters

      Returns void

    • Removes all related event listeners from the container.

      Returns void

    • Remove a callback for a given event of type.

      Parameters

      • name: string

        The name of the event

      Returns void

    • Internal

      Parameters

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

            • event: Event

            Returns void

      • Optionaloptions: boolean | EventListenerOptions

      Returns void

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

      Parameters

      • name: string

        The name of the event

      • callback:
            | undefined
            | boolean
            | ((nodes: Node[], evt: MouseEvent) => void)
            | ((nodes: Node[], evt: MouseEvent) => void)
            | ((nodes: Node[], evt: MouseEvent) => void)

        The callback to be called when the event is triggered

      Returns void