Click interaction handler that handles click, double click and right click events on nodes, relationships, and the scene.

For examples, head to the Click Interaction documentation page.

Hierarchy

Constructors

  • Creates a new click interaction handler.

    Parameters

    • nvl: NVL

      The NVL instance to attach the interaction handler to

    • options: ClickInteractionOptions = ...

      Options for the click interaction handler

    Returns ClickInteraction

Properties

callbackMap: Map<keyof ClickInteractionCallbacks,
    | undefined
    | boolean
    | ((nodes: Node, hitElements: HitTargets, event: MouseEvent) => void)
    | ((relationship: Relationship, hitElements: HitTargets, event: MouseEvent) => void)
    | ((event: MouseEvent) => void)
    | ((event: MouseEvent) => void)
    | ((event: MouseEvent) => void)
    | ((node: Node, hitElements: HitTargets, event: MouseEvent) => void)
    | ((node: Node, hitElements: HitTargets, event: MouseEvent) => void)
    | ((relationship: Relationship, hitElements: HitTargets, event: MouseEvent) => void)
    | ((relationship: 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

    Returns void

  • Removes all related event listeners from the container.

    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

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

    Parameters

    • name: string

      The name of the event

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

      The callback to be called when the event is triggered

    Returns void