Interface UndoCommandSupport

Interface for undo commands.

Example

// The UndoCommandSupport interface implementation example.
class CustomUndoCommand implements UndoCommandSupport {
  name: "CustomUndoCommand",
  execute: function(viewer) {
    return new Promise((resolve) => {
      // Put your action code here
      resolve();
    })
  },
  undo: function(viewer) {
    return new Promise((resolve) => {
      // Put your undo action here
      resolve();
    })
  }
}

interface UndoCommandSupport {
    name: string;
    execute(viewer: ImageViewerAPI): Promise<void>;
    undo(viewer: ImageViewerAPI): Promise<void>;
}

Implemented by

Methods

execute

execute(viewer: ImageViewerAPI): Promise<void>
Action implementation.
Parameters
- viewer: ImageViewerAPI
Returns Promise<void>

undo

undo(viewer: ImageViewerAPI): Promise<void>
Undo action implementation.
Parameters
- viewer: ImageViewerAPI
Returns Promise<void>

Properties

name

name: string

Optional. The unique name of the command. Used by the undo.skipCommands option setting.