Apryse WebViewer

Class: SpreadsheetEditorHistoryManager

Core.SpreadsheetEditor. SpreadsheetEditorHistoryManager

Class for managing history actions in the spreadsheet editor. An instance of this class can be retrieved by SpreadsheetEditorManager.getSpreadsheetEditorHistoryManager.

new SpreadsheetEditorHistoryManager()

Methods

canRedo()

Checks if there are actions to redo.
Returns:
- Returns true if there are actions to redo, false otherwise.
Type
boolean
Example
WebViewer(...)
  .then(instance => {
    const { documentViewer, SpreadsheetEditor } = instance.Core;
    const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
    const SpreadsheetEditorEvents = SpreadsheetEditor.SpreadsheetEditorManager.Events;

    spreadsheetEditorManager.addEventListener(SpreadsheetEditorEvents.SPREADSHEET_EDITOR_READY, () => {
      spreadsheetEditorManager.setEditMode(SpreadsheetEditor.SpreadsheetEditorEditMode.EDITING);
      const spreadsheetEditorHistoryManager = spreadsheetEditorManager.getSpreadsheetEditorHistoryManager();
      const canRedo = spreadsheetEditorHistoryManager.canRedo();
      console.log('Can redo', canRedo);
    });
  });

canUndo()

Checks if there are actions to undo.
Returns:
- Returns true if there are actions to undo, false otherwise.
Type
boolean
Example
WebViewer(...)
  .then(instance => {
    const { documentViewer, SpreadsheetEditor } = instance.Core;
    const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
    const SpreadsheetEditorEvents = SpreadsheetEditor.SpreadsheetEditorManager.Events;

    spreadsheetEditorManager.addEventListener(SpreadsheetEditorEvents.SPREADSHEET_EDITOR_READY, () => {
      spreadsheetEditorManager.setEditMode(SpreadsheetEditor.SpreadsheetEditorEditMode.EDITING);
      const spreadsheetEditorHistoryManager = spreadsheetEditorManager.getSpreadsheetEditorHistoryManager();
      const canUndo = spreadsheetEditorHistoryManager.canUndo();
      console.log('Can undo', canUndo);
    });
  });

redo()

Redoes the last undone action in the spreadsheet editor.
Returns:
A promise that resolves when the redo operation is complete
Type
Promise.<void>
Example
WebViewer(...)
  .then(instance => {
    const { documentViewer, SpreadsheetEditor } = instance.Core;
    const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
    const SpreadsheetEditorEvents = SpreadsheetEditor.SpreadsheetEditorManager.Events;

    spreadsheetEditorManager.addEventListener(SpreadsheetEditorEvents.SPREADSHEET_EDITOR_READY, () => {
      spreadsheetEditorManager.setEditMode(SpreadsheetEditor.SpreadsheetEditorEditMode.EDITING);
      const spreadsheetEditorHistoryManager = spreadsheetEditorManager.getSpreadsheetEditorHistoryManager();
      const canRedo = spreadsheetEditorHistoryManager.canRedo();
      if (canRedo) {
        await spreadsheetEditorHistoryManager.redo();
      }
    });
  });

undo()

Undoes the last action in the spreadsheet editor.
Returns:
A promise that resolves when the undo operation is complete.
Type
Promise.<void>
Example
WebViewer(...)
  .then(instance => {
    const { documentViewer, SpreadsheetEditor } = instance.Core;
    const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
    const SpreadsheetEditorEvents = SpreadsheetEditor.SpreadsheetEditorManager.Events;

    spreadsheetEditorManager.addEventListener(SpreadsheetEditorEvents.SPREADSHEET_EDITOR_READY, () => {
      spreadsheetEditorManager.setEditMode(SpreadsheetEditor.SpreadsheetEditorEditMode.EDITING);
      const spreadsheetEditorHistoryManager = spreadsheetEditorManager.getSpreadsheetEditorHistoryManager();
      const canUndo = spreadsheetEditorHistoryManager.canUndo();
      if (canUndo) {
        await spreadsheetEditorHistoryManager.undo();
      }
    });
  });