Class LassoInteraction

An interaction handler that lets you select nodes and relationships by drawing a lasso around them. When dragging, a line is drawn on the scene and all elements inside are selected.

For examples, head to the Lasso Interaction documentation page.

Hierarchy

Constructors

constructor

Accessors

currentOptions

Methods

destroy removeCallback toggleGlobalTextSelection updateCallback

Constructors

constructor

  • new LassoInteraction(nvl, options?): LassoInteraction

  • Creates a new instance of the lasso interaction handler.

    Parameters

    • nvl: NVL

      The NVL instance to attach the interaction handler to.

    • options: LassoInteractionOptions = ...

      Options for the lasso interaction handler to customize its behavior.

    Returns LassoInteraction

Accessors

currentOptions

  • get currentOptions(): P

  • Returns the current options of the interaction.

    Returns P

    The current options of the interaction.

Methods

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

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
          | ((event: MouseEvent) => void)
          | ((__namedParameters: {
              nodes: Node[];
              rels: Relationship[];
          }, event: MouseEvent) => void)

      The callback to be called when the event is triggered.

    Returns void

Settings

On This Page

Constructors
Accessors
Methods