YuvWidgetGridWorkspacesComponent
Component for managing multiple widget grids in so called workspaces. Each workspace can have its own configuration and widgets. The user can switch between workspaces to use or edit the widgets in the current workspace.
Component Metadata
Section titled “Component Metadata”Selector: yuv-widget-grid-workspaces
Standalone: No
Inputs
Section titled “Inputs”buckets
Section titled “buckets”Type: string[] | undefined
Default Value: undefined
Collection of buckets to load available widgets from. Wildcards are also posssible: [buckets]="['app.default', '*.public.*', 'app.no?.widgets']"``* represents any character 0-n times ? represents exactly one character
options
Section titled “options”Type: WidgetGridWorkspaceOptions
Default Value: this.#DEFAULT_WORKSPACE_OPTIONS
workspaceConfig
Section titled “workspaceConfig”Type: WidgetGridWorkspaceConfig | undefined
Default Value: undefined
Outputs
Section titled “Outputs”configChange
Section titled “configChange”Type: WidgetGridWorkspaceConfig | undefined
editModeChange
Section titled “editModeChange”Type: boolean
gridItemEvent
Section titled “gridItemEvent”Type: GridItemEvent
Properties
Section titled “Properties”_workspaceConfig
Section titled “_workspaceConfig”Type: unknown
Default Value: signal<WidgetGridWorkspaceConfig | undefined>(undefined)
_workspaceOptions
Section titled “_workspaceOptions”Type: unknown
Default Value: computed<WidgetGridWorkspaceOptions>(() => (\{ gridConfig: \{ ...this.#DEFAULT_WORKSPACE_OPTIONS.gridConfig, ...(this.options().gridConfig || \{\}) \} \}))
editMode
Section titled “editMode”Type: unknown
Default Value: signal<boolean>(false)
gridItemConfig
Section titled “gridItemConfig”Type: unknown
Default Value: signal<WidgetGridItemConfig[] | undefined>(undefined)
translate
Section titled “translate”Type: unknown
Default Value: inject(TranslateService)
workspace
Section titled “workspace”Type: unknown
Default Value: signal<WidgetGridWorkspace | undefined>(undefined)
workspaceDialogRef
Section titled “workspaceDialogRef”Type: MatDialogRef<unknown | unknown>
workspaceForm
Section titled “workspaceForm”Type: unknown
Default Value: this.#fb.group(\{ id: [''], label: ['', Validators.required] \})
workspaceLabel
Section titled “workspaceLabel”Type: unknown
Default Value: signal<string>('')
Methods
Section titled “Methods”getLabel
Section titled “getLabel”getLabel(workspace: WidgetGridWorkspace): stringArguments
Section titled “Arguments”| Name | Type | Description |
|---|---|---|
| workspace | WidgetGridWorkspace |
onDeleteCurrentWorkspace
Section titled “onDeleteCurrentWorkspace”onDeleteCurrentWorkspace(): voidonEnableEditMode
Section titled “onEnableEditMode”onEnableEditMode(): voidonGridChange
Section titled “onGridChange”onGridChange(grid: WidgetGridItemConfig[]): voidArguments
Section titled “Arguments”| Name | Type | Description |
|---|---|---|
| grid | WidgetGridItemConfig[] |
onGridEvent
Section titled “onGridEvent”onGridEvent(gridItemEvent: GridItemEvent): voidArguments
Section titled “Arguments”| Name | Type | Description |
|---|---|---|
| gridItemEvent | GridItemEvent |
onOpenWorkspaceDialog
Section titled “onOpenWorkspaceDialog”onOpenWorkspaceDialog(create: boolean, tplRef: TemplateRef<unknown>): voidArguments
Section titled “Arguments”| Name | Type | Description |
|---|---|---|
| create | boolean | |
| tplRef | TemplateRef<unknown> |
onPersistWorkspaceConfig
Section titled “onPersistWorkspaceConfig”Emit current changes and reset original workspace config internally
onPersistWorkspaceConfig(): voidonRevertWorkspaceConfig
Section titled “onRevertWorkspaceConfig”onRevertWorkspaceConfig(): voidonSaveWorkspace
Section titled “onSaveWorkspace”onSaveWorkspace(): voidonSetWorkspace
Section titled “onSetWorkspace”onSetWorkspace(id: string, silent: unknown): voidArguments
Section titled “Arguments”| Name | Type | Description |
|---|---|---|
| id | string | |
| silent | unknown |
onToggleEditMode
Section titled “onToggleEditMode”onToggleEditMode(): void