resetDashboard()
Home > @gooddata/sdk-ui-dashboard > resetDashboard
resetDashboard() function
This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Creates the ResetDashboard command. Dispatching this command will result in dropping all in-memory modifications of the dashboard and reverting to a state that is persisted on the backend. In other words reset will get dashboard to a state after the last save.
Note: if a dashboard is not saved on a backend, then reset will clear the dashboard to an empty state.
Limitation: reset command will have no impact on alerts or scheduled emails. These entites are persisted outside the dashboard and have their own lifecycle.
Signature:
export declare function resetDashboard(correlationId?: string): IResetDashboard;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
correlationId |
string |
(Optional) specify correlation id to use for this command. this will be included in all events that will be emitted during the command processing |
Returns: