Class HoverInteraction

Interaction handler for hovering nodes and relationships.

For examples, head to the Hover Interaction documentation page.

Hierarchy

Constructors

constructor

Accessors

currentOptions

Methods

handleHover removeCallback toggleGlobalTextSelection updateCallback

Constructors

constructor

Accessors

currentOptions

  • get currentOptions(): P

  • Returns the current options of the interaction.

    Returns P

    The current options of the interaction.

Methods

handleHover

  • handleHover(event): void

  • Handle mouse hover events

    Parameters

    • event: MouseEvent

      The mouse event.

    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: boolean | ((...args: unknown[]) => void)

      The callback to be called when the event is triggered.

    Returns void

Settings

On This Page

Constructors
Accessors
Methods