Aller au contenu

pivotick v3.0.0


pivotick / GraphUI / TopBarAction

Interface: TopBarAction ​

Défini dans : interfaces/GraphUI.ts:54

Une pilule hôte dans la barre supérieure : une action sur toute la toile, comme la sauvegarder. Chaque champ de fonction est relu sur UIManager.refreshTopBar, après un changement de données, et une fois qu'un onclick qui a renvoyé une promesse est réglé.

Propriétés ​

enabled? ​

optional enabled: boolean | (graph) => boolean

Défini dans : interfaces/GraphUI.ts:72

false dessine la pilule désactivée.

Valeur par défaut ​

ts
true

iconClass? ​

optional iconClass: string

Défini dans : interfaces/GraphUI.ts:61


id ​

id: string

Défini dans : interfaces/GraphUI.ts:56

Identifiant stable : la pilule est data-action et la clé UIManager.removeTopBarAction prend.


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

Défini dans : interfaces/GraphUI.ts:85

Lignes derrière un curseur : la pilule devient un bouton partagé, l'étiquette exécutant onclick et le curseur les ouvrant. Le même type de ligne que les menus contextuels, sans submenu. Le formulaire de fonction obtient le contexte, donc une ligne peut également demander ; il est appelé à chaque actualisation et à chaque ouverture, et aucune ligne ne signifie pas de curseur.


onclick()? ​

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

Défini dans : interfaces/GraphUI.ts:78

S'exécute sur un clic, ou Entrée/Espace sur la pilule ciblée. Une promesse renvoyée désactive la pilule jusqu'à ce qu'elle se stabilise, donc une sauvegarde lente ne peut pas être lancée deux fois, puis actualise chaque action.

Paramètres ​

evt ​

MouseEvent | KeyboardEvent

ctx ​

TopBarActionContext

Renvoie ​

void | Promise<void>


placement? ​

optional placement: "end" | "start"

Défini dans : interfaces/GraphUI.ts:68

'start' suit les pilules intégrées à gauche ; 'end' se trouve juste avant le groupe d'annulation-rétablissement sur la droite. Ordre de déclaration au sein de chacun.

Valeur par défaut ​

ts
'end'

shortcut? ​

optional shortcut: string

Défini dans : interfaces/GraphUI.ts:87

Présenté sous forme de badge sur la pilule. Visuel uniquement : la liaison appartient à l'hôte à enregistrer.


svgIcon? ​

optional svgIcon: string

Défini dans : interfaces/GraphUI.ts:62


text ​

text: string | (graph) => string

Défini dans : interfaces/GraphUI.ts:58

Le libellé : "Enregistrer sous le graphique", puis "Mettre à jour le graphique" une fois enregistré.


title? ​

optional title: string | (graph) => string

Défini dans : interfaces/GraphUI.ts:60

Affiché au survol.


visible? ​

optional visible: boolean | (graph) => boolean

Défini dans : interfaces/GraphUI.ts:70

false ne tire aucune pilule.

Valeur par défaut ​

ts
true