Skip to content

pivotick v3.0.0


pivotick / GraphUI / TopBarActionContext

Interface: TopBarActionContext ​

Defined in: interfaces/GraphUI.ts:95

What a TopBarAction's onclick and menu are handed.

Properties ​

confirm() ​

confirm: (options?) => Promise<boolean>

Defined in: interfaces/GraphUI.ts:104

Ask before doing something; resolves true only on the confirm button.

Parameters ​

options? ​

ConfirmOptions

Returns ​

Promise<boolean>


graph ​

graph: Pivotick

Defined in: interfaces/GraphUI.ts:96


promptData() ​

promptData: <T>(options) => Promise<T | null>

Defined in: interfaces/GraphUI.ts:102

Open the library's modal and resolve to the values, or null on cancel. The same declarative form the editors and a pivot's save use; titled with the action's label and submitted with OK unless the options say otherwise.

Type Parameters ​

T ​

T = Record<string, unknown>

Parameters ​

options ​

PromptDataOptions<T>

Returns ​

Promise<T | null>


refresh() ​

refresh: () => void

Defined in: interfaces/GraphUI.ts:106

Re-read every action's fields, as UIManager.refreshTopBar does.

Returns ​

void