Class DragNodeInteraction

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

constructor

Properties

callbackMap

Accessors

containerInstance currentOptions nvlInstance

Methods

addEventListener callCallbackIfRegistered destroy removeCallback removeEventListener toggleGlobalTextSelection updateCallback

Constructors

constructor

  • new DragNodeInteraction(nvl, options?): DragNodeInteraction

  • 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

    InternalcallbackMap

    callbackMap: Map<keyof DragNodeInteractionCallbacks,
        | undefined
        | boolean
        | ((nodes: Node[], evt: MouseEvent) => void)
        | ((nodes: Node[], evt: MouseEvent) => void)
        | ((nodes: Node[], evt: 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 from the container.

      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

    toggleGlobalTextSelection

    • toggleGlobalTextSelection(enable, eventFunction?): 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

          • (this, ev): void

          • Parameters

            • this: HTMLElement
            • ev: MouseEvent

            Returns void

      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
            | ((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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods