DashboardThemeBuilder

Builder tema Dashboard. Mengelola definisi, preset, langganan dan pendaftaran VSeed; komponen memakai hasil yang telah diresolusi.

Metode

constructor

Definisi:

constructor(dsl: Y.Map<any>)

Parameter:

ParameterTipeDeskripsi
dslY.Map-

observe

Mengamati perubahan nama atau definisi melalui perubahan lokal, undo/redo, dan sinkronisasi kolaboratif. Mengembalikan fungsi berhenti berlangganan.

Definisi:

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

Hasil: () => void

Parameter:

ParameterTipeDeskripsi
callbackObserveCallback- Callback perubahan tema

setTheme

Memilih tema. Definisi opsional disimpan dan dipilih dalam satu perubahan tanpa pendaftaran sebelumnya atau perubahan sumber daya grafik.

Definisi:

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

Hasil: void

Parameter:

ParameterTipeDeskripsi
themestring- Nama tema tidak kosong
definition?VBIDashboardThemeDefinition- Definisi lengkap opsional yang disimpan di Dashboard ini

registerTheme

Mendaftarkan atau memperbarui tema dalam dokumen tanpa memilihnya. Definisi disimpan dan disinkronkan bersama dokumen.

Definisi:

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

Hasil: void

Parameter:

ParameterTipeDeskripsi
themestring- Nama tema tidak kosong
definitionVBIDashboardThemeDefinition- Definisi tema lengkap

getThemeConfig

Mengembalikan salinan definisi dengan mengutamakan dokumen daripada preset bawaan. Mengembalikan undefined jika tidak ada.

Definisi:

getThemeConfig(theme?: string): VBIDashboardThemeDefinition | undefined

Hasil: VBIDashboardThemeDefinition \| undefined

Parameter:

ParameterTipeDeskripsi
theme? = this.getTheme()string- Nama tema, default tema saat ini

getThemeDefinitions

Mengembalikan salinan semua definisi tema dalam dokumen. Gunakan observe untuk mengikuti daftar tema yang tersedia.

Definisi:

getThemeDefinitions(): Record<string, VBIDashboardThemeDefinition>

Hasil: Record<string, VBIDashboardThemeDefinition>

getThemeOptions

Mendaftar nama, mode dan palet tema bawaan serta dokumen. Definisi dokumen didahulukan untuk nama yang sama.

Definisi:

getThemeOptions(): VBIDashboardThemeOption[]

Hasil: VBIDashboardThemeOption[]

resolveTheme

Meresolusi tema dan memastikan pendaftaran VSeed dengan nama runtime terisolasi. Nama tidak dikenal memakai light-default tanpa mengubah dokumen.

Definisi:

resolveTheme(theme?: string): VBIDashboardResolvedTheme

Hasil: VBIDashboardResolvedTheme

Parameter:

ParameterTipeDeskripsi
theme? = this.getTheme()string- Nama tema, default pilihan saat ini; dapat digunakan untuk pratinjau sementara tema lain

getTheme

Mengambil nama tema, dengan nilai default light-default.

Definisi:

getTheme(): string

Hasil: string

toJSON

Mengekspor nama tema.

Definisi:

toJSON(): string

Hasil: string