#DashboardThemeBuilder

Builder chủ đề Dashboard. Quản lý cấu hình, chủ đề có sẵn, đăng ký theo dõi và đăng ký VSeed; thành phần dùng kết quả đã phân giải.

#Phương thức

#constructor

Định nghĩa:

constructor(dsl: Y.Map<any>)

Tham số:

#observe

Theo dõi thay đổi tên hoặc cấu hình từ thao tác cục bộ, hoàn tác/làm lại và đồng bộ cộng tác. Trả về hàm hủy đăng ký.

Định nghĩa:

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

Trả về: () => void

Tham số:

#setTheme

Chọn chủ đề. Cấu hình tùy chọn được lưu và chọn trong một thay đổi, không cần đăng ký trước và không sửa tài nguyên biểu đồ.

Định nghĩa:

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

Trả về: void

Tham số:

#registerTheme

Đăng ký hoặc cập nhật chủ đề trong tài liệu mà không chọn nó. Cấu hình được lưu và đồng bộ cùng tài liệu.

Định nghĩa:

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

Trả về: void

Tham số:

#getThemeConfig

Trả về bản sao cấu hình, ưu tiên tài liệu hơn chủ đề có sẵn. Trả về undefined nếu không có cấu hình.

Định nghĩa:

getThemeConfig(theme?: string): VBIDashboardThemeDefinition | undefined

Trả về: VBIDashboardThemeDefinition \| undefined

Tham số:

#getThemeDefinitions

Trả về bản sao của tất cả cấu hình chủ đề trong tài liệu. Dùng observe để theo dõi danh sách chủ đề khả dụng.

Định nghĩa:

getThemeDefinitions(): Record<string, VBIDashboardThemeDefinition>

Trả về: Record<string, VBIDashboardThemeDefinition>

#getThemeOptions

Liệt kê tên, chế độ sáng/tối và bảng màu của chủ đề có sẵn và trong tài liệu. Cấu hình tài liệu được ưu tiên khi trùng tên.

Định nghĩa:

getThemeOptions(): VBIDashboardThemeOption[]

Trả về: VBIDashboardThemeOption[]

#resolveTheme

Phân giải chủ đề và bảo đảm đăng ký VSeed với tên chạy độc lập. Tên không xác định dùng light-default mà không sửa tài liệu.

Định nghĩa:

resolveTheme(theme?: string): VBIDashboardResolvedTheme

Trả về: VBIDashboardResolvedTheme

Tham số:

#getTheme

Lấy tên chủ đề, mặc định là light-default.

Định nghĩa:

getTheme(): string

Trả về: string

#toJSON

Xuất tên chủ đề.

Định nghĩa:

toJSON(): string

Trả về: string