#DashboardThemeBuilder

Builder de thèmes Dashboard. Gère les définitions, préréglages, abonnements et inscriptions VSeed ; les composants utilisent le résultat résolu.

#Méthodes

#constructor

Définition:

constructor(dsl: Y.Map<any>)

Paramètres:

#observe

Observe les changements de nom ou de configuration, y compris les modifications locales, annulations, rétablissements et synchronisations. Renvoie une fonction de désabonnement.

Définition:

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

Retour: () => void

Paramètres:

#setTheme

Sélectionne un thème. Une définition facultative est enregistrée et sélectionnée en une seule modification, sans inscription préalable ni modification des graphiques référencés.

Définition:

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

Retour: void

Paramètres:

#registerTheme

Enregistre ou actualise un thème dans le document sans le sélectionner. Les définitions sont sauvegardées et synchronisées avec le document.

Définition:

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

Retour: void

Paramètres:

#getThemeConfig

Renvoie une copie de la définition, en donnant priorité au document sur les préréglages intégrés. Renvoie undefined si elle est absente.

Définition:

getThemeConfig(theme?: string): VBIDashboardThemeDefinition | undefined

Retour: VBIDashboardThemeDefinition \| undefined

Paramètres:

#getThemeDefinitions

Renvoie des copies de toutes les définitions du document. observe permet de suivre les thèmes disponibles.

Définition:

getThemeDefinitions(): Record<string, VBIDashboardThemeDefinition>

Retour: Record<string, VBIDashboardThemeDefinition>

#getThemeOptions

Liste les noms, modes et palettes des thèmes intégrés et du document. Les définitions du document priment à nom égal.

Définition:

getThemeOptions(): VBIDashboardThemeOption[]

Retour: VBIDashboardThemeOption[]

#resolveTheme

Résout le thème et garantit son inscription VSeed sous un nom interne isolé. Un nom inconnu revient à light-default sans modifier le document.

Définition:

resolveTheme(theme?: string): VBIDashboardResolvedTheme

Retour: VBIDashboardResolvedTheme

Paramètres:

#getTheme

Obtient le nom du thème, light-default par défaut.

Définition:

getTheme(): string

Retour: string

#toJSON

Exporte le nom du thème.

Définition:

toJSON(): string

Retour: string