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

BaseInteraction<DragNodeInteractionCallbacks, Record<string, never>>
- DragNodeInteraction

Index

Constructors

Properties

Accessors

containerInstance currentOptions nvlInstance

Methods

addEventListener callCallbackIfRegistered destroy removeCallback removeEventListener 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
Overrides BaseInteraction<DragNodeInteractionCallbacks, Record<string, never>>.constructor

Properties

`Internal`callbackMap

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
Inherited from BaseInteraction.containerInstance

currentOptions

get currentOptions(): P
Returns P
Inherited from BaseInteraction.currentOptions

nvlInstance

get nvlInstance(): NVL
Internal
Returns NVL
Inherited from BaseInteraction.nvlInstance

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
Inherited from BaseInteraction.addEventListener

callCallbackIfRegistered

callCallbackIfRegistered(name, ...args): void
Internal
Parameters
- name: keyof DragNodeInteractionCallbacks
- Rest...args: unknown[]
Returns void
Inherited from BaseInteraction.callCallbackIfRegistered

destroy

destroy(): void
Removes all related event listeners from the container.

Returns void
Overrides BaseInteraction.destroy

removeCallback

removeCallback(name): void
Remove a callback for a given event of type.
Parameters
- name: string
  The name of the event
Returns void
Inherited from BaseInteraction.removeCallback

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
Inherited from BaseInteraction.removeEventListener

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
Inherited from BaseInteraction.updateCallback