Class GraphInteractions<TElement>

Type Parameters

TElement = unknown

Index

Constructors

Methods

addNodesToSelection badgeClick canvasBeforeZoom canvasClick canvasContextmenu canvasMousemove canvasPointerDown canvasPointerUp canvasZoom clearEdgeSelectionList clearNodeSelectionList dragended dragging edgeClick edgeContextmenu edgeDbclick edgeHoverIn edgeHoverOut expandNodeSelection getGraph getLastPointerEvent getSelectedEdge getSelectedEdgeIDs getSelectedEdges getSelectedNode getSelectedNodeIDs getSelectedNodes hasActiveMultiselection nodeClick nodeContextmenu nodeDbclick nodeHoverIn nodeHoverOut nodePointerDown nodePointerUp noteClick noteContextmenu noteDbclick noteDragging noteHandleClick noteHandlePointerDown noteHoverIn noteHoverOut notePointerDown notePointerUp off on refreshRendering removeNodesFromSelection selectEdge selectEdges selectNode selectNodes simulationSlowTick simulationTick unselectAll unselectEdge unselectNode

Constructors

constructor

new GraphInteractions<TElement = unknown>(
graph: Pivotick,
): GraphInteractions.GraphInteractions<TElement>
Type Parameters
- TElement = unknown
Parameters
- graph: Pivotick
Returns GraphInteractions.GraphInteractions<TElement>
- Defined in GraphInteractions.ts:23

Methods

addNodesToSelection

addNodesToSelection(addSelection: NodeSelection<TElement>[]): void
Parameters
- addSelection: NodeSelection<TElement>[]
Returns void
- Defined in GraphInteractions.ts:617

badgeClick

badgeClick(
    element: TElement,
    event: PointerEvent,
    node: Node,
    badge: NodeBadge,
): void
A rim badge was clicked. Specific before general: the badge's own onClick runs first, then the graph-wide onBadgeClick. Neither can suppress the other — a bus listener calling cancel() is the one way to stop both.
Parameters
- element: TElement
- event: PointerEvent
- node: Node
- badge: NodeBadge
Returns void
- Defined in GraphInteractions.ts:110

canvasBeforeZoom

canvasBeforeZoom(event: unknown): boolean
Parameters
- event: unknown
Returns boolean
- Defined in GraphInteractions.ts:438

canvasClick

canvasClick(event: PointerEvent): void
Parameters
- event: PointerEvent
Returns void
- Defined in GraphInteractions.ts:404

canvasContextmenu

canvasContextmenu(event: PointerEvent): void
Parameters
- event: PointerEvent
Returns void
- Defined in GraphInteractions.ts:466

canvasMousemove

canvasMousemove(event: MouseEvent): void
Parameters
- event: MouseEvent
Returns void
- Defined in GraphInteractions.ts:484

canvasPointerDown

canvasPointerDown(event: PointerEvent): void
Parameters
- event: PointerEvent
Returns void
- Defined in GraphInteractions.ts:424

canvasPointerUp

canvasPointerUp(event: PointerEvent): void
Parameters
- event: PointerEvent
Returns void
- Defined in GraphInteractions.ts:431

canvasZoom

canvasZoom(event: unknown): void
Parameters
- event: unknown
Returns void
- Defined in GraphInteractions.ts:457

clearEdgeSelectionList

clearEdgeSelectionList(): void
Returns void
- Defined in GraphInteractions.ts:727

clearNodeSelectionList

clearNodeSelectionList(): void
Returns void
- Defined in GraphInteractions.ts:708

dragended

dragended(event: PointerEvent, node: Node): void
Parameters
- event: PointerEvent
- node: Node
Returns void
- Defined in GraphInteractions.ts:214

dragging

dragging(event: PointerEvent, node: Node): void
Parameters
- event: PointerEvent
- node: Node
Returns void
- Defined in GraphInteractions.ts:207

edgeClick

edgeClick(element: TElement, event: PointerEvent, edge: Edge): void
Parameters
- element: TElement
- event: PointerEvent
- edge: Edge
Returns void
- Defined in GraphInteractions.ts:221

edgeContextmenu

edgeContextmenu(element: TElement, event: PointerEvent, edge: Edge): void
Parameters
- element: TElement
- event: PointerEvent
- edge: Edge
Returns void
- Defined in GraphInteractions.ts:258

edgeDbclick

edgeDbclick(element: TElement, event: PointerEvent, edge: Edge): void
Parameters
- element: TElement
- event: PointerEvent
- edge: Edge
Returns void
- Defined in GraphInteractions.ts:240

edgeHoverIn

