Skip to content

pivotick v3.0.0


pivotick / Pivot / PivotRun

Interface: PivotRun ​

Defined in: interfaces/Pivot.ts:551

One ingest, undoable as a unit. Holds the raw payload as well as the ids, so redo re-lands the recorded delta without refetching or re-gating.

Properties ​

at ​

at: number

Defined in: interfaces/Pivot.ts:576


childIds ​

childIds: string[]

Defined in: interfaces/Pivot.ts:566

Nodes this run added inside a container: a new container's own subtree, and children merged into a container already on canvas. Undone before the top-level nodes, so nothing is left orphaned in the graph.


edgeIds ​

edgeIds: string[]

Defined in: interfaces/Pivot.ts:568

Edges this run added.


edges ​

edges: RawEdge[]

Defined in: interfaces/Pivot.ts:575


nodeIds ​

nodeIds: string[]

Defined in: interfaces/Pivot.ts:560

Top-level nodes this run added.


nodes ​

nodes: RawNode[]

Defined in: interfaces/Pivot.ts:574


origin ​

origin: Node[]

Defined in: interfaces/Pivot.ts:558

The nodes the pivot was run on. Empty for an origin-less pivot, and what a save payload carries as "which event does this attach to".


pivotId ​

pivotId: string

Defined in: interfaces/Pivot.ts:553


restage? ​

optional restage: PivotRestageRecord

Defined in: interfaces/Pivot.ts:589

What this ingest took out of the staged set. Only the newest ingest is ever re-staged, so this is a record of what could be restored rather than a promise that it will be.


runId ​

runId: string

Defined in: interfaces/Pivot.ts:552


saved ​

saved: number

Defined in: interfaces/Pivot.ts:583

How many of this run's elements have been written to the source system — nodes, children and edges together. A surface reads it to warn before an undo rather than after: undo takes things off the canvas and issues no compensating write, so what was saved stays saved upstream.


unions ​

unions: object[]

Defined in: interfaces/Pivot.ts:573

Children merged into a node already on canvas, so redo can merge them again.

children ​

children: RawNode[]

parentId ​

parentId: string


vouchedEdgeIds ​

vouchedEdgeIds: string[]

Defined in: interfaces/Pivot.ts:571


vouchedNodeIds ​

vouchedNodeIds: string[]

Defined in: interfaces/Pivot.ts:570

Elements already on canvas that this run vouched for without adding.