> For the complete documentation index, see [llms.txt](https://docs.apryse.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.apryse.com/web/spreadsheet-editor/events.md).

# Listen to Spreadsheet Editor events

Learn how to use Spreadsheet Editor events to respond to editor, sheet, cell, selection, and formula bar actions. Includes event descriptions and code examples.

{% hint style="info" %}
**Requirements**

*These packages are required to use these features in production. Trial keys have unlimited access to all features*

<a href="/web/get-started/readme.md" class="button primary">Web SDK</a><a href="https://apryse.com/capabilities#SpreadsheetEditor" class="button primary">Package: Spreadsheet Editor</a><a href="https://showcase.apryse.com/spreadsheet-editor" class="button primary">Live demo</a>
{% endhint %}

Spreadsheet Editor events enable your application to respond to changes and user interactions within the Spreadsheet Editor.

Events are exposed through the `SpreadsheetEditorManager` class and can be used to detect editor initialization, edit mode changes, sheet updates, cell modifications, selection changes, and formula bar actions. Subscribe to these events to implement custom workflows, synchronize application state, validate data, and extend the editor experience.

## Editor events

Editor events provide notifications about the overall Spreadsheet Editor lifecycle and state. For example, these events occur when the editor is initialized and when the editing mode changes.

### Initialize the editor

The `spreadsheetEditorReady` event fires when the editor has finished initializing and is ready for use. Use this when you want to perform editor operations immediately on load.

{% tabs %}
{% tab title="JavaScript" %}
{% code lineNumbers="true" %}

```js
WebViewer(...)
  .then(instance => {
    const { documentViewer, SpreadsheetEditor } = instance.Core;
    const SpreadsheetEditorEvents = SpreadsheetEditor.SpreadsheetEditorManager.Events;
    const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();

    spreadsheetEditorManager.addEventListener(SpreadsheetEditorEvents.SPREADSHEET_EDITOR_READY, () => {
      spreadsheetEditorManager.setEditMode(SpreadsheetEditor.SpreadsheetEditorEditMode.EDITING);
    });
  });
```

{% endcode %}
{% endtab %}
{% endtabs %}

[spreadsheetEditorReady](https://sdk.apryse.com/api/web/Core.SpreadsheetEditor.SpreadsheetEditorManager.html#event:spreadsheetEditorReady__anchor)

### Detect edit mode changes

The `spreadsheetEditorEditModeChanged` event fires when the editor changes modes. Use this to detect when the editor changes to view or edit mode.

{% tabs %}
{% tab title="JavaScript" %}
{% code lineNumbers="true" %}

```js
WebViewer(...)
  .then(instance => {
    const { documentViewer, SpreadsheetEditor } = instance.Core;
    const SpreadsheetEditorEvents = SpreadsheetEditor.SpreadsheetEditorManager.Events;
    const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();

    spreadsheetEditorManager.addEventListener(SpreadsheetEditorEvents.EDIT_MODE_CHANGED, (mode) => {
      // console.log('Mode changed', mode);
    });
  });
```

{% endcode %}
{% endtab %}
{% endtabs %}

[spreadsheetEditorEditModeChanged](https://sdk.apryse.com/api/web/Core.SpreadsheetEditor.SpreadsheetEditorManager.html#event:spreadsheetEditorEditModeChanged__anchor)

## Worksheet events

Sheet events are triggered when users interact with worksheets or when sheet-level changes occur, such as switching between sheets or modifying worksheet content.

### Detect active sheet updates

The `activeSheetChanged` event fires when the editor has switched to a different sheet.

{% tabs %}
{% tab title="JavaScript" %}
{% code lineNumbers="true" %}

```js
WebViewer(...)
  .then(instance => {
    const { documentViewer, SpreadsheetEditor } = instance.Core;
    const SpreadsheetEditorEvents = SpreadsheetEditor.SpreadsheetEditorManager.Events;
    const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();

    spreadsheetEditorManager.addEventListener(SpreadsheetEditorEvents.ACTIVE_SHEET_CHANGED, (event) => {
      // console.log('Active sheet index', event.getSheetIndex());
    });
  });
```

{% endcode %}
{% endtab %}
{% endtabs %}

[activeSheetChanged](https://sdk.apryse.com/api/web/Core.SpreadsheetEditor.SpreadsheetEditorManager.html#event:activeSheetChanged__anchor)

### Track worksheet changes

The `sheetChanged` event fires when a sheet's state changes, such as renaming, deletion, creation, or visibility. The available options are listed in the `SpreadsheetChangedActions` [definition](https://sdk.apryse.com/api/web/Core.SpreadsheetEditor.SpreadsheetEditorManager.html#.SpreadsheetChangedActions__anchor).

{% tabs %}
{% tab title="JavaScript" %}
{% code lineNumbers="true" %}

```js
WebViewer(...)
  .then(instance => {
    const { documentViewer, SpreadsheetEditor } = instance.Core;
    const SpreadsheetEditorEvents = SpreadsheetEditor.SpreadsheetEditorManager.Events;
    const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();

    spreadsheetEditorManager.addEventListener(SpreadsheetEditorEvents.SHEET_CHANGED, (event) => {
      const { SpreadsheetChangedActions}  = SpreadsheetEditor.SpreadsheetEditorManager;
      if (event.action === SpreadsheetChangedActions.CREATE_SHEET) {
        // console.log('Sheet name', event.sheetName);
        // console.log('Active sheet index', event.getActiveSheetIndex());
        // console.log('Visible sheets', event.getVisibleSheets());
      }
    });
  });
```

{% endcode %}
{% endtab %}
{% endtabs %}

[sheetChanged](https://sdk.apryse.com/api/web/Core.SpreadsheetEditor.SpreadsheetEditorManager.html#event:sheetChanged__anchor) [SpreadsheetChangedActions](https://sdk.apryse.com/api/web/Core.SpreadsheetEditor.SpreadsheetEditorManager.html#.SpreadsheetChangedActions__anchor)

## Cell events

Cell events notify your application when cell data or selections change. Use these events to react to data updates, refresh dependent UI elements, or implement validation logic.

### Track cell and range updates

The `dataChanged` event fires when a cell or cell range is modified. Changes can include values, styles, cut or paste, merge or unmerge, and add or remove rows and columns. The `DataChangeType` [type](https://sdk.apryse.com/api/web/Core.SpreadsheetEditor.Types.html#.DataChangeType__anchor) shows all available options.

{% tabs %}
{% tab title="JavaScript" %}
{% code lineNumbers="true" %}

```js
WebViewer(...)
  .then(instance => {
    const { documentViewer, SpreadsheetEditor } = instance.Core;
    const SpreadsheetEditorEvents = SpreadsheetEditor.SpreadsheetEditorManager.Events;
    const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
    const { DataChangeType } = SpreadsheetEditor.Types;

    spreadsheetEditorManager.addEventListener(SpreadsheetEditorEvents.DATA_CHANGED, (event) => {
      // console.log('Sheet index', event.sheetIndex);
      // console.log('Cell ranges', event.cellRanges);
      // console.log('Change type', event.changeType);
      if (event.changeType === DataChangeType['DATA_CHANGE']) {
        // console.log('Data change was detected');
      }
    });
  });

```

{% endcode %}
{% endtab %}
{% endtabs %}

[dataChanged](https://sdk.apryse.com/api/web/Core.SpreadsheetEditor.SpreadsheetEditorManager.html#event:dataChanged__anchor) [DataChangeType](https://sdk.apryse.com/api/web/Core.SpreadsheetEditor.Types.html#.DataChangeType__anchor)

### Detect cell selection changes

The `selectionChanged` event fires when the editor selects a different cell. The editor will fire an event on initialization to indicate it has selected the top-left cell.

{% tabs %}
{% tab title="JavaScript" %}
{% code lineNumbers="true" %}

```js
WebViewer(...)
  .then(instance => {
    const { documentViewer, SpreadsheetEditor } = instance.Core;
    const SpreadsheetEditorEvents = SpreadsheetEditor.SpreadsheetEditorManager.Events;
    const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();

    spreadsheetEditorManager.addEventListener(SpreadsheetEditorEvents.SELECTION_CHANGED, (event) => {
      // console.log('Cell range', event.getCellRange());
      // console.log('Bounding cells', event.getBoundingCells());
      // console.log('Selected range', event.getSelectionRangeDisplayValue());
      // console.log('Is merged', event.isMerged());
      const clipboard = event.getClipboard();
      if (clipboard.canCopy()) {
        clipboard.copy();
      }
    });
  });
```

{% endcode %}
{% endtab %}
{% endtabs %}

[selectionChanged](https://sdk.apryse.com/api/web/Core.SpreadsheetEditor.SpreadsheetEditorManager.html#event:selectionChanged__anchor)

## Formula bar events

Formula bar events notify your application when users interact with the formula bar. Use these events to monitor formula input, surface formula information, and provide search suggestions as users build formulas.

### Track formula bar inputs

The `formulaBarTextChangedEvent` event fires when the formula bar text input changes. The following code shows how to listen to the text changed event and log each segment of the formula bar using the `getInfo()` function.

{% tabs %}
{% tab title="JavaScript" %}
{% code lineNumbers="true" %}

```js
WebViewer(...)
  .then(instance => {
    const { documentViewer, SpreadsheetEditor } = instance.Core;
    const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
    
    const formulaBarTextChangedHandler = (e) => {
      const segments = e.getInfo();
      for (let i=0; i<segments.length; i++) {
        console.log(`${segments[i].text} - ${segments[i].color}`);
      }
    };
    
    spreadsheetEditorManager.addEventListener(
      SpreadsheetEditor.SpreadsheetEditorManager.Events.FORMULA_BAR_TEXT_CHANGED,
      formulaBarTextChangedHandler
    );
  });
```

{% endcode %}
{% endtab %}
{% endtabs %}

[formulaBarTextChangedEvent](https://sdk.apryse.com/api/web/Core.SpreadsheetEditor.SpreadsheetEditorManager.html#event:formulaBarTextChangedEvent__anchor)

### Access formula information

The `formulaHelpEvent` event fires when the selection of a formula is confirmed, like `=SUM(`, and returns the formula name, description, and parameter information. The following code sample shows how to listen to the help event and log the available formula information using the `getFormulaInfo()` function.

{% tabs %}
{% tab title="JavaScript" %}
{% code lineNumbers="true" %}

```js
WebViewer(...)
  .then(instance => {
    const { documentViewer, SpreadsheetEditor } = instance.Core;
    const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
    
    const formulaSearchEventHandler = (e) => {
      const formulaInfo = e.getFormulaInfo();
      if (formulaInfo) {
        console.log(formulaInfo.name);
        console.log(formulaInfo.description);
        console.log(formulaInfo.details);
        console.log(formulaInfo.parameters);
      }
    };
    
    spreadsheetEditorManager.addEventListener(
      SpreadsheetEditor.SpreadsheetEditorManager.Events.FORMULA_HELP,
      formulaSearchEventHandler
    );
  });
```

{% endcode %}
{% endtab %}
{% endtabs %}

[formulaHelpEvent](https://sdk.apryse.com/api/web/Core.SpreadsheetEditor.SpreadsheetEditorManager.html#event:formulaHelpEvent__anchor)

### Detect formula searches

The `formulaSearchEvent` event fires when a user types in the formula bar before confirming a formula. The editor returns a list of formulas that closely match the search query. It must start with an equals sign (=) to trigger the search. The following code sample shows how to listen for the search event and log the results as an array.

{% tabs %}
{% tab title="JavaScript" %}
{% code lineNumbers="true" %}

```js
WebViewer(...)
  .then(instance => {
    const { documentViewer, SpreadsheetEditor } = instance.Core;
    const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
    
    const formulaSearchEventHandler = (e) => console.log(e.getFormulaInfoItems());
    
    spreadsheetEditorManager.addEventListener(
      SpreadsheetEditor.SpreadsheetEditorManager.Events.FORMULA_SEARCH,
      formulaSearchEventHandler
    );
  });
```

{% endcode %}
{% endtab %}
{% endtabs %}

[formulaSearchEvent](https://sdk.apryse.com/api/web/Core.SpreadsheetEditor.SpreadsheetEditorManager.html#event:formulaSearchEvent__anchor)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.apryse.com/web/spreadsheet-editor/events.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.