@univerjs/sheets 0.6.0 → 0.6.1

package/lib/types/commands/commands/set-border-command.d.ts

@@ -1,8 +1,9 @@
-import { BorderStyleTypes, ICommand, BorderType } from '@univerjs/core';
+import { BorderStyleTypes, ICommand, IRange, BorderType } from '@univerjs/core';
 import { IBorderInfo } from '../../services/border-style-manager.service';
 export interface ISetBorderBasicCommandParams {
     unitId?: string;
     subUnitId?: string;
+    ranges: IRange[];
     value: IBorderInfo;
 }
 export interface ISetBorderPositionCommandParams {
@@ -14,6 +15,7 @@ export interface ISetBorderStyleCommandParams {
 export interface ISetBorderCommandParams {
     unitId?: string;
     subUnitId?: string;
+    ranges?: IRange[];
 }
 export interface ISetBorderColorCommandParams {
     value: string;

package/lib/types/commands/operations/scroll-to-cell.operation.d.ts

@@ -1,2 +1,6 @@
 import { IOperation, IRange } from '@univerjs/core';
-export declare const ScrollToCellOperation: IOperation<IRange>;
+export interface IScrollToCellOperationParams {
+    range: IRange;
+    unitId: string;
+}
+export declare const ScrollToCellOperation: IOperation<IScrollToCellOperationParams>;

package/lib/types/controllers/permission/sheet-permission-init.controller.d.ts

@@ -16,6 +16,7 @@ export declare class SheetPermissionInitController extends Disposable {
     private _commandService;
     private _rangeProtectionCache;
     constructor(_univerInstanceService: IUniverInstanceService, _permissionService: IPermissionService, _authzIoService: IAuthzIoService, _rangeProtectionRuleModel: RangeProtectionRuleModel, _worksheetProtectionRuleModel: WorksheetProtectionRuleModel, _userManagerService: UserManagerService, _worksheetProtectionPointRuleModel: WorksheetProtectionPointModel, _sheetInterceptorService: SheetInterceptorService, _undoRedoService: IUndoRedoService, _commandService: ICommandService, _rangeProtectionCache: RangeProtectionCache);
+    initPermission(): void;
     private _initRangePermissionFromSnapshot;
     private _initRangePermissionChange;
     initWorkbookPermissionChange(_unitId?: string): Promise<void>;

package/lib/types/facade/f-defined-name.d.ts

@@ -12,7 +12,7 @@ export declare class FDefinedNameBuilder {
     /**
      * Sets the name of the defined name builder.
      * @param {string} name The name of the defined name.
-     * @returns {FDefinedNameBuilder} The defined name builder.
+     * @returns {FDefinedNameBuilder} The instance of `FDefinedNameBuilder` for method chaining.
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
@@ -26,7 +26,7 @@ export declare class FDefinedNameBuilder {
     /**
      * Sets the formula of the defined name builder.
      * @param {string }formula The formula of the defined name.
-     * @returns {FDefinedNameBuilder} The defined name builder.
+     * @returns {FDefinedNameBuilder} The instance of `FDefinedNameBuilder` for method chaining.
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
@@ -41,7 +41,7 @@ export declare class FDefinedNameBuilder {
     /**
      * Sets the reference of the defined name builder.
      * @param {string} a1Notation The reference of the defined name.
-     * @returns {FDefinedNameBuilder} The defined name builder.
+     * @returns {FDefinedNameBuilder} The instance of `FDefinedNameBuilder` for method chaining.
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
@@ -58,7 +58,7 @@ export declare class FDefinedNameBuilder {
      * @param {number} column The start column of the range.
      * @param {number} numRows The number of rows in the range.
      * @param {number} numColumns The number of columns in the range.
-     * @returns {FDefinedNameBuilder} The defined name builder.
+     * @returns {FDefinedNameBuilder} The instance of `FDefinedNameBuilder` for method chaining.
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
@@ -72,7 +72,7 @@ export declare class FDefinedNameBuilder {
     /**
      * Sets the comment of the defined name builder.
      * @param {string} comment The comment of the defined name.
-     * @returns {FDefinedNameBuilder} The defined name builder.
+     * @returns {FDefinedNameBuilder} The instance of `FDefinedNameBuilder` for method chaining.
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
@@ -86,7 +86,7 @@ export declare class FDefinedNameBuilder {
     /**
      * Sets the hidden status of the defined name builder.
      * @param {boolean} hidden The hidden status of the defined name.
-     * @returns {FDefinedNameBuilder} The defined name builder.
+     * @returns {FDefinedNameBuilder} The instance of `FDefinedNameBuilder` for method chaining.
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
@@ -98,19 +98,39 @@ export declare class FDefinedNameBuilder {
      */
     setHidden(hidden: boolean): FDefinedNameBuilder;
     /**
-     * Builds the defined name.
-     * @returns {FDefinedNameBuilder} The defined name mutation parameter.
+     * Builds the defined name parameter.
+     * @returns {ISetDefinedNameMutationParam} The defined name mutation parameter.
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
      * const definedNameBuilder = univerAPI.newDefinedName()
      *   .setRef('Sheet1!$A$1')
      *   .setName('MyDefinedName')
+     *   .setComment('This is a comment')
      *   .build();
      * workbook.insertDefinedNameBuilder(definedNameBuilder);
      * ```
      */
     build(): ISetDefinedNameMutationParam;
+    /**
+     * Loads the defined name mutation parameter.
+     * @param {ISetDefinedNameMutationParam} param - defined name mutation parameter
+     * @returns {FDefinedNameBuilder} The instance of `FDefinedNameBuilder` for method chaining.
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const definedNameParam = {
+     *   id: '4TMPceoqg8',
+     *   unitId: workbook.getId(),
+     *   name: 'MyDefinedName',
+     *   formulaOrRefString: 'Sheet1!$A$1',
+     * }
+     * const definedNameBuilder = univerAPI.newDefinedName()
+     *   .load(definedNameParam)
+     *   .build();
+     * workbook.insertDefinedNameBuilder(definedNameBuilder);
+     * ```
+     */
     load(param: ISetDefinedNameMutationParam): FDefinedNameBuilder;
 }
 /**
@@ -135,8 +155,8 @@ export declare class FDefinedName extends FBase {
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
-     * const definedName = workbook.getDefinedNames[0];
-     * console.log(definedName.getName());
+     * const definedName = workbook.getDefinedNames()[0];
+     * console.log(definedName?.getName());
      * ```
      */
     getName(): string;
@@ -146,8 +166,8 @@ export declare class FDefinedName extends FBase {
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
-     * const definedName = workbook.getDefinedName('MyDefinedName');
-     * definedName.setName('NewDefinedName');
+     * const definedName = workbook.getDefinedNames()[0];
+     * definedName?.setName('NewDefinedName');
      * ```
      */
     setName(name: string): void;
@@ -157,8 +177,8 @@ export declare class FDefinedName extends FBase {
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
-     * const definedName = workbook.getDefinedName('MyDefinedName');
-     * definedName.setFormula('SUM(Sheet1!$A$1)');
+     * const definedName = workbook.getDefinedNames()[0];
+     * definedName?.setFormula('SUM(Sheet1!$A$1)');
      * ```
      */
     setFormula(formula: string): void;
@@ -168,19 +188,19 @@ export declare class FDefinedName extends FBase {
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
-     * const definedName = workbook.getDefinedNames[0];
-     * definedName.setRef('Sheet1!$A$1');
+     * const definedName = workbook.getDefinedNames()[0];
+     * definedName?.setRef('Sheet1!$A$1');
      * ```
      */
     setRef(refString: string): void;
     /**
-     * Gets the reference of the defined name.
-     * @returns {string} The reference of the defined name.
+     * Gets the formula or reference string of the defined name.
+     * @returns {string} The formula or reference string of the defined name.
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
-     * const definedName = workbook.getDefinedNames[0];
-     * console.log(definedName.getFormulaOrRefString());
+     * const definedName = workbook.getDefinedNames()[0];
+     * console.log(definedName?.getFormulaOrRefString());
      * ```
      */
     getFormulaOrRefString(): string;
@@ -193,8 +213,8 @@ export declare class FDefinedName extends FBase {
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
-     * const definedName = workbook.getDefinedNames[0];
-     * definedName.setRefByRange(1, 3, 2, 5);
+     * const definedName = workbook.getDefinedNames()[0];
+     * definedName?.setRefByRange(1, 3, 2, 5);
      * ```
      */
     setRefByRange(row: number, column: number, numRows: number, numColumns: number): void;
@@ -204,8 +224,8 @@ export declare class FDefinedName extends FBase {
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
-     * const definedName = workbook.getDefinedNames[0];
-     * console.log(definedName.getComment());
+     * const definedName = workbook.getDefinedNames()[0];
+     * console.log(definedName?.getComment());
      * ```
      */
     getComment(): string | undefined;
@@ -215,8 +235,8 @@ export declare class FDefinedName extends FBase {
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
-     * const definedName = workbook.getDefinedNames[0];
-     * definedName.setComment('This is a comment');
+     * const definedName = workbook.getDefinedNames()[0];
+     * definedName?.setComment('This is a comment');
      * ```
      */
     setComment(comment: string): void;
@@ -226,9 +246,9 @@ export declare class FDefinedName extends FBase {
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
-     * const worksheet = workbook.getWorksheets[0];
-     * const definedName = workbook.getDefinedNames[0];
-     * definedName.setScopeToWorksheet(worksheet);
+     * const worksheet = workbook.getSheets()[0];
+     * const definedName = workbook.getDefinedNames()[0];
+     * definedName?.setScopeToWorksheet(worksheet);
      * ```
      */
     setScopeToWorksheet(worksheet: FWorksheet): void;
@@ -237,8 +257,8 @@ export declare class FDefinedName extends FBase {
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
-     * const definedName = workbook.getDefinedNames[0];
-     * definedName.setScopeToWorkbook();
+     * const definedName = workbook.getDefinedNames()[0];
+     * definedName?.setScopeToWorkbook();
      * ```
      */
     setScopeToWorkbook(): void;
@@ -248,8 +268,8 @@ export declare class FDefinedName extends FBase {
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
-     * const definedName = workbook.getDefinedNames[0];
-     * definedName.setHidden(true);
+     * const definedName = workbook.getDefinedNames()[0];
+     * definedName?.setHidden(true);
      * ```
      */
     setHidden(hidden: boolean): void;
@@ -258,8 +278,8 @@ export declare class FDefinedName extends FBase {
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
-     * const definedName = workbook.getDefinedNames[0];
-     * definedName.delete();
+     * const definedName = workbook.getDefinedNames()[0];
+     * definedName?.delete();
      * ```
      */
     delete(): void;
@@ -269,8 +289,8 @@ export declare class FDefinedName extends FBase {
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
-     * const definedName = workbook.getDefinedNames[0];
-     * console.log(definedName.getLocalSheetId());
+     * const definedName = workbook.getDefinedNames()[0];
+     * console.log(definedName?.getLocalSheetId());
      * ```
      */
     getLocalSheetId(): string | undefined;
@@ -280,8 +300,8 @@ export declare class FDefinedName extends FBase {
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
-     * const definedName = workbook.getDefinedNames[0];
-     * console.log(definedName.isWorkbookScope());
+     * const definedName = workbook.getDefinedNames()[0];
+     * console.log(definedName?.isWorkbookScope());
      * ```
      */
     isWorkbookScope(): boolean;
@@ -291,10 +311,14 @@ export declare class FDefinedName extends FBase {
      * @example
      * ```ts
      * const workbook = univerAPI.getActiveWorkbook();
-     * const definedName = workbook.getDefinedNames[0];
-     * const definedNameBuilder = definedName.toBuilder();
-     * const param definedNameBuilder.setName('NewDefinedName').setFormula('SUM(Sheet1!$A$1)').build();
-     * workbook.updateDefinedNameBuilder(param);
+     * const definedName = workbook.getDefinedNames()[0];
+     * if (!definedName) return;
+     * const definedNameBuilder = definedName
+     *   .toBuilder()
+     *   .setName('NewDefinedName')
+     *   .setFormula('SUM(Sheet1!$A$1)')
+     *   .build();
+     * workbook.updateDefinedNameBuilder(definedNameBuilder);
      * ```
      */
     toBuilder(): FDefinedNameBuilder;

package/lib/types/facade/f-enum.d.ts

@@ -1,4 +1,4 @@
-import { SheetSkeletonChangeType, SheetValueChangeType } from '@univerjs/sheets';
+import { SheetSkeletonChangeType, SheetValueChangeType, SplitDelimiterEnum } from '@univerjs/sheets';
 /**
  * @ignore
  */
@@ -13,10 +13,15 @@ export interface IFSheetsEnum {
      * Includes operations like changing row/column dimensions, visibility, and grid properties.
      */
     SheetSkeletonChangeType: typeof SheetSkeletonChangeType;
+    /**
+     * Split delimiter types.
+     */
+    SplitDelimiterType: typeof SplitDelimiterEnum;
 }
 export declare class FSheetsEnum implements IFSheetsEnum {
     get SheetValueChangeType(): typeof SheetValueChangeType;
     get SheetSkeletonChangeType(): typeof SheetSkeletonChangeType;
+    get SplitDelimiterType(): typeof SplitDelimiterEnum;
 }
 declare module '@univerjs/core/facade' {
     interface FEnum extends IFSheetsEnum {

package/lib/types/facade/f-event.d.ts

@@ -15,10 +15,12 @@ export interface IFSheetEventMixin {
      * @see {@link ISheetCreatedEventParams}
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.SheetCreated, (params) => {
+     * const disposable = univerAPI.addEvent(univerAPI.Event.SheetCreated, (params) => {
      *   const { workbook, worksheet } = params;
      *   console.log('sheet created', params);
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     get SheetCreated(): 'SheetCreated';
@@ -27,22 +29,32 @@ export interface IFSheetEventMixin {
      * @see {@link IBeforeSheetCreateEventParams}
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.BeforeSheetCreate, (params) => {
+     * 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()`
      * ```
      */
     get BeforeSheetCreate(): 'BeforeSheetCreate';
     /**
      * Event fired before the active sheet changes
-     * @see {@link IActiveSheetChangedEvent}
+     * @see {@link IBeforeActiveSheetChangeEvent}
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.ActiveSheetChanged, (params) => {
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeActiveSheetChange, (params) => {
      *   const { workbook, activeSheet, oldActiveSheet } = params;
-     *   console.log('before active sheet changed', params);
+     *   console.log('before active sheet change', params);
+     *
+     *   // Cancel the active sheet change operation
+     *   params.cancel = true;
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     get BeforeActiveSheetChange(): 'BeforeActiveSheetChange';
@@ -51,22 +63,26 @@ export interface IFSheetEventMixin {
      * @see {@link IActiveSheetChangedEvent}
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.ActiveSheetChanged, (params) => {
+     * 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()`
      * ```
      */
     get ActiveSheetChanged(): 'ActiveSheetChanged';
     /**
-     * Event fired before a sheet is deleted
-     * @see {@link IBeforeSheetDeleteEvent}
+     * Event fired after a sheet is deleted
+     * @see {@link ISheetDeletedEvent}
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.BeforeSheetDelete, (params) => {
-     *   const { workbook, worksheetId } = params;
-     *   console.log('before sheet delete', params);
+     * const disposable = univerAPI.addEvent(univerAPI.Event.SheetDeleted, (params) => {
+     *   const { workbook, sheetId } = params;
+     *   console.log('sheet deleted', params);
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     get SheetDeleted(): 'SheetDeleted';
@@ -75,10 +91,15 @@ export interface IFSheetEventMixin {
      * @see {@link IBeforeSheetDeleteEvent}
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.BeforeSheetDelete, (params) => {
+     * 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()`
      * ```
      */
     get BeforeSheetDelete(): 'BeforeSheetDelete';
@@ -87,10 +108,12 @@ export interface IFSheetEventMixin {
      * @see {@link ISheetMovedEvent}
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.SheetMoved, (params) => {
+     * 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()`
      * ```
      */
     get SheetMoved(): 'SheetMoved';
@@ -99,10 +122,15 @@ export interface IFSheetEventMixin {
      * @see {@link IBeforeSheetMoveEvent}
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.BeforeSheetMove, (params) => {
+     * 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()`
      * ```
      */
     get BeforeSheetMove(): 'BeforeSheetMove';
@@ -111,10 +139,12 @@ export interface IFSheetEventMixin {
      * @see {@link ISheetNameChangedEvent}
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.SheetNameChanged, (params) => {
+     * 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()`
      * ```
      */
     get SheetNameChanged(): 'SheetNameChanged';
@@ -123,10 +153,15 @@ export interface IFSheetEventMixin {
      * @see {@link IBeforeSheetNameChangeEvent}
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.BeforeSheetNameChange, (params) => {
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeSheetNameChange, (params) => {
      *   const { workbook, worksheet, newName, oldName } = params;
-     *   console.log('before sheet name changed', params);
+     *   console.log('before sheet name change', params);
+     *
+     *   // Cancel the sheet name change operation
+     *   params.cancel = true;
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     get BeforeSheetNameChange(): 'BeforeSheetNameChange';
@@ -135,10 +170,12 @@ export interface IFSheetEventMixin {
      * @see {@link ISheetTabColorChangedEvent}
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.SheetTabColorChanged, (params) => {
-     *   const { workbook, worksheet, color } = params;
+     * 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()`
      * ```
      */
     get SheetTabColorChanged(): 'SheetTabColorChanged';
@@ -147,10 +184,15 @@ export interface IFSheetEventMixin {
      * @see {@link IBeforeSheetTabColorChangeEvent}
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.BeforeSheetTabColorChange, (params) => {
-     *   const { workbook, worksheet, color, oldColor } = params;
-     *   console.log('before sheet tab color changed', params);
+     * 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()`
      * ```
      */
     get BeforeSheetTabColorChange(): 'BeforeSheetTabColorChange';
@@ -159,10 +201,12 @@ export interface IFSheetEventMixin {
      * @see {@link ISheetHideChangedEvent}
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.SheetHideChanged, (params) => {
-     *   const { workbook, worksheet } = params;
+     * 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()`
      * ```
      */
     get SheetHideChanged(): 'SheetHideChanged';
@@ -171,10 +215,15 @@ export interface IFSheetEventMixin {
      * @see {@link IBeforeSheetHideChangeEvent}
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.BeforeSheetHideChange, (params) => {
-     *   const { workbook, worksheet, hide } = params;
-     *   console.log('before sheet hide changed', params);
+     * 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()`
      * ```
      */
     get BeforeSheetHideChange(): 'BeforeSheetHideChange';
@@ -183,10 +232,12 @@ export interface IFSheetEventMixin {
      * @see {@link IWorkbookCreateParam}
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.WorkbookCreated, (params) => {
+     * 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()`
      * ```
      */
     get WorkbookCreated(): 'WorkbookCreated';
@@ -195,10 +246,12 @@ export interface IFSheetEventMixin {
      * @see {@link IWorkbookDisposedEvent}
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.WorkbookDisposed, (params) => {
+     * const disposable = univerAPI.addEvent(univerAPI.Event.WorkbookDisposed, (params) => {
      *   const { unitId, unitType, snapshot } = params;
-     *   console.log('unit disposed', params);
+     *   console.log('workbook disposed', params);
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     get WorkbookDisposed(): 'WorkbookDisposed';
@@ -207,10 +260,12 @@ export interface IFSheetEventMixin {
      * @see {@link IGridlineChangedEvent}
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.GridlineChanged, (params) => {
+     * 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()`
      * ```
      */
     get GridlineChanged(): 'GridlineChanged';
@@ -219,10 +274,15 @@ export interface IFSheetEventMixin {
      * @see {@link IBeforeGridlineEnableChange}
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.BeforeGridlineEnableChange, (params) => {
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeGridlineEnableChange, (params) => {
      *   const { workbook, worksheet, enabled } = params;
-     *   console.log('gridline changed', params);
+     *   console.log('before gridline enable change', params);
+     *
+     *   // Cancel the gridline enable change operation
+     *   params.cancel = true;
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     get BeforeGridlineEnableChange(): 'BeforeGridlineEnableChange';
@@ -231,20 +291,29 @@ export interface IFSheetEventMixin {
      * @see {@link IBeforeGridlineColorChanged}
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.BeforeGridlineColorChange, (params) => {
+     * const disposable = univerAPI.addEvent(univerAPI.Event.BeforeGridlineColorChange, (params) => {
      *   const { workbook, worksheet, color } = params;
-     *   console.log('gridline changed', params);
+     *   console.log('before gridline color change', params);
+     *
+     *   // Cancel the gridline color change operation
+     *   params.cancel = true;
      * });
+     *
+     * // Remove the event listener, use `disposable.dispose()`
      * ```
      */
     get BeforeGridlineColorChange(): 'BeforeGridlineColorChange';
     /**
      * Event fired when sheet value changed
+     * @see {@link ISheetValueChangedEvent}
      * @example
      * ```ts
-     * univerAPI.addEvent(univerAPI.Event.SheetValueChanged, (p)=> {
-     *   const { workbook, effectedRanges, payload } = p;
+     * 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()`
      * ```
      */
     readonly SheetValueChanged: 'SheetValueChanged';