undoLayoutChanges()

Home > @gooddata/sdk-ui-dashboard > undoLayoutChanges

undoLayoutChanges() 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 UndoLayoutChanges command.

Signature:

export declare function undoLayoutChanges(undoPointSelector?: UndoPointSelector, correlationId?: string): IUndoLayoutChanges;

Parameters

Parameter	Type	Description
undoPointSelector	UndoPointSelector	(Optional) specify function to determine up to which command to undo; if not provided the very last command will be undone
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:

IUndoLayoutChanges

Remarks

Dispatching this command will result in reverting the state of the layout to a point before a particular layout command processing.

By default, the very last command will be undone, however you can provide a function of your own to determine up to which command should the undo go.