Class BeforeEdgeSelectEventArgs

Fired BEFORE an edge relationship is selected.

Hierarchy (View Summary)

CancellableGraphEventArgs
- BeforeEdgeSelectEventArgs

Index

Constructors

Properties

Cancel CancelReason? Edge SourceNode TargetNode

Constructors

constructor

new BeforeEdgeSelectEventArgs(
    Edge: GraphEdge,
    SourceNode?: GraphNode<Record<string, unknown>> | null,
    TargetNode?: GraphNode<Record<string, unknown>> | null,
): BeforeEdgeSelectEventArgs
Parameters
- Edge: GraphEdge
- SourceNode: GraphNode<Record<string, unknown>> | null = null
- TargetNode: GraphNode<Record<string, unknown>> | null = null
Returns BeforeEdgeSelectEventArgs
Overrides CancellableGraphEventArgs.constructor
- Defined in events/graph-events.ts:61

Properties

Cancel

Cancel: boolean = false

Set to true in a Before-event listener to prevent the action from completing

`Optional`CancelReason

CancelReason?: string

Optional human-readable reason for telemetry, debugging, or UI feedback

`Readonly`Edge

Edge: GraphEdge

`Readonly`SourceNode

SourceNode: GraphNode<Record<string, unknown>> | null = null

`Readonly`TargetNode

TargetNode: GraphNode<Record<string, unknown>> | null = null