@univerjs/sheets 0.5.3 → 0.5.4-experimental.20250114-7c09c35

package/lib/es/facade.js

@@ -1,34 +1,34 @@
-var We = Object.defineProperty;
-var Te = (o, e, t) => e in o ? We(o, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : o[e] = t;
-var p = (o, e, t) => Te(o, typeof e != "symbol" ? e + "" : e, t);
-import { Inject as m, Injector as v, IAuthzIoService as Se, LocaleService as ke, ICommandService as l, IPermissionService as J, generateRandomId as Ce, FBase as Q, Rectangle as E, HorizontalAlign as R, VerticalAlign as b, isFormulaString as Me, isCellV as je, isICellData as Ae, ObjectMatrix as T, Tools as Fe, RANGE_TYPE as _, FBaseInitialable as X, BooleanNumber as u, WrapStrategy as ee, Dimension as te, ILogService as Ie, Direction as N, IResourceLoaderService as Oe, mergeWorksheetSnapshotWithDefault as Be, UndoCommand as Le, RedoCommand as ze, toDisposable as fe, UniverInstanceType as P, IUniverInstanceService as ve, FUniver as Re, FEventName as be } from "@univerjs/core";
-import { WorksheetProtectionRuleModel as pe, RangeProtectionRuleModel as ye, WorksheetProtectionPointModel as Pe, SetDefinedNameCommand as G, SCOPE_WORKBOOK_VALUE_DEFINED_NAME as q, RemoveDefinedNameCommand as Ve, PermissionPointsDefinitions as He, WorkbookEditablePermission as Ue, UnitObject as y, AddWorksheetProtectionMutation as $e, DeleteWorksheetProtectionMutation as Ge, getAllWorksheetPermissionPoint as qe, getAllWorksheetPermissionPointByPointPanel as ne, SetWorksheetPermissionPointsMutation as Ke, AddRangeProtectionMutation as Ye, DeleteRangeProtectionMutation as Je, SetRangeProtectionMutation as Qe, WorksheetEditPermission as Xe, WorksheetViewPermission as Ze, SetStyleCommand as C, SetRangeValuesCommand as se, SetTextWrapCommand as oe, SetVerticalTextAlignCommand as et, SetHorizontalTextAlignCommand as tt, addMergeCellsUtil as B, getAddMergeMutationRangeByType as re, RemoveWorksheetMergeCommand as nt, SplitTextToColumnsCommand as st, SetWorksheetRangeThemeStyleCommand as ot, DeleteWorksheetRangeThemeStyleCommand as rt, SheetRangeThemeService as Ee, getPrimaryForRange as K, SetSelectionsOperation as xe, getNextPrimaryCell as it, SheetsSelectionsService as Ne, SetWorksheetDefaultStyleMutation as at, SetColDataCommand as ie, SetRowDataCommand as ae, copyRangeStyles as D, InsertRowByRangeCommand as he, RemoveRowByRangeCommand as ht, MoveRowsCommand as ct, SetRowHiddenCommand as ce, SetSpecificRowsVisibleCommand as de, SetRowHeightCommand as me, SetWorksheetRowIsAutoHeightCommand as dt, InsertColByRangeCommand as ue, RemoveColByRangeCommand as mt, MoveColsCommand as ut, SetColHiddenCommand as le, SetSpecificColsVisibleCommand as ge, SetColWidthCommand as lt, SetFrozenCommand as L, CancelFrozenCommand as gt, ToggleGridlinesCommand as _t, SetGridlinesColorCommand as wt, SetTabColorCommand as St, SetRangeValuesMutation as _e, SetWorksheetHideCommand as kt, SetWorksheetShowCommand as Ct, SetWorksheetNameCommand as It, ClearSelectionAllCommand as ft, ClearSelectionContentCommand as vt, ClearSelectionFormatCommand as Rt, InsertSheetCommand as U, SetWorksheetActiveOperation as z, RemoveSheetCommand as bt, CopySheetCommand as pt, SetWorksheetOrderCommand as yt, RegisterWorksheetRangeThemeStyleCommand as Pt, UnregisterWorksheetRangeThemeStyleCommand as Ut } from "@univerjs/sheets";
-import { IDefinedNamesService as De, serializeRange as Z, FormulaDataModel as Et, serializeRangeWithSheet as xt, deserializeRangeWithSheet as Nt } from "@univerjs/engine-formula";
-var Dt = Object.defineProperty, Wt = Object.getOwnPropertyDescriptor, Tt = (o, e, t, n) => {
-  for (var s = n > 1 ? void 0 : n ? Wt(e, t) : e, r = o.length - 1, i; r >= 0; r--)
-    (i = o[r]) && (s = (n ? i(e, t, s) : i(s)) || s);
-  return n && s && Dt(e, t, s), s;
-}, w = (o, e) => (t, n) => e(t, n, o);
-function Mt(o, e, t) {
-  const n = t.getDefinedNameMap(o);
+var Ae = Object.defineProperty;
+var Fe = (s, e, t) => e in s ? Ae(s, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : s[e] = t;
+var k = (s, e, t) => Fe(s, typeof e != "symbol" ? e + "" : e, t);
+import { Inject as u, Injector as b, IAuthzIoService as ve, LocaleService as Re, ICommandService as l, IPermissionService as ee, generateRandomId as be, FBase as te, Rectangle as N, HorizontalAlign as y, VerticalAlign as U, isFormulaString as je, isCellV as Oe, isICellData as Ve, ObjectMatrix as A, Tools as Be, RANGE_TYPE as _, FBaseInitialable as ne, RichTextValue as p, BooleanNumber as m, WrapStrategy as oe, Dimension as ie, ILogService as pe, Registry as ye, toDisposable as F, Direction as D, IResourceLoaderService as Le, FEnum as ze, FEventName as se, mergeWorksheetSnapshotWithDefault as $e, UndoCommand as He, RedoCommand as Ge, UniverInstanceType as R, IUniverInstanceService as J, FUniver as Ue, CanceledError as qe } from "@univerjs/core";
+import { WorksheetProtectionRuleModel as Ee, RangeProtectionRuleModel as Pe, WorksheetProtectionPointModel as xe, SetDefinedNameCommand as Q, SCOPE_WORKBOOK_VALUE_DEFINED_NAME as X, RemoveDefinedNameCommand as Ke, PermissionPointsDefinitions as Ye, WorkbookEditablePermission as Ne, UnitObject as E, AddWorksheetProtectionMutation as Je, DeleteWorksheetProtectionMutation as Qe, getAllWorksheetPermissionPoint as Xe, getAllWorksheetPermissionPointByPointPanel as ae, SetWorksheetPermissionPointsMutation as Ze, AddRangeProtectionMutation as et, DeleteRangeProtectionMutation as tt, SetRangeProtectionMutation as nt, WorksheetEditPermission as st, WorksheetViewPermission as rt, SetStyleCommand as f, SetRangeValuesCommand as P, SetTextWrapCommand as he, SetVerticalTextAlignCommand as ot, SetHorizontalTextAlignCommand as it, addMergeCellsUtil as $, getAddMergeMutationRangeByType as ce, RemoveWorksheetMergeCommand as at, SplitTextToColumnsCommand as ht, SetWorksheetRangeThemeStyleCommand as ct, DeleteWorksheetRangeThemeStyleCommand as dt, SheetRangeThemeService as Me, getPrimaryForRange as Z, SetSelectionsOperation as De, getNextPrimaryCell as ut, SheetsSelectionsService as We, SetWorksheetDefaultStyleMutation as mt, SetColDataCommand as de, SetRowDataCommand as ue, copyRangeStyles as W, InsertRowByRangeCommand as me, RemoveRowByRangeCommand as lt, MoveRowsCommand as gt, SetRowHiddenCommand as le, SetSpecificRowsVisibleCommand as ge, SetRowHeightCommand as _e, SetWorksheetRowIsAutoHeightCommand as _t, InsertColByRangeCommand as we, RemoveColByRangeCommand as wt, MoveColsCommand as kt, SetColHiddenCommand as ke, SetSpecificColsVisibleCommand as Se, SetColWidthCommand as St, SetFrozenCommand as H, CancelFrozenCommand as Ct, ToggleGridlinesCommand as It, SetGridlinesColorCommand as ft, SetTabColorCommand as vt, SetRangeValuesMutation as Ce, SetWorksheetHideCommand as Rt, SetWorksheetShowCommand as bt, SetWorksheetNameCommand as pt, ClearSelectionAllCommand as yt, ClearSelectionContentCommand as Ut, ClearSelectionFormatCommand as Et, InsertSheetCommand as x, SetWorksheetActiveOperation as G, RemoveSheetCommand as Pt, CopySheetCommand as xt, SetWorksheetOrderCommand as Nt, RegisterWorksheetRangeThemeStyleCommand as Mt, UnregisterWorksheetRangeThemeStyleCommand as Dt } from "@univerjs/sheets";
+import { IDefinedNamesService as Te, serializeRange as re, FormulaDataModel as Wt, serializeRangeWithSheet as Tt, deserializeRangeWithSheet as At } from "@univerjs/engine-formula";
+var Ft = Object.defineProperty, jt = Object.getOwnPropertyDescriptor, Ot = (s, e, t, n) => {
+  for (var r = n > 1 ? void 0 : n ? jt(e, t) : e, o = s.length - 1, i; o >= 0; o--)
+    (i = s[o]) && (r = (n ? i(e, t, r) : i(r)) || r);
+  return n && r && Ft(e, t, r), r;
+}, S = (s, e) => (t, n) => e(t, n, s);
+function Vt(s, e, t) {
+  const n = t.getDefinedNameMap(s);
   if (n == null)
     return e.t("definedName.defaultName") + 1;
-  const r = Array.from(Object.values(n)).length + 1, i = e.t("definedName.defaultName") + r;
-  if (t.getValueByName(o, i) == null)
+  const o = Array.from(Object.values(n)).length + 1, i = e.t("definedName.defaultName") + o;
+  if (t.getValueByName(s, i) == null)
     return i;
-  let a = r + 1;
+  let a = o + 1;
   for (; ; ) {
     const h = e.t("definedName.defaultName") + a;
-    if (t.getValueByName(o, h) == null)
+    if (t.getValueByName(s, h) == null)
       return h;
     a++;
   }
 }
-class F {
+class L {
   constructor() {
-    p(this, "_definedNameParam");
+    k(this, "_definedNameParam");
     this._definedNameParam = {
-      id: Ce(10),
+      id: be(10),
       unitId: "",
       name: "",
       formulaOrRefString: ""
@@ -36,12 +36,12 @@ class F {
   }
   /**
    * Sets the name of the defined name builder.
-   * @param name  The name of the defined name.
-   * @returns The defined name builder.
+   * @param {string} name The name of the defined name.
+   * @returns {FDefinedNameBuilder} The defined name builder.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
-   * const definedNameBuilder = UniverAPI.newDefinedName()
+   * const workbook = univerAPI.getActiveWorkbook();
+   * const definedNameBuilder = univerAPI.newDefinedName()
    *    .setName('MyDefinedName')
    *  .build();
    * workbook.insertDefinedNameBuilder(definedNameBuilder);
@@ -52,12 +52,12 @@ class F {
   }
   /**
    * Sets the formula of the defined name builder.
-   * @param formula The formula of the defined name.
-   * @returns The defined name builder.
+   * @param {string }formula The formula of the defined name.
+   * @returns {FDefinedNameBuilder} The defined name builder.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
-   * const definedNameBuilder = UniverAPI.newDefinedName()
+   * const workbook = univerAPI.getActiveWorkbook();
+   * const definedNameBuilder = univerAPI.newDefinedName()
    *  .setFormula('SUM(Sheet1!$A$1)')
    * .setName('MyDefinedName')
    * .build();
@@ -69,12 +69,12 @@ class F {
   }
   /**
    * Sets the reference of the defined name builder.
-   * @param refString The reference of the defined name.
-   * @returns The defined name builder.
+   * @param {string} a1Notation The reference of the defined name.
+   * @returns {FDefinedNameBuilder} The defined name builder.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
-   * const definedNameBuilder = UniverAPI.newDefinedName()
+   * const workbook = univerAPI.getActiveWorkbook();
+   * const definedNameBuilder = univerAPI.newDefinedName()
    *  .setRef('Sheet1!$A$1')
    * .build();
    * workbook.insertDefinedNameBuilder(definedNameBuilder);
@@ -85,36 +85,36 @@ class F {
   }
   /**
    * Sets the reference of the defined name builder by range .
-   * @param row The start row of the range.
-   * @param column The start column of the range.
-   * @param numRows The number of rows in the range.
-   * @param numColumns The number of columns in the range.
-   * @returns The defined name builder.
+   * @param {number} row The start row of the range.
+   * @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.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
-   * const definedNameBuilder = UniverAPI.newDefinedName()
+   * const workbook = univerAPI.getActiveWorkbook();
+   * const definedNameBuilder = univerAPI.newDefinedName()
    *  .setRefByRange(1, 3, 2, 5)
    * .build();
    * workbook.insertDefinedNameBuilder(definedNameBuilder);
    * ```
    */
-  setRefByRange(e, t, n, s) {
-    return this._definedNameParam.formulaOrRefString = Z({
+  setRefByRange(e, t, n, r) {
+    return this._definedNameParam.formulaOrRefString = re({
       startRow: e,
       endRow: e + (n != null ? n : 1) - 1,
       startColumn: t,
-      endColumn: t + (s != null ? s : 1) - 1
+      endColumn: t + (r != null ? r : 1) - 1
     }), this;
   }
   /**
    * Sets the comment of the defined name builder.
-   * @param comment The comment of the defined name.
-   * @returns The defined name builder.
+   * @param {string} comment The comment of the defined name.
+   * @returns {FDefinedNameBuilder} The defined name builder.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
-   * const definedNameBuilder = UniverAPI.newDefinedName()
+   * const workbook = univerAPI.getActiveWorkbook();
+   * const definedNameBuilder = univerAPI.newDefinedName()
    *  .setComment('This is a comment')
    * .build();
    * workbook.insertDefinedNameBuilder(definedNameBuilder);
@@ -125,12 +125,12 @@ class F {
   }
   /**
    * Sets the hidden status of the defined name builder.
-   * @param hidden The hidden status of the defined name.
-   * @returns The defined name builder.
+   * @param {boolean} hidden The hidden status of the defined name.
+   * @returns {FDefinedNameBuilder} The defined name builder.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
-   * const definedNameBuilder = UniverAPI.newDefinedName()
+   * const workbook = univerAPI.getActiveWorkbook();
+   * const definedNameBuilder = univerAPI.newDefinedName()
    *  .setHidden(true)
    * .build();
    * workbook.insertDefinedNameBuilder(definedNameBuilder);
@@ -141,11 +141,11 @@ class F {
   }
   /**
    * Builds the defined name.
-   * @returns The defined name mutation parameter.
+   * @returns {FDefinedNameBuilder} The defined name mutation parameter.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
-   * const definedNameBuilder = UniverAPI.newDefinedName()
+   * const workbook = univerAPI.getActiveWorkbook();
+   * const definedNameBuilder = univerAPI.newDefinedName()
    *  .setRef('Sheet1!$A$1')
    *  .setName('MyDefinedName')
    *  .build();
@@ -159,19 +159,19 @@ class F {
     return this._definedNameParam = e, this;
   }
 }
-let M = class extends Q {
-  constructor(o, e, t, n, s, r, i, a, h, c) {
-    super(), this._definedNameParam = o, this._injector = e, this._commandService = t, this._permissionService = n, this._worksheetProtectionRuleModel = s, this._rangeProtectionRuleModel = r, this._worksheetProtectionPointRuleModel = i, this._authzIoService = a, this._localeService = h, this._definedNamesService = c;
+let j = class extends te {
+  constructor(s, e, t, n, r, o, i, a, h, c) {
+    super(), this._definedNameParam = s, this._injector = e, this._commandService = t, this._permissionService = n, this._worksheetProtectionRuleModel = r, this._rangeProtectionRuleModel = o, this._worksheetProtectionPointRuleModel = i, this._authzIoService = a, this._localeService = h, this._definedNamesService = c;
   }
   _apply() {
-    this._definedNameParam.name === "" && (this._definedNameParam.name = Mt(this._definedNameParam.unitId, this._localeService, this._definedNamesService)), this._commandService.syncExecuteCommand(G.id, this._definedNameParam);
+    this._definedNameParam.name === "" && (this._definedNameParam.name = Vt(this._definedNameParam.unitId, this._localeService, this._definedNamesService)), this._commandService.syncExecuteCommand(Q.id, this._definedNameParam);
   }
   /**
    * Gets the name of the defined name.
-   * @returns The name of the defined name.
+   * @returns {string} The name of the defined name.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
+   * const workbook = univerAPI.getActiveWorkbook();
    * const definedName = workbook.getDefinedNames[0];
    * console.log(definedName.getName());
    * ```
@@ -181,49 +181,49 @@ let M = class extends Q {
   }
   /**
    * Sets the name of the defined name.
-   * @param name The name of the defined name.
+   * @param {string} name The name of the defined name.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
+   * const workbook = univerAPI.getActiveWorkbook();
    * const definedName = workbook.getDefinedName('MyDefinedName');
    * definedName.setName('NewDefinedName');
    * ```
    */
-  setName(o) {
-    this._definedNameParam.name = o, this._apply();
+  setName(s) {
+    this._definedNameParam.name = s, this._apply();
   }
   /**
    * Sets the formula of the defined name.
-   * @param formula The formula of the defined name.
+   * @param {string} formula The formula of the defined name.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
+   * const workbook = univerAPI.getActiveWorkbook();
    * const definedName = workbook.getDefinedName('MyDefinedName');
    * definedName.setFormula('SUM(Sheet1!$A$1)');
    * ```
    */
-  setFormula(o) {
-    this._definedNameParam.formulaOrRefString = `=${o}`, this._apply();
+  setFormula(s) {
+    this._definedNameParam.formulaOrRefString = `=${s}`, this._apply();
   }
   /**
    * Sets the reference of the defined name.
-   * @param refString The reference of the defined name.
+   * @param {string} refString The reference of the defined name.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
+   * const workbook = univerAPI.getActiveWorkbook();
    * const definedName = workbook.getDefinedNames[0];
    * definedName.setRef('Sheet1!$A$1');
    * ```
    */
-  setRef(o) {
-    this._definedNameParam.formulaOrRefString = o, this._apply();
+  setRef(s) {
+    this._definedNameParam.formulaOrRefString = s, this._apply();
   }
   /**
    * Gets the reference of the defined name.
-   * @returns The reference of the defined name.
+   * @returns {string} The reference of the defined name.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
+   * const workbook = univerAPI.getActiveWorkbook();
    * const definedName = workbook.getDefinedNames[0];
    * console.log(definedName.getFormulaOrRefString());
    * ```
@@ -233,31 +233,31 @@ let M = class extends Q {
   }
   /**
    * Sets the reference of the defined name by range.
-   * @param row The start row of the range.
-   * @param column The start column of the range.
-   * @param numRows The number of rows in the range.
-   * @param numColumns The number of columns in the range.
+   * @param {number} row The start row of the range.
+   * @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.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
+   * const workbook = univerAPI.getActiveWorkbook();
    * const definedName = workbook.getDefinedNames[0];
    * definedName.setRefByRange(1, 3, 2, 5);
    * ```
    */
-  setRefByRange(o, e, t, n) {
-    this._definedNameParam.formulaOrRefString = Z({
-      startRow: o,
-      endRow: o + (t != null ? t : 1) - 1,
+  setRefByRange(s, e, t, n) {
+    this._definedNameParam.formulaOrRefString = re({
+      startRow: s,
+      endRow: s + (t != null ? t : 1) - 1,
       startColumn: e,
       endColumn: e + (n != null ? n : 1) - 1
     }), this._apply();
   }
   /**
    * Gets the comment of the defined name.
-   * @returns The comment of the defined name.
+   * @returns {string | undefined} The comment of the defined name.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
+   * const workbook = univerAPI.getActiveWorkbook();
    * const definedName = workbook.getDefinedNames[0];
    * console.log(definedName.getComment());
    * ```
@@ -267,74 +267,74 @@ let M = class extends Q {
   }
   /**
    * Sets the comment of the defined name.
-   * @param comment The comment of the defined name.
+   * @param {string} comment The comment of the defined name.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
+   * const workbook = univerAPI.getActiveWorkbook();
    * const definedName = workbook.getDefinedNames[0];
    * definedName.setComment('This is a comment');
    * ```
    */
-  setComment(o) {
-    this._definedNameParam.comment = o, this._apply();
+  setComment(s) {
+    this._definedNameParam.comment = s, this._apply();
   }
   /**
    * Sets the scope of the defined name to the worksheet.
-   * @param worksheet The worksheet to set the scope to.
+   * @param {FWorksheet} worksheet The worksheet to set the scope to.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
+   * const workbook = univerAPI.getActiveWorkbook();
    * const worksheet = workbook.getWorksheets[0];
    * const definedName = workbook.getDefinedNames[0];
    * definedName.setScopeToWorksheet(worksheet);
    * ```
    */
-  setScopeToWorksheet(o) {
-    this._definedNameParam.localSheetId = o.getSheetId(), this._apply();
+  setScopeToWorksheet(s) {
+    this._definedNameParam.localSheetId = s.getSheetId(), this._apply();
   }
   /**
    * Sets the scope of the defined name to the workbook.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
+   * const workbook = univerAPI.getActiveWorkbook();
    * const definedName = workbook.getDefinedNames[0];
    * definedName.setScopeToWorkbook();
    * ```
    */
   setScopeToWorkbook() {
-    this._definedNameParam.localSheetId = q, this._apply();
+    this._definedNameParam.localSheetId = X, this._apply();
   }
   /**
    * Sets the hidden status of the defined name.
-   * @param hidden The hidden status of the defined name.
+   * @param {boolean} hidden The hidden status of the defined name.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
+   * const workbook = univerAPI.getActiveWorkbook();
    * const definedName = workbook.getDefinedNames[0];
    * definedName.setHidden(true);
    * ```
    */
-  setHidden(o) {
-    this._definedNameParam.hidden = o, this._apply();
+  setHidden(s) {
+    this._definedNameParam.hidden = s, this._apply();
   }
   /**
    * Deletes the defined name.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
+   * const workbook = univerAPI.getActiveWorkbook();
    * const definedName = workbook.getDefinedNames[0];
    * definedName.delete();
    * ```
    */
   delete() {
-    this._commandService.syncExecuteCommand(Ve.id, this._definedNameParam);
+    this._commandService.syncExecuteCommand(Ke.id, this._definedNameParam);
   }
   /**
    * Gets the local sheet id of the defined name.
-   * @returns The local sheet id of the defined name.
+   * @returns {string | undefined} The local sheet id of the defined name.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
+   * const workbook = univerAPI.getActiveWorkbook();
    * const definedName = workbook.getDefinedNames[0];
    * console.log(definedName.getLocalSheetId());
    * ```
@@ -344,23 +344,23 @@ let M = class extends Q {
   }
   /**
    * Checks if the defined name is in the workbook scope.
-   * @returns True if the defined name is in the workbook scope, false otherwise.
+   * @returns {boolean} True if the defined name is in the workbook scope, false otherwise.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
+   * const workbook = univerAPI.getActiveWorkbook();
    * const definedName = workbook.getDefinedNames[0];
    * console.log(definedName.isWorkbookScope());
    * ```
    */
   isWorkbookScope() {
-    return this._definedNameParam.localSheetId === q;
+    return this._definedNameParam.localSheetId === X;
   }
   /**
    * Converts the defined name to a defined name builder.
-   * @returns The defined name builder.
+   * @returns {FDefinedNameBuilder} The defined name builder.
    * @example
    * ```ts
-   * const workbook = UniverAPI.getActiveWorkbook();
+   * const workbook = univerAPI.getActiveWorkbook();
    * const definedName = workbook.getDefinedNames[0];
    * const definedNameBuilder = definedName.toBuilder();
    * const param definedNameBuilder.setName('NewDefinedName').setFormula('SUM(Sheet1!$A$1)').build();
@@ -368,70 +368,66 @@ let M = class extends Q {
    * ```
    */
   toBuilder() {
-    const o = this._injector.createInstance(F);
-    return o.load(this._definedNameParam), o;
+    const s = this._injector.createInstance(L);
+    return s.load(this._definedNameParam), s;
   }
 };
-M = Tt([
-  w(1, m(v)),
-  w(2, l),
-  w(3, J),
-  w(4, m(pe)),
-  w(5, m(ye)),
-  w(6, m(Pe)),
-  w(7, m(Se)),
-  w(8, m(ke)),
-  w(9, De)
-], M);
-var jt = Object.defineProperty, At = Object.getOwnPropertyDescriptor, Ft = (o, e, t, n) => {
-  for (var s = n > 1 ? void 0 : n ? At(e, t) : e, r = o.length - 1, i; r >= 0; r--)
-    (i = o[r]) && (s = (n ? i(e, t, s) : i(s)) || s);
-  return n && s && jt(e, t, s), s;
-}, f = (o, e) => (t, n) => e(t, n, o);
-let j = class extends Q {
-  constructor(e, t, n, s, r, i, a) {
+j = Ot([
+  S(1, u(b)),
+  S(2, l),
+  S(3, ee),
+  S(4, u(Ee)),
+  S(5, u(Pe)),
+  S(6, u(xe)),
+  S(7, u(ve)),
+  S(8, u(Re)),
+  S(9, Te)
+], j);
+var Bt = Object.defineProperty, Lt = Object.getOwnPropertyDescriptor, zt = (s, e, t, n) => {
+  for (var r = n > 1 ? void 0 : n ? Lt(e, t) : e, o = s.length - 1, i; o >= 0; o--)
+    (i = s[o]) && (r = (n ? i(e, t, r) : i(r)) || r);
+  return n && r && Bt(e, t, r), r;
+}, v = (s, e) => (t, n) => e(t, n, s);
+let O = class extends te {
+  constructor(e, t, n, r, o, i, a) {
     super();
-    p(this, "permissionPointsDefinition", He);
-    this._injector = e, this._commandService = t, this._permissionService = n, this._worksheetProtectionRuleModel = s, this._rangeProtectionRuleModel = r, this._worksheetProtectionPointRuleModel = i, this._authzIoService = a;
+    k(this, "permissionPointsDefinition", Ye);
+    k(this, "rangeRuleChangedAfterAuth$");
+    k(this, "sheetRuleChangedAfterAuth$");
+    this._injector = e, this._commandService = t, this._permissionService = n, this._worksheetProtectionRuleModel = r, this._rangeProtectionRuleModel = o, this._worksheetProtectionPointRuleModel = i, this._authzIoService = a, this.rangeRuleChangedAfterAuth$ = this._rangeProtectionRuleModel.ruleRefresh$, this.sheetRuleChangedAfterAuth$ = this._worksheetProtectionRuleModel.ruleRefresh$;
   }
   /**
    * Configures a specific permission point for a workbook.
    *
    * This function sets or updates a permission point for a workbook identified by `unitId`.
    * It creates a new permission point if it does not already exist, and updates the point with the provided value.
-   *
    * @param {string} unitId - The unique identifier of the workbook for which the permission is being set.
    * @param {WorkbookPermissionPointConstructor} FPointClass - The constructor function for creating a permission point instance. Other point constructors can See the [permission-point documentation](https://github.com/dream-num/univer/tree/dev/packages/sheets/src/services/permission/permission-point) for more details.
    * @param {boolean} value - The boolean value to determine whether the permission point is enabled or disabled.
-   *
    */
   setWorkbookPermissionPoint(e, t, n) {
-    const s = new t(e);
-    this._permissionService.getPermissionPoint(s.id) || this._permissionService.addPermissionPoint(s), this._permissionService.updatePermissionPoint(s.id, n);
+    const r = new t(e);
+    this._permissionService.getPermissionPoint(r.id) || this._permissionService.addPermissionPoint(r), this._permissionService.updatePermissionPoint(r.id, n);
   }
   /**
    * This function is used to set whether the workbook can be edited
-   *
    * @param {string} unitId - The unique identifier of the workbook for which the permission is being set.
    * @param {boolean} value - A value that controls whether the workbook can be edited
-   *
    */
   setWorkbookEditPermission(e, t) {
-    this.setWorkbookPermissionPoint(e, Ue, t);
+    this.setWorkbookPermissionPoint(e, Ne, t);
   }
   /**
    * This function is used to add a base permission for a worksheet.
-   *
    * @param {string} unitId - The unique identifier of the workbook for which the permission is being set.
    * @param {string} subUnitId - The unique identifier of the worksheet for which the permission is being set.
-   *
    * @returns {Promise<string | undefined>} - Returns the `permissionId` if the permission is successfully added. If the operation fails or no result is returned, it resolves to `undefined`.
    */
   async addWorksheetBasePermission(e, t) {
     if (this._rangeProtectionRuleModel.getSubunitRuleList(e, t).length > 0)
       throw new Error("sheet protection cannot intersect with range protection");
-    const s = await this._authzIoService.create({
-      objectType: y.Worksheet,
+    const r = await this._authzIoService.create({
+      objectType: E.Worksheet,
       worksheetObject: {
         collaborators: [],
         unitID: e,
@@ -440,51 +436,48 @@ let j = class extends Q {
         scope: void 0
       }
     });
-    if (this._commandService.syncExecuteCommand($e.id, {
+    if (this._commandService.syncExecuteCommand(Je.id, {
       unitId: e,
       subUnitId: t,
       rule: {
-        permissionId: s,
-        unitType: y.Worksheet,
+        permissionId: r,
+        unitType: E.Worksheet,
         unitId: e,
         subUnitId: t
       }
     }))
-      return s;
+      return r;
   }
   /**
    * Delete the entire table protection set for the worksheet and reset the point permissions of the worksheet to true
-   *
    * @param {string} unitId - The unique identifier of the workbook for which the permission is being set.
    * @param {string} subUnitId - The unique identifier of the worksheet for which the permission is being set.
    */
   removeWorksheetPermission(e, t) {
-    this._commandService.syncExecuteCommand(Ge.id, {
+    this._commandService.syncExecuteCommand(Qe.id, {
       unitId: e,
       subUnitId: t
-    }), [...qe(), ...ne()].forEach((n) => {
-      const s = new n(e, t);
-      this._permissionService.updatePermissionPoint(s.id, !0);
+    }), [...Xe(), ...ae()].forEach((n) => {
+      const r = new n(e, t);
+      this._permissionService.updatePermissionPoint(r.id, !0);
     }), this._worksheetProtectionPointRuleModel.deleteRule(e, t);
   }
   /**
    * Sets the worksheet permission point by updating or adding the permission point for the worksheet.
    * If the worksheet doesn't have a base permission, it creates one to used render
-   *
    * @param {string} unitId - The unique identifier of the workbook.
    * @param {string} subUnitId - The unique identifier of the worksheet.
    * @param {WorkSheetPermissionPointConstructor} FPointClass - The constructor for the permission point class.
    *    See the [permission-point documentation](https://github.com/dream-num/univer/tree/dev/packages/sheets/src/services/permission/permission-point) for more details.
    * @param {boolean} value - The new permission value to be set for the worksheet.
-   *
    * @returns {Promise<string | undefined>} - Returns the `permissionId` if the permission point is successfully set or created. If no permission is set, it resolves to `undefined`.
    */
-  async setWorksheetPermissionPoint(e, t, n, s) {
-    const r = this._worksheetProtectionRuleModel.getRule(e, t);
+  async setWorksheetPermissionPoint(e, t, n, r) {
+    const o = this._worksheetProtectionRuleModel.getRule(e, t);
     let i;
-    if (n === Xe || n === Ze)
-      if (r)
-        i = r.permissionId;
+    if (n === st || n === rt)
+      if (o)
+        i = o.permissionId;
       else {
         if (this._rangeProtectionRuleModel.getSubunitRuleList(e, t).length > 0)
           throw new Error("sheet protection cannot intersect with range protection");
@@ -493,7 +486,7 @@ let j = class extends Q {
     else {
       const d = this._worksheetProtectionPointRuleModel.getRule(e, t);
       d ? i = d.permissionId : (i = await this._authzIoService.create({
-        objectType: y.Worksheet,
+        objectType: E.Worksheet,
         worksheetObject: {
           collaborators: [],
           unitID: e,
@@ -501,71 +494,67 @@ let j = class extends Q {
           name: "",
           scope: void 0
         }
-      }), this._commandService.executeCommand(Ke.id, { unitId: e, subUnitId: t, permissionId: i }));
+      }), this._commandService.executeCommand(Ze.id, { unitId: e, subUnitId: t, permissionId: i }));
     }
     const h = new n(e, t);
-    return this._permissionService.getPermissionPoint(h.id) || this._permissionService.addPermissionPoint(h), this._permissionService.updatePermissionPoint(h.id, s), i;
+    return this._permissionService.getPermissionPoint(h.id) || this._permissionService.addPermissionPoint(h), this._permissionService.updatePermissionPoint(h.id, r), i;
   }
   /**
    * Adds a range protection to the worksheet.
-   *
    * @param {string} unitId - The unique identifier of the workbook.
    * @param {string} subUnitId - The unique identifier of the worksheet.
    * @param {IRange[]} ranges - The ranges to be protected.
-   *
    * @returns {Promise<{ permissionId: string, ruleId: string } | undefined>} - Returns an object containing the `permissionId` and `ruleId` if the range protection is successfully added. If the operation fails or no result is returned, it resolves to `undefined`. permissionId is used to stitch permission point ID，ruleId is used to store permission rules
    */
   async addRangeBaseProtection(e, t, n) {
-    const s = await this._authzIoService.create({
-      objectType: y.SelectRange,
+    const r = await this._authzIoService.create({
+      objectType: E.SelectRange,
       selectRangeObject: {
         collaborators: [],
         unitID: e,
         name: "",
         scope: void 0
       }
-    }), r = `ruleId_${Ce(6)}`;
+    }), o = `ruleId_${be(6)}`;
     if (this._worksheetProtectionRuleModel.getRule(e, t))
       throw new Error("sheet protection cannot intersect with range protection");
-    if (this._rangeProtectionRuleModel.getSubunitRuleList(e, t).some((d) => d.ranges.some((O) => n.some((x) => E.intersects(x, O)))))
+    if (this._rangeProtectionRuleModel.getSubunitRuleList(e, t).some((d) => d.ranges.some((z) => n.some((M) => N.intersects(M, z)))))
       throw new Error("range protection cannot intersect");
-    if (this._commandService.syncExecuteCommand(Ye.id, {
+    if (this._commandService.syncExecuteCommand(et.id, {
       unitId: e,
       subUnitId: t,
       rules: [{
-        permissionId: s,
-        unitType: y.SelectRange,
+        permissionId: r,
+        unitType: E.SelectRange,
         unitId: e,
         subUnitId: t,
         ranges: n,
-        id: r
+        id: o
       }]
     }))
       return {
-        permissionId: s,
-        ruleId: r
+        permissionId: r,
+        ruleId: o
       };
   }
   /**
    * Removes the range protection from the worksheet.
-   *
    * @param {string} unitId - The unique identifier of the workbook.
    * @param {string} subUnitId - The unique identifier of the worksheet.
    * @param {string[]} ruleIds - The rule IDs of the range protection to be removed.
    */
   removeRangeProtection(e, t, n) {
-    this._commandService.syncExecuteCommand(Je.id, {
+    this._commandService.syncExecuteCommand(tt.id, {
       unitId: e,
       subUnitId: t,
       ruleIds: n
-    }) && this._rangeProtectionRuleModel.getSubunitRuleList(e, t).length === 0 && (this._worksheetProtectionPointRuleModel.deleteRule(e, t), [...ne()].forEach((i) => {
+    }) && this._rangeProtectionRuleModel.getSubunitRuleList(e, t).length === 0 && (this._worksheetProtectionPointRuleModel.deleteRule(e, t), [...ae()].forEach((i) => {
       const a = new i(e, t);
       this._permissionService.updatePermissionPoint(a.id, a.value);
     }));
   }
   /**
    * Modify the permission points of a custom area
-   *
    * @param {string} unitId - The unique identifier of the workbook.
    * @param {string} subUnitId - The unique identifier of the worksheet within the workbook.
    * @param {string} permissionId - The unique identifier of the permission that controls access to the range.
@@ -573,9 +562,9 @@ let j = class extends Q {
    *    See the [permission-point documentation](https://github.com/dream-num/univer/tree/dev/packages/sheets/src/services/permission/permission-point) for more details.
    * @param {boolean} value - The new permission value to be set for the range (e.g., true for allowing access, false for restricting access).
    */
-  setRangeProtectionPermissionPoint(e, t, n, s, r) {
-    const i = new s(e, t, n);
-    this._permissionService.getPermissionPoint(i.id) || this._permissionService.addPermissionPoint(i), this._permissionService.updatePermissionPoint(i.id, r);
+  setRangeProtectionPermissionPoint(e, t, n, r, o) {
+    const i = new r(e, t, n);
+    this._permissionService.getPermissionPoint(i.id) || this._permissionService.addPermissionPoint(i), this._permissionService.updatePermissionPoint(i.id, o);
   }
   /**
    * Sets the ranges for range protection in a worksheet.
@@ -583,387 +572,768 @@ let j = class extends Q {
    * This method finds the rule by unitId, subUnitId, and ruleId, and updates the rule with the provided ranges.
    * It checks for overlaps with existing ranges in the same subunit and shows an error message if any overlap is detected.
    * If no overlap is found, it executes the command to update the range protection with the new ranges.
-   *
    * @param {string} unitId - The unique identifier of the workbook.
    * @param {string} subUnitId - The unique identifier of the worksheet within the workbook.
    * @param {string} ruleId - The ruleId of the range protection rule that is being updated.
    * @param {IRange[]} ranges - The array of new ranges to be set for the range protection rule.
    */
-  setRangeProtectionRanges(e, t, n, s) {
-    const r = this._rangeProtectionRuleModel.getRule(e, t, n);
-    if (r) {
-      if (this._rangeProtectionRuleModel.getSubunitRuleList(e, t).filter((h) => h.id !== n).some((h) => h.ranges.some((c) => s.some((d) => E.intersects(d, c)))))
+  setRangeProtectionRanges(e, t, n, r) {
+    const o = this._rangeProtectionRuleModel.getRule(e, t, n);
+    if (o) {
+      if (this._rangeProtectionRuleModel.getSubunitRuleList(e, t).filter((h) => h.id !== n).some((h) => h.ranges.some((c) => r.some((d) => N.intersects(d, c)))))
         throw new Error("range protection cannot intersect");
-      this._commandService.syncExecuteCommand(Qe.id, {
+      this._commandService.syncExecuteCommand(nt.id, {
         unitId: e,
         subUnitId: t,
         ruleId: n,
         rule: {
-          ...r,
-          ranges: s
+          ...o,
+          ranges: r
         }
       });
     }
   }
-  /**
-   * Set visibility of unauthorized pop-up window
-   *
-   * @param {boolean} visible
-   */
-  setPermissionDialogVisible(e) {
-    this._permissionService.setShowComponents(e);
-  }
 };
-j = Ft([
-  f(0, m(v)),
-  f(1, l),
-  f(2, J),
-  f(3, m(pe)),
-  f(4, m(ye)),
-  f(5, m(Pe)),
-  f(6, m(Se))
-], j);
-function Ot(o) {
-  switch (o) {
+O = zt([
+  v(0, u(b)),
+  v(1, l),
+  v(2, ee),
+  v(3, u(Ee)),
+  v(4, u(Pe)),
+  v(5, u(xe)),
+  v(6, u(ve))
+], O);
+function $t(s) {
+  switch (s) {
     case "left":
-      return R.LEFT;
+      return y.LEFT;
     case "center":
-      return R.CENTER;
+      return y.CENTER;
     case "normal":
-      return R.RIGHT;
+      return y.RIGHT;
     default:
-      throw new Error(`Invalid horizontal alignment: ${o}`);
+      throw new Error(`Invalid horizontal alignment: ${s}`);
   }
 }
-function Bt(o) {
-  switch (o) {
-    case R.LEFT:
+function Ht(s) {
+  switch (s) {
+    case y.LEFT:
       return "left";
-    case R.CENTER:
+    case y.CENTER:
       return "center";
-    case R.RIGHT:
+    case y.RIGHT:
       return "normal";
     default:
-      throw new Error(`Invalid horizontal alignment: ${o}`);
+      throw new Error(`Invalid horizontal alignment: ${s}`);
   }
 }
-function Lt(o) {
-  switch (o) {
+function Gt(s) {
+  switch (s) {
     case "top":
-      return b.TOP;
+      return U.TOP;
     case "middle":
-      return b.MIDDLE;
+      return U.MIDDLE;
     case "bottom":
-      return b.BOTTOM;
+      return U.BOTTOM;
     default:
-      throw new Error(`Invalid vertical alignment: ${o}`);
+      throw new Error(`Invalid vertical alignment: ${s}`);
   }
 }
-function zt(o) {
-  switch (o) {
-    case b.TOP:
+function qt(s) {
+  switch (s) {
+    case U.TOP:
       return "top";
-    case b.MIDDLE:
+    case U.MIDDLE:
       return "middle";
-    case b.BOTTOM:
+    case U.BOTTOM:
       return "bottom";
     default:
-      throw new Error(`Invalid vertical alignment: ${o}`);
+      throw new Error(`Invalid vertical alignment: ${s}`);
   }
 }
-function Y(o) {
-  return Me(o) ? {
-    f: o
-  } : je(o) ? {
-    v: o
-  } : (Ae(o), o);
+function V(s) {
+  return je(s) ? {
+    f: s
+  } : Oe(s) ? {
+    v: s
+  } : (Ve(s), s);
 }
-function Vt(o, e) {
-  const t = new T(), { startRow: n, startColumn: s, endRow: r, endColumn: i } = e;
-  if (Fe.isArray(o))
-    for (let a = 0; a <= r - n; a++)
-      for (let h = 0; h <= i - s; h++)
-        t.setValue(a + n, h + s, Y(o[a][h]));
+function Ie(s, e) {
+  const t = new A(), { startRow: n, startColumn: r, endRow: o, endColumn: i } = e;
+  if (Be.isArray(s))
+    for (let a = 0; a <= o - n; a++)
+      for (let h = 0; h <= i - r; h++)
+        t.setValue(a + n, h + r, V(s[a][h]));
   else
-    new T(o).forValue((h, c, d) => {
-      t.setValue(h, c, Y(d));
+    new A(s).forValue((h, c, d) => {
+      t.setValue(h, c, V(d));
     });
   return t.getMatrix();
 }
-function V(o, e) {
+function q(s, e) {
   return {
-    startRow: o.startRow,
-    endRow: o.endRow,
+    startRow: s.startRow,
+    endRow: s.endRow,
     startColumn: 0,
     endColumn: e.getColumnCount() - 1,
     rangeType: _.ROW
   };
 }
-function H(o, e) {
+function K(s, e) {
   return {
     startRow: 0,
     endRow: e.getRowCount() - 1,
-    startColumn: o.startColumn,
-    endColumn: o.endColumn,
+    startColumn: s.startColumn,
+    endColumn: s.endColumn,
     rangeType: _.COLUMN
   };
 }
-var Ht = Object.defineProperty, $t = Object.getOwnPropertyDescriptor, Gt = (o, e, t, n) => {
-  for (var s = n > 1 ? void 0 : n ? $t(e, t) : e, r = o.length - 1, i; r >= 0; r--)
-    (i = o[r]) && (s = (n ? i(e, t, s) : i(s)) || s);
-  return n && s && Ht(e, t, s), s;
-}, $ = (o, e) => (t, n) => e(t, n, o);
-let k = class extends X {
-  constructor(o, e, t, n, s, r) {
-    super(n), this._workbook = o, this._worksheet = e, this._range = t, this._injector = n, this._commandService = s, this._formulaDataModel = r;
+var Kt = Object.defineProperty, Yt = Object.getOwnPropertyDescriptor, Jt = (s, e, t, n) => {
+  for (var r = n > 1 ? void 0 : n ? Yt(e, t) : e, o = s.length - 1, i; o >= 0; o--)
+    (i = s[o]) && (r = (n ? i(e, t, r) : i(r)) || r);
+  return n && r && Kt(e, t, r), r;
+}, Y = (s, e) => (t, n) => e(t, n, s);
+let w = class extends ne {
+  constructor(s, e, t, n, r, o) {
+    super(n), this._workbook = s, this._worksheet = e, this._range = t, this._injector = n, this._commandService = r, this._formulaDataModel = o;
   }
   /**
    * Get the unit ID of the current workbook
-   *
-   * @return The unit ID of the workbook
+   * @returns {string} The unit ID of the workbook
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getUnitId()
+   * ```
    */
   getUnitId() {
     return this._workbook.getUnitId();
   }
   /**
    * Gets the name of the worksheet
-   *
-   * @return The name of the worksheet
+   * @returns {string} The name of the worksheet
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getSheetName()
+   * ```
    */
   getSheetName() {
     return this._worksheet.getName();
   }
+  /**
+   * Gets the ID of the worksheet
+   * @returns {string} The ID of the worksheet
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getSheetId()
+   * ```
+   */
+  getSheetId() {
+    return this._worksheet.getSheetId();
+  }
   /**
    * Gets the area where the statement is applied
-   *
-   * @return The area where the statement is applied
+   * @returns {IRange} The area where the statement is applied
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getRange()
+   * ```
    */
   getRange() {
     return this._range;
   }
   /**
    * Gets the starting row number of the applied area
-   *
-   * @return The starting row number of the area
+   * @returns {number} The starting row number of the area
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getRow()
+   * ```
    */
   getRow() {
     return this._range.startRow;
   }
   /**
    * Gets the starting column number of the applied area
-   *
-   * @return The starting column number of the area
+   * @returns {number} The starting column number of the area
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getColumn()
+   * ```
    */
   getColumn() {
     return this._range.startColumn;
   }
   /**
    * Gets the width of the applied area
-   *
-   * @return The width of the area
+   * @returns {number} The width of the area
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getWidth()
+   * ```
    */
   getWidth() {
     return this._range.endColumn - this._range.startColumn + 1;
   }
   /**
    * Gets the height of the applied area
-   *
-   * @return The height of the area
+   * @returns {number} The height of the area
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getHeight()
+   * ```
    */
   getHeight() {
     return this._range.endRow - this._range.startRow + 1;
   }
-  /**
-   * Return first cell model data in this range
-   * @returns The cell model data
-   */
-  getCellData() {
-    var o;
-    return (o = this._worksheet.getCell(this._range.startRow, this._range.startColumn)) != null ? o : null;
-  }
   /**
    * Return range whether this range is merged
-   * @returns if true is merged
+   * @returns {boolean} if true is merged
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .isMerged()
+   * ```
    */
   isMerged() {
-    const { startColumn: o, startRow: e, endColumn: t, endRow: n } = this._range;
-    return this._worksheet.getMergedCellRange(e, o, n, t).some((r) => E.equals(r, this._range));
+    const { startColumn: s, startRow: e, endColumn: t, endRow: n } = this._range;
+    return this._worksheet.getMergedCellRange(e, s, n, t).some((o) => N.equals(o, this._range));
   }
   /**
    * Return first cell style data in this range
-   * @returns The cell style data
+   * @returns {IStyleData | null} The cell style data
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getCellStyleData()
+   * ```
    */
   getCellStyleData() {
     var t;
-    const o = this.getCellData(), e = this._workbook.getStyles();
-    return o && e && (t = e.getStyleByCell(o)) != null ? t : null;
+    const s = this.getCellData(), e = this._workbook.getStyles();
+    return s && e && (t = e.getStyleByCell(s)) != null ? t : null;
   }
   /**
-   * Returns the value of the cell at the start of this range.
-   * @returns The value of the cell.
+   * @deprecated use `getValueAndRichTextValue` instead. This api can't return rich text value.
    */
   getValue() {
-    var o, e;
-    return (e = (o = this._worksheet.getCell(this._range.startRow, this._range.startColumn)) == null ? void 0 : o.v) != null ? e : null;
+    var s, e;
+    return (e = (s = this._worksheet.getCell(this._range.startRow, this._range.startColumn)) == null ? void 0 : s.v) != null ? e : null;
   }
   /**
-   * Returns the rectangular grid of values for this range.
-   * Returns a two-dimensional array of values, indexed by row, then by column.
-   * @returns A two-dimensional array of values.
+   * @deprecated use `getValueAndRichTextValues` instead. This api can't return rich text value.
    */
   getValues() {
-    var r, i;
-    const { startRow: o, endRow: e, startColumn: t, endColumn: n } = this._range, s = [];
-    for (let a = o; a <= e; a++) {
+    var o, i;
+    const { startRow: s, endRow: e, startColumn: t, endColumn: n } = this._range, r = [];
+    for (let a = s; a <= e; a++) {
       const h = [];
       for (let c = t; c <= n; c++)
-        h.push((i = (r = this._worksheet.getCell(a, c)) == null ? void 0 : r.v) != null ? i : null);
-      s.push(h);
+        h.push((i = (o = this._worksheet.getCell(a, c)) == null ? void 0 : o.v) != null ? i : null);
+      r.push(h);
     }
-    return s;
+    return r;
+  }
+  /**
+   * Return first cell model data in this range
+   * @returns {ICellData | null} The cell model data
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getCellData()
+   * ```
+   */
+  getCellData() {
+    var s;
+    return (s = this._worksheet.getCell(this._range.startRow, this._range.startColumn)) != null ? s : null;
   }
   /**
    * Returns the cell data for the cells in the range.
-   * @returns A two-dimensional array of cell data.
+   * @returns {Nullable<ICellData>[][]} A two-dimensional array of cell data.
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getCellDatas()
+   * ```
    */
-  getCellDataGrid() {
-    const { startRow: o, endRow: e, startColumn: t, endColumn: n } = this._range, s = [];
-    for (let r = o; r <= e; r++) {
+  getCellDatas() {
+    const { startRow: s, endRow: e, startColumn: t, endColumn: n } = this._range, r = [];
+    for (let o = s; o <= e; o++) {
       const i = [];
       for (let a = t; a <= n; a++)
-        i.push(this._worksheet.getCellRaw(r, a));
-      s.push(i);
+        i.push(this._worksheet.getCellRaw(o, a));
+      r.push(i);
     }
-    return s;
+    return r;
+  }
+  /**
+   * @deprecated use `getCellDatas` instead.
+   */
+  getCellDataGrid() {
+    return this.getCellDatas();
+  }
+  /**
+   * Returns the rich text value for the cell at the start of this range.
+   * @returns {Nullable<RichTextValue>} The rich text value
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getRichTextValue()
+   * ```
+   */
+  getRichTextValue() {
+    const s = this.getCellData();
+    return s != null && s.p ? new p(s.p) : null;
+  }
+  /**
+   * Returns the rich text value for the cells in the range.
+   * @returns {Nullable<RichTextValue>[][]} A two-dimensional array of RichTextValue objects.
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getRichTextValues()
+   * ```
+   */
+  getRichTextValues() {
+    return this.getCellDataGrid().map((e) => e.map((t) => t != null && t.p ? new p(t.p) : null));
+  }
+  /**
+   * Returns the value and rich text value for the cell at the start of this range.
+   * @returns {Nullable<CellValue | RichTextValue>} The value and rich text value
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getValueAndRichTextValue()
+   * ```
+   */
+  getValueAndRichTextValue() {
+    const s = this.getCellData();
+    return s != null && s.p ? new p(s.p) : s == null ? void 0 : s.v;
+  }
+  /**
+   * Returns the value and rich text value for the cells in the range.
+   * @returns {Nullable<CellValue | RichTextValue>[][]} A two-dimensional array of value and rich text value
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getValueAndRichTextValues()
+   * ```
+   */
+  getValueAndRichTextValues() {
+    return this.getCellDatas().map((e) => e.map((t) => t != null && t.p ? new p(t.p) : t == null ? void 0 : t.v));
   }
   /**
    * Returns the formulas (A1 notation) for the cells in the range. Entries in the 2D array are empty strings for cells with no formula.
-   * @returns A two-dimensional array of formulas in string format.
+   * @returns {string[][]} A two-dimensional array of formulas in string format.
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getFormulas()
+   * ```
    */
   getFormulas() {
-    const o = [], { startRow: e, endRow: t, startColumn: n, endColumn: s } = this._range, r = this._worksheet.getSheetId(), i = this._workbook.getUnitId();
+    const s = [], { startRow: e, endRow: t, startColumn: n, endColumn: r } = this._range, o = this._worksheet.getSheetId(), i = this._workbook.getUnitId();
     for (let a = e; a <= t; a++) {
       const h = [];
-      for (let c = n; c <= s; c++) {
-        const d = this._formulaDataModel.getFormulaStringByCell(a, c, r, i);
+      for (let c = n; c <= r; c++) {
+        const d = this._formulaDataModel.getFormulaStringByCell(a, c, o, i);
         h.push(d || "");
       }
-      o.push(h);
+      s.push(h);
     }
-    return o;
+    return s;
   }
+  /**
+   * Returns true if the cell wrap is enabled
+   * @returns {boolean} True if the cell wrap is enabled
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getWrap()
+   * ```
+   */
   getWrap() {
-    return this._worksheet.getRange(this._range).getWrap() === u.TRUE;
+    return this._worksheet.getRange(this._range).getWrap() === m.TRUE;
   }
+  /**
+   * Returns the text wrapping strategy for the top left cell of the range.
+   * @returns {WrapStrategy} The text wrapping strategy
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getWrapStrategy()
+   * ```
+   */
   getWrapStrategy() {
     return this._worksheet.getRange(this._range).getWrapStrategy();
   }
+  /**
+   * Returns the horizontal alignment for the top left cell of the range.
+   * @returns {string} The horizontal alignment
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getHorizontalAlignment()
+   * ```
+   */
   getHorizontalAlignment() {
-    return Bt(this._worksheet.getRange(this._range).getHorizontalAlignment());
+    return Ht(this._worksheet.getRange(this._range).getHorizontalAlignment());
   }
+  /**
+   * Returns the vertical alignment for the top left cell of the range.
+   * @returns {string} The vertical alignment
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getVerticalAlignment()
+   * ```
+   */
   getVerticalAlignment() {
-    return zt(this._worksheet.getRange(this._range).getVerticalAlignment());
+    return qt(this._worksheet.getRange(this._range).getVerticalAlignment());
+  }
+  /**
+   * Set custom meta data for first cell in current range.
+   * @param {CustomData} data The custom meta data
+   * @returns {FRange} This range, for chaining
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .setCustomMetaData({ key: 'value' });
+   * ```
+   */
+  setCustomMetaData(s) {
+    return this.setValue({
+      custom: s
+    });
+  }
+  /**
+   * Set custom meta data for current range.
+   * @param {CustomData[][]} datas The custom meta data
+   * @returns {FRange} This range, for chaining
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .setCustomMetaDatas([[{ key: 'value' }]]);
+   * ```
+   */
+  setCustomMetaDatas(s) {
+    return this.setValues(s.map((e) => e.map((t) => ({ custom: t }))));
+  }
+  /**
+   * Returns the custom meta data for the cell at the start of this range.
+   * @returns {CustomData | null} The custom meta data
+   * @example
+   * ```
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getCustomMetaData()
+   * ```
+   */
+  getCustomMetaData() {
+    var e;
+    const s = this.getCellData();
+    return (e = s == null ? void 0 : s.custom) != null ? e : null;
+  }
+  /**
+   * Returns the custom meta data for the cells in the range.
+   * @returns {CustomData[][]} A two-dimensional array of custom meta data
+   * @example
+   * ```
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .getCustomMetaDatas()
+   * ```
+   */
+  getCustomMetaDatas() {
+    return this.getCellDataGrid().map((e) => e.map((t) => {
+      var n;
+      return (n = t == null ? void 0 : t.custom) != null ? n : null;
+    }));
   }
   // #region editing
   /**
    * Set background color for current range.
-   * @param color {string}
+   * @param {string} color The background color
+   * @returns {FRange} This range, for chaining
    * @example
-   * ```
-   * univerAPI.getActiveWorkbook().getActiveSheet().getActiveRange().setBackgroundColor('red')
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .setBackgroundColor('red')
    * ```
    */
-  setBackgroundColor(o) {
-    return this._commandService.syncExecuteCommand(C.id, {
+  setBackgroundColor(s) {
+    return this._commandService.syncExecuteCommand(f.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
       style: {
         type: "bg",
         value: {
-          rgb: o
+          rgb: s
         }
       }
     }), this;
   }
   /**
    * Set background color for current range.
+   * @param {string} color The background color
+   * @returns {FRange} This range, for chaining
    * @example
-   * ```
+   * ```typescript
    * univerAPI.getActiveWorkbook().getActiveSheet().getActiveRange().setBackground('red')
    * ```
-   * @param color {string}
    */
-  setBackground(o) {
-    return this.setBackgroundColor(o), this;
+  setBackground(s) {
+    return this.setBackgroundColor(s), this;
   }
   /**
-   * The value can be a number, string, boolean, or standard cell format. If it begins with `=`, it is interpreted as a formula. The value is tiled to all cells in the range.
-   * @param value
+   * Set new value for current cell, first cell in this range.
+   * @param {CellValue | ICellData} value The value can be a number, string, boolean, or standard cell format. If it begins with `=`, it is interpreted as a formula. The value is tiled to all cells in the range.
+   * @returns {FRange} This range, for chaining
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .setValue(1);
+   * ```
    */
-  setValue(o) {
-    const e = Y(o);
+  setValue(s) {
+    const e = V(s);
     if (!e)
       throw new Error("Invalid value");
-    return this._commandService.syncExecuteCommand(se.id, {
+    return this._commandService.syncExecuteCommand(P.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
       value: e
     }), this;
   }
+  /**
+   * Set new value for current cell, first cell in this range.
+   * @param {CellValue | ICellData} value  The value can be a number, string, boolean, or standard cell format. If it begins with `=`, it is interpreted as a formula. The value is tiled to all cells in the range.
+   * @returns {FRange} This range, for chaining
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .setValueForCell(1);
+   * ```
+   */
+  setValueForCell(s) {
+    const e = V(s);
+    if (!e)
+      throw new Error("Invalid value");
+    return this._commandService.syncExecuteCommand(P.id, {
+      unitId: this._workbook.getUnitId(),
+      subUnitId: this._worksheet.getSheetId(),
+      range: {
+        startColumn: this._range.startColumn,
+        startRow: this._range.startRow,
+        endColumn: this._range.endColumn,
+        endRow: this._range.endRow
+      },
+      value: e
+    }), this;
+  }
+  /**
+   * Set the rich text value for the cell at the start of this range.
+   * @param {RichTextValue | IDocumentData} value The rich text value
+   * @returns {FRange} The range
+   * @example
+   * ```
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .setRichTextValueForCell(new RichTextValue().insertText('Hello'));
+   * ```
+   */
+  setRichTextValueForCell(s) {
+    const e = s instanceof p ? s.getData() : s, t = {
+      unitId: this._workbook.getUnitId(),
+      subUnitId: this._worksheet.getSheetId(),
+      range: {
+        startColumn: this._range.startColumn,
+        startRow: this._range.startRow,
+        endColumn: this._range.endColumn,
+        endRow: this._range.endRow
+      },
+      value: { p: e }
+    };
+    return this._commandService.syncExecuteCommand(P.id, t), this;
+  }
+  /**
+   * Set the rich text value for the cells in the range.
+   * @param {RichTextValue[][]} values The rich text value
+   * @returns {FRange} The range
+   * @example
+   * ```ts
+   * univerAPI
+   *  .getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .setRichTextValues([[new RichTextValue().insertText('Hello')]]);
+   * ```
+   */
+  setRichTextValues(s) {
+    const e = s.map((r) => r.map((o) => o && { p: o instanceof p ? o.getData() : o })), t = Ie(e, this._range), n = {
+      unitId: this._workbook.getUnitId(),
+      subUnitId: this._worksheet.getSheetId(),
+      range: this._range,
+      value: t
+    };
+    return this._commandService.syncExecuteCommand(P.id, n), this;
+  }
   /**
    * Set the cell wrap of the given range.
    * Cells with wrap enabled (the default) resize to display their full content. Cells with wrap disabled display as much as possible in the cell without resizing or running to multiple lines.
+   * @param {boolean} isWrapEnabled Whether to enable wrap
+   * @returns {FRange} this range, for chaining
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .setWrap(true);
+   * ```
    */
-  setWrap(o) {
-    return this._commandService.syncExecuteCommand(oe.id, {
+  setWrap(s) {
+    return this._commandService.syncExecuteCommand(he.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
-      value: o ? ee.WRAP : ee.UNSPECIFIED
+      value: s ? oe.WRAP : oe.UNSPECIFIED
     }), this;
   }
   /**
    * Sets the text wrapping strategy for the cells in the range.
+   * @param {WrapStrategy} strategy The text wrapping strategy
+   * @returns {FRange} this range, for chaining
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .setWrapStrategy(WrapStrategy.WRAP);
+   * ```
    */
-  setWrapStrategy(o) {
-    return this._commandService.syncExecuteCommand(oe.id, {
+  setWrapStrategy(s) {
+    return this._commandService.syncExecuteCommand(he.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
-      value: o
+      value: s
     }), this;
   }
   /**
    * Set the vertical (top to bottom) alignment for the given range (top/middle/bottom).
+   * @param {"top" | "middle" | "bottom"} alignment The vertical alignment
+   * @returns {FRange} this range, for chaining
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .setVerticalAlignment('top');
+   * ```
    */
-  setVerticalAlignment(o) {
-    return this._commandService.syncExecuteCommand(et.id, {
+  setVerticalAlignment(s) {
+    return this._commandService.syncExecuteCommand(ot.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
-      value: Lt(o)
+      value: Gt(s)
     }), this;
   }
   /**
    * Set the horizontal (left to right) alignment for the given range (left/center/right).
+   * @param {"left" | "center" | "normal"} alignment The horizontal alignment
+   * @returns {FRange} this range, for chaining
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .setHorizontalAlignment('left');
+   * ```
    */
-  setHorizontalAlignment(o) {
-    return this._commandService.syncExecuteCommand(tt.id, {
+  setHorizontalAlignment(s) {
+    return this._commandService.syncExecuteCommand(it.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
-      value: Ot(o)
+      value: $t(s)
     }), this;
   }
   /**
    * Sets a different value for each cell in the range. The value can be a two-dimensional array or a standard range matrix (must match the dimensions of this range), consisting of numbers, strings, Boolean values or Composed of standard cell formats. If a value begins with `=`, it is interpreted as a formula.
-   * @param value
+   * @param {CellValue[][] | IObjectMatrixPrimitiveType<CellValue> | ICellData[][] | IObjectMatrixPrimitiveType<ICellData>} value The value can be a two-dimensional array or a standard range matrix (must match the dimensions of this range), consisting of numbers, strings, Boolean values or Composed of standard cell formats.
+   * @returns {FRange} This range, for chaining
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .setValues([[1, 2], [3, 4]]);
+   * ```
    */
-  setValues(o) {
-    const e = Vt(o, this._range);
-    return this._commandService.syncExecuteCommand(se.id, {
+  setValues(s) {
+    const e = Ie(s, this._range);
+    return this._commandService.syncExecuteCommand(P.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
@@ -972,15 +1342,23 @@ let k = class extends X {
   }
   /**
    * Sets the font weight for the given range (normal/bold),
-   * @param fontWeight The font weight, either 'normal' or 'bold'; a null value resets the font weight.
+   * @param {FontWeight|null} fontWeight The font weight, either 'normal' or 'bold'; a null value resets the font weight.
+   * @returns {FRange} This range, for chaining
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .setFontWeight('bold');
+   * ```
    */
-  setFontWeight(o) {
+  setFontWeight(s) {
     let e;
-    if (o === "bold")
-      e = u.TRUE;
-    else if (o === "normal")
-      e = u.FALSE;
-    else if (o === null)
+    if (s === "bold")
+      e = m.TRUE;
+    else if (s === "normal")
+      e = m.FALSE;
+    else if (s === null)
       e = null;
     else
       throw new Error("Invalid fontWeight");
@@ -993,19 +1371,27 @@ let k = class extends X {
       range: this._range,
       style: t
     };
-    return this._commandService.executeCommand(C.id, n), this;
+    return this._commandService.executeCommand(f.id, n), this;
   }
   /**
    * Sets the font style for the given range ('italic' or 'normal').
-   * @param fontStyle The font style, either 'italic' or 'normal'; a null value resets the font style.
+   * @param {FontStyle|null} fontStyle The font style, either 'italic' or 'normal'; a null value resets the font style.
+   * @returns {FRange} This range, for chaining
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .setFontStyle('italic');
+   * ```
    */
-  setFontStyle(o) {
+  setFontStyle(s) {
     let e;
-    if (o === "italic")
-      e = u.TRUE;
-    else if (o === "normal")
-      e = u.FALSE;
-    else if (o === null)
+    if (s === "italic")
+      e = m.TRUE;
+    else if (s === "normal")
+      e = m.FALSE;
+    else if (s === null)
       e = null;
     else
       throw new Error("Invalid fontStyle");
@@ -1018,28 +1404,36 @@ let k = class extends X {
       range: this._range,
       style: t
     };
-    return this._commandService.executeCommand(C.id, n), this;
+    return this._commandService.executeCommand(f.id, n), this;
   }
   /**
    * Sets the font line style of the given range ('underline', 'line-through', or 'none').
-   * @param fontLine The font line style, either 'underline', 'line-through', or 'none'; a null value resets the font line style.
+   * @param {FontLine|null} fontLine The font line style, either 'underline', 'line-through', or 'none'; a null value resets the font line style.
+   * @returns {FRange} This range, for chaining
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .setFontLine('underline');
+   * ```
    */
-  setFontLine(o) {
-    if (o === "underline")
+  setFontLine(s) {
+    if (s === "underline")
       this._setFontUnderline({
-        s: u.TRUE
+        s: m.TRUE
       });
-    else if (o === "line-through")
+    else if (s === "line-through")
       this._setFontStrikethrough({
-        s: u.TRUE
+        s: m.TRUE
       });
-    else if (o === "none")
+    else if (s === "none")
       this._setFontUnderline({
-        s: u.FALSE
+        s: m.FALSE
       }), this._setFontStrikethrough({
-        s: u.FALSE
+        s: m.FALSE
       });
-    else if (o === null)
+    else if (s === null)
       this._setFontUnderline(null), this._setFontStrikethrough(null);
     else
       throw new Error("Invalid fontLine");
@@ -1047,136 +1441,215 @@ let k = class extends X {
   }
   /**
    * Sets the font underline style of the given ITextDecoration
+   * @param {ITextDecoration|null} value The font underline style of the given ITextDecoration; a null value resets the font underline style
+   * @returns {void}
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .setFontLine('underline');
+   * ```
    */
-  _setFontUnderline(o) {
+  _setFontUnderline(s) {
     const e = {
       type: "ul",
-      value: o
+      value: s
     }, t = {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
       style: e
     };
-    this._commandService.executeCommand(C.id, t);
+    this._commandService.executeCommand(f.id, t);
   }
   /**
    * Sets the font strikethrough style of the given ITextDecoration
+   * @param {ITextDecoration|null} value The font strikethrough style of the given ITextDecoration; a null value resets the font strikethrough style
+   * @returns {void}
    */
-  _setFontStrikethrough(o) {
+  _setFontStrikethrough(s) {
     const e = {
       type: "st",
-      value: o
+      value: s
     }, t = {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
       style: e
     };
-    this._commandService.executeCommand(C.id, t);
+    this._commandService.executeCommand(f.id, t);
   }
   /**
    * Sets the font family, such as "Arial" or "Helvetica".
-   * @param fontFamily The font family to set; a null value resets the font family.
+   * @param {string|null} fontFamily The font family to set; a null value resets the font family.
+   * @returns {FRange} This range, for chaining
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .setFontFamily('Arial');
+   * ```
    */
-  setFontFamily(o) {
+  setFontFamily(s) {
     const e = {
       type: "ff",
-      value: o
+      value: s
     }, t = {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
       style: e
     };
-    return this._commandService.executeCommand(C.id, t), this;
+    return this._commandService.executeCommand(f.id, t), this;
   }
   /**
    * Sets the font size, with the size being the point size to use.
-   * @param size A font size in point size. A null value resets the font size.
+   * @param {number|null} size A font size in point size. A null value resets the font size.
+   * @returns {FRange} This range, for chaining
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .setFontSize(12);
+   * ```
    */
-  setFontSize(o) {
+  setFontSize(s) {
     const e = {
       type: "fs",
-      value: o
+      value: s
     }, t = {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
       style: e
     };
-    return this._commandService.executeCommand(C.id, t), this;
+    return this._commandService.executeCommand(f.id, t), this;
   }
   /**
    * Sets the font color in CSS notation (such as '#ffffff' or 'white').
-   * @param color The font color in CSS notation (such as '#ffffff' or 'white'); a null value resets the color.
+   * @param {string|null} color The font color in CSS notation (such as '#ffffff' or 'white'); a null value resets the color.
+   * @returns {FRange} This range, for chaining
+   * @example
+   * ```ts
+   * univerAPI.getActiveWorkbook()
+   *  .getActiveSheet()
+   *  .getActiveRange()
+   *  .setFontColor('#ff0000');
+   * ```
    */
-  setFontColor(o) {
+  setFontColor(s) {
     const t = {
       type: "cl",
-      value: o === null ? null : { rgb: o }
+      value: s === null ? null : { rgb: s }
     }, n = {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
       style: t
     };
-    return this._commandService.executeCommand(C.id, n), this;
+    return this._commandService.executeCommand(f.id, n), this;
   }
   // #endregion editing
   //#region Merge cell
   /**
    * Merge cells in a range into one merged cell
-   *
-   * @param [defaultMerge] - If true, only the value in the upper left cell is retained.
-   *
-   * @returns This range, for chaining
+   * @param {boolean} [defaultMerge] - If true, only the value in the upper left cell is retained.
+   * @returns {FRange} This range, for chaining
+   * @example
+   * ```ts
+   * const workbook = univerAPI.getActiveWorkbook();
+   * const worksheet = workbook.getActiveSheet();
+   * const range = worksheet.getRange(0, 0, 2, 2);
+   * const merge = range.merge();
+   * const isMerged = merge.isMerged();
+   * console.log('debugger', isMerged);
+   * ```
    */
-  merge(o = !0) {
+  merge(s = !0) {
     const e = this._workbook.getUnitId(), t = this._worksheet.getSheetId();
-    return B(this._injector, e, t, [this._range], o), this;
+    return $(this._injector, e, t, [this._range], s), this;
   }
   /**
    * Merges cells in a range horizontally.
-   *
-   * @param [defaultMerge] - If true, only the value in the upper left cell is retained.
-   *
-   * @returns This range, for chaining
+   * @param {boolean} [defaultMerge] - If true, only the value in the upper left cell is retained.
+   * @returns {FRange} This range, for chaining
+   * @example
+   * ```ts
+   * const workbook = univerAPI.getActiveWorkbook();
+   * const worksheet = workbook.getActiveSheet();
+   * const range = worksheet.getRange(2, 2, 2, 2);
+   * const merge = range.mergeAcross();
+   * const allMerge = worksheet.getMergeData();
+   * console.log(allMerge.length); // There will be two merged cells.
+   * ```
    */
-  mergeAcross(o = !0) {
-    const e = re([this._range], te.ROWS), t = this._workbook.getUnitId(), n = this._worksheet.getSheetId();
-    return B(this._injector, t, n, e, o), this;
+  mergeAcross(s = !0) {
+    const e = ce([this._range], ie.ROWS), t = this._workbook.getUnitId(), n = this._worksheet.getSheetId();
+    return $(this._injector, t, n, e, s), this;
   }
   /**
    * Merges cells in a range vertically.
-   *
-   * @param [defaultMerge] - If true, only the value in the upper left cell is retained.
-   *
-   * @returns This range, for chaining
+   * @param {boolean} [defaultMerge] - If true, only the value in the upper left cell is retained.
+   * @returns {FRange} This range, for chaining
+   * @example
+   * ```ts
+   * const workbook = univerAPI.getActiveWorkbook();
+   * const worksheet = workbook.getActiveSheet();
+   * const range = worksheet.getRange(4, 4, 2, 2);
+   * const merge = range.mergeVertically();
+   * const allMerge = worksheet.getMergeData();
+   * console.log(allMerge.length); // There will be two merged cells.
+   * ```
    */
-  mergeVertically(o = !0) {
-    const e = re([this._range], te.COLUMNS), t = this._workbook.getUnitId(), n = this._worksheet.getSheetId();
-    return B(this._injector, t, n, e, o), this;
+  mergeVertically(s = !0) {
+    const e = ce([this._range], ie.COLUMNS), t = this._workbook.getUnitId(), n = this._worksheet.getSheetId();
+    return $(this._injector, t, n, e, s), this;
   }
   /**
    * Returns true if cells in the current range overlap a merged cell.
    * @returns {boolean} is overlap with a merged cell
+   * @example
+   * ```ts
+   * const workbook = univerAPI.getActiveWorkbook();
+   * const worksheet = workbook.getActiveSheet();
+   * const range = worksheet.getRange(0,0,2,2);
+   * const merge = range.merge();
+   * const anchor = worksheet.getRange(0,0);
+   * const isPartOfMerge = anchor.isPartOfMerge();
+   * console.log('debugger, isPartOfMerge) // true
+   * ```
    */
   isPartOfMerge() {
-    const { startRow: o, startColumn: e, endRow: t, endColumn: n } = this._range;
-    return this._worksheet.getMergedCellRange(o, e, t, n).length > 0;
+    const { startRow: s, startColumn: e, endRow: t, endColumn: n } = this._range;
+    return this._worksheet.getMergedCellRange(s, e, t, n).length > 0;
   }
   /**
    * Break all horizontally- or vertically-merged cells contained within the range list into individual cells again.
-   * @returns This range, for chaining
+   * @returns {FRange} This range, for chaining
+   * @example
+   * ```ts
+   * const workbook = univerAPI.getActiveWorkbook();
+   * const worksheet = workbook.getActiveSheet();
+   * const range = worksheet.getRange(0,0,2,2);
+   * const merge = range.merge();
+   * const anchor = worksheet.getRange(0,0);
+   * const isPartOfMergeFirst = anchor.isPartOfMerge();
+   * console.log('debugger' isPartOfMergeFirst) // true
+   * range.breakApart();
+   * const isPartOfMergeSecond = anchor.isPartOfMerge();
+   * console.log('debugger' isPartOfMergeSecond) // false
+   * ```
    */
   breakApart() {
-    return this._commandService.executeCommand(nt.id, { ranges: [this._range] }), this;
+    return this._commandService.executeCommand(at.id, { ranges: [this._range] }), this;
   }
   //#endregion
   /**
    * Iterate cells in this range. Merged cells will be respected.
-   * @param callback the callback function to be called for each cell in the range
+   * @param {Function} callback the callback function to be called for each cell in the range
    * @param {number} callback.row the row number of the cell
    * @param {number} callback.col the column number of the cell
    * @param {ICellData} callback.cell the cell data
@@ -1189,14 +1662,15 @@ let k = class extends X {
    * });
    * ```
    */
-  forEach(o) {
-    const { startColumn: e, startRow: t, endColumn: n, endRow: s } = this._range;
-    this._worksheet.getMatrixWithMergedCells(t, e, s, n).forValue((r, i, a) => {
-      o(r, i, a);
+  forEach(s) {
+    const { startColumn: e, startRow: t, endColumn: n, endRow: r } = this._range;
+    this._worksheet.getMatrixWithMergedCells(t, e, r, n).forValue((o, i, a) => {
+      s(o, i, a);
     });
   }
   /**
    * Returns a string description of the range, in A1 notation.
+   * @param {boolean} [withSheet] - If true, the sheet name is included in the A1 notation.
    * @returns {string} The A1 notation of the range.
    * ```ts
    * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -1205,8 +1679,8 @@ let k = class extends X {
    * console.log(fRange.getA1Notation()); // A1:B2
    * ```
    */
-  getA1Notation(o) {
-    return o ? xt(this._worksheet.getName(), this._range) : Z(this._range);
+  getA1Notation(s) {
+    return s ? Tt(this._worksheet.getName(), this._range) : re(this._range);
   }
   /**
    * Sets the specified range as the active range, with the top left cell in the range as the current cell.
@@ -1230,8 +1704,8 @@ let k = class extends X {
    * @description If the range is not a single cell, an error will be thrown.
    */
   activateAsCurrentCell() {
-    const o = this._worksheet.getMergedCell(this._range.startRow, this._range.startColumn);
-    if (o && E.equals(o, this._range) || !o && this._range.startRow === this._range.endRow && this._range.startColumn === this._range.endColumn)
+    const s = this._worksheet.getMergedCell(this._range.startRow, this._range.startColumn);
+    if (s && N.equals(s, this._range) || !s && this._range.startRow === this._range.endRow && this._range.startColumn === this._range.endColumn)
       return this.activate();
     throw new Error("The range is not a single cell");
   }
@@ -1267,14 +1741,14 @@ let k = class extends X {
    * //  1 | 2 | 3
    * //  4 | 5 | 6
    */
-  splitTextToColumns(o, e, t) {
-    this._commandService.executeCommand(st.id, {
+  splitTextToColumns(s, e, t) {
+    this._commandService.executeCommand(ht.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
       delimiter: e,
       customDelimiter: t,
-      treatMultipleDelimitersAsOne: o
+      treatMultipleDelimitersAsOne: s
     });
   }
   /**
@@ -1288,16 +1762,16 @@ let k = class extends X {
    * fRange.useThemeStyle('default');
    * ```
    */
-  useThemeStyle(o) {
-    if (o == null) {
+  useThemeStyle(s) {
+    if (s == null) {
       const e = this.getUsedThemeStyle();
       e && this.removeThemeStyle(e);
     } else
-      this._commandService.executeCommand(ot.id, {
+      this._commandService.executeCommand(ct.id, {
         unitId: this._workbook.getUnitId(),
         subUnitId: this._worksheet.getSheetId(),
         range: this._range,
-        themeName: o
+        themeName: s
       });
   }
   /**
@@ -1311,12 +1785,12 @@ let k = class extends X {
    * fRange.removeThemeStyle('default');
    * ```
    */
-  removeThemeStyle(o) {
-    this._commandService.executeCommand(rt.id, {
+  removeThemeStyle(s) {
+    this._commandService.executeCommand(dt.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
-      themeName: o
+      themeName: s
     });
   }
   /**
@@ -1333,49 +1807,49 @@ let k = class extends X {
    * ```
    */
   getUsedThemeStyle() {
-    return this._injector.get(Ee).getAppliedRangeThemeStyle({
+    return this._injector.get(Me).getAppliedRangeThemeStyle({
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range
     });
   }
 };
-k = Gt([
-  $(3, m(v)),
-  $(4, l),
-  $(5, m(Et))
-], k);
-var qt = Object.defineProperty, Kt = Object.getOwnPropertyDescriptor, Yt = (o, e, t, n) => {
-  for (var s = n > 1 ? void 0 : n ? Kt(e, t) : e, r = o.length - 1, i; r >= 0; r--)
-    (i = o[r]) && (s = (n ? i(e, t, s) : i(s)) || s);
-  return n && s && qt(e, t, s), s;
-}, Jt = (o, e) => (t, n) => e(t, n, o);
-let A = class {
-  constructor(o, e, t, n) {
-    this._workbook = o, this._worksheet = e, this._selections = t, this._injector = n;
+w = Jt([
+  Y(3, u(b)),
+  Y(4, l),
+  Y(5, u(Wt))
+], w);
+var Qt = Object.defineProperty, Xt = Object.getOwnPropertyDescriptor, Zt = (s, e, t, n) => {
+  for (var r = n > 1 ? void 0 : n ? Xt(e, t) : e, o = s.length - 1, i; o >= 0; o--)
+    (i = s[o]) && (r = (n ? i(e, t, r) : i(r)) || r);
+  return n && r && Qt(e, t, r), r;
+}, en = (s, e) => (t, n) => e(t, n, s);
+let B = class {
+  constructor(s, e, t, n) {
+    this._workbook = s, this._worksheet = e, this._selections = t, this._injector = n;
   }
   /**
    * Represents the active selection in the sheet. Which means the selection contains the active cell.
    * @returns {FRange | null} The active selection.
    */
   getActiveRange() {
-    const o = this._selections.find((e) => !!e.primary);
-    return o ? this._injector.createInstance(k, this._workbook, this._worksheet, o.range) : null;
+    const s = this._selections.find((e) => !!e.primary);
+    return s ? this._injector.createInstance(w, this._workbook, this._worksheet, s.range) : null;
   }
   /**
    * Represents the active selection list in the sheet.
    * @returns {FRange[]} The active selection list.
    */
   getActiveRangeList() {
-    return this._selections.map((o) => this._injector.createInstance(k, this._workbook, this._worksheet, o.range));
+    return this._selections.map((s) => this._injector.createInstance(w, this._workbook, this._worksheet, s.range));
   }
   /**
    * Represents the current select cell in the sheet.
    * @returns {ISelectionCell} The current select cell info.Pay attention to the type of the return value.
    */
   getCurrentCell() {
-    const o = this._selections.find((e) => !!e.primary);
-    return o ? o.primary : null;
+    const s = this._selections.find((e) => !!e.primary);
+    return s ? s.primary : null;
   }
   /**
    * Returns the active sheet in the spreadsheet.
@@ -1390,8 +1864,8 @@ let A = class {
    * ```
    */
   getActiveSheet() {
-    const o = this._injector.createInstance(I, this._workbook);
-    return this._injector.createInstance(g, o, this._workbook, this._worksheet);
+    const s = this._injector.createInstance(I, this._workbook);
+    return this._injector.createInstance(g, s, this._workbook, this._worksheet);
   }
   /**
    * Update the primary cell in the selection. if the primary cell not exists in selections, add it to the selections and clear the old selections.
@@ -1407,31 +1881,31 @@ let A = class {
    * console.log(newSelection.getActiveRange().getA1Notation()); // A1
    * ```
    */
-  updatePrimaryCell(o) {
+  updatePrimaryCell(s) {
     const e = this._injector.get(l);
     let t = [], n = !1;
-    for (const { range: r, style: i } of this._selections)
-      E.contains(r, o.getRange()) ? (t.push({
-        range: r,
-        primary: K(o.getRange(), this._worksheet),
+    for (const { range: o, style: i } of this._selections)
+      N.contains(o, s.getRange()) ? (t.push({
+        range: o,
+        primary: Z(s.getRange(), this._worksheet),
         style: i
       }), n = !0) : t.push({
-        range: r,
+        range: o,
         primary: null,
         style: i
       });
     n || (t = [
       {
-        range: o.getRange(),
-        primary: K(o.getRange(), this._worksheet)
+        range: s.getRange(),
+        primary: Z(s.getRange(), this._worksheet)
       }
     ]);
-    const s = {
+    const r = {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       selections: t
     };
-    return e.syncExecuteCommand(xe.id, s), new A(this._workbook, this._worksheet, t, this._injector);
+    return e.syncExecuteCommand(De.id, r), new B(this._workbook, this._worksheet, t, this._injector);
   }
   /**
    *Get the next primary cell in the specified direction. If the primary cell not exists in selections, return null.
@@ -1448,30 +1922,68 @@ let A = class {
    * console.log(nextCell?.getA1Notation()); // B1
    * ```
    */
-  getNextDataRange(o) {
+  getNextDataRange(s) {
     if (!this._selections.find((n) => !!n.primary))
       return null;
-    const t = it(this._selections.concat(), o, this._worksheet);
-    return t ? this._injector.createInstance(k, this._workbook, this._worksheet, t) : null;
+    const t = ut(this._selections.concat(), s, this._worksheet);
+    return t ? this._injector.createInstance(w, this._workbook, this._worksheet, t) : null;
   }
 };
-A = Yt([
-  Jt(3, m(v))
-], A);
-var Qt = Object.defineProperty, Xt = Object.getOwnPropertyDescriptor, Zt = (o, e, t, n) => {
-  for (var s = n > 1 ? void 0 : n ? Xt(e, t) : e, r = o.length - 1, i; r >= 0; r--)
-    (i = o[r]) && (s = (n ? i(e, t, s) : i(s)) || s);
-  return n && s && Qt(e, t, s), s;
-}, W = (o, e) => (t, n) => e(t, n, o);
-let g = class extends X {
-  constructor(e, t, n, s, r, i, a) {
-    super(s);
+B = Zt([
+  en(3, u(b))
+], B);
+var tn = Object.defineProperty, nn = Object.getOwnPropertyDescriptor, sn = (s, e, t, n) => {
+  for (var r = n > 1 ? void 0 : n ? nn(e, t) : e, o = s.length - 1, i; o >= 0; o--)
+    (i = s[o]) && (r = (n ? i(e, t, r) : i(r)) || r);
+  return n && r && tn(e, t, r), r;
+}, T = (s, e) => (t, n) => e(t, n, s);
+let g = class extends ne {
+  constructor(e, t, n, r, o, i, a) {
+    super(r);
+    k(this, "_eventRegistry", /* @__PURE__ */ new Map());
     /**
      * Sets the active selection region for this sheet.
      * @param range The range to set as the active selection.
      */
-    p(this, "setActiveSelection", this.setActiveRange);
-    this._fWorkbook = e, this._workbook = t, this._worksheet = n, this._injector = s, this._selectionManagerService = r, this._logService = i, this._commandService = a;
+    k(this, "setActiveSelection", this.setActiveRange);
+    this._fWorkbook = e, this._workbook = t, this._worksheet = n, this._injector = r, this._selectionManagerService = o, this._logService = i, this._commandService = a;
+  }
+  getSheet() {
+    return this._worksheet;
+  }
+  _ensureEventRegistry(e) {
+    return this._eventRegistry.has(e) || this._eventRegistry.set(e, new ye()), this._eventRegistry.get(e);
+  }
+  /**
+   * Add an event listener
+   * @param event key of event
+   * @param callback callback when event triggered
+   * @returns {Disposable} The Disposable instance, for remove the listener
+   * @example
+   * ```ts
+   * univerAPI.addEvent(univerAPI.event.UnitCreated, (params) => {
+   *     console.log('unit created', params);
+   * });
+   * ```
+   */
+  addEvent(e, t) {
+    return this._ensureEventRegistry(e).add(t), F(() => this._ensureEventRegistry(e).delete(t));
+  }
+  /**
+   * Fire an event, used in internal only.
+   * @param event {string} key of event
+   * @param params {any} params of event
+   * @returns {boolean} should cancel
+   * @example
+   * ```ts
+   * this.fireEvent(univerAPI.event.UnitCreated, params);
+   * ```
+   */
+  fireEvent(e, t) {
+    var n;
+    return (n = this._eventRegistry.get(e)) == null || n.getData().forEach((r) => {
+      r(t);
+    }), t.cancel;
   }
   /**
    * Returns the injector
@@ -1507,7 +2019,7 @@ let g = class extends X {
    */
   getSelection() {
     const e = this._selectionManagerService.getCurrentSelections();
-    return e ? this._injector.createInstance(A, this._workbook, this._worksheet, e) : null;
+    return e ? this._injector.createInstance(B, this._workbook, this._worksheet, e) : null;
   }
   // #region rows
   // #region default style
@@ -1530,7 +2042,7 @@ let g = class extends X {
   /**
    * Get the default style of the worksheet column
    * @param {number} index The column index
-   * @param  {boolean} [keepRaw] If true, return the raw style data maybe the style name or style data, otherwise return the data from col manager
+   * @param {boolean} [keepRaw] If true, return the raw style data maybe the style name or style data, otherwise return the data from col manager
    * @returns {Nullable<IStyleData> | string} The default style of the worksheet column name or style data
    */
   getColumnDefaultStyle(e, t = !1) {
@@ -1543,7 +2055,7 @@ let g = class extends X {
    */
   setDefaultStyle(e) {
     const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId();
-    return this._commandService.syncExecuteCommand(at.id, {
+    return this._commandService.syncExecuteCommand(mt.id, {
       unitId: t,
       subUnitId: n,
       defaultStyle: e
@@ -1556,16 +2068,16 @@ let g = class extends X {
    * @returns {FWorksheet} This sheet, for chaining.
    */
   setColumnDefaultStyle(e, t) {
-    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = {
+    const n = this._workbook.getUnitId(), r = this._worksheet.getSheetId(), o = {
       unitId: n,
-      subUnitId: s,
+      subUnitId: r,
       columnData: {
         [e]: {
           s: t
         }
       }
     };
-    return this._commandService.syncExecuteCommand(ie.id, r), this;
+    return this._commandService.syncExecuteCommand(de.id, o), this;
   }
   /**
    * Set the default style of the worksheet column
@@ -1574,24 +2086,24 @@ let g = class extends X {
    * @returns {FWorksheet} This sheet, for chaining.
    */
   setRowDefaultStyle(e, t) {
-    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = {
+    const n = this._workbook.getUnitId(), r = this._worksheet.getSheetId(), o = {
       unitId: n,
-      subUnitId: s,
+      subUnitId: r,
       rowData: {
         [e]: {
           s: t
         }
       }
     };
-    return this._commandService.syncExecuteCommand(ae.id, r), this;
+    return this._commandService.syncExecuteCommand(ue.id, o), this;
   }
-  getRange(e, t, n, s) {
-    let r, i;
+  getRange(e, t, n, r) {
+    let o, i;
     if (typeof e == "string") {
-      const { range: a, sheetName: h } = Nt(e), c = h ? this._workbook.getSheetBySheetName(h) : this._worksheet;
+      const { range: a, sheetName: h } = At(e), c = h ? this._workbook.getSheetBySheetName(h) : this._worksheet;
       if (!c)
         throw new Error("Range not found");
-      i = c, r = {
+      i = c, o = {
         ...a,
         unitId: this._workbook.getUnitId(),
         sheetId: i.getSheetId(),
@@ -1604,44 +2116,44 @@ let g = class extends X {
         endColumn: a.rangeType === _.ROW ? i.getMaxColumns() - 1 : a.endColumn
       };
     } else if (typeof e == "number" && t !== void 0)
-      i = this._worksheet, r = {
+      i = this._worksheet, o = {
         startRow: e,
         endRow: e + (n != null ? n : 1) - 1,
         startColumn: t,
-        endColumn: t + (s != null ? s : 1) - 1,
+        endColumn: t + (r != null ? r : 1) - 1,
         unitId: this._workbook.getUnitId(),
         sheetId: this._worksheet.getSheetId()
       };
     else
       throw new Error("Invalid range specification");
-    return this._injector.createInstance(k, this._workbook, i, r);
+    return this._injector.createInstance(w, this._workbook, i, o);
   }
   /**
    * Returns the current number of columns in the sheet, regardless of content.
-   * @return The maximum columns count of the sheet
+   * @returns {number} The maximum columns count of the sheet
    */
   getMaxColumns() {
     return this._worksheet.getMaxColumns();
   }
   /**
    * Returns the current number of rows in the sheet, regardless of content.
-   * @return The maximum rows count of the sheet
+   * @returns {number}The maximum rows count of the sheet
    */
   getMaxRows() {
     return this._worksheet.getMaxRows();
   }
   /**
    * Inserts a row after the given row position.
-   * @param afterPosition The row after which the new row should be added, starting at 0 for the first row.
-   * @returns This sheet, for chaining.
+   * @param {number} afterPosition The row after which the new row should be added, starting at 0 for the first row.
+   * @returns {FWorksheet} This sheet, for chaining.
    */
   insertRowAfter(e) {
     return this.insertRowsAfter(e, 1);
   }
   /**
    * Inserts a row before the given row position.
-   * @param beforePosition The row before which the new row should be added, starting at 0 for the first row.
-   * @returns This sheet, for chaining.
+   * @param {number} beforePosition The row before which the new row should be added, starting at 0 for the first row.
+   * @returns {FWorksheet} This sheet, for chaining.
    */
   insertRowBefore(e) {
     return this.insertRowsBefore(e, 1);
@@ -1662,11 +2174,11 @@ let g = class extends X {
    * @returns This sheet, for chaining.
    */
   insertRowsAfter(e, t) {
-    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = N.DOWN, i = e + 1, a = e + t, h = 0, c = this._worksheet.getColumnCount() - 1, d = D(this._worksheet, i, a, h, c, !0, e);
-    return this._commandService.syncExecuteCommand(he.id, {
+    const n = this._workbook.getUnitId(), r = this._worksheet.getSheetId(), o = D.DOWN, i = e + 1, a = e + t, h = 0, c = this._worksheet.getColumnCount() - 1, d = W(this._worksheet, i, a, h, c, !0, e);
+    return this._commandService.syncExecuteCommand(me.id, {
       unitId: n,
-      subUnitId: s,
-      direction: r,
+      subUnitId: r,
+      direction: o,
       range: {
         startRow: i,
         endRow: a,
@@ -1683,11 +2195,11 @@ let g = class extends X {
    * @returns This sheet, for chaining.
    */
   insertRowsBefore(e, t) {
-    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = N.UP, i = e, a = e + t - 1, h = 0, c = this._worksheet.getColumnCount() - 1, d = D(this._worksheet, i, a, h, c, !0, e - 1);
-    return this._commandService.syncExecuteCommand(he.id, {
+    const n = this._workbook.getUnitId(), r = this._worksheet.getSheetId(), o = D.UP, i = e, a = e + t - 1, h = 0, c = this._worksheet.getColumnCount() - 1, d = W(this._worksheet, i, a, h, c, !0, e - 1);
+    return this._commandService.syncExecuteCommand(me.id, {
       unitId: n,
-      subUnitId: s,
-      direction: r,
+      subUnitId: r,
+      direction: o,
       range: {
         startRow: i,
         endRow: a,
@@ -1718,7 +2230,7 @@ let g = class extends X {
       startColumn: 0,
       endColumn: this._worksheet.getColumnCount() - 1
     };
-    return this._commandService.syncExecuteCommand(ht.id, {
+    return this._commandService.syncExecuteCommand(lt.id, {
       range: n,
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId()
@@ -1731,16 +2243,16 @@ let g = class extends X {
    * @returns This sheet, for chaining.
    */
   moveRows(e, t) {
-    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = V(e.getRange(), this._worksheet), i = r, a = {
+    const n = this._workbook.getUnitId(), r = this._worksheet.getSheetId(), o = q(e.getRange(), this._worksheet), i = o, a = {
       startRow: t,
       endRow: t,
-      startColumn: r.startColumn,
-      endColumn: r.endColumn
+      startColumn: o.startColumn,
+      endColumn: o.endColumn
     };
-    return this._commandService.syncExecuteCommand(ct.id, {
+    return this._commandService.syncExecuteCommand(gt.id, {
       unitId: n,
-      subUnitId: s,
-      range: r,
+      subUnitId: r,
+      range: o,
       fromRange: i,
       toRange: a
     }), this;
@@ -1751,114 +2263,115 @@ let g = class extends X {
    * @returns This sheet, for chaining.
    */
   hideRow(e) {
-    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId(), s = V(e.getRange(), this._worksheet);
-    return this._commandService.syncExecuteCommand(ce.id, {
+    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId(), r = q(e.getRange(), this._worksheet);
+    return this._commandService.syncExecuteCommand(le.id, {
       unitId: t,
       subUnitId: n,
-      ranges: [s]
+      ranges: [r]
     }), this;
   }
   /**
    * Hides one or more consecutive rows starting at the given index. Use 0-index for this method.
-   * @param rowIndex The starting index of the rows to hide.
-   * @param numRows The number of rows to hide.
-   * @returns This sheet, for chaining.
+   * @param {number} rowIndex The starting index of the rows to hide.
+   * @param {number} numRows The number of rows to hide.
+   * @returns {FWorksheet} This sheet, for chaining.
    */
   hideRows(e, t = 1) {
-    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = {
+    const n = this._workbook.getUnitId(), r = this._worksheet.getSheetId(), o = {
       startRow: e,
       endRow: e + t - 1,
       startColumn: 0,
       endColumn: this._worksheet.getColumnCount() - 1,
       rangeType: _.ROW
     };
-    return this._commandService.syncExecuteCommand(ce.id, {
+    return this._commandService.syncExecuteCommand(le.id, {
       unitId: n,
-      subUnitId: s,
-      ranges: [r]
+      subUnitId: r,
+      ranges: [o]
     }), this;
   }
   /**
-   * Unhides the row in the given range.
-   * @param row The range to unhide, if hidden.
-   * @returns This sheet, for chaining.
+   * Make the row in the given range visible.
+   * @param {FRange} row The range to unhide, if hidden.
+   * @returns {FWorksheet} This sheet, for chaining.
    */
   unhideRow(e) {
-    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId(), s = V(e.getRange(), this._worksheet);
-    return this._commandService.syncExecuteCommand(de.id, {
+    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId(), r = q(e.getRange(), this._worksheet);
+    return this._commandService.syncExecuteCommand(ge.id, {
       unitId: t,
       subUnitId: n,
-      ranges: [s]
+      ranges: [r]
     }), this;
   }
   /**
-   * Unhides one or more consecutive rows starting at the given index. Use 0-index for this method.
-   * @param rowIndex The starting index of the rows to unhide.
-   * @param numRows The number of rows to unhide.
-   * @returns This sheet, for chaining.
+   * Scrolling sheet to make specific rows visible.
+   * @param {number} rowIndex The starting index of the rows
+   * @param {number} numRows The number of rows
+   * @returns {FWorksheet} This sheet, for chaining.
    */
   showRows(e, t = 1) {
-    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = {
+    const n = this._workbook.getUnitId(), r = this._worksheet.getSheetId(), o = {
       startRow: e,
       endRow: e + t - 1,
       startColumn: 0,
       endColumn: this._worksheet.getColumnCount() - 1,
       rangeType: _.ROW
     };
-    return this._commandService.syncExecuteCommand(de.id, {
+    return this._commandService.syncExecuteCommand(ge.id, {
       unitId: n,
-      subUnitId: s,
-      ranges: [r]
+      subUnitId: r,
+      ranges: [o]
     }), this;
   }
   /**
    * Sets the row height of the given row in pixels. By default, rows grow to fit cell contents. If you want to force rows to a specified height, use setRowHeightsForced(startRow, numRows, height).
-   * @param rowPosition The row position to change.
-   * @param height The height in pixels to set it to.
-   * @returns This sheet, for chaining.
+   * @param {number} rowPosition The row position to change.
+   * @param {number} height The height in pixels to set it to.
+   * @returns {FWorksheet} This sheet, for chaining.
    */
   setRowHeight(e, t) {
     return this.setRowHeights(e, 1, t);
   }
   /**
-   * Sets the height of the given rows in pixels. By default, rows grow to fit cell contents. If you want to force rows to a specified height, use setRowHeightsForced(startRow, numRows, height).
-   * @param startRow The starting row position to change.
-   * @param numRows The number of rows to change.
-   * @param height The height in pixels to set it to.
-   * @returns This sheet, for chaining.
+   * Sets the height of the given rows in pixels.
+   * By default, rows grow to fit cell contents. If you want to force rows to a specified height, use setRowHeightsForced(startRow, numRows, height).
+   * @param {number} startRow The starting row position to change.
+   * @param {number} numRows The number of rows to change.
+   * @param {number} height The height in pixels to set it to.
+   * @returns {FWorksheet} This sheet, for chaining.
    */
   setRowHeights(e, t, n) {
     var c;
-    const s = this._workbook.getUnitId(), r = this._worksheet.getSheetId(), i = this._worksheet.getRowManager(), a = [], h = [];
+    const r = this._workbook.getUnitId(), o = this._worksheet.getSheetId(), i = this._worksheet.getRowManager(), a = [], h = [];
     for (let d = e; d < e + t; d++) {
-      const O = ((c = i.getRow(d)) == null ? void 0 : c.ah) || this._worksheet.getConfig().defaultRowHeight, x = {
+      const z = ((c = i.getRow(d)) == null ? void 0 : c.ah) || this._worksheet.getConfig().defaultRowHeight, M = {
         startRow: d,
         endRow: d,
         startColumn: 0,
         endColumn: this._worksheet.getColumnCount() - 1
       };
-      n <= O ? a.push(x) : h.push(x);
+      n <= z ? a.push(M) : h.push(M);
     }
-    return h.length > 0 && this._commandService.syncExecuteCommand(me.id, {
-      unitId: s,
-      subUnitId: r,
+    return h.length > 0 && this._commandService.syncExecuteCommand(_e.id, {
+      unitId: r,
+      subUnitId: o,
       ranges: h,
       value: n
-    }), a.length > 0 && this._commandService.syncExecuteCommand(dt.id, {
-      unitId: s,
-      subUnitId: r,
+    }), a.length > 0 && this._commandService.syncExecuteCommand(_t.id, {
+      unitId: r,
+      subUnitId: o,
       ranges: a
     }), this;
   }
   /**
    * Sets the height of the given rows in pixels. By default, rows grow to fit cell contents. When you use setRowHeightsForced, rows are forced to the specified height even if the cell contents are taller than the row height.
-   * @param startRow The starting row position to change.
-   * @param numRows The number of rows to change.
-   * @param height The height in pixels to set it to.
-   * @returns This sheet, for chaining.
+   * @param {number} startRow The starting row position to change.
+   * @param {number} numRows The number of rows to change.
+   * @param {number} height The height in pixels to set it to.
+   * @returns {FWorksheet} This sheet, for chaining.
    */
   setRowHeightsForced(e, t, n) {
-    const s = this._workbook.getUnitId(), r = this._worksheet.getSheetId(), i = [
+    const r = this._workbook.getUnitId(), o = this._worksheet.getSheetId(), i = [
       {
         startRow: e,
         endRow: e + t - 1,
@@ -1866,9 +2379,9 @@ let g = class extends X {
         endColumn: this._worksheet.getColumnCount() - 1
       }
     ];
-    return this._commandService.syncExecuteCommand(me.id, {
-      unitId: s,
-      subUnitId: r,
+    return this._commandService.syncExecuteCommand(_e.id, {
+      unitId: r,
+      subUnitId: o,
       ranges: i,
       value: n
     }), this;
@@ -1880,17 +2393,17 @@ let g = class extends X {
    * @returns This sheet, for chaining.
    */
   setRowCustom(e) {
-    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId(), s = {};
+    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId(), r = {};
     for (const [i, a] of Object.entries(e))
-      s[Number(i)] = {
+      r[Number(i)] = {
         custom: a
       };
-    const r = {
+    const o = {
       unitId: t,
       subUnitId: n,
-      rowData: s
+      rowData: r
     };
-    return this._commandService.syncExecuteCommand(ae.id, r), this;
+    return this._commandService.syncExecuteCommand(ue.id, o), this;
   }
   // #region Column
   /**
@@ -1925,11 +2438,11 @@ let g = class extends X {
    * @returns This sheet, for chaining.
    */
   insertColumnsAfter(e, t) {
-    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = N.RIGHT, i = 0, a = this._worksheet.getRowCount() - 1, h = e + 1, c = e + t, d = D(this._worksheet, i, a, h, c, !1, e);
-    return this._commandService.syncExecuteCommand(ue.id, {
+    const n = this._workbook.getUnitId(), r = this._worksheet.getSheetId(), o = D.RIGHT, i = 0, a = this._worksheet.getRowCount() - 1, h = e + 1, c = e + t, d = W(this._worksheet, i, a, h, c, !1, e);
+    return this._commandService.syncExecuteCommand(we.id, {
       unitId: n,
-      subUnitId: s,
-      direction: r,
+      subUnitId: r,
+      direction: o,
       range: {
         startRow: i,
         endRow: a,
@@ -1946,11 +2459,11 @@ let g = class extends X {
    * @returns This sheet, for chaining.
    */
   insertColumnsBefore(e, t) {
-    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = N.LEFT, i = 0, a = this._worksheet.getRowCount() - 1, h = e, c = e + t - 1, d = D(this._worksheet, i, a, h, c, !1, e - 1);
-    return this._commandService.syncExecuteCommand(ue.id, {
+    const n = this._workbook.getUnitId(), r = this._worksheet.getSheetId(), o = D.LEFT, i = 0, a = this._worksheet.getRowCount() - 1, h = e, c = e + t - 1, d = W(this._worksheet, i, a, h, c, !1, e - 1);
+    return this._commandService.syncExecuteCommand(we.id, {
       unitId: n,
-      subUnitId: s,
-      direction: r,
+      subUnitId: r,
+      direction: o,
       range: {
         startRow: i,
         endRow: a,
@@ -1981,7 +2494,7 @@ let g = class extends X {
       startColumn: e,
       endColumn: e + t - 1
     };
-    return this._commandService.syncExecuteCommand(mt.id, {
+    return this._commandService.syncExecuteCommand(wt.id, {
       range: n,
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId()
@@ -1994,16 +2507,16 @@ let g = class extends X {
    * @returns This sheet, for chaining.
    */
   moveColumns(e, t) {
-    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = H(e.getRange(), this._worksheet), i = r, a = {
+    const n = this._workbook.getUnitId(), r = this._worksheet.getSheetId(), o = K(e.getRange(), this._worksheet), i = o, a = {
       startRow: 0,
       endRow: this._worksheet.getRowCount() - 1,
       startColumn: t,
       endColumn: t
     };
-    return this._commandService.syncExecuteCommand(ut.id, {
+    return this._commandService.syncExecuteCommand(kt.id, {
       unitId: n,
-      subUnitId: s,
-      range: r,
+      subUnitId: r,
+      range: o,
       fromRange: i,
       toRange: a
     }), this;
@@ -2014,11 +2527,11 @@ let g = class extends X {
    * @returns This sheet, for chaining.
    */
   hideColumn(e) {
-    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId(), s = H(e.getRange(), this._worksheet);
-    return this._commandService.syncExecuteCommand(le.id, {
+    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId(), r = K(e.getRange(), this._worksheet);
+    return this._commandService.syncExecuteCommand(ke.id, {
       unitId: t,
       subUnitId: n,
-      ranges: [s]
+      ranges: [r]
     }), this;
   }
   /**
@@ -2028,50 +2541,50 @@ let g = class extends X {
    * @returns This sheet, for chaining.
    */
   hideColumns(e, t = 1) {
-    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = {
+    const n = this._workbook.getUnitId(), r = this._worksheet.getSheetId(), o = {
       startRow: 0,
       endRow: this._worksheet.getRowCount() - 1,
       startColumn: e,
       endColumn: e + t - 1,
       rangeType: _.COLUMN
     };
-    return this._commandService.syncExecuteCommand(le.id, {
+    return this._commandService.syncExecuteCommand(ke.id, {
       unitId: n,
-      subUnitId: s,
-      ranges: [r]
+      subUnitId: r,
+      ranges: [o]
     }), this;
   }
   /**
-   * Unhides the column in the given range.
+   * Show the column in the given range.
    * @param column The range to unhide, if hidden.
    * @returns This sheet, for chaining.
    */
   unhideColumn(e) {
-    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId(), s = H(e.getRange(), this._worksheet);
-    return this._commandService.syncExecuteCommand(ge.id, {
+    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId(), r = K(e.getRange(), this._worksheet);
+    return this._commandService.syncExecuteCommand(Se.id, {
       unitId: t,
       subUnitId: n,
-      ranges: [s]
+      ranges: [r]
     }), this;
   }
   /**
-   * Unhides one or more consecutive columns starting at the given index. Use 0-index for this method.
+   * Show one or more consecutive columns starting at the given index. Use 0-index for this method.
    * @param columnIndex The starting index of the columns to unhide.
    * @param numColumns The number of columns to unhide.
    * @returns This sheet, for chaining.
    */
   showColumns(e, t = 1) {
-    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = {
+    const n = this._workbook.getUnitId(), r = this._worksheet.getSheetId(), o = {
       startRow: 0,
       endRow: this._worksheet.getRowCount() - 1,
       startColumn: e,
       endColumn: e + t - 1,
       rangeType: _.COLUMN
     };
-    return this._commandService.syncExecuteCommand(ge.id, {
+    return this._commandService.syncExecuteCommand(Se.id, {
       unitId: n,
-      subUnitId: s,
-      ranges: [r]
+      subUnitId: r,
+      ranges: [o]
     }), this;
   }
   /**
@@ -2091,7 +2604,7 @@ let g = class extends X {
    * @returns This sheet, for chaining.
    */
   setColumnWidths(e, t, n) {
-    const s = this._workbook.getUnitId(), r = this._worksheet.getSheetId(), i = [
+    const r = this._workbook.getUnitId(), o = this._worksheet.getSheetId(), i = [
       {
         startColumn: e,
         endColumn: e + t - 1,
@@ -2099,9 +2612,9 @@ let g = class extends X {
         endRow: this._worksheet.getRowCount() - 1
       }
     ];
-    return this._commandService.syncExecuteCommand(lt.id, {
-      unitId: s,
-      subUnitId: r,
+    return this._commandService.syncExecuteCommand(St.id, {
+      unitId: r,
+      subUnitId: o,
       ranges: i,
       value: n
     }), this;
@@ -2113,17 +2626,17 @@ let g = class extends X {
    * @returns This sheet, for chaining.
    */
   setColumnCustom(e) {
-    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId(), s = {};
+    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId(), r = {};
     for (const [i, a] of Object.entries(e))
-      s[Number(i)] = {
+      r[Number(i)] = {
         custom: a
       };
-    const r = {
+    const o = {
       unitId: t,
       subUnitId: n,
-      columnData: s
+      columnData: r
     };
-    return this._commandService.syncExecuteCommand(ie.id, r), this;
+    return this._commandService.syncExecuteCommand(de.id, o), this;
   }
   // #region merge cells
   /**
@@ -2131,7 +2644,7 @@ let g = class extends X {
    * @returns all merged cells
    */
   getMergedRanges() {
-    return this._worksheet.getSnapshot().mergeData.map((t) => this._injector.createInstance(k, this._workbook, this._worksheet, t));
+    return this._worksheet.getSnapshot().mergeData.map((t) => this._injector.createInstance(w, this._workbook, this._worksheet, t));
   }
   /**
    * Get the merged cell data of the specified row and column.
@@ -2140,9 +2653,9 @@ let g = class extends X {
    * @returns {FRange|undefined} The merged cell data, or undefined if the cell is not merged.
    */
   getCellMergeData(e, t) {
-    const s = this._worksheet.getMergedCell(e, t);
-    if (s)
-      return this._injector.createInstance(k, this._workbook, this._worksheet, s);
+    const r = this._worksheet.getMergedCell(e, t);
+    if (r)
+      return this._injector.createInstance(w, this._workbook, this._worksheet, r);
   }
   // #endregion
   /**
@@ -2154,24 +2667,24 @@ let g = class extends X {
   }
   /**
    * Sets the active selection region for this sheet.
-   * @param range The range to set as the active selection.
+   * @param {FRange} range The range to set as the active selection.
+   * @returns {FWorksheet} This sheet, for chaining.
    */
   setActiveRange(e) {
     const { unitId: t, sheetId: n } = e.getRange();
     if (t !== this._workbook.getUnitId() || n !== this._worksheet.getSheetId())
       throw new Error("Specified range must be part of the sheet.");
-    this._fWorkbook.setActiveRange(e);
+    return this._fWorkbook.setActiveRange(e), this;
   }
   /**
    * Sets the frozen state of the current sheet.
    * @param freeze - the scrolling viewport start range and count of freezed rows and columns.
    * that means if you want to freeze the first 3 rows and 2 columns, you should set freeze as { startRow: 3, startColumn: 2, xSplit: 2, ySplit: 3 }
-   *
    * @deprecated use `setFrozenRows` and `setFrozenColumns` instead.
    * @returns True if the command was successful, false otherwise.
    */
   setFreeze(e) {
-    return this._logService.warn("setFreeze is deprecated, use setFrozenRows and setFrozenColumns instead"), this._commandService.syncExecuteCommand(L.id, {
+    return this._logService.warn("setFreeze is deprecated, use setFrozenRows and setFrozenColumns instead"), this._commandService.syncExecuteCommand(H.id, {
       ...e,
       unitId: this._workbook.getUnitId(),
       subUnitId: this.getSheetId()
@@ -2182,7 +2695,7 @@ let g = class extends X {
    * @returns True if the command was successful, false otherwise.
    */
   cancelFreeze() {
-    return this._commandService.syncExecuteCommand(gt.id, {
+    return this._commandService.syncExecuteCommand(Ct.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this.getSheetId()
     }), this;
@@ -2190,7 +2703,6 @@ let g = class extends X {
   /**
    * Get the freeze state of the current sheet.
    * @returns The freeze state of the current sheet.
-   *
    * @deprecated use `getRowFreezeStatus` and `getColumnFreezeStatus` instead.
    */
   getFreeze() {
@@ -2206,10 +2718,10 @@ let g = class extends X {
         xSplit: n
       });
     } else if (arguments.length === 2) {
-      let [n = 0, s = 0] = e;
-      n > s && ([n, s] = [s, n]), this._commandService.syncExecuteCommand(L.id, {
-        startColumn: s + 1,
-        xSplit: s - n + 1,
+      let [n = 0, r = 0] = e;
+      n > r && ([n, r] = [r, n]), this._commandService.syncExecuteCommand(H.id, {
+        startColumn: r + 1,
+        xSplit: r - n + 1,
         startRow: t.startRow,
         ySplit: t.ySplit,
         unitId: this._workbook.getUnitId(),
@@ -2228,10 +2740,10 @@ let g = class extends X {
         ySplit: n
       });
     } else if (arguments.length === 2) {
-      let [n = 0, s = 0] = e;
-      n > s && ([n, s] = [s, n]), this._commandService.syncExecuteCommand(L.id, {
-        startRow: s + 1,
-        ySplit: s - n + 1,
+      let [n = 0, r = 0] = e;
+      n > r && ([n, r] = [r, n]), this._commandService.syncExecuteCommand(H.id, {
+        startRow: r + 1,
+        ySplit: r - n + 1,
         startColumn: t.startColumn,
         xSplit: t.xSplit,
         unitId: this._workbook.getUnitId(),
@@ -2242,8 +2754,7 @@ let g = class extends X {
   }
   /**
    * Get the number of frozen columns.
-   * @returns The number of frozen columns.
-   * Returns 0 if no columns are frozen.
+   * @returns The number of frozen columns, returns 0 if no columns are frozen.
    */
   getFrozenColumns() {
     const e = this.getFreeze();
@@ -2251,8 +2762,7 @@ let g = class extends X {
   }
   /**
    * Get the number of frozen rows.
-   * @returns The number of frozen rows.
-   * Returns 0 if no rows are frozen.
+   * @returns The number of frozen rows. returns 0 if no rows are frozen.
    */
   getFrozenRows() {
     const e = this.getFreeze();
@@ -2260,6 +2770,7 @@ let g = class extends X {
   }
   /**
    * Get freezed rows.
+   * @returns {IRowRange} The range of the frozen rows.
    */
   getFrozenRowRange() {
     const e = this._worksheet.getFreeze();
@@ -2270,6 +2781,7 @@ let g = class extends X {
   }
   /**
    * Get freezed columns
+   * @returns {IColumnRange} The range of the frozen columns.
    */
   getFrozenColumnRange() {
     const e = this._worksheet.getFreeze();
@@ -2292,11 +2804,12 @@ let g = class extends X {
    * ```
    */
   hasHiddenGridLines() {
-    return this._worksheet.getConfig().showGridlines === u.FALSE;
+    return this._worksheet.getConfig().showGridlines === m.FALSE;
   }
   /**
    * Hides or reveals the sheet gridlines.
    * @param {boolean} hidden If `true`, hide gridlines in this sheet; otherwise show the gridlines.
+   * @returns {FWorksheet} Returns the current worksheet instance for method chaining
    * @example
    * ``` ts
    * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -2306,10 +2819,10 @@ let g = class extends X {
    * ```
    */
   setHiddenGridlines(e) {
-    return this._commandService.executeCommand(_t.id, {
+    return this._commandService.executeCommand(It.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
-      showGridlines: e ? u.FALSE : u.TRUE
+      showGridlines: e ? m.FALSE : m.TRUE
     }), this;
   }
   /**
@@ -2325,7 +2838,7 @@ let g = class extends X {
    * ```
    */
   setGridLinesColor(e) {
-    return this._commandService.syncExecuteCommand(wt.id, {
+    return this._commandService.syncExecuteCommand(ft.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       color: e
@@ -2351,7 +2864,7 @@ let g = class extends X {
    * ```
    */
   setTabColor(e) {
-    return this._commandService.executeCommand(St.id, {
+    return this._commandService.executeCommand(vt.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       color: e
@@ -2390,9 +2903,9 @@ let g = class extends X {
    */
   onCellDataChange(e) {
     return this._injector.get(l).onCommandExecuted((n) => {
-      if (n.id === _e.id) {
-        const s = n.params;
-        s.unitId === this._workbook.getUnitId() && s.subUnitId === this._worksheet.getSheetId() && s.cellValue && e(new T(s.cellValue));
+      if (n.id === Ce.id) {
+        const r = n.params;
+        r.unitId === this._workbook.getUnitId() && r.subUnitId === this._worksheet.getSheetId() && r.cellValue && e(new A(r.cellValue));
       }
     });
   }
@@ -2414,27 +2927,28 @@ let g = class extends X {
    */
   onBeforeCellDataChange(e) {
     return this._injector.get(l).beforeCommandExecuted((n) => {
-      if (n.id === _e.id) {
-        const s = n.params;
-        s.unitId === this._workbook.getUnitId() && s.subUnitId === this._worksheet.getSheetId() && s.cellValue && e(new T(s.cellValue));
+      if (n.id === Ce.id) {
+        const r = n.params;
+        r.unitId === this._workbook.getUnitId() && r.subUnitId === this._worksheet.getSheetId() && r.cellValue && e(new A(r.cellValue));
       }
     });
   }
   /**
    * Hides this sheet. Has no effect if the sheet is already hidden. If this method is called on the only visible sheet, it throws an exception.
+   * @returns {FWorksheet} Returns the current worksheet instance for method chaining
    * @example
    * ```ts
    * const fWorkbook = univerAPI.getActiveWorkbook();
    * const fWorkSheet = fWorkbook.getActiveSheet();
    * // hide the active sheet
    * fWorkSheet.hideSheet();
-   * ``
+   * ```
    */
   hideSheet() {
     const e = this._injector.get(l);
-    if (this._workbook.getSheets().filter((r) => r.isSheetHidden() !== u.TRUE).length <= 1)
+    if (this._workbook.getSheets().filter((o) => o.isSheetHidden() !== m.TRUE).length <= 1)
       throw new Error("Cannot hide the only visible sheet");
-    return e.syncExecuteCommand(kt.id, {
+    return e.syncExecuteCommand(Rt.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId()
     }), this;
@@ -2451,7 +2965,7 @@ let g = class extends X {
    * ```
    */
   showSheet() {
-    return this._injector.get(l).syncExecuteCommand(Ct.id, {
+    return this._injector.get(l).syncExecuteCommand(bt.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId()
     }), this;
@@ -2461,7 +2975,7 @@ let g = class extends X {
    * @returns {boolean} True if the sheet is hidden; otherwise, false.
    */
   isSheetHidden() {
-    return this._worksheet.isSheetHidden() === u.TRUE;
+    return this._worksheet.isSheetHidden() === m.TRUE;
   }
   /**
    * Sets the sheet name.
@@ -2476,7 +2990,7 @@ let g = class extends X {
    * ```
    */
   setName(e) {
-    return this._commandService.syncExecuteCommand(It.id, {
+    return this._commandService.syncExecuteCommand(pt.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       name: e
@@ -2521,20 +3035,17 @@ let g = class extends X {
    * ```
    */
   clear(e) {
-    if (e && e.contentsOnly && !e.formatOnly)
-      return this.clearContents();
-    if (e && e.formatOnly && !e.contentsOnly)
-      return this.clearFormats();
-    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId(), s = this._injector.get(l), r = {
+    e && e.contentsOnly && !e.formatOnly && this.clearContents(), e && e.formatOnly && !e.contentsOnly && this.clearFormats();
+    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId(), r = this._injector.get(l), o = {
       startRow: 0,
       endRow: this._worksheet.getRowCount() - 1,
       startColumn: 0,
       endColumn: this._worksheet.getColumnCount() - 1
     };
-    return s.syncExecuteCommand(ft.id, {
+    return r.syncExecuteCommand(yt.id, {
       unitId: t,
       subUnitId: n,
-      ranges: [r],
+      ranges: [o],
       options: e
     }), this;
   }
@@ -2550,16 +3061,16 @@ let g = class extends X {
    * ```
    */
   clearContents() {
-    const e = this._workbook.getUnitId(), t = this._worksheet.getSheetId(), n = this._injector.get(l), s = {
+    const e = this._workbook.getUnitId(), t = this._worksheet.getSheetId(), n = this._injector.get(l), r = {
       startRow: 0,
       endRow: this._worksheet.getRowCount() - 1,
       startColumn: 0,
       endColumn: this._worksheet.getColumnCount() - 1
     };
-    return n.syncExecuteCommand(vt.id, {
+    return n.syncExecuteCommand(Ut.id, {
       unitId: e,
       subUnitId: t,
-      ranges: [s]
+      ranges: [r]
     }), this;
   }
   /**
@@ -2574,16 +3085,16 @@ let g = class extends X {
    * ```
    */
   clearFormats() {
-    const e = this._workbook.getUnitId(), t = this._worksheet.getSheetId(), n = this._injector.get(l), s = {
+    const e = this._workbook.getUnitId(), t = this._worksheet.getSheetId(), n = this._injector.get(l), r = {
       startRow: 0,
       endRow: this._worksheet.getRowCount() - 1,
       startColumn: 0,
       endColumn: this._worksheet.getColumnCount() - 1
     };
-    return n.syncExecuteCommand(Rt.id, {
+    return n.syncExecuteCommand(Et.id, {
       unitId: e,
       subUnitId: t,
-      ranges: [s]
+      ranges: [r]
     }), this;
   }
   /**
@@ -2619,6 +3130,7 @@ let g = class extends X {
     return this._worksheet.getLastColumnWithContent();
   }
   /**
+   * @deprecated use getLastColumn instead.
    * Returns the position of the last column that has content. Same as getLastColumns.
    * @returns {number} the last column of the sheet that contains content.
    * @example
@@ -2633,6 +3145,7 @@ let g = class extends X {
     return this._worksheet.getLastColumnWithContent();
   }
   /**
+   * @deprecated use getLastRow instead.
    * Returns the position of the last row that has content.
    * @returns {number} the last row of the sheet that contains content.
    * @example
@@ -2688,8 +3201,8 @@ let g = class extends X {
    * ```
    */
   insertDefinedName(e, t) {
-    const s = this._injector.createInstance(F).setName(e).setRef(t).build();
-    s.localSheetId = this.getSheetId(), this._fWorkbook.insertDefinedNameBuilder(s);
+    const r = this._injector.createInstance(L).setName(e).setRef(t).build();
+    r.localSheetId = this.getSheetId(), this._fWorkbook.insertDefinedNameBuilder(r);
   }
   /**
    * Get all the defined names in the worksheet.
@@ -2705,23 +3218,159 @@ let g = class extends X {
   getDefinedNames() {
     return this._fWorkbook.getDefinedNames().filter((t) => t.getLocalSheetId() === this.getSheetId());
   }
+  /**
+   * Set custom metadata of worksheet
+   * @param {CustomData | undefined} custom custom metadata
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * fWorkSheet.setCustomMetadata({ key: 'value' });
+   * ```
+   */
+  setCustomMetadata(e) {
+    return this._worksheet.setCustomMetadata(e), this;
+  }
+  /**
+   * Set custom metadata of row
+   * @param {number} index row index
+   * @param {CustomData | undefined} custom custom metadata
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * fWorkSheet.setRowCustomMetadata(0, { key: 'value' });
+   * ```
+   */
+  setRowCustomMetadata(e, t) {
+    return this._worksheet.getRowManager().setCustomMetadata(e, t), this;
+  }
+  /**
+   * Set custom metadata of column
+   * @param {number} index column index
+   * @param {CustomData | undefined} custom custom metadata
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * fWorkSheet.setColumnCustomMetadata(0, { key: 'value' });
+   * ```
+   */
+  setColumnCustomMetadata(e, t) {
+    return this._worksheet.getColumnManager().setCustomMetadata(e, t), this;
+  }
+  /**
+   * Get custom metadata of row
+   * @param {number} index row index
+   * @returns {CustomData | undefined} custom metadata
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * const custom = fWorkSheet.getRowCustomMetadata(0);
+   * ```
+   */
+  getRowCustomMetadata(e) {
+    return this._worksheet.getRowManager().getCustomMetadata(e);
+  }
+  /**
+   * Get custom metadata of column
+   * @param {number} index column index
+   * @returns {CustomData | undefined} custom metadata
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * const custom = fWorkSheet.getColumnCustomMetadata(0);
+   * ```
+   */
+  getColumnCustomMetadata(e) {
+    return this._worksheet.getColumnManager().getCustomMetadata(e);
+  }
+  /**
+   * Get all merged cells in the current worksheet
+   * @returns {FRange[]} All the merged cells in the worksheet
+   * @example
+   * ```ts
+   * const workbook = univerAPI.getActiveWorkbook();
+   * const worksheet = workbook.getActiveSheet();
+   * const rangeFirst = worksheet.getRange(0, 0, 2, 2);
+   * const mergeFirst = rangeFirst.merge();
+   * const rangeSecond = worksheet.getRange(5, 0, 2, 2);
+   * const mergeSecond = rangeSecond.merge();
+   * const mergeData = worksheet.getMergeData();
+   * console.log('debugger', mergeData);
+   * ```
+   */
+  getMergeData() {
+    return this._worksheet.getMergeData().map((e) => this._injector.createInstance(w, this._workbook, this._worksheet, e));
+  }
 };
-g = Zt([
-  W(3, m(v)),
-  W(4, m(Ne)),
-  W(5, m(Ie)),
-  W(6, l)
+g = sn([
+  T(3, u(b)),
+  T(4, u(We)),
+  T(5, u(pe)),
+  T(6, l)
 ], g);
-var en = Object.defineProperty, tn = Object.getOwnPropertyDescriptor, nn = (o, e, t, n) => {
-  for (var s = n > 1 ? void 0 : n ? tn(e, t) : e, r = o.length - 1, i; r >= 0; r--)
-    (i = o[r]) && (s = (n ? i(e, t, s) : i(s)) || s);
-  return n && s && en(e, t, s), s;
-}, S = (o, e) => (t, n) => e(t, n, o);
-let I = class extends X {
-  constructor(e, t, n, s, r, i, a, h, c, d) {
+var rn = Object.defineProperty, on = Object.getOwnPropertyDescriptor, an = (s, e, t, n) => {
+  for (var r = n > 1 ? void 0 : n ? on(e, t) : e, o = s.length - 1, i; o >= 0; o--)
+    (i = s[o]) && (r = (n ? i(e, t, r) : i(r)) || r);
+  return n && r && rn(e, t, r), r;
+}, C = (s, e) => (t, n) => e(t, n, s);
+let I = class extends ne {
+  constructor(e, t, n, r, o, i, a, h, c, d) {
     super(t);
-    p(this, "id");
-    this._workbook = e, this._injector = t, this._resourceLoaderService = n, this._selectionManagerService = s, this._univerInstanceService = r, this._commandService = i, this._permissionService = a, this._logService = h, this._localeService = c, this._definedNamesService = d, this.id = this._workbook.getUnitId();
+    k(this, "id");
+    k(this, "_eventRegistry", /* @__PURE__ */ new Map());
+    this._workbook = e, this._injector = t, this._resourceLoaderService = n, this._selectionManagerService = r, this._univerInstanceService = o, this._commandService = i, this._permissionService = a, this._logService = h, this._localeService = c, this._definedNamesService = d, this.id = this._workbook.getUnitId();
+  }
+  getWorkbook() {
+    return this._workbook;
+  }
+  _ensureEventRegistry(e) {
+    return this._eventRegistry.has(e) || this._eventRegistry.set(e, new ye()), this._eventRegistry.get(e);
+  }
+  /**
+   * Add an event listener
+   * @param event key of event
+   * @param callback callback when event triggered
+   * @returns {Disposable} The Disposable instance, for remove the listener
+   * @example
+   * ```ts
+   * univerAPI.addEvent(univerAPI.event.UnitCreated, (params) => {
+   *     console.log('unit created', params);
+   * });
+   * ```
+   */
+  addEvent(e, t) {
+    return this._ensureEventRegistry(e).add(t), this.addUIEvent(e, t), F(() => this._ensureEventRegistry(e).delete(t));
+  }
+  /**
+   * Fire an event, used in internal only.
+   * @param event {string} key of event
+   * @param params {any} params of event
+   * @returns {boolean} should cancel
+   * @example
+   * ```ts
+   * this.fireEvent(univerAPI.event.UnitCreated, params);
+   * ```
+   */
+  fireEvent(e, t) {
+    var n;
+    return (n = this._eventRegistry.get(e)) == null || n.getData().forEach((r) => {
+      r(t);
+    }), t.cancel;
+  }
+  addUIEvent(e, t) {
+  }
+  get Enum() {
+    return ze.get();
+  }
+  /**
+   * @returns {FEventName} The event name.
+   */
+  get Event() {
+    return se.get();
   }
   /**
    * Get the id of the workbook.
@@ -2763,8 +3412,8 @@ let I = class extends X {
     this._workbook.setName(e);
   }
   /**
-   * save workbook snapshot data, including conditional formatting, data validation, and other plugin data.
-   * @return Workbook snapshot data
+   * Save workbook snapshot data, including conditional formatting, data validation, and other plugin data.
+   * @returns {IWorkbookData} Workbook snapshot data
    * @example
    * ```ts
    * // The code below saves the workbook snapshot data
@@ -2777,7 +3426,7 @@ let I = class extends X {
   }
   /**
    * @deprecated use 'save' instead.
-   * @return {*}  {IWorkbookData} Workbook snapshot data
+   * @returns {*}  {IWorkbookData} Workbook snapshot data
    * @memberof FWorkbook
    */
   getSnapshot() {
@@ -2785,7 +3434,7 @@ let I = class extends X {
   }
   /**
    * Get the active sheet of the workbook.
-   * @returns The active sheet of the workbook
+   * @returns {FWorksheet} The active sheet of the workbook
    * @example
    * ```ts
    * // The code below gets the active sheet of the workbook
@@ -2799,7 +3448,7 @@ let I = class extends X {
   }
   /**
    * Gets all the worksheets in this workbook
-   * @returns An array of all the worksheets in the workbook
+   * @returns {FWorksheet[]} An array of all the worksheets in the workbook
    * @example
    * ```ts
    * // The code below gets all the worksheets in the workbook
@@ -2824,24 +3473,24 @@ let I = class extends X {
    * ```
    */
   create(e, t, n) {
-    const s = Be({});
-    s.rowCount = t, s.columnCount = n, s.name = e, s.id = e.toLowerCase().replace(/ /g, "-"), this._commandService.syncExecuteCommand(U.id, {
+    const r = $e({});
+    r.rowCount = t, r.columnCount = n, r.name = e, r.id = e.toLowerCase().replace(/ /g, "-"), this._commandService.syncExecuteCommand(x.id, {
       unitId: this.id,
       index: this._workbook.getSheets().length,
-      sheet: s
-    }), this._commandService.syncExecuteCommand(z.id, {
+      sheet: r
+    }), this._commandService.syncExecuteCommand(G.id, {
       unitId: this.id,
       subUnitId: this._workbook.getSheets()[this._workbook.getSheets().length - 1].getSheetId()
     });
-    const r = this._workbook.getActiveSheet();
-    if (!r)
+    const o = this._workbook.getActiveSheet();
+    if (!o)
       throw new Error("No active sheet found");
-    return this._injector.createInstance(g, this, this._workbook, r);
+    return this._injector.createInstance(g, this, this._workbook, o);
   }
   /**
    * Get a worksheet by sheet id.
    * @param sheetId The id of the sheet to get.
-   * @return The worksheet with given sheet id
+   * @returns The worksheet with given sheet id
    * @example
    * ```ts
    * // The code below gets a worksheet by sheet id
@@ -2881,7 +3530,7 @@ let I = class extends X {
    * ```
    */
   setActiveSheet(e) {
-    return this._commandService.syncExecuteCommand(z.id, {
+    return this._commandService.syncExecuteCommand(G.id, {
       unitId: this.id,
       subUnitId: e.getSheetId()
     }), e;
@@ -2903,20 +3552,21 @@ let I = class extends X {
    * ```
    */
   insertSheet(e) {
-    e != null ? this._commandService.syncExecuteCommand(U.id, { sheet: { name: e } }) : this._commandService.syncExecuteCommand(U.id);
+    e != null ? this._commandService.syncExecuteCommand(x.id, { sheet: { name: e } }) : this._commandService.syncExecuteCommand(x.id);
     const t = this.id, n = this._workbook.getSheets()[this._workbook.getSheets().length - 1].getSheetId();
-    this._commandService.syncExecuteCommand(z.id, {
+    this._commandService.syncExecuteCommand(G.id, {
       unitId: t,
       subUnitId: n
     });
-    const s = this._workbook.getActiveSheet();
-    if (!s)
+    const r = this._workbook.getActiveSheet();
+    if (!r)
       throw new Error("No active sheet found");
-    return this._injector.createInstance(g, this, this._workbook, s);
+    return this._injector.createInstance(g, this, this._workbook, r);
   }
   /**
    * Deletes the specified worksheet.
    * @param sheet The worksheet to delete.
+   * @returns {boolean} True if the worksheet was deleted, false otherwise.
    * @example
    * ```ts
    * // The code below deletes the specified worksheet
@@ -2927,7 +3577,7 @@ let I = class extends X {
    */
   deleteSheet(e) {
     const t = this.id, n = e.getSheetId();
-    return this._commandService.syncExecuteCommand(bt.id, {
+    return this._commandService.syncExecuteCommand(Pt.id, {
       unitId: t,
       subUnitId: n
     });
@@ -2935,7 +3585,7 @@ let I = class extends X {
   // #region editing
   /**
    * Undo the last action.
-   * @returns A promise that resolves to true if the undo was successful, false otherwise.
+   * @returns {FWorkbook} A promise that resolves to true if the undo was successful, false otherwise.
    * @example
    * ```ts
    * // The code below undoes the last action
@@ -2944,7 +3594,7 @@ let I = class extends X {
    * ```
    */
   undo() {
-    return this._univerInstanceService.focusUnit(this.id), this._commandService.syncExecuteCommand(Le.id), this;
+    return this._univerInstanceService.focusUnit(this.id), this._commandService.syncExecuteCommand(He.id), this;
   }
   /**
    * Redo the last undone action.
@@ -2957,7 +3607,7 @@ let I = class extends X {
    * ```
    */
   redo() {
-    return this._univerInstanceService.focusUnit(this.id), this._commandService.syncExecuteCommand(ze.id), this;
+    return this._univerInstanceService.focusUnit(this.id), this._commandService.syncExecuteCommand(Ge.id), this;
   }
   /**
    * Callback for command execution.
@@ -3008,7 +3658,6 @@ let I = class extends X {
   }
   /**
    * Callback for selection changes.
-   *
    * @callback onSelectionChangeCallback
    * @param {IRange[]} selections The new selection.
    */
@@ -3018,46 +3667,50 @@ let I = class extends X {
    * @returns A function to dispose the listening
    */
   onSelectionChange(e) {
-    return fe(
+    return F(
       this._selectionManagerService.selectionMoveEnd$.subscribe((t) => {
-        this._univerInstanceService.getCurrentUnitForType(P.UNIVER_SHEET).getUnitId() === this.id && (t != null && t.length ? e(t.map((n) => n.range)) : e([]));
+        this._univerInstanceService.getCurrentUnitForType(R.UNIVER_SHEET).getUnitId() === this.id && (t != null && t.length ? e(t.map((n) => n.range)) : e([]));
       })
     );
   }
   /**
    * Used to modify the editing permissions of the workbook. When the value is false, editing is not allowed.
    * @param {boolean} value  editable value want to set
+   * @returns {FWorkbook} FWorkbook instance
    */
   setEditable(e) {
-    const t = new Ue(this._workbook.getUnitId());
-    this._permissionService.getPermissionPoint(t.id) || this._permissionService.addPermissionPoint(t), this._permissionService.updatePermissionPoint(t.id, e);
+    const t = new Ne(this._workbook.getUnitId());
+    return this._permissionService.getPermissionPoint(t.id) || this._permissionService.addPermissionPoint(t), this._permissionService.updatePermissionPoint(t.id, e), this;
   }
   /**
-   * Sets the active selection region for this sheet.
+   * Sets the selection region for active sheet.
    * @param range The range to set as the active selection.
+   * @returns {FWorkbook} FWorkbook instance
    */
   setActiveRange(e) {
-    const t = this.getActiveSheet(), n = e.getRange().sheetId || t.getSheetId(), s = n ? this._workbook.getSheetBySheetId(n) : this._workbook.getActiveSheet(!0);
-    if (!s)
+    const t = this.getActiveSheet(), n = e.getRange().sheetId || t.getSheetId(), r = n ? this._workbook.getSheetBySheetId(n) : this._workbook.getActiveSheet(!0);
+    if (!r)
       throw new Error("No active sheet found");
-    s.getSheetId() !== t.getSheetId() && this.setActiveSheet(this._injector.createInstance(g, this, this._workbook, s));
-    const r = {
+    r.getSheetId() !== t.getSheetId() && this.setActiveSheet(this._injector.createInstance(g, this, this._workbook, r));
+    const o = {
       unitId: this.getId(),
       subUnitId: n,
-      selections: [e].map((i) => ({ range: i.getRange(), primary: K(i.getRange(), s), style: null }))
+      selections: [e].map((i) => ({ range: i.getRange(), primary: Z(i.getRange(), r), style: null }))
     };
-    this._commandService.syncExecuteCommand(xe.id, r);
+    return this._commandService.syncExecuteCommand(De.id, o), this;
   }
   /**
    * Returns the selected range in the active sheet, or null if there is no active range.
    * @returns the active range
    */
+  // could sheet have no active range ?
   getActiveRange() {
-    const e = this._workbook.getActiveSheet(), n = this._selectionManagerService.getCurrentSelections().find((s) => !!s.primary);
-    return n ? this._injector.createInstance(k, this._workbook, e, n.range) : null;
+    const e = this._workbook.getActiveSheet(), n = this._selectionManagerService.getCurrentSelections().find((r) => !!r.primary);
+    return n ? this._injector.createInstance(w, this._workbook, e, n.range) : null;
   }
   /**
    * Deletes the currently active sheet.
+   * @returns {boolean} true if the sheet was deleted, false otherwise
    * @example
    * ```ts
    * // The code below deletes the currently active sheet and stores the new active
@@ -3082,7 +3735,7 @@ let I = class extends X {
    * ```
    */
   duplicateSheet(e) {
-    return this._commandService.syncExecuteCommand(pt.id, {
+    return this._commandService.syncExecuteCommand(xt.id, {
       unitId: e.getWorkbook().getUnitId(),
       subUnitId: e.getSheetId()
     }), this._injector.createInstance(g, this, this._workbook, this._workbook.getActiveSheet());
@@ -3127,9 +3780,17 @@ let I = class extends X {
   getLocale() {
     return this._localeService.getCurrentLocale();
   }
+  /**
+   * @deprecated use setSpreadsheetLocale instead.
+   * @param {LocaleType} locale - The locale to set
+   */
+  setLocale(e) {
+    this._localeService.setLocale(e);
+  }
   /**
    * Set the locale of the workbook.
    * @param {LocaleType} locale The locale to set
+   * @returns {FWorkbook} This workbook, for chaining
    * @example
    * ```ts
    * // The code below sets the locale of the workbook
@@ -3137,8 +3798,8 @@ let I = class extends X {
    * activeSpreadsheet.setLocale(LocaleType.EN_US);
    * ```
    */
-  setLocale(e) {
-    this._localeService.setLocale(e);
+  setSpreadsheetLocale(e) {
+    return this._localeService.setLocale(e), this;
   }
   /**
    * Get the URL of the workbook.
@@ -3168,7 +3829,7 @@ let I = class extends X {
    */
   moveSheet(e, t) {
     let n = t;
-    return n < 0 ? n = 0 : n > this._workbook.getSheets().length - 1 && (n = this._workbook.getSheets().length - 1), this._commandService.syncExecuteCommand(yt.id, {
+    return n < 0 ? n = 0 : n > this._workbook.getSheets().length - 1 && (n = this._workbook.getSheets().length - 1), this._commandService.syncExecuteCommand(Nt.id, {
       unitId: e.getWorkbook().getUnitId(),
       order: n,
       subUnitId: e.getSheetId()
@@ -3191,11 +3852,10 @@ let I = class extends X {
   }
   /**
    * Get the PermissionInstance.
-   *
    * @returns {FPermission} - The PermissionInstance.
    */
   getPermission() {
-    return this._injector.createInstance(j);
+    return this._injector.createInstance(O);
   }
   /**
    * Get the defined name by name.
@@ -3210,7 +3870,7 @@ let I = class extends X {
    */
   getDefinedName(e) {
     const t = this._definedNamesService.getValueByName(this.id, e);
-    return t ? this._injector.createInstance(M, { ...t, unitId: this.id }) : null;
+    return t ? this._injector.createInstance(j, { ...t, unitId: this.id }) : null;
   }
   /**
    * Get all the defined names in the workbook.
@@ -3224,12 +3884,13 @@ let I = class extends X {
    */
   getDefinedNames() {
     const e = this._definedNamesService.getDefinedNameMap(this.id);
-    return e ? Object.values(e).map((t) => this._injector.createInstance(M, { ...t, unitId: this.id })) : [];
+    return e ? Object.values(e).map((t) => this._injector.createInstance(j, { ...t, unitId: this.id })) : [];
   }
   /**
    * Insert a defined name.
    * @param {string} name The name of the defined name to insert
    * @param {string} formulaOrRefString The formula(=sum(A2:b10)) or reference(A1) string of the defined name to insert
+   * @returns {FWorkbook} The current FWorkbook instance
    * @example
    * ```ts
    * // The code below inserts a defined name
@@ -3238,8 +3899,8 @@ let I = class extends X {
    * ```
    */
   insertDefinedName(e, t) {
-    const s = this._injector.createInstance(F).setName(e).setRef(t).build();
-    s.localSheetId = q, this.insertDefinedNameBuilder(s);
+    const r = this._injector.createInstance(L).setName(e).setRef(t).build();
+    return r.localSheetId = X, this.insertDefinedNameBuilder(r), this;
   }
   /**
    * Delete the defined name with the given name.
@@ -3257,7 +3918,7 @@ let I = class extends X {
     return t ? (t.delete(), !0) : !1;
   }
   /**
-   * insert a defined name by builder param
+   * Insert a defined name by builder param.
    * @param {ISetDefinedNameMutationParam} param The param to insert the defined name
    * @example
    * ```ts
@@ -3269,7 +3930,7 @@ let I = class extends X {
    * ```
    */
   insertDefinedNameBuilder(e) {
-    e.unitId = this.getId(), this._commandService.syncExecuteCommand(G.id, e);
+    e.unitId = this.getId(), this._commandService.syncExecuteCommand(Q.id, e);
   }
   /**
    * Update the defined name with the given name.
@@ -3284,7 +3945,7 @@ let I = class extends X {
    * ```
    */
   updateDefinedNameBuilder(e) {
-    this._commandService.syncExecuteCommand(G.id, e);
+    this._commandService.syncExecuteCommand(Q.id, e);
   }
   /**
    * Gets the registered range themes.
@@ -3298,10 +3959,11 @@ let I = class extends X {
    * ```
    */
   getRegisteredRangeThemes() {
-    return this._injector.get(Ee).getRegisteredRangeThemes();
+    return this._injector.get(Me).getRegisteredRangeThemes();
   }
   /**
    * Register a custom range theme style.
+   * @param rangeThemeStyle
    * @example
    * ```ts
    * // import {RangeThemeStyle} from '@univerjs/sheets';
@@ -3316,13 +3978,14 @@ let I = class extends X {
    * ```
    */
   registerRangeTheme(e) {
-    this._commandService.syncExecuteCommand(Pt.id, {
+    this._commandService.syncExecuteCommand(Mt.id, {
       unitId: this.getId(),
       rangeThemeStyle: e
     });
   }
   /**
    * Unregister a custom range theme style.
+   * @param themeName
    * @example
    * ```ts
    * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -3330,32 +3993,106 @@ let I = class extends X {
    * ```
    */
   unregisterRangeTheme(e) {
-    this._commandService.syncExecuteCommand(Ut.id, {
+    this._commandService.syncExecuteCommand(Dt.id, {
       unitId: this.getId(),
       themeName: e
     });
   }
+  /**
+   * Set custom metadata of workbook
+   * @param {CustomData | undefined} custom custom metadata
+   * @returns {FWorkbook} FWorkbook
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * fWorkbook.setCustomMetadata({ key: 'value' });
+   * ```
+   */
+  setCustomMetadata(e) {
+    return this._workbook.setCustomMetadata(e), this;
+  }
+  /**
+   * Get custom metadata of workbook
+   * @returns {CustomData | undefined} custom metadata
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const custom = fWorkbook.getCustomMetadata();
+   * ```
+   */
+  getCustomMetadata() {
+    return this._workbook.getCustomMetadata();
+  }
 };
-I = nn([
-  S(1, m(v)),
-  S(2, m(Oe)),
-  S(3, m(Ne)),
-  S(4, ve),
-  S(5, l),
-  S(6, J),
-  S(7, Ie),
-  S(8, m(ke)),
-  S(9, De)
+I = an([
+  C(1, u(b)),
+  C(2, u(Le)),
+  C(3, u(We)),
+  C(4, J),
+  C(5, l),
+  C(6, ee),
+  C(7, pe),
+  C(8, u(Re)),
+  C(9, Te)
 ], I);
-class sn extends Re {
+class hn extends Ue {
+  getCommandSheetTarget(e) {
+    var o;
+    const t = e.params;
+    if (!t) return;
+    const n = t.unitId ? this.getUniverSheet(t.unitId) : (o = this.getActiveWorkbook) == null ? void 0 : o.call(this);
+    if (!n)
+      return;
+    const r = n.getSheetBySheetId(t.subUnitId || t.sheetId) || n.getActiveSheet();
+    if (r)
+      return { workbook: n, worksheet: r };
+  }
+  getSheetTarget(e, t) {
+    const n = this.getUniverSheet(e);
+    if (!n)
+      return;
+    const r = n.getSheetBySheetId(t);
+    if (r)
+      return { workbook: n, worksheet: r };
+  }
+  _initWorkbookEvent(e) {
+    const t = e.get(J);
+    this.disposeWithMe(
+      t.unitDisposed$.subscribe((n) => {
+        this._eventRegistry.get(this.Event.WorkbookDisposed) && n.type === R.UNIVER_SHEET && this.fireEvent(
+          this.Event.WorkbookDisposed,
+          {
+            unitId: n.getUnitId(),
+            unitType: n.type,
+            snapshot: n.getSnapshot()
+          }
+        );
+      })
+    ), this.disposeWithMe(
+      t.unitAdded$.subscribe((n) => {
+        if (this._eventRegistry.get(this.Event.WorkbookCreated) && n.type === R.UNIVER_SHEET) {
+          const r = n, o = e.createInstance(I, r);
+          this.fireEvent(
+            this.Event.WorkbookCreated,
+            {
+              unitId: n.getUnitId(),
+              type: n.type,
+              workbook: o,
+              unit: o
+            }
+          );
+        }
+      })
+    );
+  }
   _initialize(e) {
     const t = e.get(l);
     this.disposeWithMe(
       t.beforeCommandExecuted((n) => {
-        var s;
+        var r;
         switch (n.id) {
-          case U.id: {
-            const r = n.params, { unitId: i, index: a, sheet: h } = r || {}, c = i ? this.getUniverSheet(i) : (s = this.getActiveWorkbook) == null ? void 0 : s.call(this);
+          case x.id: {
+            const o = n.params, { unitId: i, index: a, sheet: h } = o || {}, c = i ? this.getUniverSheet(i) : (r = this.getActiveWorkbook) == null ? void 0 : r.call(this);
             if (!c)
               return;
             const d = {
@@ -3367,17 +4104,17 @@ class sn extends Re {
               this.Event.BeforeSheetCreate,
               d
             ), d.cancel)
-              throw new Error("Sheet create canceled by facade api.");
+              throw new qe();
             break;
           }
         }
       })
     ), this.disposeWithMe(
       t.onCommandExecuted((n) => {
-        var s;
+        var r;
         switch (n.id) {
-          case U.id: {
-            const r = n.params, { unitId: i } = r || {}, a = i ? this.getUniverSheet(i) : (s = this.getActiveWorkbook) == null ? void 0 : s.call(this);
+          case x.id: {
+            const o = n.params, { unitId: i } = o || {}, a = i ? this.getUniverSheet(i) : (r = this.getActiveWorkbook) == null ? void 0 : r.call(this);
             if (!a)
               return;
             const h = a.getActiveSheet();
@@ -3395,66 +4132,78 @@ class sn extends Re {
           }
         }
       })
-    );
+    ), this._initWorkbookEvent(e);
   }
   createUniverSheet(e) {
-    const n = this._injector.get(ve).createUnit(P.UNIVER_SHEET, e);
+    const n = this._injector.get(J).createUnit(R.UNIVER_SHEET, e);
     return this._injector.createInstance(I, n);
   }
-  getActiveUniverSheet() {
-    const e = this._univerInstanceService.getCurrentUnitForType(P.UNIVER_SHEET);
-    return e ? this._injector.createInstance(I, e) : null;
+  createWorkbook(e) {
+    return this.createUniverSheet(e);
   }
   getActiveWorkbook() {
-    return this.getActiveUniverSheet();
+    const e = this._univerInstanceService.getCurrentUnitForType(R.UNIVER_SHEET);
+    return e ? this._injector.createInstance(I, e) : null;
+  }
+  getActiveUniverSheet() {
+    return this.getActiveWorkbook();
   }
   getUniverSheet(e) {
-    const t = this._univerInstanceService.getUnit(e, P.UNIVER_SHEET);
+    const t = this._univerInstanceService.getUnit(e, R.UNIVER_SHEET);
     return t ? this._injector.createInstance(I, t) : null;
   }
+  getWorkbook(e) {
+    return this.getUniverSheet(e);
+  }
   getPermission() {
-    return this._injector.createInstance(j);
+    return this._injector.createInstance(O);
   }
   onUniverSheetCreated(e) {
-    const t = this._univerInstanceService.getTypeOfUnitAdded$(P.UNIVER_SHEET).subscribe((n) => {
-      const s = this._injector.createInstance(I, n);
-      e(s);
+    const t = this._univerInstanceService.getTypeOfUnitAdded$(R.UNIVER_SHEET).subscribe((n) => {
+      const r = this._injector.createInstance(I, n);
+      e(r);
     });
-    return fe(t);
+    return F(t);
   }
   newDefinedName() {
-    return this._injector.createInstance(F);
+    return this._injector.createInstance(L);
   }
 }
-Re.extend(sn);
-class on extends be {
+Ue.extend(hn);
+class cn extends se {
   get SheetCreated() {
     return "SheetCreated";
   }
   get BeforeSheetCreate() {
     return "BeforeSheetCreate";
   }
+  get WorkbookCreated() {
+    return "WorkbookCreated";
+  }
+  get WorkbookDisposed() {
+    return "WorkbookDisposed";
+  }
 }
-be.extend(on);
-var rn = Object.defineProperty, an = Object.getOwnPropertyDescriptor, hn = (o, e, t, n) => {
-  for (var s = n > 1 ? void 0 : n ? an(e, t) : e, r = o.length - 1, i; r >= 0; r--)
-    (i = o[r]) && (s = (n ? i(e, t, s) : i(s)) || s);
-  return n && s && rn(e, t, s), s;
-}, cn = (o, e) => (t, n) => e(t, n, o);
-let we = class extends Q {
-  constructor(o) {
-    super(), this._injector = o;
+se.extend(cn);
+var dn = Object.defineProperty, un = Object.getOwnPropertyDescriptor, mn = (s, e, t, n) => {
+  for (var r = n > 1 ? void 0 : n ? un(e, t) : e, o = s.length - 1, i; o >= 0; o--)
+    (i = s[o]) && (r = (n ? i(e, t, r) : i(r)) || r);
+  return n && r && dn(e, t, r), r;
+}, ln = (s, e) => (t, n) => e(t, n, s);
+let fe = class extends te {
+  constructor(s) {
+    super(), this._injector = s;
   }
 };
-we = hn([
-  cn(0, m(v))
-], we);
+fe = mn([
+  ln(0, u(b))
+], fe);
 export {
-  j as FPermission,
-  k as FRange,
-  A as FSelection,
-  on as FSheetEventName,
-  we as FSheetHooks,
+  O as FPermission,
+  w as FRange,
+  B as FSelection,
+  cn as FSheetEventName,
+  fe as FSheetHooks,
   I as FWorkbook,
   g as FWorksheet
 };