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();
    })
  }
}

Properties

name

name: string;

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

Methods

execute()

execute(viewer): Promise<void>;

Action implementation.

Parameters

viewer

ImageViewerAPI

Returns

Promise<void>

undo()

undo(viewer): Promise<void>;

Undo action implementation.

Parameters

viewer

ImageViewerAPI

Returns

Promise<void>