edgeHoverIn(element: TElement, event: PointerEvent, edge: Edge): void
Parameters
- element: TElement
- event: PointerEvent
- edge: Edge
Returns void
- Defined in GraphInteractions.ts:276

edgeHoverOut

edgeHoverOut(element: TElement, event: PointerEvent, edge: Edge): void
Parameters
- element: TElement
- event: PointerEvent
- edge: Edge
Returns void
- Defined in GraphInteractions.ts:283

expandNodeSelection

expandNodeSelection(): void
Returns void
- Defined in GraphInteractions.ts:773

getGraph

getGraph(): Pivotick
Returns Pivotick
- Defined in GraphInteractions.ts:61

getLastPointerEvent

getLastPointerEvent(): MouseEvent | null
Returns MouseEvent | null
- Defined in GraphInteractions.ts:783

getSelectedEdge

getSelectedEdge(): EdgeSelection<TElement> | null
Returns EdgeSelection<TElement> | null
- Defined in GraphInteractions.ts:753

getSelectedEdgeIDs

getSelectedEdgeIDs(): string[] | null
Returns string[] | null
- Defined in GraphInteractions.ts:765

getSelectedEdges

getSelectedEdges(): EdgeSelection<TElement>[]
Returns EdgeSelection<TElement>[]
- Defined in GraphInteractions.ts:769

getSelectedNode

getSelectedNode(): NodeSelection<TElement> | null
Returns NodeSelection<TElement> | null
- Defined in GraphInteractions.ts:749

getSelectedNodeIDs

getSelectedNodeIDs(): string[] | null
Returns string[] | null
- Defined in GraphInteractions.ts:757

getSelectedNodes

getSelectedNodes(): NodeSelection<TElement>[]
Returns NodeSelection<TElement>[]
- Defined in GraphInteractions.ts:761

hasActiveMultiselection

hasActiveMultiselection(): boolean
Returns boolean
- Defined in GraphInteractions.ts:740

nodeClick

nodeClick(element: TElement, event: PointerEvent, node: Node): void
Parameters
- element: TElement
- event: PointerEvent
- node: Node
Returns void
- Defined in GraphInteractions.ts:74

nodeContextmenu

nodeContextmenu(element: TElement, event: PointerEvent, node: Node): void
Parameters
- element: TElement
- event: PointerEvent
- node: Node
Returns void
- Defined in GraphInteractions.ts:150

nodeDbclick

nodeDbclick(element: TElement, event: PointerEvent, node: Node): void
Parameters
- element: TElement
- event: PointerEvent
- node: Node
Returns void
- Defined in GraphInteractions.ts:131

nodeHoverIn

nodeHoverIn(element: TElement, event: PointerEvent, node: Node): void
Parameters
- element: TElement
- event: PointerEvent
- node: Node
Returns void
- Defined in GraphInteractions.ts:193

nodeHoverOut

nodeHoverOut(element: TElement, event: PointerEvent, node: Node): void
Parameters
- element: TElement
- event: PointerEvent
- node: Node
Returns void
- Defined in GraphInteractions.ts:200

nodePointerDown

nodePointerDown(element: TElement, event: PointerEvent, node: Node): void
Parameters
- element: TElement
- event: PointerEvent
- node: Node
Returns void
- Defined in GraphInteractions.ts:168

nodePointerUp

nodePointerUp(element: TElement, event: PointerEvent, node: Node): void
Parameters
- element: TElement
- event: PointerEvent
- node: Node
Returns void
- Defined in GraphInteractions.ts:186

noteClick

noteClick(element: TElement, event: PointerEvent, note: Note): void
Parameters
- element: TElement
- event: PointerEvent
- note: Note
Returns void
- Defined in GraphInteractions.ts:290

noteContextmenu

noteContextmenu(element: TElement, event: PointerEvent, note: Note): void
Parameters
- element: TElement
- event: PointerEvent
- note: Note
Returns void
- Defined in GraphInteractions.ts:326

noteDbclick

noteDbclick(element: TElement, event: PointerEvent, note: Note): void
Parameters
- element: TElement
- event: PointerEvent
- note: Note
Returns void
- Defined in GraphInteractions.ts:308

noteDragging

noteDragging(event: PointerEvent, note: Note): void
Parameters
- event: PointerEvent
- note: Note
Returns void
- Defined in GraphInteractions.ts:397

noteHandleClick

noteHandleClick(handle: HTMLElement, event: PointerEvent, note: Note): void
Parameters
- handle: HTMLElement
- event: PointerEvent
- note: Note
Returns void
- Defined in GraphInteractions.ts:372

noteHandlePointerDown

