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

Accessors

Methods

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

Accessors

currentOptions

get currentOptions(): P
Returns the current options of the interaction.

Returns P
The current options of the interaction.

Inherited from BaseInteraction.currentOptions

Methods

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

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

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