Section:

Spreadsheet Editor - View Mode

View mode allows user to navigate spreadsheets using a familiar grid interface. View calculated cells and formulas, and change workbook sheets without making unexpected changes. The spreadsheet editor is in view mode by default.

Spreadsheet Editor must be purchased as an add-on to your Web SDK subscription.

spreadsheet editor sample

APIs

You can use APIs to check the current editor mode.

getEditMode

Use the getEditMode API to check the current editor mode:

JavaScript

1const { documentViewer } = WebViewer.getInstance().Core;
2const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
3const spreadsheetMode = spreadsheetEditorManager.getEditMode();
4console.log(spreadsheetMode); // 'viewOnly'

Events

Use Events to get cell information or detect when a user switches sheets.

SelectionChangedEvent

Use the SELECTION_CHANGED event to get cell information when a user selects a single cell or a cell range:

JavaScript

1const { documentViewer, SpreadsheetEditor } = WebViewer.getInstance().Core;
2const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
3spreadsheetEditorManager.addEventListener(
4    SpreadsheetEditor.SpreadsheetEditorManager.Events.SELECTION_CHANGED, 
5    (e) => console.log(e) // SelectionChangedEvent class
6);
7

ActiveSheetChangedEvent

Use the ACTIVE_SHEET_CHANGED event to detect when a user switches sheets:

JavaScript

1const { documentViewer, SpreadsheetEditor } = WebViewer.getInstance().Core;
2const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
3spreadsheetEditorManager.addEventListener(
4    SpreadsheetEditor.SpreadsheetEditorManager.Events.ACTIVE_SHEET_CHANGED, 
5    (e) => console.log(e) // ActiveSheetChangedEvent class
6);

Did you find this helpful?

Trial setup questions?

Ask experts on Discord

Need other help?

Contact Support

Pricing or product questions?

Contact Sales