interface
Source: layout.ts ↗
IDashboardLayout
Dashboard layout describes the data to be displayed on the dashboard, and their structure for UI rendering. Generic TWidget param is here to support type checking with custom widgets (e.g. in Dashboard component).
export interface IDashboardLayout<TWidget = IDashboardWidget>
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) Layout configuration. | |||
IDashboardLayoutSection<TWidget>[] | Layout sections. | ||
(Optional) Layout size. | |||
“IDashboardLayout” | Unique type to identify dashboard layout. |
Property details
IDashboardLayout.configurationpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Layout configuration.
configuration?: IDashboardLayoutConfiguration;
IDashboardLayout.sectionsproperty
Layout sections.
sections: IDashboardLayoutSection<TWidget>[];
IDashboardLayout.sizeproperty
Layout size.
size?: IDashboardLayoutSize;
IDashboardLayout.typeproperty
Unique type to identify dashboard layout.
type: "IDashboardLayout";