renameDashboard()
Home > @gooddata/sdk-ui-dashboard > renameDashboard
renameDashboard() 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 RenameDashboard command. Dispatching this command will result in rename of the dashboard. The changes will be done only in-memory and have to be flushed to backend using the SaveDashboard command.
Signature:
export declare function renameDashboard(newTitle: string, correlationId?: string): IRenameDashboard;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
newTitle |
string |
new dashboard title |
|
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: