#DashboardThemeBuilder

Dashboard-Theme-Builder. Verwaltet Definitionen, Vorlagen, Beobachtung und VSeed-Registrierung; Komponenten verwenden das aufgelöste Ergebnis.

#Methoden

#constructor

Definition:

constructor(dsl: Y.Map<any>)

Parameter:

#observe

Beobachtet lokale, rückgängig gemachte, wiederholte und synchronisierte Änderungen an Namen oder Definitionen. Gibt eine Funktion zum Abmelden zurück.

Definition:

observe(callback: ObserveCallback): () => void

Rückgabe: () => void

Parameter:

#setTheme

Wählt ein Theme. Eine optionale Definition wird im selben Schritt gespeichert und ausgewählt, ohne vorherige Registrierung oder Änderung der Diagrammressourcen.

Definition:

setTheme(theme: string, definition?: VBIDashboardThemeDefinition): void

Rückgabe: void

Parameter:

#registerTheme

Registriert oder aktualisiert ein Theme im Dokument, ohne es auszuwählen. Definitionen werden mit dem Dokument gespeichert und synchronisiert.

Definition:

registerTheme(theme: string, definition: VBIDashboardThemeDefinition): void

Rückgabe: void

Parameter:

#getThemeConfig

Gibt eine Kopie der Definition zurück. Dokumentdefinitionen haben Vorrang vor integrierten Vorlagen. Fehlt eine Definition, wird undefined zurückgegeben.

Definition:

getThemeConfig(theme?: string): VBIDashboardThemeDefinition | undefined

Rückgabe: VBIDashboardThemeDefinition \| undefined

Parameter:

#getThemeDefinitions

Gibt Kopien aller Theme-Definitionen im Dokument zurück. observe abonniert Änderungen der verfügbaren Themes.

Definition:

getThemeDefinitions(): Record<string, VBIDashboardThemeDefinition>

Rückgabe: Record<string, VBIDashboardThemeDefinition>

#getThemeOptions

Liefert Namen, Modi und Paletten der integrierten und dokumenteigenen Themes. Bei gleichen Namen hat das Dokument Vorrang.

Definition:

getThemeOptions(): VBIDashboardThemeOption[]

Rückgabe: VBIDashboardThemeOption[]

#resolveTheme

Löst ein Theme auf und registriert es in VSeed mit isoliertem Laufzeitnamen. Unbekannte Namen fallen auf light-default zurück, ohne das Dokument zu ändern.

Definition:

resolveTheme(theme?: string): VBIDashboardResolvedTheme

Rückgabe: VBIDashboardResolvedTheme

Parameter:

#getTheme

Liest den Theme-Namen, standardmäßig light-default.

Definition:

getTheme(): string

Rückgabe: string

#toJSON

Exportiert den Theme-Namen.

Definition:

toJSON(): string

Rückgabe: string