Class BeforeHopExpandEventArgs

Fired BEFORE expanding graph hops for a given node.

Hierarchy (View Summary)

CancellableGraphEventArgs
- BeforeHopExpandEventArgs

Index

Constructors

Properties

Cancel CancelReason? CurrentDepth Node TargetDepth

Constructors

constructor

new BeforeHopExpandEventArgs(
    Node: GraphNode,
    TargetDepth: number,
    CurrentDepth: number,
): BeforeHopExpandEventArgs
Parameters
- Node: GraphNode
- TargetDepth: number
- CurrentDepth: number
Returns BeforeHopExpandEventArgs
Overrides CancellableGraphEventArgs.constructor
- Defined in events/graph-events.ts:89

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`CurrentDepth

CurrentDepth: number

`Readonly`Node

Node: GraphNode

`Readonly`TargetDepth

TargetDepth: number