pivotick / Pivot / PivotManagerLike
Interface: PivotManagerLike
Defined in: interfaces/Pivot.ts:621
The shape Graph.pivots exposes. Declared as an interface so the consumer-facing surface is documented in one place and the implementation can stay internal.
Methods
all()
all():
PivotDefinition[]
Defined in: interfaces/Pivot.ts:640
Every registered pivot, in registration order.
Returns
applicableCount()
applicableCount(
node):number
Defined in: interfaces/Pivot.ts:653
How many pivots apply to one node — what the 'summary' rim badge counts. Held between graph changes, so it is cheap to ask per node per render.
Parameters
node
Returns
number
cancel()
cancel(
pivotId?,kind?):void
Defined in: interfaces/Pivot.ts:661
Abort in-flight calls — one pivot's or all, and optionally only one kind.
Parameters
pivotId?
string
kind?
"summarize" | "fetch"
Returns
void
canonicalId()
canonicalId(
element):string|undefined
Defined in: interfaces/Pivot.ts:695
The id the source system assigned this element when it was saved, when it assigned one. The element keeps its own id — re-keying reaches into edges, clusters, selection, the query engine and the history — so graph.getNode(canonicalId) still misses and this is the read that does not.
Parameters
element
Returns
string | undefined
dismissPending()
dismissPending(
pivotId):void
Defined in: interfaces/Pivot.ts:658
Drop a waiting re-run and keep triaging what is on show.
Parameters
pivotId
string
Returns
void
for()
for(
nodes):PivotDefinition[]
Defined in: interfaces/Pivot.ts:642
What applies to this origin. An empty origin yields the origin-less pivots.
Parameters
nodes
Node[]
Returns
get()
get(
id):PivotDefinition|undefined
Defined in: interfaces/Pivot.ts:638
Parameters
id
string
Returns
PivotDefinition | undefined
invalidate()
invalidate(
pivotId?,nodes?):void
Defined in: interfaces/Pivot.ts:659
Parameters
pivotId?
string
nodes?
Node[]
Returns
void
isSavable()
isSavable(
element):boolean
Defined in: interfaces/Pivot.ts:688
Whether this element belongs to a run whose pivot can write it anywhere.
Parameters
element
Returns
boolean
isSaved()
isSaved(
element):boolean
Defined in: interfaces/Pivot.ts:686
Written to the source system. false for the unsaved and the not-savable.
Parameters
element
Returns
boolean
originFor()
originFor(
id,nodes):Node[]
Defined in: interfaces/Pivot.ts:648
How much of nodes one pivot applies to — the origin it would actually be run with. Empty when it does not apply at all, and always empty for an origin-less pivot. What a surface reads to say "3 of the 5 you picked".
Parameters
id
string
nodes
Node[]
Returns
Node[]
register()
register(
definition): () =>void
Defined in: interfaces/Pivot.ts:636
Parameters
definition
Returns
():
void
Returns
void
run()
run(
id,nodes?,narrowing?,options?):Promise<PivotRunOutcome>
Defined in: interfaces/Pivot.ts:654
Parameters
id
string
nodes?
Node[]
narrowing?
options?
Returns
Promise<PivotRunOutcome>
save()
save(
target?,options?):Promise<PivotSaveReport>
Defined in: interfaces/Pivot.ts:677
Write ingested runs back to their source systems. Runs go one at a time, and a run whose pivot declares no save is never among them.
Each run is sent only what is still unsaved, so a retry is the same call.
Parameters
target?
A run id for one run, a pivot id for every unsaved run of that pivot, a PivotSaveSelection for just those elements, or nothing for all of them.
string | PivotSaveSelection
options?
interactive: true when an analyst asked for the save, so PivotSaveContext.promptData can open its modal.
Returns
Promise<PivotSaveReport>
showPending()
showPending(
pivotId):void
Defined in: interfaces/Pivot.ts:656
Promote a waiting re-run to the set on show.
Parameters
pivotId
string
Returns
void
unregister()
unregister(
id):void
Defined in: interfaces/Pivot.ts:637
Parameters
id
string
Returns
void
unsaved()
unsaved():
PivotRun[]
Defined in: interfaces/Pivot.ts:679
Savable runs with elements still on canvas and not yet written.
Returns
PivotRun[]
unsavedCount()
unsavedCount(
pivotId?):object
Defined in: interfaces/Pivot.ts:684
What a Save would send, exact rather than advisory. Narrowed to one pivot's runs when given an id — what a triage pane's own line counts.
Parameters
pivotId?
string
Returns
object
edges
edges:
number
nodes
nodes:
number
Properties
candidateCeiling
candidateCeiling:
number
Defined in: interfaces/Pivot.ts:623
Absolute ceiling on what one fetch may stage. Refuses rather than truncates.
quickIngestLimit
quickIngestLimit:
number
Defined in: interfaces/Pivot.ts:629
How many new candidates a one-click pivot lands without triage — what the UI manager's quickPivot passes as PivotRunOptions.autoIngestUpTo. A run made any other way is unaffected.
rimBadge
rimBadge:
PivotRimBadge
Defined in: interfaces/Pivot.ts:631
What the library draws on a node's rim for its pivots.
rimBadgeVisible
rimBadgeVisible:
PivotRimBadgeVisibility
Defined in: interfaces/Pivot.ts:633
When those rim badges are drawn.
saveControls
saveControls:
boolean
Defined in: interfaces/Pivot.ts:635
Whether the Pivot panel and the triage pane offer their own Save.