pivotick / Pivot / PivotCandidateSet
Interface: PivotCandidateSet
Defined in: interfaces/Pivot.ts:492
One fetch's worth of candidates, held for triage. There is at most one set per pivot id: a re-run replaces it.
Properties
carried?
optionalcarried:RawEdge[]
Defined in: interfaces/Pivot.ts:515
Edges that are not rows: they follow their endpoints and land iff both ends end up on canvas. Not shown in triage — an edge to a node the analyst did not take is not a decision of its own.
deduped
deduped:
number
Defined in: interfaces/Pivot.ts:504
How many of them are already on canvas.
edges
edges:
PivotCandidateEdge[]
Defined in: interfaces/Pivot.ts:509
Edge-only results: both endpoints already on canvas, so they are rows of their own.
error?
optionalerror:unknown
Defined in: interfaces/Pivot.ts:530
Set when fetch rejected — the pane offers a retry.
fetched
fetched:
number
Defined in: interfaces/Pivot.ts:502
How many nodes the provider returned, before dedup or suppression.
label
label:
string
Defined in: interfaces/Pivot.ts:494
loading
loading:
boolean
Defined in: interfaces/Pivot.ts:517
True while fetch is in flight.
narrowing
narrowing:
PivotNarrowing
Defined in: interfaces/Pivot.ts:498
The narrowing this set was fetched with.
nodes
nodes:
PivotCandidate[]
Defined in: interfaces/Pivot.ts:507
origin
origin:
Node[]
Defined in: interfaces/Pivot.ts:496
The nodes the pivot was run on. Empty for an origin-less pivot.
pending?
optionalpending:PivotCandidateSet
Defined in: interfaces/Pivot.ts:542
A re-run of this pivot, waiting rather than replacing: it landed while rows were marked, and throwing the analyst's triage away unasked is not a swap the library gets to make. The surface announces it and offers both ways out — PivotManagerLike.showPending and PivotManagerLike.dismissPending.
A re-run with nothing marked replaces outright, and never lands here.
pivotId
pivotId:
string
Defined in: interfaces/Pivot.ts:493
provisional?
optionalprovisional:boolean
Defined in: interfaces/Pivot.ts:528
The run might still land without triage, so nothing here has been offered yet. The set exists from the moment fetch starts — that is what makes the run watchable and cancellable — but a surface must not put a provisional set in front of the analyst: it is about to disappear onto the canvas, and taking the screen to say so costs more than the result it is announcing.
Cleared the moment the run turns out to need triage, which is the surface's cue to come forward. A run that was always going to stage is never provisional.
refused?
optionalrefused:PivotRefusal
Defined in: interfaces/Pivot.ts:532
Set when the provider blew through the absolute ceiling. Nothing was staged.
runId
runId:
string
Defined in: interfaces/Pivot.ts:500
The id this set's first ingest will be recorded under.
suppressed
suppressed:
number
Defined in: interfaces/Pivot.ts:506
How many were dropped because they were explicitly rejected earlier this session.