Events Reference

This page lists SpreadJS events with a brief description, scope, and whether the event supports cancellation.

For detailed parameters and usage examples, see the API Reference.

Notes:
Scope indicates the typical object used for binding. Some events can be bound at the Workbook level depending on usage context.
Cancelable events expose a cancel property in the event arguments.

Workbook and Sheet Lifecycle Events

Event	Description	Scope	Cancelable
ActiveSheetChanging	Occurs before the active sheet changes.	Workbook	Yes
ActiveSheetChanged	Occurs after the active sheet changes.	Workbook	No
BeforePrint	Occurs before printing.	Workbook	Yes
SheetChanging	Occurs before a sheet property changes.	Workbook	Yes
SheetChanged	Occurs after a sheet property changes.	Workbook	No
SheetMoving	Occurs before a sheet is moved.	Workbook	Yes
SheetMoved	Occurs after a sheet is moved.	Workbook	No
SheetNameChanging	Occurs before the sheet name changes.	Workbook	Yes
SheetNameChanged	Occurs after the sheet name changes.	Workbook	No
SheetTabClick	Occurs when a sheet tab is clicked.	Workbook	No
SheetTabDoubleClick	Occurs when a sheet tab is double-clicked.	Workbook	No
PermissionChanged	Occurs when workbook permissions change.	Workbook	No

Cell Interaction and Selection

Event	Description	Scope	Cancelable
CellClick	Occurs when a cell is clicked.	Worksheet	No
CellDoubleClick	Occurs when a cell is double-clicked.	Worksheet	No
ButtonClicked	Occurs when a button, checkbox, or hyperlink cell is clicked.	Workbook	No
EnterCell	Occurs when focus enters a cell.	Worksheet	No
LeaveCell	Occurs when focus leaves a cell.	Worksheet	Yes
CellChanged	Occurs when a cell property changes and requires repaint.	Worksheet	No
SelectionChanging	Occurs while selection is changing.	Worksheet	No
SelectionChanged	Occurs after selection changes.	Worksheet	No
TopRowChanged	Occurs when the top row changes.	Worksheet	No
LeftColumnChanged	Occurs when the left column changes.	Worksheet	No

Editing and Value Events

Event	Description	Scope	Cancelable
EditStarting	Occurs before entering edit mode.	Worksheet	Yes
EditChange	Occurs while editing text changes.	Worksheet	No
EditEnding	Occurs before leaving edit mode.	Worksheet	Yes
EditEnded	Occurs after leaving edit mode.	Worksheet	No
EditorStatusChanged	Occurs when the editor status changes.	Worksheet	No
ValueChanged	Occurs when a cell value changes.	Worksheet	No
UserFormulaEntered	Occurs when a formula is entered.	Worksheet	No
ValidationError	Occurs when a cell value is invalid.	Worksheet	No

Clipboard Events

Event	Description	Scope	Cancelable
ClipboardChanging	Occurs before clipboard data is set.	Workbook	Yes
ClipboardChanged	Occurs after clipboard data changes.	Workbook	No
ClipboardPasting	Occurs before paste is applied.	Workbook	Yes
ClipboardPasted	Occurs after paste completes.	Workbook	No

Row and Column Events

Event	Description	Scope	Cancelable
RowChanging	Occurs before a row property changes.	Worksheet	Yes
RowChanged	Occurs after a row property changes.	Worksheet	No
RowHeightChanging	Occurs before row height changes.	Worksheet	Yes
RowHeightChanged	Occurs after row height changes.	Worksheet	No
ColumnChanging	Occurs before a column property changes.	Worksheet	Yes
ColumnChanged	Occurs after a column property changes.	Worksheet	No
ColumnWidthChanging	Occurs before column width changes.	Worksheet	Yes
ColumnWidthChanged	Occurs after column width changes.	Worksheet	No

Range, Filter, and Sort Events

Event	Description	Scope	Cancelable
RangeChanged	Occurs after a range changes.	Worksheet	No
RangeFiltering	Occurs before automatic filtering.	Worksheet	No
RangeFiltered	Occurs after automatic filtering.	Worksheet	No
RangeFilterClearing	Occurs before filter clearing.	Worksheet	No
RangeFilterCleared	Occurs after filter clearing.	Worksheet	No
RangeSorting	Occurs before automatic sorting.	Worksheet	Yes
RangeSorted	Occurs after automatic sorting.	Worksheet	No
RangeGroupStateChanging	Occurs before outline state changes.	Worksheet	Yes
RangeGroupStateChanged	Occurs after outline state changes.	Worksheet	No
OutlineColumnCheckStatusChanged	Occurs when an outline column check status changes.	Worksheet	No

