WidgetGridService

service

Service managing a widget grid. Also includes a set of labels that will be used by the grid and its widgets. Default labels are provided out of the box. But if you want to use custom ones or add i18n you could overwrite them. The grid as well as the widgets will use those labels or fall back to their default ones. If you are developing own widgets you should consider using those labels as well.

Properties

addItemSize

Type: AddItemSize

Default Value: \{ rows: 2, cols: 3 \}

widgetGrid$

Type: Observable<WidgetGridItem[]>

Default Value: this.#widgetGridSource.asObservable()

widgetGridUpdate$

Type: Observable<string>

Default Value: this.#widgetGridUpdateSource.asObservable()

Emitted when the widget grid has been updated

Methods

addWidget

Add a new grid item to the widget grid.

addWidget(widgetName: string, setupWidgetConfig?: unknown): void

Arguments

Name	Type	Description
widgetName	string
setupWidgetConfig	unknown

removeWidget

removeWidget(gridItemId: string): void

Arguments

Name	Type	Description
gridItemId	string

replaceWidget

replaceWidget(widgetId: string, widgetName: string, setupWidgetConfig?: unknown): void

Arguments

Name	Type	Description
widgetId	string
widgetName	string
setupWidgetConfig	unknown

setWidgetGrid

setWidgetGrid(gridItemConfig: WidgetGridItemConfig[] | undefined): void

Arguments

Name	Type	Description
gridItemConfig	WidgetGridItemConfig[] | undefined

updateWidget

Update config of an existing widget

updateWidget(widgetId: string, setupWidgetConfig: unknown): void

Arguments

Name	Type	Description
widgetId	string
setupWidgetConfig	unknown