deleteDashboard()
Home > @gooddata/sdk-ui-dashboard > deleteDashboard
deleteDashboard() 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 DeleteDashboard command. Dispatching this command will result in removal of the currently rendered dashboard from analytical backend and reverting the dashboard component to an 'empty' state where it is initialized to create a new dashboard.
Signature:
export declare function deleteDashboard(correlationId?: string): IDeleteDashboard;
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: