Neo4j Visualization Library
    Preparing search index...

    Class HoverInteraction

    Interaction handler for hovering nodes and relationships.

    Clusters are not hoverable elements: element is never a cluster and no hover state is drawn for hulls. Read hitElements.clusters in HoverInteractionCallbacks.onHover, or call NVL.getHits with ['cluster'], to react to the pointer being inside a cluster hull.

    For examples, head to the Hover Interaction documentation page.

    Hierarchy

    Index
    constructor
    currentOptions
    handleHover removeCallback toggleGlobalTextSelection updateCallback
    • get currentOptions(): P

      Returns the current options of the interaction.

      Returns P

      The current options of the interaction.

    • 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

    • 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.

      Returns 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