pivotick v3.0.0

---

pivotick / GraphInteractions / GraphInteractions

Class: GraphInteractions<TElement>

Defined in: GraphInteractions.ts:20

Type Parameters

TElement

TElement = unknown

Constructors

Constructor

new GraphInteractions<TElement>(graph): GraphInteractions<TElement>

Defined in: GraphInteractions.ts:33

Parameters

graph

Pivotick

Returns

GraphInteractions<TElement>

Methods

addNodesToSelection()

addNodesToSelection(addSelection): void

Defined in: GraphInteractions.ts:633

Parameters

addSelection

NodeSelection<TElement>[]

Returns

void

---

badgeClick()

badgeClick(element, event, node, badge): void

Defined in: GraphInteractions.ts:120

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

---

canvasBeforeZoom()

canvasBeforeZoom(event): boolean

Defined in: GraphInteractions.ts:454

Parameters

event

unknown

Returns

boolean

---

canvasClick()

canvasClick(event): void

Defined in: GraphInteractions.ts:420

Parameters

event

PointerEvent

Returns

void

---

canvasContextmenu()

canvasContextmenu(event): void

Defined in: GraphInteractions.ts:482

Parameters

event

PointerEvent

Returns

void

---

canvasMousemove()

canvasMousemove(event): void

Defined in: GraphInteractions.ts:500

Parameters

event

MouseEvent

Returns

void

---

canvasPointerDown()

canvasPointerDown(event): void

Defined in: GraphInteractions.ts:440

Parameters

event

PointerEvent

Returns

void

---

canvasPointerUp()

canvasPointerUp(event): void

Defined in: GraphInteractions.ts:447

Parameters

event

PointerEvent

Returns

void

---

canvasZoom()

canvasZoom(event): void

Defined in: GraphInteractions.ts:473

Parameters

event

unknown

Returns

void

---

clearEdgeSelectionList()

clearEdgeSelectionList(): void

Defined in: GraphInteractions.ts:743

Returns

void

---

clearNodeSelectionList()

clearNodeSelectionList(): void

Defined in: GraphInteractions.ts:724

Returns

void

---

dragended()

dragended(event, node): void

Defined in: GraphInteractions.ts:225

Parameters

event

PointerEvent

node

Node

Returns

void

---

dragging()

dragging(event, node): void

Defined in: GraphInteractions.ts:218

Parameters

event

PointerEvent

node

Node

Returns

void

---

edgeClick()

edgeClick(element, event, drawn): void

Defined in: GraphInteractions.ts:232

Parameters

element

TElement

event

PointerEvent

drawn

Edge

Returns

void

---

edgeContextmenu()

edgeContextmenu(element, event, drawn): void

Defined in: GraphInteractions.ts:271

Parameters

element

TElement

event

PointerEvent

drawn

Edge

Returns

void

---

edgeDbclick()

edgeDbclick(element, event, drawn): void

Defined in: GraphInteractions.ts:252

Parameters

element

TElement

event

PointerEvent

drawn

Edge

Returns

void

---

edgeHoverIn()

edgeHoverIn(element, event, drawn): void

Defined in: GraphInteractions.ts:290

Parameters

element

TElement

event

PointerEvent

drawn

Edge

Returns

void

---

edgeHoverOut()

edgeHoverOut(element, event, drawn): void

Defined in: GraphInteractions.ts:298

Parameters

element

TElement

event

PointerEvent

drawn

Edge

Returns

void

---

expandNodeSelection()

expandNodeSelection(): void

Defined in: GraphInteractions.ts:790

Expand or collapse the selected clusters, and open or close the selected groups.

Returns

void

---

getGraph()

getGraph(): Pivotick

Defined in: GraphInteractions.ts:71

Returns

Pivotick

---

getLastPointerEvent()

getLastPointerEvent(): MouseEvent | null

Defined in: GraphInteractions.ts:802

Returns

MouseEvent | null

---

getSelectedEdge()

getSelectedEdge(): EdgeSelection<TElement> | null

Defined in: GraphInteractions.ts:769

Returns

EdgeSelection<TElement> | null

---

getSelectedEdgeIDs()

getSelectedEdgeIDs(): string[] | null

Defined in: GraphInteractions.ts:781

Returns

string[] | null

---

getSelectedEdges()

getSelectedEdges(): EdgeSelection<TElement>[]

Defined in: GraphInteractions.ts:785

Returns

EdgeSelection<TElement>[]

---

getSelectedNode()

getSelectedNode(): NodeSelection<TElement> | null

Defined in: GraphInteractions.ts:765

Returns

NodeSelection<TElement> | null

---

getSelectedNodeIDs()

getSelectedNodeIDs(): string[] | null

Defined in: GraphInteractions.ts:773

Returns

string[] | null

---

getSelectedNodes()

getSelectedNodes(): NodeSelection<TElement>[]

Defined in: GraphInteractions.ts:777

Returns

NodeSelection<TElement>[]

---

hasActiveMultiselection()

hasActiveMultiselection(): boolean

Defined in: GraphInteractions.ts:756

Returns

boolean

---

nodeClick()

nodeClick(element, event, node): void

Defined in: GraphInteractions.ts:84

