core/dashboard/dashboard.model.ts
Is used to configure a widget dashboard. It allows to set certain parameter that change the behavior of the dashboard.
Properties |
|
| alignViewHeight |
alignViewHeight:
|
Type : boolean
|
| Optional |
|
When true, the dashboard height is aligned to the current viewport height minus an offset. Only applicable when layout is 'custom'. |
| allowFullscreen |
allowFullscreen:
|
Type : boolean
|
|
Should the user be able to switch to fullscreen mode. |
| canCopy |
canCopy:
|
Type : boolean
|
| Optional |
|
If set to false, the dashboard can not be copied (default true). |
| canDelete |
canDelete:
|
Type : boolean
|
| Optional |
|
If set to false, the dashboard can not be removed (default true). |
| columns |
columns:
|
Type : number
|
| Optional |
|
The amount of columns on that dashboard. Can be freely chosen, but product uses either 12 or 24. |
| defaultHeight |
defaultHeight:
|
Type : number
|
|
New added widgets get that height attached (in css grid columns units) |
| defaultWidth |
defaultWidth:
|
Type : number
|
|
New added widgets get that width attached (in css grid row units) |
| float |
float:
|
Type : boolean
|
| Optional |
|
When true, widgets can be freely positioned and will not collapse upward. Only applicable when layout is 'custom'. |
| isDisabled |
isDisabled:
|
Type : boolean
|
|
If the dashboard is disabled, no changes on this dashboard are allowed. E.g. because the user doesn't have the rights. |
| isFrozen |
isFrozen:
|
Type : boolean
|
|
If the dashboard is frozen, the user can't edit it any more. However he can delete it and change the frozen state. |
| isLoading |
isLoading:
|
Type : boolean
|
| Optional |
|
Indicates that the dashboard is loading. |
| layout |
layout:
|
Type : "grid" | "custom"
|
| Optional |
|
Layout mode: 'grid' for standard grid or 'custom' for user-configured layout. |
| rows |
rows:
|
Type : number | "auto"
|
| Optional |
|
The number of rows on the dashboard. Only used when alignViewHeight is true. |
| title |
title:
|
Type : string
|
| Optional |
|
A global title that is used for this dashboard. |
| translateDashboardTitle |
translateDashboardTitle:
|
Type : boolean
|
|
Should attempt translating user-defined dashboard's title if translation is available. |
| translateWidgetTitle |
translateWidgetTitle:
|
Type : boolean
|
|
Should attempt translating user-defined widget's title if translation is available. |
| widgetMargin |
widgetMargin:
|
Type : number
|
|
The gap between each widget as pixel |