Interaction handler for hovering nodes and relationships.

For examples, head to the Hover Interaction documentation page.

Hierarchy

Constructors

Properties

callbackMap: Map<"onHover", undefined | boolean | ((element: Node | Relationship, hitElements: HitTargets, event: MouseEvent) => void)>

Accessors

  • get containerInstance(): HTMLElement
  • Internal

    Returns HTMLElement

  • get currentOptions(): P
  • Returns P

  • get nvlInstance(): NVL
  • Internal

    Returns NVL

Methods

  • Internal

    Parameters

    • type: keyof HTMLElementEventMap
    • listener: ((event: Event) => void)
        • (event): void
        • Parameters

          • event: Event

          Returns void

    • Optionaloptions: boolean | AddEventListenerOptions

    Returns void

  • Internal

    Parameters

    • name: "onHover"
    • Rest...args: unknown[]

    Returns void

  • Internal

    Returns void

  • Handle mouse hover events

    Parameters

    • event: MouseEvent

      The mouse event

    Returns void

  • Remove a callback for a given event of type.

    Parameters

    • name: string

      The name of the event

    Returns void

  • Internal

    Parameters

    • type: keyof HTMLElementEventMap
    • listener: ((event: Event) => void)
        • (event): void
        • Parameters

          • event: Event

          Returns void

    • Optionaloptions: boolean | EventListenerOptions

    Returns 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

  • Add or update a callback for a given event of type.

    Parameters

    • name: string

      The name of the event

    • callback: undefined | boolean | ((element: Node | Relationship, hitElements: HitTargets, event: MouseEvent) => void)

      The callback to be called when the event is triggered

    Returns void