Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: UndoManager
[ AMD Module Require | Legacy Module Require ]
require(["esri/undoManager"], function(UndoManager) { /* code goes here */ });
Description
(Added at v2.2)
The UndoManager is a utility object that allows you to easily build applications with undo/redo functionality. Use the UndoManager to add operations (edits, navigation changes, graphics drawing) to the stack. The API includes a set of edit operations (add, delete, update, cut and union), created by inheriting from the OperationBase class. You can inherit from the OperationBase class to create custom operations that take advantage of undo/redo.Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new UndoManager(options?) | Creates a new UndoManager object. |
Properties
| Name | Type | Summary |
|---|---|---|
| canRedo | Boolean | When true, there are redo operations available on the stack. |
| canUndo | Boolean | When true, there are undo operations available on the stack. |
| length | Number | The number of operations stored in the history stack. |
| position | Number | The current operation position. |
Methods
| Name | Return type | Summary |
|---|---|---|
| add(operation) | None | Adds an undo operation to the stack and clears the redo stack. |
| clearRedo() | None | Clear the redo stack. |
| clearUndo() | None | Clear the undo stack. |
| destroy() | None | Destroy the operation manager. |
| get(operationId) | OperationBase | Get the specified operation from the stack. |
| peekRedo() | OperationBase | Get the next redo operation from the stack. |
| peekUndo() | OperationBase | Get the next undo operation from the stack. |
| redo() | None | Moves the current position to the next redo operation and calls the operation's performRedo() method. |
| remove(operationId) | OperationBase | Remove the specified operation from the stack. |
| undo() | None | Moves the current position to the next undo operation and calls the operation's performUndo method. |
Events
[ On Style Events | Connect Style Event ]
All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
Events
| Name | Event Object | Summary |
|---|---|---|
| add | Fires when the add method is called to add an operation is added to the stack. | |
| change | Fires when the undo/redo stack changes. | |
| redo | Fires when the redo method is called. | |
| undo | Fires when the undo method is called. |
Constructor Details
Creates a new UndoManager object.
Parameters:
< |
Optional | See options list for parameters. |
options properties: < |
Optional | The maximum number of operations the UndoManager can perform. If a number less than or equal to zero is provided the number of operations is unlimited. The default value is 10. |
Sample:
require([
"esri/undoManager", ...
], function(UndoManager, ... ) {
var undoManager = new UndoManager({maxOperations:8});
...
});
Property Details
<Boolean
BooleanWhen true, there are redo operations available on the stack.
Known values:
true | falseSample:
require([
"esri/undoManager", "dijit/registry", ...
], function(UndoManager, registry, ... ) {
var undoManager = new UndoManager( ... );
if (undoManager.canRedo) {
registry.byId("redo").set("disabled", false);
} else {
registry.byId("redo").set("disabled", true);
}
...
});
<Boolean
BooleanWhen true, there are undo operations available on the stack.
Known values:
true | falseSample:
require([
"esri/undoManager", "dijit/registry", ...
], function(UndoManager, registry, ... ) {
var undoManager = new UndoManager( ... );
if (undoManager.canUndo) {
registry.byId("undo").set("disabled", false);
} else {
registry.byId("undo").set("disabled", true);
};
...
});
<Number
NumberThe number of operations stored in the history stack.
<Number
NumberThe current operation position. A position value of 0 means that no operations are available on the stack. When an undo operation is performed the position decreases by 1. When a redo occurs the position is incremented by 1.
Sample:
require([
"esri/undoManager", ...
], function(UndoManager, ... ) {
var undoManager = new UndoManager( ... );
console.log('The current position is: " + undoManager.position);
...
});
Method Details
Adds an undo operation to the stack and clears the redo stack.
Parameters:
< |
Required | An operation to add to the stack. |
Sample:
require([
"esri/undoManager", "esri/dijit/editing/Delete", ...
], function(UndoManager, Delete, ... ) {
var undoManager = new UndoManager();
var operation = new Delete({
featureLayer: layer,
deletedGraphics: [feature]
});
undoManager.add(operation);
...
});
Destroy the operation manager. Sets the history stack to null and cleans up all references.
Get the specified operation from the stack.
Return type:
OperationBaseParameters:
< |
Required | The operation id. |
Sample:
var lastOperation = undoManager.get(2);
Get the next redo operation from the stack
Return type:
OperationBaseSample:
var nextOperation = undoManager.peekRedo();
Get the next undo operation from the stack.
Return type:
OperationBaseSample:
var nextOperation = undoManager.peekUndo();
Moves the current position to the next redo operation and calls the operation's
performRedo() method.Sample:
<button onclick="undoManager.redo();" data-dojo-type="dijit.form.Button">Redo</button>
Remove the specified operation from the stack.
Return type:
OperationBaseParameters:
< |
Required | The operation id. |
Sample:
var operation = undoManager.remove(2);
Moves the current position to the next undo operation and calls the operation's
performUndo method.Sample:
undoManager.undo();
Event Details
[ On Style Events | Connect Style Event ]
Fires when the add method is called to add an operation is added to the stack. Should be used in favor of onAdd. (Added at v3.5)