Drag and Fill Events

Event	Description	Scope	Cancelable
DragDropBlock	Occurs during drag-and-drop of a cell range.	Worksheet	Yes
DragDropBlockCompleted	Occurs after drag-and-drop completes.	Worksheet	No
DragFillBlock	Occurs during drag fill.	Worksheet	Yes
DragFillBlockCompleted	Occurs after drag fill completes.	Worksheet	No
DragMerging	Occurs before drag merge.	Worksheet	Yes
DragMerged	Occurs after drag merge.	Worksheet	No

Table Events

Event	Description	Scope	Cancelable
TableFiltering	Occurs before table filtering.	Worksheet	No
TableFiltered	Occurs after table filtering.	Worksheet	No
TableFilterClearing	Occurs before clearing table filter.	Worksheet	No
TableFilterCleared	Occurs after clearing table filter.	Worksheet	No
TableResizing	Occurs before resizing a table.	Workbook	Yes
TableResized	Occurs after resizing a table.	Workbook	No
TableColumnsChanged	Occurs after table columns change.	Workbook	No
TableRowsChanged	Occurs after table rows change.	Workbook	No

Shapes, Objects, and Comments

Event	Description	Scope	Cancelable
ShapeRemoving	Occurs before a shape is removed.	Worksheet	Yes
ShapeRemoved	Occurs after a shape is removed.	Worksheet	No
ShapeChanged	Occurs when a shape property changes.	Worksheet	No
ShapeSelectionChanged	Occurs when shape selection changes.	Worksheet	No
FloatingObjectLoaded	Occurs when a custom floating object’s content is loaded.	Worksheet	No
FloatingObjectRemoving	Occurs before a floating object is removed.	Worksheet	Yes
FloatingObjectRemoved	Occurs after a floating object is removed.	Worksheet	No
FloatingObjectChanged	Occurs when a floating object changes.	Worksheet	No
FloatingObjectSelectionChanged	Occurs when floating object selection changes.	Worksheet	No
PictureChanged	Occurs when a picture changes.	Worksheet	No
PictureSelectionChanged	Occurs when picture selection changes.	Worksheet	No
ThreadedCommentChanging	Occurs before a threaded comment changes.	Worksheet	Yes
ThreadedCommentChanged	Occurs after a threaded comment changes.	Worksheet	No
CommentRemoving	Occurs before a comment is removed.	Worksheet	Yes
CommentRemoved	Occurs after a comment is removed.	Worksheet	No
CommentChanged	Occurs when a comment changes.	Worksheet	No

Advanced and System Events

Event	Description	Scope	Cancelable
CalculationProgress	Occurs during incremental calculation.	Workbook	No
DataFetchCompleted	Occurs when data manager tables finish loading.	Workbook	No
InvalidOperation	Occurs when an invalid operation is performed.	Worksheet	No
PivotTableChanging	Occurs before a PivotTable field changes.	Worksheet	Yes
PivotTableChanged	Occurs after PivotTable changes.	Worksheet	No
SlicerChanged	Occurs when a slicer changes.	Worksheet	No
SparklineChanged	Occurs when a sparkline changes.	Worksheet	No
TouchToolStripOpening	Occurs before the touch toolbar opens.	Worksheet	No
ViewZooming	Occurs before zoom changes.	Worksheet	Yes
ViewZoomed	Occurs after zoom changes.	Worksheet	No
UserMentioned	Occurs when users are mentioned.	Worksheet	No

ReportSheet Events

Event	Description	Scope	Cancelable
ReportSheetDataChanging	Occurs before report sheet data changes.	ReportSheet	Yes
ReportSheetDataChanged	Occurs after report sheet data changes.	ReportSheet	No
ReportSheetRecordsSubmitting	Occurs before submitting changes.	ReportSheet	Yes
ReportSheetRecordsSubmitted	Occurs after submitting changes.	ReportSheet	No

Collaboration Events

Event	Description	Scope	Cancelable
CollaborationStartUndo	Occurs before a collaborative undo operation.	Workbook	No
CollaborationEndUndo	Occurs after a collaborative undo operation.	Workbook	No
CollaborationStartRedo	Occurs before a collaborative redo operation.	Workbook	No
CollaborationEndRedo	Occurs after a collaborative redo operation.	Workbook	No