IChangeDashboardDefinitionPayload
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Payload of the IChangeDashboardDefinition command.
export interface IChangeDashboardDefinitionPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| (ALPHA) Dashboard definition to apply to the current dashboard. | ||
| ReadonlyArray<IInsight> | (ALPHA) (Optional) Insights used in the dashboard definition. | |
| Partial<IDashboardReferences> | (ALPHA) (Optional) Referenced objects used in the dashboard definition. |
Property details
IChangeDashboardDefinitionPayload.dashboardpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Dashboard definition to apply to the current dashboard.
readonly dashboard: IDashboard;
IChangeDashboardDefinitionPayload.insightspropertyAlphaDeprecated
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Warning: This API is now obsolete.
Use references.insights instead.
Insights used in the dashboard definition.
readonly insights?: ReadonlyArray<IInsight>;
IChangeDashboardDefinitionPayload.referencespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Referenced objects used in the dashboard definition.
readonly references?: Partial<IDashboardReferences>;