Skip to Content
ClassesFEventName

Class: FEventName

Properties

PropertyModifierTypeDescription

BeforeClipboardChange

readonly

"BeforeClipboardChange"

Trigger this event before the clipboard content changes. Type of the event parameter is IBeforeClipboardChangeParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeClipboardChange, (params) => {
  const { workbook, worksheet, text, html, fromSheet, fromRange } = params;
  console.log(params);
 
  // Cancel the clipboard change operation
  params.cancel = true;
})
 
// Remove the event listener, use `disposable.dispose()`

BeforeClipboardPaste

readonly

"BeforeClipboardPaste"

Trigger this event before pasting. Type of the event parameter is IBeforeClipboardPasteParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeClipboardPaste, (params) => {
  const { workbook, worksheet, text, html } = params;
  console.log(params);
 
  // Cancel the clipboard paste operation
  params.cancel = true;
})
 
// Remove the event listener, use `disposable.dispose()`

BeforeCommentAdd

readonly

"BeforeCommentAdd"

Event fired before comment added

See

IBeforeSheetCommentAddEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommentAdd, (params) => {
  const { comment, workbook, worksheet, row, col } = params;
  console.log(params);
 
  // Cancel the comment add operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

BeforeCommentDelete

readonly

"BeforeCommentDelete"

Event fired before comment delete

See

IBeforeSheetCommentDeleteEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommentDelete, (params) => {
  const { comment, workbook, worksheet, row, col } = params;
  console.log(params);
 
  // Cancel the comment delete operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

BeforeCommentResolve

readonly

"BeforeCommentResolve"

Event fired before comment resolve

See

ISheetCommentResolveEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommentResolve, (params) => {
  const { comment, row, col, resolved, workbook, worksheet } = params;
  console.log(params);
 
  // Cancel the comment resolve operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

BeforeCommentUpdate

readonly

"BeforeCommentUpdate"

Event fired before comment update

See

IBeforeSheetCommentUpdateEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommentUpdate, (params) => {
  const { comment, workbook, worksheet, row, col, newContent } = params;
  console.log(params);
 
  // Cancel the comment update operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

BeforeFloatDomAdd

readonly

"BeforeFloatDomAdd"

Triggered before float dom insertion.

See

IBeforeFloatDomAddParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeFloatDomAdd, (params) => {
  console.log(params);
  // do something
  const { workbook, drawings } = params;
  // Cancel the insertion operation
  params.cancel = true;
})
 
// Remove the event listener, use `disposable.dispose()`

BeforeFloatDomDelete

readonly

"BeforeFloatDomDelete"

Triggered before float dom deletion.

See

IBeforeFloatDomDeleteParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeFloatDomDelete, (params) => {
  console.log(params);
  // do something
  const { workbook, drawings } = params;
  // Cancel the deletion operation
  params.cancel = true;
})
 
// Remove the event listener, use `disposable.dispose()`

BeforeFloatDomUpdate

readonly

"BeforeFloatDomUpdate"

Triggered before float dom update.

See

IBeforeFloatDomUpdateParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeFloatDomUpdate, (params) => {
  console.log(params);
  // do something
  const { workbook, drawings } = params;
  // Cancel the update operation
  params.cancel = true;
})
 
// Remove the event listener, use `disposable.dispose()`

BeforeOverGridImageChange

readonly

"BeforeOverGridImageChange"

Triggered before floating image change.

See

IBeforeOverGridImageChangeParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeOverGridImageChange, (params) => {
  console.log(params);
  // do something
  const { workbook, images } = params;
  // Cancel the image change
  params.cancel = true;
})
 
// Remove the event listener, use `disposable.dispose()`

BeforeOverGridImageInsert

readonly

"BeforeOverGridImageInsert"

Triggered before floating image insertion.

See

IBeforeOverGridImageInsertParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeOverGridImageInsert, (params) => {
  console.log(params);
  // do something
  const { workbook, insertImageParams } = params;
  // Cancel the insertion operation
  params.cancel = true;
})
 
// Remove the event listener, use `disposable.dispose()`

BeforeOverGridImageRemove

readonly

"BeforeOverGridImageRemove"

Triggered before floating image removal.

See

IBeforeOverGridImageRemoveParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeOverGridImageRemove, (params) => {
  console.log(params);
  // do something
  const { workbook, images } = params;
  // Cancel the removal operation
  params.cancel = true;
})
 
// Remove the event listener, use `disposable.dispose()`

BeforeOverGridImageSelect

readonly

"BeforeOverGridImageSelect"

Triggered before floating image selection.

See

IBeforeOverGridImageSelectParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeOverGridImageSelect, (params) => {
  console.log(params);
  // do something
  const { workbook, selectedImages, oldSelectedImages } = params;
  // cancel the selection operation
  params.cancel = true;
})
 
// Remove the event listener, use `disposable.dispose()`

BeforePivotTableAdd

readonly

"BeforePivotTableAdd"

The before pivot table add event.The event parameter is IPivotTableAddedEventParams

Example

univerAPI.addEvent(univerAPI.Event.BeforePivotTableAdd, (params) => {
    const { positionType, targetCellInfo } = params;
    if (positionType === univerAPI.Enum.PositionTypeEnum.Existing && targetCellInfo.sheetName === 'Sheet 1') {
        params.cancel = true;
        console.log(`The pivot table can't be added to the sheet ${targetCellInfo.sheetName}`);
    }
});

BeforePivotTableMove

readonly

"BeforePivotTableMove"

The before pivot table moved event.The event parameter is IPivotTableMovedEventParams

Example