Parameters

element

TElement

event

PointerEvent

node

Node

Returns

void

---

nodeContextmenu()

nodeContextmenu(element, event, node): void

Defined in: GraphInteractions.ts:161

Parameters

element

TElement

event

PointerEvent

node

Node

Returns

void

---

nodeDbclick()

nodeDbclick(element, event, node): void

Defined in: GraphInteractions.ts:141

Parameters

element

TElement

event

PointerEvent

node

Node

Returns

void

---

nodeHoverIn()

nodeHoverIn(element, event, node): void

Defined in: GraphInteractions.ts:204

Parameters

element

TElement

event

PointerEvent

node

Node

Returns

void

---

nodeHoverOut()

nodeHoverOut(element, event, node): void

Defined in: GraphInteractions.ts:211

Parameters

element

TElement

event

PointerEvent

node

Node

Returns

void

---

nodePointerDown()

nodePointerDown(element, event, node): void

Defined in: GraphInteractions.ts:179

Parameters

element

TElement

event

PointerEvent

node

Node

Returns

void

---

nodePointerUp()

nodePointerUp(element, event, node): void

Defined in: GraphInteractions.ts:197

Parameters

element

TElement

event

PointerEvent

node

Node

Returns

void

---

noteClick()

noteClick(element, event, note): void

Defined in: GraphInteractions.ts:306

Parameters

element

TElement

event

PointerEvent

note

Note

Returns

void

---

noteContextmenu()

noteContextmenu(element, event, note): void

Defined in: GraphInteractions.ts:342

Parameters

element

TElement

event

PointerEvent

note

Note

Returns

void

---

noteDbclick()

noteDbclick(element, event, note): void

Defined in: GraphInteractions.ts:324

Parameters

element

TElement

event

PointerEvent

note

Note

Returns

void

---

noteDragging()

noteDragging(event, note): void

Defined in: GraphInteractions.ts:413

Parameters

event

PointerEvent

note

Note

Returns

void

---

noteHandleClick()

noteHandleClick(handle, event, note): void

Defined in: GraphInteractions.ts:388

Parameters

handle

HTMLElement

event

PointerEvent

note

Note

Returns

void

---

noteHandlePointerDown()

noteHandlePointerDown(handle, event, note): void

Defined in: GraphInteractions.ts:406

Parameters

handle

HTMLElement

event

PointerEvent

note

Note

Returns

void

---

noteHoverIn()

noteHoverIn(element, event, note): void

Defined in: GraphInteractions.ts:360

Parameters

element

TElement

event

PointerEvent

note

Note

Returns

void

---

noteHoverOut()

noteHoverOut(element, event, note): void

Defined in: GraphInteractions.ts:367

Parameters

element

TElement

event

PointerEvent

note

Note

Returns

void

---

notePointerDown()

notePointerDown(element, event, note): void

Defined in: GraphInteractions.ts:374

Parameters

element

TElement

event

PointerEvent

note

Note

Returns

void

---

notePointerUp()

notePointerUp(element, event, note): void

Defined in: GraphInteractions.ts:381

Parameters

element

TElement

event

PointerEvent

note

Note

Returns

void

---

off()

off<K>(event, handler): void

Defined in: GraphInteractions.ts:64

Type Parameters

K

K extends keyof GraphInteractionEvents<TElement>

Parameters

event

K

handler

GraphInteractionEvents<TElement>[K]

Returns

void

---

on()

on<K>(event, handler): void

Defined in: GraphInteractions.ts:57

Type Parameters

K

K extends keyof GraphInteractionEvents<TElement>

Parameters

event

K

handler

GraphInteractionEvents<TElement>[K]

Returns

void

---

refreshRendering()

refreshRendering(): void

Defined in: GraphInteractions.ts:760

Returns

void

---

removeNodesFromSelection()

removeNodesFromSelection(removeSelection): void

Defined in: GraphInteractions.ts:654

Parameters

removeSelection

NodeSelection<TElement>[]

Returns

void

---

selectEdge()

selectEdge(element, edge): void

Defined in: GraphInteractions.ts:669

Parameters

element

TElement

edge

Edge

Returns

void

---

selectEdges()

selectEdges(selection): void

Defined in: GraphInteractions.ts:683

Parameters

selection

[Edge, TElement][]

Returns

void

---

selectNode()

selectNode(element, node): void

Defined in: GraphInteractions.ts:522

Parameters

element

TElement

node

Node

Returns

void

---

selectNodes()

selectNodes(selection): void

Defined in: GraphInteractions.ts:619

Parameters

selection

NodeSelection<TElement>[]

Returns

void

---

simulationSlowTick()

simulationSlowTick(): void

Defined in: GraphInteractions.ts:515

Returns

void

---

simulationTick()

simulationTick(): void

Defined in: GraphInteractions.ts:508

Returns

void

---

unselectAll()

unselectAll(): void

Defined in: GraphInteractions.ts:716

Returns

void

---

unselectEdge()

unselectEdge(): void

Defined in: GraphInteractions.ts:702

Returns

void

---

unselectNode()

unselectNode(): void

Defined in: GraphInteractions.ts:537

Returns

void