Zum Inhalt springen

pivotick v3.0.0


pivotick / Notifier

Interface: Notifier ​

Definiert in: ui/Notifier.ts:197

Verwaltet und zeigt Benachrichtigungsmeldungen in der Diagramm-Benutzeroberfläche an.

Verwenden Sie diese Komponente, um dem Benutzer Erfolgs-, Warn-, Fehler- oder Infomeldungen anzuzeigen.

Beispiele ​

ts
graph.notifier.warning('This is a warning', 'Content of the message goes here.')

Eine Benachrichtigung kann auch eine Aktion ausführen und die standardmäßigen vier Sekunden überdauern. Auf diese Weise bietet sich ein Ergebnis an, sich selbst rückgängig zu machen:

ts
const toast = graph.notifier.success('Ingested 12 nodes', undefined, {
    action: { label: 'Undo', onClick: (t) => { undo(); t.update({ title: 'Undone' }) } },
})

Methoden ​

error() ​

error(title, message?, options?): NotificationHandle | undefined

Definiert in: ui/Notifier.ts:234

Parameter ​

title ​

string

message? ​

string

options? ​

Pick<Notification, "action" | "duration">

Rückgabewert ​

NotificationHandle | undefined


info() ​

info(title, message?, options?): NotificationHandle | undefined

Definiert in: ui/Notifier.ts:238

Parameter ​

title ​

string

message? ​

string

options? ​

Pick<Notification, "action" | "duration">

Rückgabewert ​

NotificationHandle | undefined


notify() ​

notify(level, title, message?, options?): NotificationHandle | undefined

Definiert in: ui/Notifier.ts:216

Senden Sie eine Benachrichtigung an den UIManager.

Parameter ​

level ​

NotificationLevel

Der Schweregrad der Benachrichtigung.

title ​

string

Der Titel, der in der Benachrichtigung angezeigt werden soll.

message? ​

string

Optionale detaillierte Nachricht für die Benachrichtigung.

options? ​

Pick<Notification, "action" | "duration">

Eine Aktion, die Sie anbieten möchten, und wie lange Sie bleiben sollten.

Rückgabewert ​

NotificationHandle | undefined

Ein Handle auf dem Toast oder undefined, wo es nirgendwo eine Anzeige gibt (ein UI-Modus ohne Benachrichtigungsslot).


success() ​

success(title, message?, options?): NotificationHandle | undefined

Definiert in: ui/Notifier.ts:226

Parameter ​

title ​

string

message? ​

string

options? ​

Pick<Notification, "action" | "duration">

Rückgabewert ​

NotificationHandle | undefined


warning() ​

warning(title, message?, options?): NotificationHandle | undefined

Definiert in: ui/Notifier.ts:230

Parameter ​

title ​

string

message? ​

string

options? ​

Pick<Notification, "action" | "duration">

Rückgabewert ​

NotificationHandle | undefined