Naar inhoud

pivotick v3.0.0


draaipunt / GraphUI / TopBarAction

Interface: TopBarAction ​

Gedefinieerd in: interfaces/GraphUI.ts:54

Eén hostpil in de bovenste balk: een actie op het hele canvas, zoals het opslaan ervan. Elk functieveld wordt opnieuw ingelezen op UIManager.refreshTopBar, na een data veranderen, en zodra een onclick een belofte heeft teruggegeven, wordt deze afgehandeld.

Eigenschappen ​

enabled? ​

optional enabled: boolean | (graph) => boolean

Gedefinieerd in: interfaces/GraphUI.ts:72

false trekt de pil uitgeschakeld.

Standaard ​

ts
true

iconClass? ​

optional iconClass: string

Gedefinieerd in: interfaces/GraphUI.ts:61


id ​

id: string

Gedefinieerd in: interfaces/GraphUI.ts:56

Stabiele id: de pil data-action en de sleutel UIManager.removeTopBarAction neemt.


optional menu: MenuActionItemOptions<UIElement>[] | (ctx) => MenuActionItemOptions<UIElement>[]

Gedefinieerd in: interfaces/GraphUI.ts:85

Rijen achter een dakje: de pil wordt een splitsknop, het label loopt met onclick en het dakje dat deze opent. Hetzelfde rijtype als de contextmenu's, zonder submenu. De functievorm krijgt de context, dus een rij kan ook vragen; het wordt genoemd bij elke vernieuwing en elke opening, en geen rijen betekent geen dakje.


onclick()? ​

optional onclick: (evt, ctx) => void | Promise<void>

Gedefinieerd in: interfaces/GraphUI.ts:78

Wordt uitgevoerd met een klik, of Enter / Space op de gerichte pil. Een geretourneerde belofte wordt uitgeschakeld de pil totdat deze is bezinkt, dus een langzame opslag kan niet twee keer worden gestart en vervolgens worden vernieuwd elke actie.

Parameters ​

evt ​

MouseEvent | KeyboardEvent

ctx ​

TopBarActionContext

Retouren ​

void | Promise<void>


placement? ​

optional placement: "end" | "start"

Gedefinieerd in: interfaces/GraphUI.ts:68

'start' volgt de ingebouwde pillen aan de linkerkant; 'end' zit vlak voor de groep ongedaan maken-opnieuw aan de rechterkant. Aangiftevolgorde binnen elk.

Standaard ​

ts
'end'

shortcut? ​

optional shortcut: string

Gedefinieerd in: interfaces/GraphUI.ts:87

Getoond als een badge op de pil. Alleen visueel: de binding moet door de host worden geregistreerd.


svgIcon? ​

optional svgIcon: string

Gedefinieerd in: interfaces/GraphUI.ts:62


text ​

text: string | (graph) => string

Gedefinieerd in: interfaces/GraphUI.ts:58

Het label: "Opslaan als grafiek" en vervolgens "Grafiek bijwerken" zodra het is opgeslagen.


title? ​

optional title: string | (graph) => string

Gedefinieerd in: interfaces/GraphUI.ts:60

Getoond bij zweven.


visible? ​

optional visible: boolean | (graph) => boolean

Gedefinieerd in: interfaces/GraphUI.ts:70

false trekt geen pil.

Standaard ​

ts
true