pivotick / Pivot / PivotSaveContext
Interface: PivotSaveContext
Defined in: interfaces/Pivot.ts:174
Handed to PivotDefinition.save as the last argument. Mirrors PivotContext minus the narrowing concerns.
signal is here so a write can be forwarded like any other request, but the library never aborts it except when the graph is destroyed: cancelling a write mid-flight leaves nobody knowing what happened, which is worse than waiting.
Properties
graph
graph:
Pivotick
Defined in: interfaces/Pivot.ts:175
pivotId
pivotId:
string
Defined in: interfaces/Pivot.ts:176
promptData()
promptData: <
T>(options) =>Promise<T|null>
Defined in: interfaces/Pivot.ts:188
Ask the analyst for something before writing, in the library's own modal: a declarative form (fields) or custom HTML (render + getValues), titled and submitted with Save unless told otherwise. Resolves to the values, or null on cancel.
A save nobody clicked (PivotDefinition.autoSave, or PivotManagerLike.save called without interactive) gets null at once, with nothing drawn. Return { cancelled: true } after a null to leave the run pending with no toast.
Type Parameters
T
T = Record<string, unknown>
Parameters
options
Returns
Promise<T | null>
signal
signal:
AbortSignal
Defined in: interfaces/Pivot.ts:177