Skip to main content

getUndoStack

Description​

Returns the stack of stored undo user actions

getUndoStack: () => UndoRedoAction[]

Returns​

  • stack - (UndoRedoAction[]) - an array of the undo user actions

Example​

var stack = gantt.getUndoStack();

Details​

note

This method is defined in the undo extension, so you need to enable the undo plugin. Read the details in the Undo/Redo Functionality article.

The returned stack is an array of the undo user actions. Each user action contains a set of commands. A command is an object with the following attributes:

  • type - (string) the type of a command: "add/remove/update"
  • entity - (string) the type of the object which was changed: "task" or "link"
  • value - (object) the changed task/link object
  • oldValue - (object) the task/link object before changes

Have a look at the example below: get_undo_stack

The getUndoStack() method returns a stack with 2 undo user actions. The first action contains 3 commands, while the second one has 1 command.

Change log​

  • added in version 4.0
Need help?
Got a question about the documentation? Reach out to our technical support team for help and guidance. For custom component solutions, visit the Services page.
Need more help?Contact Support