Neo4j Visualization Library
    Preparing search index...

    Type Alias ClickInteractionCallbacks

    Callbacks for the click interaction handler.

    type ClickInteractionCallbacks = {
        onCanvasClick?: ((event: MouseEvent) => void) | boolean;
        onCanvasDoubleClick?: ((event: MouseEvent) => void) | boolean;
        onCanvasRightClick?: ((event: MouseEvent) => void) | boolean;
        onClusterClick?:
            | (
                (cluster: Cluster, hitElements: HitTargets, event: MouseEvent) => void
            )
            | boolean;
        onClusterDoubleClick?:
            | (
                (cluster: Cluster, hitElements: HitTargets, event: MouseEvent) => void
            )
            | boolean;
        onClusterRightClick?:
            | (
                (cluster: Cluster, hitElements: HitTargets, event: MouseEvent) => void
            )
            | boolean;
        onNodeClick?:
            | ((node: Node, hitElements: HitTargets, event: MouseEvent) => void)
            | boolean;
        onNodeDoubleClick?:
            | ((node: Node, hitElements: HitTargets, event: MouseEvent) => void)
            | boolean;
        onNodeRightClick?:
            | ((node: Node, hitElements: HitTargets, event: MouseEvent) => void)
            | boolean;
        onRelationshipClick?:
            | (
                (
                    relationship: Relationship,
                    hitElements: HitTargets,
                    event: MouseEvent,
                ) => void
            )
            | boolean;
        onRelationshipDoubleClick?:
            | (
                (
                    relationship: Relationship,
                    hitElements: HitTargets,
                    event: MouseEvent,
                ) => void
            )
            | boolean;
        onRelationshipRightClick?:
            | (
                (
                    relationship: Relationship,
                    hitElements: HitTargets,
                    event: MouseEvent,
                ) => void
            )
            | boolean;
    }
    Index
    onCanvasClick? onCanvasDoubleClick? onCanvasRightClick? onClusterClick? onClusterDoubleClick? onClusterRightClick? onNodeClick? onNodeDoubleClick? onNodeRightClick? onRelationshipClick? onRelationshipDoubleClick? onRelationshipRightClick?
    onCanvasClick?: ((event: MouseEvent) => void) | boolean

    Called when the canvas is clicked.

    The original mouse event.

    onCanvasDoubleClick?: ((event: MouseEvent) => void) | boolean

    Called when the canvas is double-clicked.

    The original mouse event.

    onCanvasRightClick?: ((event: MouseEvent) => void) | boolean

    Called when the canvas is right-clicked.

    The original mouse event.

    onClusterClick?:
        | (
            (cluster: Cluster, hitElements: HitTargets, event: MouseEvent) => void
        )
        | boolean

    Called when a cluster hull is clicked (empty space inside a clusterBy hull).

    The cluster that was clicked.

    All elements that were hit by the click.

    The original mouse event.

    onClusterDoubleClick?:
        | (
            (cluster: Cluster, hitElements: HitTargets, event: MouseEvent) => void
        )
        | boolean

    Called when a cluster hull is double-clicked.

    The cluster that was double-clicked.

    All elements that were hit by the double-click.

    The original mouse event.

    onClusterRightClick?:
        | (
            (cluster: Cluster, hitElements: HitTargets, event: MouseEvent) => void
        )
        | boolean

    Called when a cluster hull is right-clicked.

    The cluster that was right-clicked.

    All elements that were hit by the right-click.

    The original mouse event.

    onNodeClick?:
        | ((node: Node, hitElements: HitTargets, event: MouseEvent) => void)
        | boolean

    Called when a node is clicked.

    The node that was clicked.

    All elements that were hit by the click.

    The original mouse event.

    onNodeDoubleClick?:
        | ((node: Node, hitElements: HitTargets, event: MouseEvent) => void)
        | boolean

    Called when a node is double-clicked.

    The node that was double-clicked.

    All elements that were hit by the double-click.

    The original mouse event.

    onNodeRightClick?:
        | ((node: Node, hitElements: HitTargets, event: MouseEvent) => void)
        | boolean

    Called when a node is right-clicked.

    The node that was right-clicked.

    All elements that were hit by the right-click.

    The original mouse event.

    onRelationshipClick?:
        | (
            (
                relationship: Relationship,
                hitElements: HitTargets,
                event: MouseEvent,
            ) => void
        )
        | boolean

    Called when a relationship is clicked.

    The relationship that was clicked.

    All elements that were hit by the click.

    The original mouse event.

    onRelationshipDoubleClick?:
        | (
            (
                relationship: Relationship,
                hitElements: HitTargets,
                event: MouseEvent,
            ) => void
        )
        | boolean

    Called when a relationship is double-clicked.

    The relationship that was double-clicked.

    All elements that were hit by the double-click.

    The original mouse event.

    onRelationshipRightClick?:
        | (
            (
                relationship: Relationship,
                hitElements: HitTargets,
                event: MouseEvent,
            ) => void
        )
        | boolean

    Called when a relationship is right-clicked.

    The relationship that was right-clicked.

    All elements that were hit by the right-click.

    The original mouse event.

    Settings

    On This Page
    Properties