noteHandlePointerDown(
    handle: HTMLElement,
    event: PointerEvent,
    note: Note,
): void
Parameters
- handle: HTMLElement
- event: PointerEvent
- note: Note
Returns void
- Defined in GraphInteractions.ts:390

noteHoverIn

noteHoverIn(element: TElement, event: PointerEvent, note: Note): void
Parameters
- element: TElement
- event: PointerEvent
- note: Note
Returns void
- Defined in GraphInteractions.ts:344

noteHoverOut

noteHoverOut(element: TElement, event: PointerEvent, note: Note): void
Parameters
- element: TElement
- event: PointerEvent
- note: Note
Returns void
- Defined in GraphInteractions.ts:351

notePointerDown

notePointerDown(element: TElement, event: PointerEvent, note: Note): void
Parameters
- element: TElement
- event: PointerEvent
- note: Note
Returns void
- Defined in GraphInteractions.ts:358

notePointerUp

notePointerUp(element: TElement, event: PointerEvent, note: Note): void
Parameters
- element: TElement
- event: PointerEvent
- note: Note
Returns void
- Defined in GraphInteractions.ts:365

off

off<K extends keyof GraphInteractionEvents<TElement>>(
event: K,
handler: GraphInteractionEvents<TElement>[K],
): void
Type Parameters
- K extends keyof GraphInteractionEvents<TElement>
Parameters
- event: K
- handler: GraphInteractionEvents<TElement>[K]
Returns void
- Defined in GraphInteractions.ts:54

on

on<K extends keyof GraphInteractionEvents<TElement>>(
event: K,
handler: GraphInteractionEvents<TElement>[K],
): void
Type Parameters
- K extends keyof GraphInteractionEvents<TElement>
Parameters
- event: K
- handler: GraphInteractionEvents<TElement>[K]
Returns void
- Defined in GraphInteractions.ts:47

refreshRendering

refreshRendering(): void
Returns void
- Defined in GraphInteractions.ts:744

removeNodesFromSelection

removeNodesFromSelection(removeSelection: NodeSelection<TElement>[]): void
Parameters
- removeSelection: NodeSelection<TElement>[]
Returns void
- Defined in GraphInteractions.ts:638

selectEdge

selectEdge(element: TElement, edge: Edge): void
Parameters
- element: TElement
- edge: Edge
Returns void
- Defined in GraphInteractions.ts:653

selectEdges

selectEdges(selection: [Edge, TElement][]): void
Parameters
- selection: [Edge, TElement][]
Returns void
- Defined in GraphInteractions.ts:667

selectNode

selectNode(element: TElement, node: Node): void
Parameters
- element: TElement
- node: Node
Returns void
- Defined in GraphInteractions.ts:506

selectNodes

selectNodes(selection: NodeSelection<TElement>[]): void
Parameters
- selection: NodeSelection<TElement>[]
Returns void
- Defined in GraphInteractions.ts:603

simulationSlowTick

simulationSlowTick(): void
Returns void
- Defined in GraphInteractions.ts:499

simulationTick

simulationTick(): void
Returns void
- Defined in GraphInteractions.ts:492

unselectAll

unselectAll(): void
Returns void
- Defined in GraphInteractions.ts:700

unselectEdge

unselectEdge(): void
Returns void
- Defined in GraphInteractions.ts:686

unselectNode

unselectNode(): void
Returns void
- Defined in GraphInteractions.ts:521

Class GraphInteractions<TElement>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns GraphInteractions.GraphInteractions<TElement>

Methods

addNodesToSelection

Parameters

Returns void

badgeClick

Parameters

Returns void

canvasBeforeZoom

Parameters

Returns boolean

canvasClick

Parameters

Returns void

canvasContextmenu

Parameters

Returns void

canvasMousemove

Parameters

Returns void

canvasPointerDown

Parameters

Returns void

canvasPointerUp

Parameters

Returns void

canvasZoom

Parameters

Returns void

clearEdgeSelectionList

Returns void

clearNodeSelectionList

Returns void

dragended

Parameters

Returns void

dragging

Parameters

Returns void

edgeClick

Parameters

Returns void

edgeContextmenu

Parameters

Returns void

edgeDbclick

Parameters

Returns void

edgeHoverIn

Parameters

Returns void

edgeHoverOut

Parameters

Returns void

expandNodeSelection

Returns void

getGraph

Returns Pivotick

getLastPointerEvent

Returns MouseEvent | null

getSelectedEdge

Returns EdgeSelection<TElement> | null

getSelectedEdgeIDs

Returns string[] | null

getSelectedEdges

Returns EdgeSelection<TElement>[]

getSelectedNode

Returns NodeSelection<TElement> | null

getSelectedNodeIDs

Returns string[] | null

getSelectedNodes