changeDashboardDefinition()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Creates the IChangeDashboardDefinition command.
export declare function changeDashboardDefinition(dashboard: IDashboard, references?: Partial<IDashboardReferences> | ReadonlyArray<IInsight>, correlationId?: string): IChangeDashboardDefinition;
Parameters
Parameter | Type | Description |
|---|---|---|
dashboard | new dashboard definition | |
references | Partial<IDashboardReferences> | ReadonlyArray<IInsight> | (Optional) optional partial dashboard references or array of insights used in the dashboard |
correlationId | string | (Optional) specify correlation id. It will be included in all events emitted during command processing. |
Returns
change dashboard definition command
Remarks
Dispatching this command will update the dashboard definition, tabs, layout, filter context, and references in the active dashboard store without remounting or re-initializing the dashboard component.