univerAPI.addEvent(univerAPI.Event.BeforePivotTableMove, (params) => {
    const { pivotTableId, targetCellInfo } = params;
    if (pivotTableId === 'pivotTable1' && targetCellInfo.sheetName === 'Sheet 1') {
        params.cancel = true;
        console.log(`The pivot table can't be moved to the sheet ${targetCellInfo.sheetName}`);
    }
});

BeforeSheetDataValidationAdd

readonly

"BeforeSheetDataValidationAdd"

Event fired before a rule is added

See

IBeforeSheetDataValidationAddEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationAdd, (params) => {
  const { worksheet, workbook, rule } = params;
  console.log(params);
 
  // Cancel the data validation rule addition operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

BeforeSheetDataValidationCriteriaUpdate

readonly

"BeforeSheetDataValidationCriteriaUpdate"

Event fired before the criteria of a rule are updated

See

IBeforeSheetDataValidationCriteriaUpdateEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationCriteriaUpdate, (params) => {
  const { worksheet, workbook, ruleId, rule, newCriteria } = params;
  console.log(params);
 
  // Cancel the data validation rule criteria update operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

BeforeSheetDataValidationDelete

readonly

"BeforeSheetDataValidationDelete"

Event fired before a rule is deleted

See

IBeforeSheetDataValidationDeleteEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationDelete, (params) => {
  const { worksheet, workbook, ruleId, rule } = params;
  console.log(params);
 
  // Cancel the data validation rule deletion operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

BeforeSheetDataValidationDeleteAll

readonly

"BeforeSheetDataValidationDeleteAll"

Event fired before all rules are deleted

See

IBeforeSheetDataValidationDeleteAllEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationDeleteAll, (params) => {
  const { worksheet, workbook, rules } = params;
  console.log(params);
 
  // Cancel the data validation rule deletion operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

BeforeSheetDataValidationOptionsUpdate

readonly

"BeforeSheetDataValidationOptionsUpdate"

Event fired before the options of a rule are updated

See

IBeforeSheetDataValidationOptionsUpdateEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationOptionsUpdate, (params) => {
  const { worksheet, workbook, ruleId, rule, newOptions } = params;
  console.log(params);
 
  // Cancel the data validation rule options update operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

BeforeSheetDataValidationRangeUpdate

readonly

"BeforeSheetDataValidationRangeUpdate"

Event fired before the range of a rule is updated

See

IBeforeSheetDataValidationRangeUpdateEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetDataValidationRangeUpdate, (params) => {
  const { worksheet, workbook, ruleId, rule, newRanges } = params;
  console.log(params);
 
  // Cancel the data validation rule range update operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

BeforeSheetEditEnd

readonly

"BeforeSheetEditEnd"

Event fired before a cell edit ends

See

IBeforeSheetEditEndEventParams

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetEditEnd, (params) => {
  const { worksheet, workbook, row, column, value, eventType, keycode, isZenEditor, isConfirm } = params;
  console.log(params);
 
  // Cancel the cell edit end operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

BeforeSheetEditStart

readonly

"BeforeSheetEditStart"

Event fired before a cell is edited

See

IBeforeSheetEditStartEventParams

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetEditStart, (params) => {
  const { worksheet, workbook, row, column, eventType, keycode, isZenEditor } = params;
  console.log(params);
 
  // Cancel the cell edit start operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

BeforeSheetLinkAdd

readonly

"BeforeSheetLinkAdd"

Event triggered before adding a link

See

IBeforeSheetLinkAddEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetLinkAdd, (params) => {
  const { workbook, worksheet, row, col, link } = params;
  console.log('before sheet link add', params);
 
  // Cancel the sheet link add operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

BeforeSheetLinkCancel

readonly

"BeforeSheetLinkCancel"

Event triggered before canceling a link

See

IBeforeSheetLinkCancelEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetLinkCancel, (params) => {
  const { workbook, worksheet, row, column, id } = params;
  console.log('before sheet link cancel', params);
 
  // Cancel the sheet link cancel operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

BeforeSheetLinkUpdate

readonly

"BeforeSheetLinkUpdate"

Event triggered before updating a link

See

IBeforeSheetLinkUpdateEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetLinkUpdate, (params) => {
  const { workbook, worksheet, row, column, id, payload } = params;
  console.log('before sheet link update', params);
 
  // Cancel the sheet link update operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

BeforeSheetNoteAdd

public

"BeforeSheetNoteAdd"

Event fired before a note is added

See

ISheetNoteAddEventParams

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetNoteAdd, (params) => {
  const { workbook, worksheet, row, col, note } = params;
  console.log(params);
 
  // Cancel the note addition operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

BeforeSheetNoteDelete

public

"BeforeSheetNoteDelete"

Event fired before a note is deleted

See

ISheetNoteDeleteEventParams

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetNoteDelete, (params) => {
  const { workbook, worksheet, row, col, oldNote } = params;
  console.log(params);
 
  // Cancel the note deletion operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

BeforeSheetNoteHide

public

"BeforeSheetNoteHide"

Event fired before a note is hidden

See

ISheetNoteHideEventParams

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetNoteHide, (params) => {
  const { workbook, worksheet, row, col } = params;
  console.log(params);
 
  // Cancel the note hide operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

BeforeSheetNoteShow

public

"BeforeSheetNoteShow"

Event fired before a note is shown

See

ISheetNoteShowEventParams

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetNoteShow, (params) => {
  const { workbook, worksheet, row, col } = params;
  console.log(params);
 
  // Cancel the note show operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

BeforeSheetNoteUpdate

public

"BeforeSheetNoteUpdate"

Event fired before a note is updated

See

ISheetNoteUpdateEventParams

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetNoteUpdate, (params) => {
  const { workbook, worksheet, row, col, note, oldNote } = params;
  console.log(params);
 
  // Cancel the note update operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

BeforeSheetPrintCanceled

readonly

"BeforeSheetPrintCanceled"

Event triggered before print operation is canceled

See

IBeforeSheetPrintCancelEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetPrintCanceled, (params) => {
  const { renderConfig, layoutConfig } = params;
  console.log('params', params);
 
  // Cancel the print cancel operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`.

BeforeSheetPrintConfirm

readonly

"BeforeSheetPrintConfirm"

Event triggered before print settings are confirmed

See

IBeforeSheetPrintConfirmEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetPrintConfirm, (params) => {
  const { renderConfig, layoutConfig } = params;
  console.log('params', params);
 
  // Cancel the print confirmation operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`.

BeforeSheetPrintOpen

readonly

"BeforeSheetPrintOpen"

Event triggered before print dialog opens

See

IBeforeSheetPrintOpenEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetPrintOpen, (params) => {
  const { workbook, worksheet } = params;
  console.log('params', params);
 
  // Cancel open print configuration dialog operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`.

BeforeSheetZoomChange

readonly

"BeforeSheetZoomChange"

Event fired before zoom changed

See

ISheetZoomEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetZoomChange, (params)=> {
  const { worksheet, workbook, zoom } = params;
  console.log(params);
 
  // Cancel the zoom change operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`

CellClicked

readonly

"CellClicked"

Event fired when a cell is clicked

See

ICellEventParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.CellClicked, (params) => {
  const { worksheet, workbook, row, column } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

CellHover

readonly

"CellHover"

Event fired when a cell is hovered

See

ICellEventParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.CellHover, (params) => {
  const { worksheet, workbook, row, column } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

CellPointerDown

readonly

"CellPointerDown"

Event fired when a cell is pointer down

See

ICellEventParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.CellPointerDown, (params) => {
  const { worksheet, workbook, row, column } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

CellPointerMove

readonly

"CellPointerMove"

Event fired when move on spreadsheet cells

See

ICellEventParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.CellPointerMove, (params) => {
  const { worksheet, workbook, row, column } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

CellPointerUp

readonly

"CellPointerUp"

Event fired when a cell is pointer up

See

ICellEventParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.CellPointerUp, (params) => {
  const { worksheet, workbook, row, column } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

ClipboardChanged

readonly

"ClipboardChanged"

Trigger this event after the clipboard content changes. Type of the event parameter is IClipboardChangedParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.ClipboardChanged, (params) => {
  const { workbook, worksheet, text, html, fromSheet, fromRange } = params;
  console.log(params);
})
 
// Remove the event listener, use `disposable.dispose()`

ClipboardPasted

readonly

"ClipboardPasted"

Trigger this event after pasting. Type of the event parameter is IClipboardPastedParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.ClipboardPasted, (params) => {
  const { workbook, worksheet, text, html } = params;
  console.log(params);
})
 
// Remove the event listener, use `disposable.dispose()`

ColumnHeaderClick

readonly

"ColumnHeaderClick"

Triggered when a column header is clicked

See

ISheetColumnHeaderEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.ColumnHeaderClick, (params) => {
  const { worksheet, workbook, column } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

ColumnHeaderHover

readonly

"ColumnHeaderHover"

Triggered when pointer hovers over a column header

See

ISheetColumnHeaderEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.ColumnHeaderHover, (params) => {
  const { worksheet, workbook, column } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

ColumnHeaderPointerDown

readonly

"ColumnHeaderPointerDown"

Triggered when pointer is pressed down on a column header

See

ISheetColumnHeaderEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.ColumnHeaderPointerDown, (params) => {
  const { worksheet, workbook, column } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

ColumnHeaderPointerUp

readonly

"ColumnHeaderPointerUp"

Triggered when pointer is released on a column header

See

ISheetColumnHeaderEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.ColumnHeaderPointerUp, (params) => {
  const { worksheet, workbook, column } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

CommentAdded

readonly

"CommentAdded"

Event fired after comment added

See

ISheetCommentAddEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.CommentAdded, (params) => {
  const { comment, workbook, worksheet, row, col } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

CommentDeleted

readonly

"CommentDeleted"

Event fired after comment deleted

See

ISheetCommentDeleteEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.CommentDeleted, (params) => {
  const { commentId, workbook, worksheet } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

CommentResolved

readonly

"CommentResolved"

Event fired after comment resolve

See

ISheetCommentResolveEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.CommentResolved, (params) => {
  const { comment, row, col, resolved, workbook, worksheet } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

CommentUpdated

readonly

"CommentUpdated"

Event fired after comment updated

See

ISheetCommentUpdateEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.CommentUpdated, (params) => {
  const { comment, workbook, worksheet, row, col } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

CrosshairHighlightColorChanged

readonly

"CrosshairHighlightColorChanged"

Triggered when the crosshair highlight color is changed.

See

ICrosshairHighlightColorChangedEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.CrosshairHighlightColorChanged, (params) => {
  const { color, workbook, worksheet } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

CrosshairHighlightEnabledChanged

readonly

"CrosshairHighlightEnabledChanged"

Triggered when the crosshair highlight is enabled or disabled.

See

ICrosshairHighlightEnabledChangedEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.CrosshairHighlightEnabledChanged, (params) => {
  const { enabled, workbook, worksheet } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

DragOver

readonly

"DragOver"

Event fired when the drag element passes over the spreadsheet cells

See

ICellEventParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.DragOver, (params) => {
  const { worksheet, workbook, row, column } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

Drop

readonly

"Drop"

Event fired when the drag element is dropped on the spreadsheet cells

See

ICellEventParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.Drop, (params) => {
  const { worksheet, workbook, row, column } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

FloatDomAdded

readonly

"FloatDomAdded"

Triggered after float dom insertion.

See

IFloatDomAddedParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.FloatDomAdded, (params) => {
  console.log(params);
  // do something
  const { workbook, drawings } = params;
})
 
// Remove the event listener, use `disposable.dispose()`

FloatDomDeleted

readonly

"FloatDomDeleted"

Triggered after float dom deletion.

See

IFloatDomDeletedParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.FloatDomDeleted, (params) => {
  console.log(params);
  // do something
  const { workbook, drawings } = params;
})
 
// Remove the event listener, use `disposable.dispose()`

FloatDomUpdated

readonly

"FloatDomUpdated"

Triggered after float dom update.

See

IFloatDomUpdatedParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.FloatDomUpdated, (params) => {
  console.log(params);
  // do something
  const { workbook, drawings } = params;
})
 
// Remove the event listener, use `disposable.dispose()`

OverGridImageChanged

readonly

"OverGridImageChanged"

Triggered after floating image change.

See

IOverGridImageChangedParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.OverGridImageChanged, (params) => {
  console.log(params);
  // do something
  const { workbook, images } = params;
})
 
// Remove the event listener, use `disposable.dispose()`

OverGridImageInserted

readonly

"OverGridImageInserted"

Triggered after floating image insertion.

See

IOverGridImageInsertedParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.OverGridImageInserted, (params) => {
  console.log(params);
  // do something
  const { workbook, images } = params;
})
 
// Remove the event listener, use `disposable.dispose()`

OverGridImageRemoved

readonly

"OverGridImageRemoved"

Triggered after floating image removal.

See

IOverGridImageRemovedParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.OverGridImageRemoved, (params) => {
  console.log(params);
  // do something
  const { workbook, removeImageParams } = params;
})
 
// Remove the event listener, use `disposable.dispose()`

OverGridImageSelected

readonly

"OverGridImageSelected"

Triggered after floating image selection.

See

IOverGridImageSelectedParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.OverGridImageSelected, (params) => {
  console.log(params);
  // do something
  const { workbook, selectedImages } = params;
})
 
// Remove the event listener, use `disposable.dispose()`

PivotTableAdded

readonly

"PivotTableAdded"

The pivot table added event.The event parameter is IPivotTableAddedEventParams

Example

univerAPI.addEvent(univerAPI.Event.PivotTableAdded, (params) => {
  const { positionType, targetCellInfo } = params;
  if (positionType === univerAPI.Enum.PositionTypeEnum.Existing) {
    console.log('A pivot table created in an existing sheet');
    console.log(`
      The target sheet name is ${targetCellInfo.sheetName},
      the target row is ${targetCellInfo.row}, the target column is ${targetCellInfo.column}
    `);
  } else {
    console.log('A pivot table created in a new sheet');
  }
});

PivotTableFieldAdded

readonly

"PivotTableFieldAdded"

The pivot table field added event. The event parameter is IAddPivotFieldCommandParams

Example

const fWorkbook = univerAPI.getActiveWorkbook();
univerAPI.addEvent(univerAPI.Event.PivotTableFieldAdded, (params) => {
   const { pivotTableId, fieldId, fieldArea, fieldIndex } = params;
   const pivotTable = fWorkbook.getPivotTableById(pivotTableId);
   const fieldSetting = pivotTable.getFieldSetting('fieldId');
   console.log(fieldSetting);
});

PivotTableFieldCollapseChanged

readonly

"PivotTableFieldCollapseChanged"

The pivot table field collapse changed event. The event parameter is ISetPivotCollapseCommandParams

Example

const fWorkbook = univerAPI.getActiveWorkbook();
univerAPI.addEvent(univerAPI.Event.PivotTableFieldCollapseChanged, (params) => {
  const { pivotTableId, fieldId, isCollapsed } = params;
  const pivotTable = fWorkbook.getPivotTableById(pivotTableId);
  const fieldSetting = pivotTable.getFieldSetting(fieldId);
  console.log(`The source name ${fieldSetting.sourceName} the display name ${fieldSetting.displayName}`);
});

PivotTableFieldFilterChanged

readonly

"PivotTableFieldFilterChanged"

The pivot table field filter changed event. The event parameter is ISetPivotFilterCommandParams

Example

const fWorkbook = univerAPI.getActiveWorkbook();
univerAPI.addEvent(univerAPI.Event.PivotTableFieldFilterChanged, (params) => {
    const { pivotTableId, fieldId, filter } = params;
    const pivotTable = fWorkbook.getPivotTableById(pivotTableId);
    const fieldSetting = pivotTable.getFieldSetting(fieldId);
    console.log(`The Checklist filter value is ${fieldSetting.filterInfo.checklist}`);
});

PivotTableFieldMoved

readonly

"PivotTableFieldMoved"

The pivot table field moved event. The event parameter is IMovePivotFieldCommandParams

Example

const fWorkbook = univerAPI.getActiveWorkbook();
univerAPI.addEvent(univerAPI.Event.PivotTableFieldMoved, (params) => {
  const { pivotTableId, fieldId, fieldArea, fieldIndex } = params;
  const pivotTable = fWorkbook.getPivotTableById(pivotTableId);
  const fieldSetting = pivotTable.getFieldSetting(fieldId);
  console.log(`The source name ${fieldSetting.sourceName} the display name ${fieldSetting.displayName}`);
});

PivotTableFieldRemoved

readonly

"PivotTableFieldRemoved"

The pivot table field removed event. The event parameter is IRemovePivotFieldCommandParams

Example

const fWorkbook = univerAPI.getActiveWorkbook();
univerAPI.addEvent(univerAPI.Event.PivotTableFieldRemoved, (params) => {
    const { pivotTableId, fieldId } = params;
    const pivotTable = fWorkbook.getPivotTableById(pivotTableId);
    const fieldSetting = pivotTable.getFieldSetting(fieldId);
    console.log(fieldSetting);
});

PivotTableFieldSettingChanged

readonly

"PivotTableFieldSettingChanged"

The pivot table field setting changed event. The event parameter is IUpdatePivotFieldSettingCommandParams

Example

const fWorkbook = univerAPI.getActiveWorkbook();
univerAPI.addEvent(univerAPI.Event.PivotTableFieldSettingChanged, (params) => {
    const { pivotTableId, fieldId, setting } = params;
    const pivotTable = fWorkbook.getPivotTableById(pivotTableId);
    const fieldSetting = pivotTable.getFieldSetting(fieldId);
    console.log(`The source name ${fieldSetting.sourceName} the display name ${fieldSetting.displayName}`);
});

PivotTableFieldSortChanged

readonly

"PivotTableFieldSortChanged"

The pivot table field sort changed event. The event parameter is ISetPivotSortCommandParams

Example

const fWorkbook = univerAPI.getActiveWorkbook();
univerAPI.addEvent(univerAPI.Event.PivotTableFieldSortChanged, (params) => {
   const { pivotTableId, fieldId, sort } = params;
   const pivotTable = fWorkbook.getPivotTableById(pivotTableId);
   const fieldSetting = pivotTable.getFieldSetting(fieldId);
   console.log(`The sort info is ${fieldSetting.sortInfo}`);
});

PivotTableMoved

readonly

"PivotTableMoved"

The pivot table moved event. The event parameter is IPivotTableMovedEventParams

Example

univerAPI.addEvent(univerAPI.Event.PivotTableMoved, (params) => {
  const { pivotTableId, targetCellInfo, originTargetInfo } = params;
  if (pivotTableId === 'pivotTable1') {
    console.log(`
      The pivot table moved from row: ${originTargetInfo.row} & column: ${originTargetInfo.column}
      to the sheet ${targetCellInfo.sheetName} row: ${targetCellInfo.row} & column: ${targetCellInfo.column}
    `);
  }
});

PivotTableRemoved

readonly

"PivotTableRemoved"

The pivot table removed event. The event parameter is IPivotTableRemovedEventParams

Example

univerAPI.addEvent(univerAPI.Event.PivotTableRemoved, (params) => {
   const { pivotTableId } = params;
   console.log(`The pivot table ${pivotTableId} has been removed`);
});

PivotTableRendered

readonly

"PivotTableRendered"

The pivot table calculated done and fill the value to worksheet, the event parameter is IPivotTableRenderedEventParams

Example

// import { unionPivotViewRange } from '@univerjs-pro/sheets-pivot';
univerAPI.addEvent(univerAPI.Event.PivotTableRendered, (params) => {
    const { pivotTableId, rangeInfo } = params;
    console.log(`The pivot table ${pivotTableId} has been rendered`);
    if (rangeInfo) {
        console.log(unionPivotViewRange(rangeInfo));
    }
});

PivotTableValuePositionChanged

readonly

"PivotTableValuePositionChanged"

The pivot table value position changed event. The event parameter is IUpdatePivotValuePositionCommandParams

Example

const fWorkbook = univerAPI.getActiveWorkbook();
univerAPI.addEvent(univerAPI.Event.PivotTableValuePositionChanged, (params) => {
    const { pivotTableId, valueId, position } = params;
    const pivotTable = fWorkbook.getPivotTableById(pivotTableId);
    const valueSetting = pivotTable.getValueSetting(valueId);
    console.log(`The source name ${valueSetting.sourceName} the display name ${valueSetting.displayName}`);
});

RowHeaderClick

readonly

"RowHeaderClick"

Triggered when a row header is clicked

See

ISheetRowHeaderEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.RowHeaderClick, (params) => {
  const { worksheet, workbook, row } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

RowHeaderHover

readonly

"RowHeaderHover"

Triggered when pointer hovers over a row header

See

ISheetRowHeaderEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.RowHeaderHover, (params) => {
  const { worksheet, workbook, row } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

RowHeaderPointerDown

readonly

"RowHeaderPointerDown"

Triggered when pointer is pressed down on a row header

See

ISheetRowHeaderEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.RowHeaderPointerDown, (params) => {
  const { worksheet, workbook, row } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

RowHeaderPointerUp

readonly

"RowHeaderPointerUp"

Triggered when pointer is released on a row header

See

ISheetRowHeaderEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.RowHeaderPointerUp, (params) => {
  const { worksheet, workbook, row } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

Scroll

readonly

"Scroll"

Event fired when scroll spreadsheet.

See

IScrollEventParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.Scroll, (params) => {
  const { worksheet, workbook, scrollX, scrollY } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

SelectionChanged

readonly

"SelectionChanged"

Event fired when selection changed.

See

ISelectionEventParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SelectionChanged, (params)=> {
  const { worksheet, workbook, selections } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

SelectionMoveEnd

readonly

"SelectionMoveEnd"

Event fired when selection move end

See

ISelectionEventParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SelectionMoveEnd, (params)=> {
  const { worksheet, workbook, selections } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

SelectionMoveStart

readonly

"SelectionMoveStart"

Event fired when selection move start

See

ISelectionEventParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SelectionMoveStart, (params)=> {
  const { worksheet, workbook, selections } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

SelectionMoving

readonly

"SelectionMoving"

Event fired when selection move end

See

ISelectionEventParam

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SelectionMoving, (params)=> {
  const { worksheet, workbook, selections } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

SheetBeforeRangeFilter

readonly

"SheetBeforeRangeFilter"

This event will be emitted before the filter criteria on a column is changed.

See

ISheetRangeFilteredParams

Example

const callbackDisposable = univerAPI.addEvent(univerAPI.Event.SheetBeforeRangeFilter, (params) => {
  console.log(params);
  const { workbook, worksheet, col, criteria } = params;
 
  // your custom logic
 
  // Cancel the filter criteria change operation
  params.cancel = true;
});
 
// Remove the event listener, use `callbackDisposable.dispose()`

SheetBeforeRangeFilterClear

readonly

"SheetBeforeRangeFilterClear"

This event will be emitted after the filter on a worksheet is cleared.

See

ISheetRangeFilterClearedEventParams

Example

const callbackDisposable = univerAPI.addEvent(univerAPI.Event.SheetBeforeRangeFilterClear, (params) => {
  console.log(params);
  const { workbook, worksheet } = params;
 
  // your custom logic
 
  // Cancel the filter clear operation
  params.cancel = true;
});
 
// Remove the event listener, use `callbackDisposable.dispose()`

SheetBeforeRangeSort

public

"SheetBeforeRangeSort"

This event will be emitted before sorting a range on a worksheet.

See

ISheetRangeSortParams

Example

const callbackDisposable = univerAPI.addEvent(univerAPI.Event.SheetBeforeRangeSort, (params) => {
  console.log(params);
  const { workbook, worksheet, range, sortColumn } = params;
 
  // Cancel the sorting operation.
  params.cancel = true;
});
 
// Remove the event listener, use `callbackDisposable.dispose()`

SheetDataValidationChanged

readonly

"SheetDataValidationChanged"

Event fired when a rule is added, deleted, or modified

See

ISheetDataValidationChangedEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SheetDataValidationChanged, (params) => {
  const { origin, worksheet, workbook, changeType, oldRule, rule } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

SheetDataValidatorStatusChanged

readonly

"SheetDataValidatorStatusChanged"

Event fired when a cell validator status is changed

See

ISheetDataValidatorStatusChangedEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SheetDataValidatorStatusChanged, (params) => {
  const { worksheet, workbook, row, column, status, rule } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

SheetEditChanging

readonly

"SheetEditChanging"

Event fired when a cell is being edited

See

ISheetEditChangingEventParams

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SheetEditChanging, (params) => {
  const { worksheet, workbook, row, column, value, isZenEditor } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

SheetEditEnded

readonly

"SheetEditEnded"

Event fired after a cell edit ends

See

ISheetEditEndedEventParams

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SheetEditEnded, (params) => {
  const { worksheet, workbook, row, column, eventType, keycode, isZenEditor, isConfirm } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

SheetEditStarted

readonly

"SheetEditStarted"

Event fired after a cell is edited

See

ISheetEditStartedEventParams

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SheetEditStarted, (params) => {
  const { worksheet, workbook, row, column, eventType, keycode, isZenEditor } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

SheetNoteAdd

public

"SheetNoteAdd"

Event fired when a note is added

See

ISheetNoteAddEventParams

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SheetNoteAdd, (params) => {
  const { workbook, worksheet, row, col, note } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

SheetNoteDelete

public

"SheetNoteDelete"

Event fired when a note is deleted

See

ISheetNoteDeleteEventParams

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SheetNoteDelete, (params) => {
  const { workbook, worksheet, row, col, oldNote } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

SheetNoteHide

public

"SheetNoteHide"

Event fired when a note is hidden

See

ISheetNoteHideEventParams

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SheetNoteHide, (params) => {
  const { workbook, worksheet, row, col } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

SheetNoteShow

public

"SheetNoteShow"

Event fired when a note is shown

See

ISheetNoteShowEventParams

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SheetNoteShow, (params) => {
  const { workbook, worksheet, row, col } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

SheetNoteUpdate

public

"SheetNoteUpdate"

Event fired when a note is updated

See

ISheetNoteUpdateEventParams

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SheetNoteUpdate, (params) => {
  const { workbook, worksheet, row, col, note, oldNote } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

SheetPrintCanceled

readonly

"SheetPrintCanceled"

Event triggered when print operation is canceled

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SheetPrintCanceled, (params) => {
  const { renderConfig, layoutConfig } = params;
  console.log('params', params);
});
 
// Remove the event listener, use `disposable.dispose()`.

SheetPrintConfirmed

readonly

"SheetPrintConfirmed"

Event triggered when print settings are confirmed

See

ISheetPrintConfirmedEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SheetPrintConfirmed, (params) => {
  const { renderConfig, layoutConfig } = params;
  console.log('params', params);
});
 
// Remove the event listener, use `disposable.dispose()`.

SheetPrintOpen

readonly

"SheetPrintOpen"

Event triggered when print dialog opens

See

ISheetPrintOpenEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SheetPrintOpen, (params) => {
  const { workbook, worksheet } = params;
  console.log('params', params);
});
 
// Remove the event listener, use `disposable.dispose()`.

SheetRangeFilterCleared

readonly

"SheetRangeFilterCleared"

This event will be emitted when the filter on a worksheet is cleared.

See

ISheetRangeFilterClearedEventParams

Example

const callbackDisposable = univerAPI.addEvent(univerAPI.Event.SheetRangeFilterCleared, (params) => {
  console.log(params);
  const { workbook, worksheet } = params;
 
  // your custom logic
});
 
// Remove the event listener, use `callbackDisposable.dispose()`

SheetRangeFiltered

readonly

"SheetRangeFiltered"

This event will be emitted when the filter criteria on a column is changed.

See

ISheetRangeFilteredParams

Example

const callbackDisposable = univerAPI.addEvent(univerAPI.Event.SheetRangeFiltered, (params) => {
  console.log(params);
  const { workbook, worksheet, col, criteria } = params;
 
  // your custom logic
});
 
// Remove the event listener, use `callbackDisposable.dispose()`

SheetRangeSorted

public

"SheetRangeSorted"

This event will be emitted when a range on a worksheet is sorted.

See

ISheetRangeSortParams

Example

const callbackDisposable = univerAPI.addEvent(univerAPI.Event.SheetRangeSorted, (params) => {
  console.log(params);
  const { workbook, worksheet, range, sortColumn } = params;
});
 
// Remove the event listener, use `callbackDisposable.dispose()`

SheetSkeletonChanged

readonly

"SheetSkeletonChanged"

Event fired when sheet skeleton changed

See

ISheetSkeletonChangedEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SheetSkeletonChanged, (params)=> {
  const { worksheet, workbook, skeleton, payload, effectedRanges } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

SheetSparklineChanged

readonly

"SheetSparklineChanged"

Trigger this event after the sparkline changes. Type of the event parameter is IFSheetSparklineChangedEventParams

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SheetSparklineChanged, (params) => {
  console.log('SheetSparklineChanged', params);
  const { workbook, worksheet, sparklines } = params;
});
 
// Remove the event listener, use `disposable.dispose()`.

SheetValueChanged

readonly

"SheetValueChanged"

Event fired when sheet value changed

See

ISheetValueChangedEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SheetValueChanged, (params)=> {
  const { effectedRanges, payload } = params;
  console.log('sheet value changed', params);
});
 
// Remove the event listener, use `disposable.dispose()`

SheetZoomChanged

readonly

"SheetZoomChanged"

Event fired when zoom changed

See

ISheetZoomEvent

Example

const disposable = univerAPI.addEvent(univerAPI.Event.SheetZoomChanged, (params)=> {
  const { worksheet, workbook, zoom } = params;
  console.log(params);
});
 
// Remove the event listener, use `disposable.dispose()`

Accessors

ActiveSheetChanged

Get Signature

get ActiveSheetChanged(): "ActiveSheetChanged";

Event fired after the active sheet changes

See

IActiveSheetChangedEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.ActiveSheetChanged, (params) => {
  const { workbook, activeSheet } = params;
  console.log('after active sheet changed', params);
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"ActiveSheetChanged"

BeforeActiveSheetChange

Get Signature

get BeforeActiveSheetChange(): "BeforeActiveSheetChange";

Event fired before the active sheet changes

See

IBeforeActiveSheetChangeEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeActiveSheetChange, (params) => {
  const { workbook, activeSheet, oldActiveSheet } = params;
  console.log('before active sheet change', params);
 
  // Cancel the active sheet change operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"BeforeActiveSheetChange"

BeforeCommandExecute

Get Signature

get BeforeCommandExecute(): "BeforeCommandExecute";

Event fired before a command is executed

See

ICommandEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeCommandExecute, (event) => {
  const { params, id, type, options } = event;
  console.log('before command executed', event);
 
  // Cancel the command execution
  event.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"BeforeCommandExecute"

BeforeGridlineColorChange

Get Signature

get BeforeGridlineColorChange(): "BeforeGridlineColorChange";

Event fired before gridline color changed

See

IBeforeGridlineColorChanged

Example
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeGridlineColorChange, (params) => {
  const { workbook, worksheet, color } = params;
  console.log('before gridline color change', params);
 
  // Cancel the gridline color change operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"BeforeGridlineColorChange"

BeforeGridlineEnableChange

Get Signature

get BeforeGridlineEnableChange(): "BeforeGridlineEnableChange";

Event fired before gridline enable changed

See

IBeforeGridlineEnableChange

Example
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeGridlineEnableChange, (params) => {
  const { workbook, worksheet, enabled } = params;
  console.log('before gridline enable change', params);
 
  // Cancel the gridline enable change operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"BeforeGridlineEnableChange"

BeforeRedo

Get Signature

get BeforeRedo(): "BeforeRedo";

Event fired before a redo command is executed

See

ICommandEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeRedo, (event) => {
  const { params, id, type } = event;
  console.log('before redo command executed', event);
 
  // Cancel the redo operation
  event.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"BeforeRedo"

BeforeSheetCreate

Get Signature

get BeforeSheetCreate(): "BeforeSheetCreate";

Event fired before a sheet is created

See

IBeforeSheetCreateEventParams

Example
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetCreate, (params) => {
  const { workbook, index, sheet } = params;
  console.log('before sheet create', params);
 
  // Cancel the sheet creation operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"BeforeSheetCreate"

BeforeSheetDelete

Get Signature

get BeforeSheetDelete(): "BeforeSheetDelete";

Event fired before a sheet is deleted

See

IBeforeSheetDeleteEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetDelete, (params) => {
  const { workbook, worksheet } = params;
  console.log('before sheet delete', params);
 
  // Cancel the sheet deletion operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"BeforeSheetDelete"

BeforeSheetHideChange

Get Signature

get BeforeSheetHideChange(): "BeforeSheetHideChange";

Event fired before a sheet is hidden

See

IBeforeSheetHideChangeEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetHideChange, (params) => {
  const { workbook, worksheet, hidden } = params;
  console.log('before sheet hide change', params);
 
  // Cancel the sheet hide operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"BeforeSheetHideChange"

BeforeSheetMove

Get Signature

get BeforeSheetMove(): "BeforeSheetMove";

Event fired before a sheet is moved

See

IBeforeSheetMoveEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetMove, (params) => {
  const { workbook, worksheet, newIndex, oldIndex } = params;
  console.log('before sheet move', params);
 
  // Cancel the sheet move operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"BeforeSheetMove"

BeforeSheetNameChange

Get Signature

get BeforeSheetNameChange(): "BeforeSheetNameChange";

Event fired before a sheet name is changed

See

IBeforeSheetNameChangeEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetNameChange, (params) => {
  const { workbook, worksheet, newName, oldName } = params;
  console.log('before sheet name change', params);
 
  // Cancel the sheet name change operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"BeforeSheetNameChange"

BeforeSheetTabColorChange

Get Signature

get BeforeSheetTabColorChange(): "BeforeSheetTabColorChange";

Event fired before a sheet tab color is changed

See

IBeforeSheetTabColorChangeEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetTabColorChange, (params) => {
  const { workbook, worksheet, newColor, oldColor } = params;
  console.log('before sheet tab color change', params);
 
  // Cancel the sheet tab color change operation
  params.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"BeforeSheetTabColorChange"

BeforeUndo

Get Signature

get BeforeUndo(): "BeforeUndo";

Event fired before an undo command is executed

See

ICommandEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.BeforeUndo, (event) => {
  const { params, id, type } = event;
  console.log('before undo command executed', event);
 
  // Cancel the undo operation
  event.cancel = true;
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"BeforeUndo"

CommandExecuted

Get Signature

get CommandExecuted(): "CommandExecuted";

Event fired when a command is executed

See

ICommandEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.CommandExecuted, (event) => {
  const { params, id, type, options } = event;
  console.log('command executed', event);
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"CommandExecuted"

DocCreated

Get Signature

get DocCreated(): "DocCreated";

Event fired when a document is created

See

IDocCreatedParam

Example
const disposable = univerAPI.addEvent(univerAPI.Event.DocCreated, (params) => {
  const { unitId, type, doc, unit } = params;
  console.log('doc created', params);
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"DocCreated"

DocDisposed

Get Signature

get DocDisposed(): "DocDisposed";

Event fired when a document is disposed

See

IDocDisposedEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.DocDisposed, (params) => {
  const { unitId, unitType, snapshot } = params;
  console.log('doc disposed', params);
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"DocDisposed"

GridlineChanged

Get Signature

get GridlineChanged(): "GridlineChanged";

Event fired when gridline changed

See

IGridlineChangedEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.GridlineChanged, (params) => {
  const { workbook, worksheet, enabled, color } = params;
  console.log('gridline changed', params);
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"GridlineChanged"

LifeCycleChanged

Get Signature

get LifeCycleChanged(): "LifeCycleChanged";

Event fired when life cycle is changed

See

ILifeCycleChangedEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, (params) => {
  const { stage } = params;
  console.log('life cycle changed', params);
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"LifeCycleChanged"

Redo

Get Signature

get Redo(): "Redo";

Event fired when a redo command is executed

See

ICommandEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.Redo, (event) => {
  const { params, id, type } = event;
  console.log('redo command executed', event);
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"Redo"

SheetCreated

Get Signature

get SheetCreated(): "SheetCreated";

Event fired after a sheet is created

See

ISheetCreatedEventParams

Example
const disposable = univerAPI.addEvent(univerAPI.Event.SheetCreated, (params) => {
  const { workbook, worksheet } = params;
  console.log('sheet created', params);
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"SheetCreated"

SheetDeleted

Get Signature

get SheetDeleted(): "SheetDeleted";

Event fired after a sheet is deleted

See

ISheetDeletedEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.SheetDeleted, (params) => {
  const { workbook, sheetId } = params;
  console.log('sheet deleted', params);
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"SheetDeleted"

SheetHideChanged

Get Signature

get SheetHideChanged(): "SheetHideChanged";

Event fired after a sheet is hidden

See

ISheetHideChangedEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.SheetHideChanged, (params) => {
  const { workbook, worksheet, hidden } = params;
  console.log('sheet hide changed', params);
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"SheetHideChanged"

SheetMoved

Get Signature

get SheetMoved(): "SheetMoved";

Event fired after a sheet is moved

See

ISheetMovedEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.SheetMoved, (params) => {
  const { workbook, worksheet, newIndex } = params;
  console.log('sheet moved', params);
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"SheetMoved"

SheetNameChanged

Get Signature

get SheetNameChanged(): "SheetNameChanged";

Event fired after a sheet name is changed

See

ISheetNameChangedEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.SheetNameChanged, (params) => {
  const { workbook, worksheet, newName } = params;
  console.log('sheet name changed', params);
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"SheetNameChanged"

SheetTabColorChanged

Get Signature

get SheetTabColorChanged(): "SheetTabColorChanged";

Event fired after a sheet tab color is changed

See

ISheetTabColorChangedEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.SheetTabColorChanged, (params) => {
  const { workbook, worksheet, newColor } = params;
  console.log('sheet tab color changed', params);
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"SheetTabColorChanged"

Undo

Get Signature

get Undo(): "Undo";

Event fired when an undo command is executed

See

ICommandEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.Undo, (event) => {
  const { params, id, type } = event;
  console.log('undo command executed', event);
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"Undo"

WorkbookCreated

Get Signature

get WorkbookCreated(): "WorkbookCreated";

Event fired after a workbook is created

See

IWorkbookCreateParam

Example
const disposable = univerAPI.addEvent(univerAPI.Event.WorkbookCreated, (params) => {
  const { unitId, type, workbook, unit } = params;
  console.log('workbook created', params);
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"WorkbookCreated"

WorkbookDisposed

Get Signature

get WorkbookDisposed(): "WorkbookDisposed";

Event fired after a workbook is disposed

See

IWorkbookDisposedEvent

Example
const disposable = univerAPI.addEvent(univerAPI.Event.WorkbookDisposed, (params) => {
  const { unitId, unitType, snapshot } = params;
  console.log('workbook disposed', params);
});
 
// Remove the event listener, use `disposable.dispose()`
Returns

"WorkbookDisposed"

Methods

get()

static get(): FEventName;

Returns

FEventName

FEnumFEventRegistry