pivotick v3.0.0

---

Pivotick / GraphUI / TopBarAction

Interface: TopBarAction

Definiert in: interfaces/GraphUI.ts:54

Eine Host-Pille in der oberen Leiste: eine Aktion auf der gesamten Arbeitsfläche, beispielsweise das Speichern. Jedes Funktionsfeld wird auf UIManager.refreshTopBar erneut gelesen, nach einer Datenänderung und sobald ein onclick, das ein Versprechen zurückgegeben hat, erfüllt ist.

Eigenschaften

enabled?

optional enabled: boolean | (graph) => boolean

Definiert in: interfaces/GraphUI.ts:72

false zeichnet die Pille deaktiviert.

Standardwert

true

---

iconClass?

optional iconClass: string

Definiert in: interfaces/GraphUI.ts:61

---

id

id: string

Definiert in: interfaces/GraphUI.ts:56

Stabile ID: Die Pille ist data-action und der Schlüssel UIManager.removeTopBarAction dauert.

---

menu?

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

Definiert in: interfaces/GraphUI.ts:85

Zeilen hinter einer Einfügemarke: Die Pille wird zu einer geteilten Schaltfläche, die Beschriftung lautet onclick und die Einfügemarke öffnet diese. Derselbe Zeilentyp wie die Kontextmenüs, ohne submenu. Das Funktionsformular erhält den Kontext, sodass eine Zeile auch eine Eingabeaufforderung erstellen kann. Es wird bei jeder Aktualisierung und jedem Öffnen aufgerufen, und keine Zeilen bedeuten kein Caret.

---

onclick()?

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

Definiert in: interfaces/GraphUI.ts:78

Läuft mit einem Klick oder mit der Eingabe-/Leertaste auf der fokussierten Pille. Ein zurückgegebenes Versprechen deaktiviert die Pille, bis sie sich beruhigt, sodass ein langsamer Speicher nicht zweimal gestartet werden kann und dann jede Aktion aktualisiert wird.

Parameter

evt

MouseEvent | KeyboardEvent

ctx

TopBarActionContext

Rückgabewert

void | Promise<void>

---

placement?

optional placement: "end" | "start"

Definiert in: interfaces/GraphUI.ts:68

'start' folgt den integrierten Pillen auf der linken Seite; 'end' befindet sich direkt vor der Undo-Redo-Gruppe auf der rechten Seite. Deklarationsreihenfolge innerhalb jedes.

Standardwert

'end'

---

shortcut?

optional shortcut: string

Definiert in: interfaces/GraphUI.ts:87

Wird als Abzeichen auf der Pille angezeigt. Nur visuell: Die Bindung liegt beim Host, der sich registrieren muss.

---

svgIcon?

optional svgIcon: string

Definiert in: interfaces/GraphUI.ts:62

---

text

text: string | (graph) => string

Definiert in: interfaces/GraphUI.ts:58

Die Beschriftung: „Als Grafik speichern“, dann „Grafik aktualisieren“, sobald sie gespeichert ist.

---

title?

optional title: string | (graph) => string

Definiert in: interfaces/GraphUI.ts:60

Wird beim Schweben angezeigt.

---

visible?

optional visible: boolean | (graph) => boolean

Definiert in: interfaces/GraphUI.ts:70

false zieht keine Pille.

Standardwert

true