@univerjs/sheets 0.5.1 → 0.5.2-nightly.202412281605

package/lib/es/facade.js

@@ -1,17 +1,398 @@
-var me = Object.defineProperty;
-var le = (n, e, t) => e in n ? me(n, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : n[e] = t;
-var E = (n, e, t) => le(n, typeof e != "symbol" ? e + "" : e, t);
-import { Inject as u, Injector as R, IAuthzIoService as ge, FBase as b, generateRandomId as _e, Rectangle as T, ICommandService as v, IPermissionService as ae, HorizontalAlign as C, VerticalAlign as I, isFormulaString as we, isCellV as ke, isICellData as Se, ObjectMatrix as P, Tools as Ce, RANGE_TYPE as l, BooleanNumber as m, WrapStrategy as H, Dimension as N, Direction as p, IResourceLoaderService as Ie, mergeWorksheetSnapshotWithDefault as ve, UndoCommand as Re, RedoCommand as fe, toDisposable as be, UniverInstanceType as O, IUniverInstanceService as he, ILogService as pe, FUniver as ce } from "@univerjs/core";
-import { WorksheetProtectionRuleModel as ye, RangeProtectionRuleModel as Pe, WorksheetProtectionPointModel as Ue, WorkbookEditablePermission as de, UnitObject as f, AddWorksheetProtectionMutation as xe, DeleteWorksheetProtectionMutation as Ee, getAllWorksheetPermissionPoint as Me, getAllWorksheetPermissionPointByPointPanel as $, SetWorksheetPermissionPointsMutation as Fe, AddRangeProtectionMutation as We, DeleteRangeProtectionMutation as Ae, SetRangeProtectionMutation as De, WorksheetEditPermission as je, WorksheetViewPermission as Te, SetStyleCommand as _, SetRangeValuesCommand as G, SetTextWrapCommand as q, SetVerticalTextAlignCommand as Oe, SetHorizontalTextAlignCommand as Ve, addMergeCellsUtil as M, getAddMergeMutationRangeByType as Y, RemoveWorksheetMergeCommand as ze, SheetsSelectionsService as ue, SetWorksheetDefaultStyleMutation as Le, SetColDataCommand as J, SetRowDataCommand as K, copyRangeStyles as y, InsertRowCommand as Q, RemoveRowCommand as Be, MoveRowsCommand as He, SetRowHiddenCommand as X, SetSpecificRowsVisibleCommand as Z, SetRowHeightCommand as ee, SetWorksheetRowIsAutoHeightCommand as Ne, InsertColCommand as te, RemoveColCommand as $e, MoveColsCommand as Ge, SetColHiddenCommand as ne, SetSpecificColsVisibleCommand as oe, SetColWidthCommand as qe, SetFrozenCommand as Ye, CancelFrozenCommand as Je, ToggleGridlinesCommand as Ke, SetRangeValuesMutation as se, InsertSheetCommand as re, SetWorksheetActiveOperation as F, RemoveSheetCommand as Qe, getPrimaryForRange as Xe, SetSelectionsOperation as Ze } from "@univerjs/sheets";
-import { FormulaDataModel as et, deserializeRangeWithSheet as tt } from "@univerjs/engine-formula";
-var nt = Object.defineProperty, ot = Object.getOwnPropertyDescriptor, st = (n, e, t, o) => {
-  for (var s = o > 1 ? void 0 : o ? ot(e, t) : e, r = n.length - 1, i; r >= 0; r--)
-    (i = n[r]) && (s = (o ? i(e, t, s) : i(s)) || s);
-  return o && s && nt(e, t, s), s;
-}, w = (n, e) => (t, o) => e(t, o, n);
-let V = class extends b {
-  constructor(n, e, t, o, s, r, i) {
-    super(), this._injector = n, this._commandService = e, this._permissionService = t, this._worksheetProtectionRuleModel = o, this._rangeProtectionRuleModel = s, this._worksheetProtectionPointRuleModel = r, this._authzIoService = i;
+var xe = Object.defineProperty;
+var Ee = (o, e, t) => e in o ? xe(o, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : o[e] = t;
+var P = (o, e, t) => Ee(o, typeof e != "symbol" ? e + "" : e, t);
+import { Inject as m, Injector as v, IAuthzIoService as we, LocaleService as ke, ICommandService as l, IPermissionService as Q, generateRandomId as Se, FBase as p, Rectangle as N, HorizontalAlign as R, VerticalAlign as b, isFormulaString as De, isCellV as Me, isICellData as je, ObjectMatrix as j, Tools as We, RANGE_TYPE as g, BooleanNumber as u, WrapStrategy as Z, Dimension as ee, ILogService as Ce, Direction as E, IResourceLoaderService as Oe, mergeWorksheetSnapshotWithDefault as Fe, UndoCommand as Ae, RedoCommand as Te, toDisposable as Ie, UniverInstanceType as U, IUniverInstanceService as fe, FUniver as ve } from "@univerjs/core";
+import { IDefinedNamesService as Re, serializeRange as X, FormulaDataModel as Le, serializeRangeWithSheet as Be, deserializeRangeWithSheet as ze } from "@univerjs/engine-formula";
+import { WorksheetProtectionRuleModel as be, RangeProtectionRuleModel as pe, WorksheetProtectionPointModel as Pe, SetDefinedNameCommand as q, SCOPE_WORKBOOK_VALUE_DEFINED_NAME as K, RemoveDefinedNameCommand as Ve, PermissionPointsDefinitions as He, WorkbookEditablePermission as ye, UnitObject as y, AddWorksheetProtectionMutation as $e, DeleteWorksheetProtectionMutation as Ge, getAllWorksheetPermissionPoint as qe, getAllWorksheetPermissionPointByPointPanel as te, SetWorksheetPermissionPointsMutation as Ke, AddRangeProtectionMutation as Ye, DeleteRangeProtectionMutation as Je, SetRangeProtectionMutation as Qe, WorksheetEditPermission as Xe, WorksheetViewPermission as Ze, SetStyleCommand as C, SetRangeValuesCommand as ne, SetTextWrapCommand as se, SetVerticalTextAlignCommand as et, SetHorizontalTextAlignCommand as tt, addMergeCellsUtil as L, getAddMergeMutationRangeByType as oe, RemoveWorksheetMergeCommand as nt, SplitTextToColumnsCommand as st, getPrimaryForRange as Y, SetSelectionsOperation as Ue, getNextPrimaryCell as ot, SheetsSelectionsService as Ne, SetWorksheetDefaultStyleMutation as rt, SetColDataCommand as re, SetRowDataCommand as ie, copyRangeStyles as D, InsertRowCommand as ae, RemoveRowCommand as it, MoveRowsCommand as at, SetRowHiddenCommand as he, SetSpecificRowsVisibleCommand as ce, SetRowHeightCommand as de, SetWorksheetRowIsAutoHeightCommand as ht, InsertColCommand as me, RemoveColCommand as ct, MoveColsCommand as dt, SetColHiddenCommand as ue, SetSpecificColsVisibleCommand as le, SetColWidthCommand as mt, SetFrozenCommand as B, CancelFrozenCommand as ut, ToggleGridlinesCommand as lt, SetGridlinesColorCommand as gt, SetTabColorCommand as _t, SetRangeValuesMutation as ge, SetWorksheetHideCommand as wt, SetWorksheetShowCommand as kt, SetWorksheetNameCommand as St, ClearSelectionAllCommand as Ct, ClearSelectionContentCommand as It, ClearSelectionFormatCommand as ft, InsertSheetCommand as z, SetWorksheetActiveOperation as V, RemoveSheetCommand as vt, CopySheetCommand as Rt, SetWorksheetOrderCommand as bt } from "@univerjs/sheets";
+var pt = Object.defineProperty, Pt = Object.getOwnPropertyDescriptor, yt = (o, e, t, n) => {
+  for (var s = n > 1 ? void 0 : n ? Pt(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 && pt(e, t, s), s;
+}, w = (o, e) => (t, n) => e(t, n, o);
+function Ut(o, e, t) {
+  const n = t.getDefinedNameMap(o);
+  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)
+    return i;
+  let a = r + 1;
+  for (; ; ) {
+    const h = e.t("definedName.defaultName") + a;
+    if (t.getValueByName(o, h) == null)
+      return h;
+    a++;
+  }
+}
+class A {
+  constructor() {
+    P(this, "_definedNameParam");
+    this._definedNameParam = {
+      id: Se(10),
+      unitId: "",
+      name: "",
+      formulaOrRefString: ""
+    };
+  }
+  /**
+   * Sets the name of the defined name builder.
+   * @param name  The name of the defined name.
+   * @returns The defined name builder.
+   * @example
+   * ```ts
+   * const workbook = UniverAPI.getActiveWorkbook();
+   * const definedNameBuilder = UniverAPI.newDefinedName()
+   *    .setName('MyDefinedName')
+   *  .build();
+   * workbook.insertDefinedNameBuilder(definedNameBuilder);
+   * ```
+   */
+  setName(e) {
+    return this._definedNameParam.name = e, this;
+  }
+  /**
+   * Sets the formula of the defined name builder.
+   * @param formula The formula of the defined name.
+   * @returns The defined name builder.
+   * @example
+   * ```ts
+   * const workbook = UniverAPI.getActiveWorkbook();
+   * const definedNameBuilder = UniverAPI.newDefinedName()
+   *  .setFormula('SUM(Sheet1!$A$1)')
+   * .setName('MyDefinedName')
+   * .build();
+   * workbook.insertDefinedNameBuilder(definedNameBuilder);
+   * ```
+   */
+  setFormula(e) {
+    return this._definedNameParam.formulaOrRefString = `=${e}`, this;
+  }
+  /**
+   * Sets the reference of the defined name builder.
+   * @param refString The reference of the defined name.
+   * @returns The defined name builder.
+   * @example
+   * ```ts
+   * const workbook = UniverAPI.getActiveWorkbook();
+   * const definedNameBuilder = UniverAPI.newDefinedName()
+   *  .setRef('Sheet1!$A$1')
+   * .build();
+   * workbook.insertDefinedNameBuilder(definedNameBuilder);
+   * ```
+   */
+  setRef(e) {
+    return this._definedNameParam.formulaOrRefString = e, this;
+  }
+  /**
+   * 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.
+   * @example
+   * ```ts
+   * 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 = X({
+      startRow: e,
+      endRow: e + (n != null ? n : 1) - 1,
+      startColumn: t,
+      endColumn: t + (s != null ? s : 1) - 1
+    }), this;
+  }
+  /**
+   * Sets the comment of the defined name builder.
+   * @param comment The comment of the defined name.
+   * @returns The defined name builder.
+   * @example
+   * ```ts
+   * const workbook = UniverAPI.getActiveWorkbook();
+   * const definedNameBuilder = UniverAPI.newDefinedName()
+   *  .setComment('This is a comment')
+   * .build();
+   * workbook.insertDefinedNameBuilder(definedNameBuilder);
+   * ```
+   */
+  setComment(e) {
+    return this._definedNameParam.comment = e, this;
+  }
+  /**
+   * Sets the hidden status of the defined name builder.
+   * @param hidden The hidden status of the defined name.
+   * @returns The defined name builder.
+   * @example
+   * ```ts
+   * const workbook = UniverAPI.getActiveWorkbook();
+   * const definedNameBuilder = UniverAPI.newDefinedName()
+   *  .setHidden(true)
+   * .build();
+   * workbook.insertDefinedNameBuilder(definedNameBuilder);
+   * ```
+   */
+  setHidden(e) {
+    return this._definedNameParam.hidden = e, this;
+  }
+  /**
+   * Builds the defined name.
+   * @returns The defined name mutation parameter.
+   * @example
+   * ```ts
+   * const workbook = UniverAPI.getActiveWorkbook();
+   * const definedNameBuilder = UniverAPI.newDefinedName()
+   *  .setRef('Sheet1!$A$1')
+   *  .setName('MyDefinedName')
+   *  .build();
+   * workbook.insertDefinedNameBuilder(definedNameBuilder);
+   * ```
+   */
+  build() {
+    return this._definedNameParam;
+  }
+  load(e) {
+    return this._definedNameParam = e, this;
+  }
+}
+let W = class extends p {
+  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;
+  }
+  _apply() {
+    this._definedNameParam.name === "" && (this._definedNameParam.name = Ut(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.
+   * @example
+   * ```ts
+   * const workbook = UniverAPI.getActiveWorkbook();
+   * const definedName = workbook.getDefinedNames[0];
+   * console.log(definedName.getName());
+   * ```
+   */
+  getName() {
+    return this._definedNameParam.name;
+  }
+  /**
+   * Sets the name of the defined name.
+   * @param name The name of the defined name.
+   * @example
+   * ```ts
+   * const workbook = UniverAPI.getActiveWorkbook();
+   * const definedName = workbook.getDefinedName('MyDefinedName');
+   * definedName.setName('NewDefinedName');
+   * ```
+   */
+  setName(o) {
+    this._definedNameParam.name = o, this._apply();
+  }
+  /**
+   * Sets the formula of the defined name.
+   * @param formula The formula of the defined name.
+   * @example
+   * ```ts
+   * const workbook = UniverAPI.getActiveWorkbook();
+   * const definedName = workbook.getDefinedName('MyDefinedName');
+   * definedName.setFormula('SUM(Sheet1!$A$1)');
+   * ```
+   */
+  setFormula(o) {
+    this._definedNameParam.formulaOrRefString = `=${o}`, this._apply();
+  }
+  /**
+   * Sets the reference of the defined name.
+   * @param refString The reference of the defined name.
+   * @example
+   * ```ts
+   * const workbook = UniverAPI.getActiveWorkbook();
+   * const definedName = workbook.getDefinedNames[0];
+   * definedName.setRef('Sheet1!$A$1');
+   * ```
+   */
+  setRef(o) {
+    this._definedNameParam.formulaOrRefString = o, this._apply();
+  }
+  /**
+   * Gets the reference of the defined name.
+   * @returns The reference of the defined name.
+   * @example
+   * ```ts
+   * const workbook = UniverAPI.getActiveWorkbook();
+   * const definedName = workbook.getDefinedNames[0];
+   * console.log(definedName.getFormulaOrRefString());
+   * ```
+   */
+  getFormulaOrRefString() {
+    return this._definedNameParam.formulaOrRefString;
+  }
+  /**
+   * 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.
+   * @example
+   * ```ts
+   * const workbook = UniverAPI.getActiveWorkbook();
+   * const definedName = workbook.getDefinedNames[0];
+   * definedName.setRefByRange(1, 3, 2, 5);
+   * ```
+   */
+  setRefByRange(o, e, t, n) {
+    this._definedNameParam.formulaOrRefString = X({
+      startRow: o,
+      endRow: o + (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.
+   * @example
+   * ```ts
+   * const workbook = UniverAPI.getActiveWorkbook();
+   * const definedName = workbook.getDefinedNames[0];
+   * console.log(definedName.getComment());
+   * ```
+   */
+  getComment() {
+    return this._definedNameParam.comment;
+  }
+  /**
+   * Sets the comment of the defined name.
+   * @param comment The comment of the defined name.
+   * @example
+   * ```ts
+   * const workbook = UniverAPI.getActiveWorkbook();
+   * const definedName = workbook.getDefinedNames[0];
+   * definedName.setComment('This is a comment');
+   * ```
+   */
+  setComment(o) {
+    this._definedNameParam.comment = o, this._apply();
+  }
+  /**
+   * Sets the scope of the defined name to the worksheet.
+   * @param worksheet The worksheet to set the scope to.
+   * @example
+   * ```ts
+   * 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();
+  }
+  /**
+   * Sets the scope of the defined name to the workbook.
+   * @example
+   * ```ts
+   * const workbook = UniverAPI.getActiveWorkbook();
+   * const definedName = workbook.getDefinedNames[0];
+   * definedName.setScopeToWorkbook();
+   * ```
+   */
+  setScopeToWorkbook() {
+    this._definedNameParam.localSheetId = K, this._apply();
+  }
+  /**
+   * Sets the hidden status of the defined name.
+   * @param hidden The hidden status of the defined name.
+   * @example
+   * ```ts
+   * const workbook = UniverAPI.getActiveWorkbook();
+   * const definedName = workbook.getDefinedNames[0];
+   * definedName.setHidden(true);
+   * ```
+   */
+  setHidden(o) {
+    this._definedNameParam.hidden = o, this._apply();
+  }
+  /**
+   * Deletes the defined name.
+   * @example
+   * ```ts
+   * const workbook = UniverAPI.getActiveWorkbook();
+   * const definedName = workbook.getDefinedNames[0];
+   * definedName.delete();
+   * ```
+   */
+  delete() {
+    this._commandService.syncExecuteCommand(Ve.id, this._definedNameParam);
+  }
+  /**
+   * Gets the local sheet id of the defined name.
+   * @returns The local sheet id of the defined name.
+   * @example
+   * ```ts
+   * const workbook = UniverAPI.getActiveWorkbook();
+   * const definedName = workbook.getDefinedNames[0];
+   * console.log(definedName.getLocalSheetId());
+   * ```
+   */
+  getLocalSheetId() {
+    return this._definedNameParam.localSheetId;
+  }
+  /**
+   * Checks if the defined name is in the workbook scope.
+   * @returns True if the defined name is in the workbook scope, false otherwise.
+   * @example
+   * ```ts
+   * const workbook = UniverAPI.getActiveWorkbook();
+   * const definedName = workbook.getDefinedNames[0];
+   * console.log(definedName.isWorkbookScope());
+   * ```
+   */
+  isWorkbookScope() {
+    return this._definedNameParam.localSheetId === K;
+  }
+  /**
+   * Converts the defined name to a defined name builder.
+   * @returns The defined name builder.
+   * @example
+   * ```ts
+   * const workbook = UniverAPI.getActiveWorkbook();
+   * const definedName = workbook.getDefinedNames[0];
+   * const definedNameBuilder = definedName.toBuilder();
+   * const param definedNameBuilder.setName('NewDefinedName').setFormula('SUM(Sheet1!$A$1)').build();
+   * workbook.updateDefinedNameBuilder(param);
+   * ```
+   */
+  toBuilder() {
+    const o = this._injector.createInstance(A);
+    return o.load(this._definedNameParam), o;
+  }
+};
+W = yt([
+  w(1, m(v)),
+  w(2, l),
+  w(3, Q),
+  w(4, m(be)),
+  w(5, m(pe)),
+  w(6, m(Pe)),
+  w(7, m(we)),
+  w(8, m(ke)),
+  w(9, Re)
+], W);
+var Nt = Object.defineProperty, xt = Object.getOwnPropertyDescriptor, Et = (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 && Nt(e, t, s), s;
+}, f = (o, e) => (t, n) => e(t, n, o);
+let O = class extends p {
+  constructor(e, t, n, s, r, 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;
   }
   /**
    * Configures a specific permission point for a workbook.
@@ -24,9 +405,9 @@ let V = class extends b {
    * @param {boolean} value - The boolean value to determine whether the permission point is enabled or disabled.
    *
    */
-  setWorkbookPermissionPoint(n, e, t) {
-    const o = new e(n);
-    this._permissionService.getPermissionPoint(o.id) || this._permissionService.addPermissionPoint(o), this._permissionService.updatePermissionPoint(o.id, t);
+  setWorkbookPermissionPoint(e, t, n) {
+    const s = new t(e);
+    this._permissionService.getPermissionPoint(s.id) || this._permissionService.addPermissionPoint(s), this._permissionService.updatePermissionPoint(s.id, n);
   }
   /**
    * This function is used to set whether the workbook can be edited
@@ -35,8 +416,8 @@ let V = class extends b {
    * @param {boolean} value - A value that controls whether the workbook can be edited
    *
    */
-  setWorkbookEditPermission(n, e) {
-    this.setWorkbookPermissionPoint(n, de, e);
+  setWorkbookEditPermission(e, t) {
+    this.setWorkbookPermissionPoint(e, ye, t);
   }
   /**
    * This function is used to add a base permission for a worksheet.
@@ -46,21 +427,30 @@ let V = class extends b {
    *
    * @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(n, e) {
-    if (this._rangeProtectionRuleModel.getSubunitRuleList(n, e).length > 0)
+  async addWorksheetBasePermission(e, t) {
+    if (this._rangeProtectionRuleModel.getSubunitRuleList(e, t).length > 0)
       throw new Error("sheet protection cannot intersect with range protection");
-    const o = await this._authzIoService.create({ objectType: f.Worksheet });
-    if (this._commandService.syncExecuteCommand(xe.id, {
-      unitId: n,
-      subUnitId: e,
+    const s = await this._authzIoService.create({
+      objectType: y.Worksheet,
+      worksheetObject: {
+        collaborators: [],
+        unitID: e,
+        strategies: [],
+        name: "",
+        scope: void 0
+      }
+    });
+    if (this._commandService.syncExecuteCommand($e.id, {
+      unitId: e,
+      subUnitId: t,
       rule: {
-        permissionId: o,
-        unitType: f.Worksheet,
-        unitId: n,
-        subUnitId: e
+        permissionId: s,
+        unitType: y.Worksheet,
+        unitId: e,
+        subUnitId: t
       }
     }))
-      return o;
+      return s;
   }
   /**
    * Delete the entire table protection set for the worksheet and reset the point permissions of the worksheet to true
@@ -68,14 +458,14 @@ let V = class extends b {
    * @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(n, e) {
-    this._commandService.syncExecuteCommand(Ee.id, {
-      unitId: n,
-      subUnitId: e
-    }), [...Me(), ...$()].forEach((t) => {
-      const o = new t(n, e);
-      this._permissionService.updatePermissionPoint(o.id, !0);
-    }), this._worksheetProtectionPointRuleModel.deleteRule(n, e);
+  removeWorksheetPermission(e, t) {
+    this._commandService.syncExecuteCommand(Ge.id, {
+      unitId: e,
+      subUnitId: t
+    }), [...qe(), ...te()].forEach((n) => {
+      const s = new n(e, t);
+      this._permissionService.updatePermissionPoint(s.id, !0);
+    }), this._worksheetProtectionPointRuleModel.deleteRule(e, t);
   }
   /**
    * Sets the worksheet permission point by updating or adding the permission point for the worksheet.
@@ -89,23 +479,32 @@ let V = class extends b {
    *
    * @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(n, e, t, o) {
-    const s = this._worksheetProtectionRuleModel.getRule(n, e);
-    let r;
-    if (t === je || t === Te)
-      if (s)
-        r = s.permissionId;
+  async setWorksheetPermissionPoint(e, t, n, s) {
+    const r = this._worksheetProtectionRuleModel.getRule(e, t);
+    let i;
+    if (n === Xe || n === Ze)
+      if (r)
+        i = r.permissionId;
       else {
-        if (this._rangeProtectionRuleModel.getSubunitRuleList(n, e).length > 0)
+        if (this._rangeProtectionRuleModel.getSubunitRuleList(e, t).length > 0)
           throw new Error("sheet protection cannot intersect with range protection");
-        r = await this.addWorksheetBasePermission(n, e);
+        i = await this.addWorksheetBasePermission(e, t);
       }
     else {
-      const c = this._worksheetProtectionPointRuleModel.getRule(n, e);
-      c ? r = c.permissionId : (r = await this._authzIoService.create({ objectType: f.Worksheet }), this._commandService.executeCommand(Fe.id, { unitId: n, subUnitId: e, permissionId: r }));
+      const d = this._worksheetProtectionPointRuleModel.getRule(e, t);
+      d ? i = d.permissionId : (i = await this._authzIoService.create({
+        objectType: y.Worksheet,
+        worksheetObject: {
+          collaborators: [],
+          unitID: e,
+          strategies: [],
+          name: "",
+          scope: void 0
+        }
+      }), this._commandService.executeCommand(Ke.id, { unitId: e, subUnitId: t, permissionId: i }));
     }
-    const a = new t(n, e);
-    return this._permissionService.getPermissionPoint(a.id) || this._permissionService.addPermissionPoint(a), this._permissionService.updatePermissionPoint(a.id, o), r;
+    const h = new n(e, t);
+    return this._permissionService.getPermissionPoint(h.id) || this._permissionService.addPermissionPoint(h), this._permissionService.updatePermissionPoint(h.id, s), i;
   }
   /**
    * Adds a range protection to the worksheet.
@@ -116,27 +515,35 @@ let V = class extends b {
    *
    * @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(n, e, t) {
-    const o = await this._authzIoService.create({ objectType: f.SelectRange }), s = `ruleId_${_e(6)}`;
-    if (this._worksheetProtectionRuleModel.getRule(n, e))
+  async addRangeBaseProtection(e, t, n) {
+    const s = await this._authzIoService.create({
+      objectType: y.SelectRange,
+      selectRangeObject: {
+        collaborators: [],
+        unitID: e,
+        name: "",
+        scope: void 0
+      }
+    }), r = `ruleId_${Se(6)}`;
+    if (this._worksheetProtectionRuleModel.getRule(e, t))
       throw new Error("sheet protection cannot intersect with range protection");
-    if (this._rangeProtectionRuleModel.getSubunitRuleList(n, e).some((c) => c.ranges.some((d) => t.some((x) => T.intersects(x, d)))))
+    if (this._rangeProtectionRuleModel.getSubunitRuleList(e, t).some((d) => d.ranges.some((T) => n.some((x) => N.intersects(x, T)))))
       throw new Error("range protection cannot intersect");
-    if (this._commandService.syncExecuteCommand(We.id, {
-      unitId: n,
-      subUnitId: e,
+    if (this._commandService.syncExecuteCommand(Ye.id, {
+      unitId: e,
+      subUnitId: t,
       rules: [{
-        permissionId: o,
-        unitType: f.SelectRange,
-        unitId: n,
-        subUnitId: e,
-        ranges: t,
-        id: s
+        permissionId: s,
+        unitType: y.SelectRange,
+        unitId: e,
+        subUnitId: t,
+        ranges: n,
+        id: r
       }]
     }))
       return {
-        permissionId: o,
-        ruleId: s
+        permissionId: s,
+        ruleId: r
       };
   }
   /**
@@ -146,14 +553,14 @@ let V = class extends b {
    * @param {string} subUnitId - The unique identifier of the worksheet.
    * @param {string[]} ruleIds - The rule IDs of the range protection to be removed.
    */
-  removeRangeProtection(n, e, t) {
-    this._commandService.syncExecuteCommand(Ae.id, {
-      unitId: n,
-      subUnitId: e,
-      ruleIds: t
-    }) && this._rangeProtectionRuleModel.getSubunitRuleList(n, e).length === 0 && (this._worksheetProtectionPointRuleModel.deleteRule(n, e), [...$()].forEach((r) => {
-      const i = new r(n, e);
-      this._permissionService.updatePermissionPoint(i.id, i.value);
+  removeRangeProtection(e, t, n) {
+    this._commandService.syncExecuteCommand(Je.id, {
+      unitId: e,
+      subUnitId: t,
+      ruleIds: n
+    }) && this._rangeProtectionRuleModel.getSubunitRuleList(e, t).length === 0 && (this._worksheetProtectionPointRuleModel.deleteRule(e, t), [...te()].forEach((i) => {
+      const a = new i(e, t);
+      this._permissionService.updatePermissionPoint(a.id, a.value);
     }));
   }
   /**
@@ -166,9 +573,9 @@ let V = class extends b {
    *    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(n, e, t, o, s) {
-    const r = new o(n, e, t);
-    this._permissionService.getPermissionPoint(r.id) || this._permissionService.addPermissionPoint(r), this._permissionService.updatePermissionPoint(r.id, s);
+  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);
   }
   /**
    * Sets the ranges for range protection in a worksheet.
@@ -182,125 +589,133 @@ let V = class extends b {
    * @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(n, e, t, o) {
-    const s = this._rangeProtectionRuleModel.getRule(n, e, t);
-    if (s) {
-      if (this._rangeProtectionRuleModel.getSubunitRuleList(n, e).filter((a) => a.id !== t).some((a) => a.ranges.some((h) => o.some((c) => T.intersects(c, h)))))
+  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) => N.intersects(d, c)))))
         throw new Error("range protection cannot intersect");
-      this._commandService.syncExecuteCommand(De.id, {
-        unitId: n,
-        subUnitId: e,
-        ruleId: t,
+      this._commandService.syncExecuteCommand(Qe.id, {
+        unitId: e,
+        subUnitId: t,
+        ruleId: n,
         rule: {
-          ...s,
-          ranges: o
+          ...r,
+          ranges: s
         }
       });
     }
   }
+  /**
+   * Set visibility of unauthorized pop-up window
+   *
+   * @param {boolean} visible
+   */
+  setPermissionDialogVisible(e) {
+    this._permissionService.setShowComponents(e);
+  }
 };
-V = st([
-  w(0, u(R)),
-  w(1, v),
-  w(2, ae),
-  w(3, u(ye)),
-  w(4, u(Pe)),
-  w(5, u(Ue)),
-  w(6, u(ge))
-], V);
-function rt(n) {
-  switch (n) {
+O = Et([
+  f(0, m(v)),
+  f(1, l),
+  f(2, Q),
+  f(3, m(be)),
+  f(4, m(pe)),
+  f(5, m(Pe)),
+  f(6, m(we))
+], O);
+function Dt(o) {
+  switch (o) {
     case "left":
-      return C.LEFT;
+      return R.LEFT;
     case "center":
-      return C.CENTER;
+      return R.CENTER;
     case "normal":
-      return C.RIGHT;
+      return R.RIGHT;
     default:
-      throw new Error(`Invalid horizontal alignment: ${n}`);
+      throw new Error(`Invalid horizontal alignment: ${o}`);
   }
 }
-function it(n) {
-  switch (n) {
-    case C.LEFT:
+function Mt(o) {
+  switch (o) {
+    case R.LEFT:
       return "left";
-    case C.CENTER:
+    case R.CENTER:
       return "center";
-    case C.RIGHT:
+    case R.RIGHT:
       return "normal";
     default:
-      throw new Error(`Invalid horizontal alignment: ${n}`);
+      throw new Error(`Invalid horizontal alignment: ${o}`);
   }
 }
-function at(n) {
-  switch (n) {
+function jt(o) {
+  switch (o) {
     case "top":
-      return I.TOP;
+      return b.TOP;
     case "middle":
-      return I.MIDDLE;
+      return b.MIDDLE;
     case "bottom":
-      return I.BOTTOM;
+      return b.BOTTOM;
     default:
-      throw new Error(`Invalid vertical alignment: ${n}`);
+      throw new Error(`Invalid vertical alignment: ${o}`);
   }
 }
-function ht(n) {
-  switch (n) {
-    case I.TOP:
+function Wt(o) {
+  switch (o) {
+    case b.TOP:
       return "top";
-    case I.MIDDLE:
+    case b.MIDDLE:
       return "middle";
-    case I.BOTTOM:
+    case b.BOTTOM:
       return "bottom";
     default:
-      throw new Error(`Invalid vertical alignment: ${n}`);
+      throw new Error(`Invalid vertical alignment: ${o}`);
   }
 }
-function z(n) {
-  return we(n) ? {
-    f: n
-  } : ke(n) ? {
-    v: n
-  } : (Se(n), n);
+function J(o) {
+  return De(o) ? {
+    f: o
+  } : Me(o) ? {
+    v: o
+  } : (je(o), o);
 }
-function ct(n, e) {
-  const t = new P(), { startRow: o, startColumn: s, endRow: r, endColumn: i } = e;
-  if (Ce.isArray(n))
-    for (let a = 0; a <= r - o; a++)
+function Ot(o, e) {
+  const t = new j(), { startRow: n, startColumn: s, endRow: r, endColumn: i } = e;
+  if (We.isArray(o))
+    for (let a = 0; a <= r - n; a++)
       for (let h = 0; h <= i - s; h++)
-        t.setValue(a + o, h + s, z(n[a][h]));
+        t.setValue(a + n, h + s, J(o[a][h]));
   else
-    new P(n).forValue((h, c, d) => {
-      t.setValue(h, c, z(d));
+    new j(o).forValue((h, c, d) => {
+      t.setValue(h, c, J(d));
     });
   return t.getMatrix();
 }
-function W(n, e) {
+function H(o, e) {
   return {
-    startRow: n.startRow,
-    endRow: n.endRow,
+    startRow: o.startRow,
+    endRow: o.endRow,
     startColumn: 0,
     endColumn: e.getColumnCount() - 1,
-    rangeType: l.ROW
+    rangeType: g.ROW
   };
 }
-function A(n, e) {
+function $(o, e) {
   return {
     startRow: 0,
     endRow: e.getRowCount() - 1,
-    startColumn: n.startColumn,
-    endColumn: n.endColumn,
-    rangeType: l.COLUMN
+    startColumn: o.startColumn,
+    endColumn: o.endColumn,
+    rangeType: g.COLUMN
   };
 }
-var dt = Object.defineProperty, ut = Object.getOwnPropertyDescriptor, mt = (n, e, t, o) => {
-  for (var s = o > 1 ? void 0 : o ? ut(e, t) : e, r = n.length - 1, i; r >= 0; r--)
-    (i = n[r]) && (s = (o ? i(e, t, s) : i(s)) || s);
-  return o && s && dt(e, t, s), s;
-}, D = (n, e) => (t, o) => e(t, o, n);
-let S = class extends b {
-  constructor(n, e, t, o, s, r) {
-    super(), this._workbook = n, this._worksheet = e, this._range = t, this._injector = o, this._commandService = s, this._formulaDataModel = r;
+var Ft = Object.defineProperty, At = Object.getOwnPropertyDescriptor, Tt = (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 && Ft(e, t, s), s;
+}, G = (o, e) => (t, n) => e(t, n, o);
+let S = class extends p {
+  constructor(o, e, t, n, s, r) {
+    super(), this._workbook = o, this._worksheet = e, this._range = t, this._injector = n, this._commandService = s, this._formulaDataModel = r;
   }
   /**
    * Get the unit ID of the current workbook
@@ -363,16 +778,16 @@ let S = class extends b {
    * @returns The cell model data
    */
   getCellData() {
-    var n;
-    return (n = this._worksheet.getCell(this._range.startRow, this._range.startColumn)) != null ? n : null;
+    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
    */
   isMerged() {
-    const { startColumn: n, startRow: e, endColumn: t, endRow: o } = this._range;
-    return this._worksheet.getMergedCellRange(e, n, o, t).some((r) => T.equals(r, this._range));
+    const { startColumn: o, startRow: e, endColumn: t, endRow: n } = this._range;
+    return this._worksheet.getMergedCellRange(e, o, n, t).some((r) => N.equals(r, this._range));
   }
   /**
    * Return first cell style data in this range
@@ -380,16 +795,16 @@ let S = class extends b {
    */
   getCellStyleData() {
     var t;
-    const n = this.getCellData(), e = this._workbook.getStyles();
-    return n && e && (t = e.getStyleByCell(n)) != null ? t : null;
+    const o = this.getCellData(), e = this._workbook.getStyles();
+    return o && e && (t = e.getStyleByCell(o)) != null ? t : null;
   }
   /**
    * Returns the value of the cell at the start of this range.
    * @returns The value of the cell.
    */
   getValue() {
-    var n, e;
-    return (e = (n = this._worksheet.getCell(this._range.startRow, this._range.startColumn)) == null ? void 0 : n.v) != null ? e : null;
+    var o, e;
+    return (e = (o = this._worksheet.getCell(this._range.startRow, this._range.startColumn)) == null ? void 0 : o.v) != null ? e : null;
   }
   /**
    * Returns the rectangular grid of values for this range.
@@ -398,10 +813,10 @@ let S = class extends b {
    */
   getValues() {
     var r, i;
-    const { startRow: n, endRow: e, startColumn: t, endColumn: o } = this._range, s = [];
-    for (let a = n; a <= e; a++) {
+    const { startRow: o, endRow: e, startColumn: t, endColumn: n } = this._range, s = [];
+    for (let a = o; a <= e; a++) {
       const h = [];
-      for (let c = t; c <= o; c++)
+      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);
     }
@@ -412,10 +827,10 @@ let S = class extends b {
    * @returns A two-dimensional array of cell data.
    */
   getCellDataGrid() {
-    const { startRow: n, endRow: e, startColumn: t, endColumn: o } = this._range, s = [];
-    for (let r = n; r <= e; r++) {
+    const { startRow: o, endRow: e, startColumn: t, endColumn: n } = this._range, s = [];
+    for (let r = o; r <= e; r++) {
       const i = [];
-      for (let a = t; a <= o; a++)
+      for (let a = t; a <= n; a++)
         i.push(this._worksheet.getCellRaw(r, a));
       s.push(i);
     }
@@ -426,52 +841,71 @@ let S = class extends b {
    * @returns A two-dimensional array of formulas in string format.
    */
   getFormulas() {
-    const n = [], { startRow: e, endRow: t, startColumn: o, endColumn: s } = this._range, r = this._worksheet.getSheetId(), i = this._workbook.getUnitId();
+    const o = [], { startRow: e, endRow: t, startColumn: n, endColumn: s } = this._range, r = this._worksheet.getSheetId(), i = this._workbook.getUnitId();
     for (let a = e; a <= t; a++) {
       const h = [];
-      for (let c = o; c <= s; c++) {
+      for (let c = n; c <= s; c++) {
         const d = this._formulaDataModel.getFormulaStringByCell(a, c, r, i);
         h.push(d || "");
       }
-      n.push(h);
+      o.push(h);
     }
-    return n;
+    return o;
   }
   getWrap() {
-    return this._worksheet.getRange(this._range).getWrap() === m.TRUE;
+    return this._worksheet.getRange(this._range).getWrap() === u.TRUE;
   }
   getWrapStrategy() {
     return this._worksheet.getRange(this._range).getWrapStrategy();
   }
   getHorizontalAlignment() {
-    return it(this._worksheet.getRange(this._range).getHorizontalAlignment());
+    return Mt(this._worksheet.getRange(this._range).getHorizontalAlignment());
   }
   getVerticalAlignment() {
-    return ht(this._worksheet.getRange(this._range).getVerticalAlignment());
+    return Wt(this._worksheet.getRange(this._range).getVerticalAlignment());
   }
   // #region editing
-  setBackgroundColor(n) {
-    return this._commandService.executeCommand(_.id, {
+  /**
+   * Set background color for current range.
+   * @param color {string}
+   * @example
+   * ```
+   * univerAPI.getActiveWorkbook().getActiveSheet().getActiveRange().setBackgroundColor('red')
+   * ```
+   */
+  setBackgroundColor(o) {
+    return this._commandService.executeCommand(C.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
       style: {
         type: "bg",
         value: {
-          rgb: n
+          rgb: o
         }
       }
     });
   }
+  /**
+   * Set background color for current range.
+   * @example
+   * ```
+   * univerAPI.getActiveWorkbook().getActiveSheet().getActiveRange().setBackground('red')
+   * ```
+   * @param color {string}
+   */
+  setBackground(o) {
+    return this.setBackgroundColor(o);
+  }
   /**
    * 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
    */
-  setValue(n) {
-    const e = z(n);
+  setValue(o) {
+    const e = J(o);
     if (!e)
       throw new Error("Invalid value");
-    return this._commandService.executeCommand(G.id, {
+    return this._commandService.executeCommand(ne.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
@@ -482,54 +916,54 @@ let S = class extends b {
    * 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.
    */
-  setWrap(n) {
-    return this._commandService.executeCommand(q.id, {
+  setWrap(o) {
+    return this._commandService.executeCommand(se.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
-      value: n ? H.WRAP : H.UNSPECIFIED
+      value: o ? Z.WRAP : Z.UNSPECIFIED
     });
   }
   /**
    * Sets the text wrapping strategy for the cells in the range.
    */
-  setWrapStrategy(n) {
-    return this._commandService.executeCommand(q.id, {
+  setWrapStrategy(o) {
+    return this._commandService.executeCommand(se.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
-      value: n
+      value: o
     });
   }
   /**
    * Set the vertical (top to bottom) alignment for the given range (top/middle/bottom).
    */
-  setVerticalAlignment(n) {
-    return this._commandService.executeCommand(Oe.id, {
+  setVerticalAlignment(o) {
+    return this._commandService.executeCommand(et.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
-      value: at(n)
+      value: jt(o)
     });
   }
   /**
    * Set the horizontal (left to right) alignment for the given range (left/center/right).
    */
-  setHorizontalAlignment(n) {
-    return this._commandService.executeCommand(Ve.id, {
+  setHorizontalAlignment(o) {
+    return this._commandService.executeCommand(tt.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
-      value: rt(n)
+      value: Dt(o)
     });
   }
   /**
    * 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
    */
-  setValues(n) {
-    const e = ct(n, this._range);
-    return this._commandService.executeCommand(G.id, {
+  setValues(o) {
+    const e = Ot(o, this._range);
+    return this._commandService.executeCommand(ne.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
@@ -540,72 +974,72 @@ let S = class extends b {
    * 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.
    */
-  setFontWeight(n) {
+  setFontWeight(o) {
     let e;
-    if (n === "bold")
-      e = m.TRUE;
-    else if (n === "normal")
-      e = m.FALSE;
-    else if (n === null)
+    if (o === "bold")
+      e = u.TRUE;
+    else if (o === "normal")
+      e = u.FALSE;
+    else if (o === null)
       e = null;
     else
       throw new Error("Invalid fontWeight");
     const t = {
       type: "bl",
       value: e
-    }, o = {
+    }, n = {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
       style: t
     };
-    return this._commandService.executeCommand(_.id, o), this;
+    return this._commandService.executeCommand(C.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.
    */
-  setFontStyle(n) {
+  setFontStyle(o) {
     let e;
-    if (n === "italic")
-      e = m.TRUE;
-    else if (n === "normal")
-      e = m.FALSE;
-    else if (n === null)
+    if (o === "italic")
+      e = u.TRUE;
+    else if (o === "normal")
+      e = u.FALSE;
+    else if (o === null)
       e = null;
     else
       throw new Error("Invalid fontStyle");
     const t = {
       type: "it",
       value: e
-    }, o = {
+    }, n = {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
       style: t
     };
-    return this._commandService.executeCommand(_.id, o), this;
+    return this._commandService.executeCommand(C.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.
    */
-  setFontLine(n) {
-    if (n === "underline")
+  setFontLine(o) {
+    if (o === "underline")
       this._setFontUnderline({
-        s: m.TRUE
+        s: u.TRUE
       });
-    else if (n === "line-through")
+    else if (o === "line-through")
       this._setFontStrikethrough({
-        s: m.TRUE
+        s: u.TRUE
       });
-    else if (n === "none")
+    else if (o === "none")
       this._setFontUnderline({
-        s: m.FALSE
+        s: u.FALSE
       }), this._setFontStrikethrough({
-        s: m.FALSE
+        s: u.FALSE
       });
-    else if (n === null)
+    else if (o === null)
       this._setFontUnderline(null), this._setFontStrikethrough(null);
     else
       throw new Error("Invalid fontLine");
@@ -614,170 +1048,368 @@ let S = class extends b {
   /**
    * Sets the font underline style of the given ITextDecoration
    */
-  _setFontUnderline(n) {
+  _setFontUnderline(o) {
     const e = {
       type: "ul",
-      value: n
+      value: o
     }, t = {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
       style: e
     };
-    this._commandService.executeCommand(_.id, t);
+    this._commandService.executeCommand(C.id, t);
   }
   /**
    * Sets the font strikethrough style of the given ITextDecoration
    */
-  _setFontStrikethrough(n) {
+  _setFontStrikethrough(o) {
     const e = {
       type: "st",
-      value: n
+      value: o
     }, t = {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
       style: e
     };
-    this._commandService.executeCommand(_.id, t);
+    this._commandService.executeCommand(C.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.
    */
-  setFontFamily(n) {
+  setFontFamily(o) {
     const e = {
       type: "ff",
-      value: n
+      value: o
     }, t = {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
       style: e
     };
-    return this._commandService.executeCommand(_.id, t), this;
+    return this._commandService.executeCommand(C.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.
    */
-  setFontSize(n) {
+  setFontSize(o) {
     const e = {
       type: "fs",
-      value: n
+      value: o
     }, t = {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
       style: e
     };
-    return this._commandService.executeCommand(_.id, t), this;
+    return this._commandService.executeCommand(C.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.
    */
-  setFontColor(n) {
+  setFontColor(o) {
     const t = {
       type: "cl",
-      value: n === null ? null : { rgb: n }
-    }, o = {
+      value: o === null ? null : { rgb: o }
+    }, n = {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
       range: this._range,
       style: t
     };
-    return this._commandService.executeCommand(_.id, o), this;
+    return this._commandService.executeCommand(C.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
    */
-  async merge() {
-    const n = this._workbook.getUnitId(), e = this._worksheet.getSheetId();
-    return await M(this._injector, n, e, [this._range]), this;
+  async merge(o = !0) {
+    const e = this._workbook.getUnitId(), t = this._worksheet.getSheetId();
+    return await L(this._injector, e, t, [this._range], o), 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
    */
-  async mergeAcross() {
-    const n = Y([this._range], N.ROWS), e = this._workbook.getUnitId(), t = this._worksheet.getSheetId();
-    return await M(this._injector, e, t, n), this;
+  async mergeAcross(o = !0) {
+    const e = oe([this._range], ee.ROWS), t = this._workbook.getUnitId(), n = this._worksheet.getSheetId();
+    return await L(this._injector, t, n, e, o), 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
    */
-  async mergeVertically() {
-    const n = Y([this._range], N.COLUMNS), e = this._workbook.getUnitId(), t = this._worksheet.getSheetId();
-    return await M(this._injector, e, t, n), this;
+  async mergeVertically(o = !0) {
+    const e = oe([this._range], ee.COLUMNS), t = this._workbook.getUnitId(), n = this._worksheet.getSheetId();
+    return await L(this._injector, t, n, e, o), this;
   }
   /**
    * Returns true if cells in the current range overlap a merged cell.
    * @returns {boolean} is overlap with a merged cell
    */
   isPartOfMerge() {
-    const { startRow: n, startColumn: e, endRow: t, endColumn: o } = this._range;
-    return this._worksheet.getMergedCellRange(n, e, t, o).length > 0;
+    const { startRow: o, startColumn: e, endRow: t, endColumn: n } = this._range;
+    return this._worksheet.getMergedCellRange(o, e, t, n).length > 0;
   }
   /**
-   * Unmerge cells in the range
+   * Break all horizontally- or vertically-merged cells contained within the range list into individual cells again.
    * @returns This range, for chaining
    */
   breakApart() {
-    return this._commandService.executeCommand(ze.id, { ranges: [this._range] }), this;
+    return this._commandService.executeCommand(nt.id, { ranges: [this._range] }), this;
   }
   //#endregion
   /**
    * Iterate cells in this range. Merged cells will be respected.
-   * @param callback
-   */
-  forEach(n) {
-    const { startColumn: e, startRow: t, endColumn: o, endRow: s } = this._range;
-    this._worksheet.getMatrixWithMergedCells(t, e, s, o).forValue((r, i, a) => {
-      n(r, i, a);
+   * @param 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
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorksheet = fWorkbook.getActiveSheet();
+   * const fRange = fWorksheet.getRange('A1:B2');
+   * fRange.forEach((row, col, cell) => {
+   *    console.log(row, col, cell);
+   * });
+   * ```
+   */
+  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);
+    });
+  }
+  /**
+   * Returns a string description of the range, in A1 notation.
+   * @returns {string} The A1 notation of the range.
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorksheet = fWorkbook.getActiveSheet();
+   * const fRange = fWorksheet.getRange('A1:B2');
+   * console.log(fRange.getA1Notation()); // A1:B2
+   * ```
+   */
+  getA1Notation(o) {
+    return o ? Be(this._worksheet.getName(), this._range) : X(this._range);
+  }
+  /**
+   * Sets the specified range as the active range, with the top left cell in the range as the current cell.
+   * @returns {FRange}  This range, for chaining.
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorksheet = fWorkbook.getActiveSheet();
+   * const fRange = fWorksheet.getRange('A1:B2');
+   * fRange.activate(); // the active cell will be A1
+   * ```
+   */
+  activate() {
+    return this._injector.createInstance(I, this._workbook).setActiveRange(this), this;
+  }
+  /**
+   * Sets the specified cell as the current cell.
+   * If the specified cell is present in an existing range, then that range becomes the active range with the cell as the current cell.
+   * If the specified cell is not part of an existing range, then a new range is created with the cell as the active range and the current cell.
+   * @returns {FRange}  This range, for chaining.
+   * @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 && N.equals(o, this._range) || !o && 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");
+  }
+  /**
+   * Splits a column of text into multiple columns based on a custom specified delimiter.
+   * @param {boolean} [treatMultipleDelimitersAsOne] Whether to treat multiple continuous delimiters as one. The default value is false.
+   * @param {SplitDelimiterEnum} [delimiter] The delimiter to use to split the text. The default delimiter is Tab(1)、Comma(2)、Semicolon(4)、Space(8)、Custom(16).A delimiter like 6 (SplitDelimiterEnum.Comma|SplitDelimiterEnum.Semicolon) means using Comma and Semicolon to split the text.
+   * @param {string} [customDelimiter] The custom delimiter to split the text. An error will be thrown if custom delimiter is set but the customDelimiter is not a character.
+   * @example Show how to split text to columns with combined delimiter. The bit operations are used to combine the delimiters.
+   * // A1:A3 has following values:
+   * //     A   | B | C
+   * //  1;;2;3 |   |
+   * //  1;,2;3 |   |
+   * // After calling splitTextToColumns(false, SplitDelimiterEnum.Semicolon|SplitDelimiterEnum.Comma), the range will be:
+   * //  A | B | C | D
+   * //  1 |   | 2 | 3
+   * //  1 |   | 2 | 3
+   * // After calling splitTextToColumns(true, SplitDelimiterEnum.Semicolon|SplitDelimiterEnum.Comma), the range will be:
+   * //  A | B | C
+   * //  1 | 2 | 3
+   * //  1 | 2 | 3
+   * @example Show how to split text to columns with custom delimiter
+   * // A1:A3 has following values:
+   * //     A   | B | C
+   * //  1#2#3  |   |
+   * //  4##5#6 |   |
+   * // After calling splitTextToColumns(false, SplitDelimiterEnum.Custom, '#'), the range will be:
+   * //  A | B | C | D
+   * //  1 | 2 | 3 |
+   * //  4 |   | 5 | 6
+   * // After calling splitTextToColumns(true, SplitDelimiterEnum.Custom, '#'), the range will be:
+   * //  A | B | C
+   * //  1 | 2 | 3
+   * //  4 | 5 | 6
+   */
+  splitTextToColumns(o, e, t) {
+    this._commandService.executeCommand(st.id, {
+      unitId: this._workbook.getUnitId(),
+      subUnitId: this._worksheet.getSheetId(),
+      range: this._range,
+      delimiter: e,
+      customDelimiter: t,
+      treatMultipleDelimitersAsOne: o
     });
   }
 };
-S = mt([
-  D(3, u(R)),
-  D(4, v),
-  D(5, u(et))
+S = Tt([
+  G(3, m(v)),
+  G(4, l),
+  G(5, m(Le))
 ], S);
-var lt = Object.defineProperty, gt = Object.getOwnPropertyDescriptor, _t = (n, e, t, o) => {
-  for (var s = o > 1 ? void 0 : o ? gt(e, t) : e, r = n.length - 1, i; r >= 0; r--)
-    (i = n[r]) && (s = (o ? i(e, t, s) : i(s)) || s);
-  return o && s && lt(e, t, s), s;
-}, wt = (n, e) => (t, o) => e(t, o, n);
-let L = class {
-  constructor(n, e, t, o) {
-    this._workbook = n, this._worksheet = e, this._selections = t, this._injector = o;
+var Lt = Object.defineProperty, Bt = Object.getOwnPropertyDescriptor, zt = (o, e, t, n) => {
+  for (var s = n > 1 ? void 0 : n ? Bt(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 && Lt(e, t, s), s;
+}, Vt = (o, e) => (t, n) => e(t, n, o);
+let F = class {
+  constructor(o, e, t, n) {
+    this._workbook = o, 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 n = this._selections.find((e) => !!e.primary);
-    return n ? this._injector.createInstance(S, this._workbook, this._worksheet, n.range) : null;
+    const o = this._selections.find((e) => !!e.primary);
+    return o ? this._injector.createInstance(S, this._workbook, this._worksheet, o.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(S, this._workbook, this._worksheet, o.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;
+  }
+  /**
+   * Returns the active sheet in the spreadsheet.
+   * @returns {FWorksheet} The active sheet in the spreadsheet.
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorksheet = fWorkbook.getActiveSheet();
+   * const fSelection = fWorksheet.getSelection();
+   * const activeSheet = fSelection.getActiveSheet();
+   * console.log(activeSheet.equalTo(fWorksheet)); // true
+   * ```
+   */
+  getActiveSheet() {
+    const o = this._injector.createInstance(I, this._workbook);
+    return this._injector.createInstance(_, o, 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.
+   * @param {FRange} cell The new primary cell to update.
+   * @returns {FSelection} The new selection after updating the primary cell.Because the selection is immutable, the return value is a new selection.
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorksheet = fWorkbook.getActiveSheet();
+   * const fSelection = fWorksheet.getSelection();
+   * const cell = fWorksheet.getCell('A1');
+   * const newSelection = fSelection.updatePrimaryCell(cell);
+   * console.log(newSelection.getActiveRange().getA1Notation()); // A1
+   * ```
+   */
+  async updatePrimaryCell(o) {
+    const e = this._injector.get(l);
+    let t = [], n = !1;
+    for (const { range: r, style: i } of this._selections)
+      N.contains(r, o.getRange()) ? (t.push({
+        range: r,
+        primary: Y(o.getRange(), this._worksheet),
+        style: i
+      }), n = !0) : t.push({
+        range: r,
+        primary: null,
+        style: i
+      });
+    n || (t = [
+      {
+        range: o.getRange(),
+        primary: Y(o.getRange(), this._worksheet)
+      }
+    ]);
+    const s = {
+      unitId: this._workbook.getUnitId(),
+      subUnitId: this._worksheet.getSheetId(),
+      selections: t
+    };
+    return await e.syncExecuteCommand(Ue.id, s), new F(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.
+   * @param {Direction} direction The direction to move the primary cell.The enum value is maybe one of the following: UP(0),RIGHT(1), DOWN(2), LEFT(3).
+   * @returns {FRange | null} The next primary cell in the specified direction.
+   * @example
+   * ```ts
+   * // import { Direction } from '@univerjs/core';
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorksheet = fWorkbook.getActiveSheet();
+   * // make sure the active cell is A1 and selection is A1:C3
+   * const fSelection = fWorksheet.getSelection();
+   * const nextCell = fSelection.getNextDataRange(Direction.RIGHT);
+   * console.log(nextCell?.getA1Notation()); // B1
+   * ```
+   */
+  getNextDataRange(o) {
+    if (!this._selections.find((n) => !!n.primary))
+      return null;
+    const t = ot(this._selections.concat(), o, this._worksheet);
+    return t ? this._injector.createInstance(S, this._workbook, this._worksheet, t) : null;
   }
 };
-L = _t([
-  wt(3, u(R))
-], L);
-var kt = Object.defineProperty, St = Object.getOwnPropertyDescriptor, Ct = (n, e, t, o) => {
-  for (var s = o > 1 ? void 0 : o ? St(e, t) : e, r = n.length - 1, i; r >= 0; r--)
-    (i = n[r]) && (s = (o ? i(e, t, s) : i(s)) || s);
-  return o && s && kt(e, t, s), s;
-}, j = (n, e) => (t, o) => e(t, o, n);
-let g = class extends b {
-  constructor(e, t, o, s, r, i) {
+F = zt([
+  Vt(3, m(v))
+], F);
+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;
+}, M = (o, e) => (t, n) => e(t, n, o);
+let _ = class extends p {
+  constructor(e, t, n, s, r, i, a) {
     super();
     /**
      * Sets the active selection region for this sheet.
      * @param range The range to set as the active selection.
      */
-    E(this, "setActiveSelection", this.setActiveRange);
-    this._fWorkbook = e, this._workbook = t, this._worksheet = o, this._injector = s, this._selectionManagerService = r, this._commandService = i;
+    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;
   }
   /**
    * Returns the injector
@@ -788,34 +1420,38 @@ let g = class extends b {
   }
   /**
    * Returns the workbook
-   * @returns The workbook
+   * @returns {Workbook} The workbook instance.
    */
   getWorkbook() {
     return this._workbook;
   }
   /**
-   * Returns the worksheet id
-   * @returns The id of the worksheet
+   * Returns the worksheet id.
+   * @returns {string} The id of the worksheet.
    */
   getSheetId() {
     return this._worksheet.getSheetId();
   }
   /**
-   * Returns the worksheet name
-   * @returns The name of the worksheet
+   * Returns the worksheet name.
+   * @returns {string} The name of the worksheet.
    */
   getSheetName() {
     return this._worksheet.getName();
   }
+  /**
+   * Represents the selection ranges info of the worksheet.
+   * @returns {FSelection} return the current selections of the worksheet or null if there is no selection.
+   */
   getSelection() {
     const e = this._selectionManagerService.getCurrentSelections();
-    return e ? this._injector.createInstance(L, this._workbook, this._worksheet, e) : null;
+    return e ? this._injector.createInstance(F, this._workbook, this._worksheet, e) : null;
   }
   // #region rows
   // #region default style
   /**
    * Get the default style of the worksheet
-   * @returns Default style
+   * @returns {IStyleData} Default style of the worksheet.
    */
   getDefaultStyle() {
     return this._worksheet.getDefaultCellStyle();
@@ -840,14 +1476,14 @@ let g = class extends b {
   }
   /**
    * Set the default style of the worksheet
-   * @param style default style
-   * @returns this worksheet
+   * @param {StyleDataInfo} style default style
+   * @returns {Promise<FWorksheet>} This sheet, for chaining.
    */
   async setDefaultStyle(e) {
-    const t = this._workbook.getUnitId(), o = this._worksheet.getSheetId();
-    return await this._commandService.executeCommand(Le.id, {
+    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId();
+    return await this._commandService.executeCommand(rt.id, {
       unitId: t,
-      subUnitId: o,
+      subUnitId: n,
       defaultStyle: e
     }), this._worksheet.setDefaultCellStyle(e), this;
   }
@@ -855,10 +1491,11 @@ let g = class extends b {
    * Set the default style of the worksheet row
    * @param {number} index The row index
    * @param {string | Nullable<IStyleData>} style The style name or style data
+   * @returns {Promise<FWorksheet>} This sheet, for chaining.
    */
   async setColumnDefaultStyle(e, t) {
-    const o = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = {
-      unitId: o,
+    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = {
+      unitId: n,
       subUnitId: s,
       columnData: {
         [e]: {
@@ -866,16 +1503,17 @@ let g = class extends b {
         }
       }
     };
-    return await this._commandService.executeCommand(J.id, r), this;
+    return await this._commandService.executeCommand(re.id, r), this;
   }
   /**
    * Set the default style of the worksheet column
    * @param {number} index The column index
    * @param {string | Nullable<IStyleData>} style The style name or style data
+   * @returns {Promise<FWorksheet>} This sheet, for chaining.
    */
   async setRowDefaultStyle(e, t) {
-    const o = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = {
-      unitId: o,
+    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = {
+      unitId: n,
       subUnitId: s,
       rowData: {
         [e]: {
@@ -883,12 +1521,12 @@ let g = class extends b {
         }
       }
     };
-    return await this._commandService.executeCommand(K.id, r), this;
+    return await this._commandService.executeCommand(ie.id, r), this;
   }
-  getRange(e, t, o, s) {
+  getRange(e, t, n, s) {
     let r, i;
     if (typeof e == "string") {
-      const { range: a, sheetName: h } = tt(e), c = h ? this._workbook.getSheetBySheetName(h) : this._worksheet;
+      const { range: a, sheetName: h } = ze(e), c = h ? this._workbook.getSheetBySheetName(h) : this._worksheet;
       if (!c)
         throw new Error("Range not found");
       i = c, r = {
@@ -897,16 +1535,16 @@ let g = class extends b {
         sheetId: i.getSheetId(),
         // Use the current range instead of the future actual range to match Apps Script behavior.
         // Users can create the latest range in real time when needed.
-        rangeType: l.NORMAL,
-        startRow: a.rangeType === l.COLUMN ? 0 : a.startRow,
-        endRow: a.rangeType === l.COLUMN ? i.getMaxRows() - 1 : a.endRow,
-        startColumn: a.rangeType === l.ROW ? 0 : a.startColumn,
-        endColumn: a.rangeType === l.ROW ? i.getMaxColumns() - 1 : a.endColumn
+        rangeType: g.NORMAL,
+        startRow: a.rangeType === g.COLUMN ? 0 : a.startRow,
+        endRow: a.rangeType === g.COLUMN ? i.getMaxRows() - 1 : a.endRow,
+        startColumn: a.rangeType === g.ROW ? 0 : a.startColumn,
+        endColumn: a.rangeType === g.ROW ? i.getMaxColumns() - 1 : a.endColumn
       };
     } else if (typeof e == "number" && t !== void 0)
       i = this._worksheet, r = {
         startRow: e,
-        endRow: e + (o != null ? o : 1) - 1,
+        endRow: e + (n != null ? n : 1) - 1,
         startColumn: t,
         endColumn: t + (s != null ? s : 1) - 1,
         unitId: this._workbook.getUnitId(),
@@ -962,9 +1600,9 @@ let g = class extends b {
    * @returns This sheet, for chaining.
    */
   async insertRowsAfter(e, t) {
-    const o = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = p.DOWN, i = e + 1, a = e + t, h = 0, c = this._worksheet.getColumnCount() - 1, d = y(this._worksheet, i, a, h, c, !0, e);
-    return await this._commandService.executeCommand(Q.id, {
-      unitId: o,
+    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = E.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 await this._commandService.executeCommand(ae.id, {
+      unitId: n,
       subUnitId: s,
       direction: r,
       range: {
@@ -983,9 +1621,9 @@ let g = class extends b {
    * @returns This sheet, for chaining.
    */
   async insertRowsBefore(e, t) {
-    const o = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = p.UP, i = e, a = e + t - 1, h = 0, c = this._worksheet.getColumnCount() - 1, d = y(this._worksheet, i, a, h, c, !0, e - 1);
-    return await this._commandService.executeCommand(Q.id, {
-      unitId: o,
+    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = E.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 await this._commandService.executeCommand(ae.id, {
+      unitId: n,
       subUnitId: s,
       direction: r,
       range: {
@@ -1012,14 +1650,14 @@ let g = class extends b {
    * @returns This sheet, for chaining.
    */
   async deleteRows(e, t) {
-    const o = {
+    const n = {
       startRow: e,
       endRow: e + t - 1,
       startColumn: 0,
       endColumn: this._worksheet.getColumnCount() - 1
     };
-    return await this._commandService.executeCommand(Be.id, {
-      range: o
+    return await this._commandService.executeCommand(it.id, {
+      range: n
     }), this;
   }
   /**
@@ -1029,14 +1667,14 @@ let g = class extends b {
    * @returns This sheet, for chaining.
    */
   async moveRows(e, t) {
-    const o = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = W(e.getRange(), this._worksheet), i = r, a = {
+    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = H(e.getRange(), this._worksheet), i = r, a = {
       startRow: t,
       endRow: t,
       startColumn: r.startColumn,
       endColumn: r.endColumn
     };
-    return await this._commandService.executeCommand(He.id, {
-      unitId: o,
+    return await this._commandService.executeCommand(at.id, {
+      unitId: n,
       subUnitId: s,
       range: r,
       fromRange: i,
@@ -1049,10 +1687,10 @@ let g = class extends b {
    * @returns This sheet, for chaining.
    */
   async hideRow(e) {
-    const t = this._workbook.getUnitId(), o = this._worksheet.getSheetId(), s = W(e.getRange(), this._worksheet);
-    return await this._commandService.executeCommand(X.id, {
+    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId(), s = H(e.getRange(), this._worksheet);
+    return await this._commandService.executeCommand(he.id, {
       unitId: t,
-      subUnitId: o,
+      subUnitId: n,
       ranges: [s]
     }), this;
   }
@@ -1063,15 +1701,15 @@ let g = class extends b {
    * @returns This sheet, for chaining.
    */
   async hideRows(e, t = 1) {
-    const o = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = {
+    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = {
       startRow: e,
       endRow: e + t - 1,
       startColumn: 0,
       endColumn: this._worksheet.getColumnCount() - 1,
-      rangeType: l.ROW
+      rangeType: g.ROW
     };
-    return await this._commandService.executeCommand(X.id, {
-      unitId: o,
+    return await this._commandService.executeCommand(he.id, {
+      unitId: n,
       subUnitId: s,
       ranges: [r]
     }), this;
@@ -1082,10 +1720,10 @@ let g = class extends b {
    * @returns This sheet, for chaining.
    */
   async unhideRow(e) {
-    const t = this._workbook.getUnitId(), o = this._worksheet.getSheetId(), s = W(e.getRange(), this._worksheet);
-    return await this._commandService.executeCommand(Z.id, {
+    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId(), s = H(e.getRange(), this._worksheet);
+    return await this._commandService.executeCommand(ce.id, {
       unitId: t,
-      subUnitId: o,
+      subUnitId: n,
       ranges: [s]
     }), this;
   }
@@ -1096,15 +1734,15 @@ let g = class extends b {
    * @returns This sheet, for chaining.
    */
   async showRows(e, t = 1) {
-    const o = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = {
+    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = {
       startRow: e,
       endRow: e + t - 1,
       startColumn: 0,
       endColumn: this._worksheet.getColumnCount() - 1,
-      rangeType: l.ROW
+      rangeType: g.ROW
     };
-    return await this._commandService.executeCommand(Z.id, {
-      unitId: o,
+    return await this._commandService.executeCommand(ce.id, {
+      unitId: n,
       subUnitId: s,
       ranges: [r]
     }), this;
@@ -1125,24 +1763,24 @@ let g = class extends b {
    * @param height The height in pixels to set it to.
    * @returns This sheet, for chaining.
    */
-  async setRowHeights(e, t, o) {
+  async setRowHeights(e, t, n) {
     var c;
     const s = this._workbook.getUnitId(), r = this._worksheet.getSheetId(), i = this._worksheet.getRowManager(), a = [], h = [];
     for (let d = e; d < e + t; d++) {
-      const x = ((c = i.getRow(d)) == null ? void 0 : c.ah) || this._worksheet.getConfig().defaultRowHeight, B = {
+      const T = ((c = i.getRow(d)) == null ? void 0 : c.ah) || this._worksheet.getConfig().defaultRowHeight, x = {
         startRow: d,
         endRow: d,
         startColumn: 0,
         endColumn: this._worksheet.getColumnCount() - 1
       };
-      o <= x ? a.push(B) : h.push(B);
+      n <= T ? a.push(x) : h.push(x);
     }
-    return h.length > 0 && await this._commandService.executeCommand(ee.id, {
+    return h.length > 0 && await this._commandService.executeCommand(de.id, {
       unitId: s,
       subUnitId: r,
       ranges: h,
-      value: o
-    }), a.length > 0 && await this._commandService.executeCommand(Ne.id, {
+      value: n
+    }), a.length > 0 && await this._commandService.executeCommand(ht.id, {
       unitId: s,
       subUnitId: r,
       ranges: a
@@ -1155,7 +1793,7 @@ let g = class extends b {
    * @param height The height in pixels to set it to.
    * @returns This sheet, for chaining.
    */
-  async setRowHeightsForced(e, t, o) {
+  async setRowHeightsForced(e, t, n) {
     const s = this._workbook.getUnitId(), r = this._worksheet.getSheetId(), i = [
       {
         startRow: e,
@@ -1164,11 +1802,11 @@ let g = class extends b {
         endColumn: this._worksheet.getColumnCount() - 1
       }
     ];
-    return await this._commandService.executeCommand(ee.id, {
+    return await this._commandService.executeCommand(de.id, {
       unitId: s,
       subUnitId: r,
       ranges: i,
-      value: o
+      value: n
     }), this;
   }
   // #endregion
@@ -1178,17 +1816,17 @@ let g = class extends b {
    * @returns This sheet, for chaining.
    */
   async setRowCustom(e) {
-    const t = this._workbook.getUnitId(), o = this._worksheet.getSheetId(), s = {};
+    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId(), s = {};
     for (const [i, a] of Object.entries(e))
       s[Number(i)] = {
         custom: a
       };
     const r = {
       unitId: t,
-      subUnitId: o,
+      subUnitId: n,
       rowData: s
     };
-    return await this._commandService.executeCommand(K.id, r), this;
+    return await this._commandService.executeCommand(ie.id, r), this;
   }
   // #region Column
   /**
@@ -1223,9 +1861,9 @@ let g = class extends b {
    * @returns This sheet, for chaining.
    */
   async insertColumnsAfter(e, t) {
-    const o = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = p.RIGHT, i = 0, a = this._worksheet.getRowCount() - 1, h = e + 1, c = e + t, d = y(this._worksheet, i, a, h, c, !1, e);
-    return await this._commandService.executeCommand(te.id, {
-      unitId: o,
+    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = E.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 await this._commandService.executeCommand(me.id, {
+      unitId: n,
       subUnitId: s,
       direction: r,
       range: {
@@ -1244,9 +1882,9 @@ let g = class extends b {
    * @returns This sheet, for chaining.
    */
   async insertColumnsBefore(e, t) {
-    const o = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = p.LEFT, i = 0, a = this._worksheet.getRowCount() - 1, h = e, c = e + t - 1, d = y(this._worksheet, i, a, h, c, !1, e - 1);
-    return await this._commandService.executeCommand(te.id, {
-      unitId: o,
+    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = E.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 await this._commandService.executeCommand(me.id, {
+      unitId: n,
       subUnitId: s,
       direction: r,
       range: {
@@ -1273,14 +1911,14 @@ let g = class extends b {
    * @returns This sheet, for chaining.
    */
   async deleteColumns(e, t) {
-    const o = {
+    const n = {
       startRow: 0,
       endRow: this._worksheet.getRowCount() - 1,
       startColumn: e,
       endColumn: e + t - 1
     };
-    return await this._commandService.executeCommand($e.id, {
-      range: o
+    return await this._commandService.executeCommand(ct.id, {
+      range: n
     }), this;
   }
   /**
@@ -1290,14 +1928,14 @@ let g = class extends b {
    * @returns This sheet, for chaining.
    */
   async moveColumns(e, t) {
-    const o = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = A(e.getRange(), this._worksheet), i = r, a = {
+    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = $(e.getRange(), this._worksheet), i = r, a = {
       startRow: 0,
       endRow: this._worksheet.getRowCount() - 1,
       startColumn: t,
       endColumn: t
     };
-    return await this._commandService.executeCommand(Ge.id, {
-      unitId: o,
+    return await this._commandService.executeCommand(dt.id, {
+      unitId: n,
       subUnitId: s,
       range: r,
       fromRange: i,
@@ -1310,10 +1948,10 @@ let g = class extends b {
    * @returns This sheet, for chaining.
    */
   async hideColumn(e) {
-    const t = this._workbook.getUnitId(), o = this._worksheet.getSheetId(), s = A(e.getRange(), this._worksheet);
-    return await this._commandService.executeCommand(ne.id, {
+    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId(), s = $(e.getRange(), this._worksheet);
+    return await this._commandService.executeCommand(ue.id, {
       unitId: t,
-      subUnitId: o,
+      subUnitId: n,
       ranges: [s]
     }), this;
   }
@@ -1324,15 +1962,15 @@ let g = class extends b {
    * @returns This sheet, for chaining.
    */
   async hideColumns(e, t = 1) {
-    const o = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = {
+    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = {
       startRow: 0,
       endRow: this._worksheet.getRowCount() - 1,
       startColumn: e,
       endColumn: e + t - 1,
-      rangeType: l.COLUMN
+      rangeType: g.COLUMN
     };
-    return await this._commandService.executeCommand(ne.id, {
-      unitId: o,
+    return await this._commandService.executeCommand(ue.id, {
+      unitId: n,
       subUnitId: s,
       ranges: [r]
     }), this;
@@ -1343,10 +1981,10 @@ let g = class extends b {
    * @returns This sheet, for chaining.
    */
   async unhideColumn(e) {
-    const t = this._workbook.getUnitId(), o = this._worksheet.getSheetId(), s = A(e.getRange(), this._worksheet);
-    return await this._commandService.executeCommand(oe.id, {
+    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId(), s = $(e.getRange(), this._worksheet);
+    return await this._commandService.executeCommand(le.id, {
       unitId: t,
-      subUnitId: o,
+      subUnitId: n,
       ranges: [s]
     }), this;
   }
@@ -1357,15 +1995,15 @@ let g = class extends b {
    * @returns This sheet, for chaining.
    */
   async showColumns(e, t = 1) {
-    const o = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = {
+    const n = this._workbook.getUnitId(), s = this._worksheet.getSheetId(), r = {
       startRow: 0,
       endRow: this._worksheet.getRowCount() - 1,
       startColumn: e,
       endColumn: e + t - 1,
-      rangeType: l.COLUMN
+      rangeType: g.COLUMN
     };
-    return await this._commandService.executeCommand(oe.id, {
-      unitId: o,
+    return await this._commandService.executeCommand(le.id, {
+      unitId: n,
       subUnitId: s,
       ranges: [r]
     }), this;
@@ -1386,7 +2024,7 @@ let g = class extends b {
    * @param width The width in pixels to set it to.
    * @returns This sheet, for chaining.
    */
-  async setColumnWidths(e, t, o) {
+  async setColumnWidths(e, t, n) {
     const s = this._workbook.getUnitId(), r = this._worksheet.getSheetId(), i = [
       {
         startColumn: e,
@@ -1395,11 +2033,11 @@ let g = class extends b {
         endRow: this._worksheet.getRowCount() - 1
       }
     ];
-    return await this._commandService.executeCommand(qe.id, {
+    return await this._commandService.executeCommand(mt.id, {
       unitId: s,
       subUnitId: r,
       ranges: i,
-      value: o
+      value: n
     }), this;
   }
   // #endregion
@@ -1409,17 +2047,17 @@ let g = class extends b {
    * @returns This sheet, for chaining.
    */
   async setColumnCustom(e) {
-    const t = this._workbook.getUnitId(), o = this._worksheet.getSheetId(), s = {};
+    const t = this._workbook.getUnitId(), n = this._worksheet.getSheetId(), s = {};
     for (const [i, a] of Object.entries(e))
       s[Number(i)] = {
         custom: a
       };
     const r = {
       unitId: t,
-      subUnitId: o,
+      subUnitId: n,
       columnData: s
     };
-    return await this._commandService.executeCommand(J.id, r), this;
+    return await this._commandService.executeCommand(re.id, r), this;
   }
   // #region merge cells
   /**
@@ -1453,18 +2091,21 @@ let g = class extends b {
    * @param range The range to set as the active selection.
    */
   setActiveRange(e) {
-    const { unitId: t, sheetId: o } = e.getRange();
-    if (t !== this._workbook.getUnitId() || o !== this._worksheet.getSheetId())
+    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);
   }
   /**
    * Sets the frozen state of the current sheet.
-   * @param freeze - The freeze object containing the parameters for freezing the 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._commandService.syncExecuteCommand(Ye.id, {
+    return this._logService.warn("setFreeze is deprecated, use setFrozenRows and setFrozenColumns instead"), this._commandService.syncExecuteCommand(B.id, {
       ...e,
       unitId: this._workbook.getUnitId(),
       subUnitId: this.getSheetId()
@@ -1475,7 +2116,7 @@ let g = class extends b {
    * @returns True if the command was successful, false otherwise.
    */
   cancelFreeze() {
-    return this._commandService.syncExecuteCommand(Je.id, {
+    return this._commandService.syncExecuteCommand(ut.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this.getSheetId()
     });
@@ -1483,35 +2124,53 @@ let g = class extends b {
   /**
    * Get the freeze state of the current sheet.
    * @returns The freeze state of the current sheet.
+   *
+   * @deprecated use `getRowFreezeStatus` and `getColumnFreezeStatus` instead.
    */
   getFreeze() {
     return this._worksheet.getFreeze();
   }
-  /**
-   * Set the number of frozen columns.
-   * @param columns The number of columns to freeze.
-   * To unfreeze all columns, set this value to 0.
-   */
-  setFrozenColumns(e) {
+  setFrozenColumns(...e) {
     const t = this.getFreeze();
-    this.setFreeze({
-      ...t,
-      startColumn: e > 0 ? e : -1,
-      xSplit: e
-    });
+    if (arguments.length === 1) {
+      const n = e[0];
+      this.setFreeze({
+        ...t,
+        startColumn: n > 0 ? n : -1,
+        xSplit: n
+      });
+    } else if (arguments.length === 2) {
+      let [n = 0, s = 0] = e;
+      n > s && ([n, s] = [s, n]), this._commandService.syncExecuteCommand(B.id, {
+        startColumn: s + 1,
+        xSplit: s - n + 1,
+        startRow: t.startRow,
+        ySplit: t.ySplit,
+        unitId: this._workbook.getUnitId(),
+        subUnitId: this.getSheetId()
+      });
+    }
   }
-  /**
-   * Set the number of frozen rows.
-   * @param rows The number of rows to freeze.
-   * To unfreeze all rows, set this value to 0.
-   */
-  setFrozenRows(e) {
+  setFrozenRows(...e) {
     const t = this.getFreeze();
-    this.setFreeze({
-      ...t,
-      startRow: e > 0 ? e : -1,
-      ySplit: e
-    });
+    if (arguments.length === 1) {
+      const n = e[0];
+      this.setFreeze({
+        ...t,
+        startRow: n > 0 ? n : -1,
+        ySplit: n
+      });
+    } else if (arguments.length === 2) {
+      let [n = 0, s = 0] = e;
+      n > s && ([n, s] = [s, n]), this._commandService.syncExecuteCommand, this._commandService.syncExecuteCommand(B.id, {
+        startRow: s + 1,
+        ySplit: s - n + 1,
+        startColumn: t.startColumn,
+        xSplit: t.xSplit,
+        unitId: this._workbook.getUnitId(),
+        subUnitId: this.getSheetId()
+      });
+    }
   }
   /**
    * Get the number of frozen columns.
@@ -1531,33 +2190,141 @@ let g = class extends b {
     const e = this.getFreeze();
     return e.startRow === -1 ? 0 : e.startRow;
   }
+  /**
+   * Get freezed rows.
+   */
+  getFrozenRowRange() {
+    const e = this._worksheet.getFreeze();
+    return {
+      startRow: e.startRow - e.ySplit,
+      endRow: e.startRow - 1
+    };
+  }
+  /**
+   * Get freezed columns
+   */
+  getFrozenColumnRange() {
+    const e = this._worksheet.getFreeze();
+    return {
+      startColumn: e.startColumn - e.xSplit,
+      endColumn: e.startColumn - 1
+    };
+  }
   /**
    * Returns true if the sheet's gridlines are hidden; otherwise returns false. Gridlines are visible by default.
+   * @returns {boolean} True if the sheet's gridlines are hidden; otherwise false.
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * // check if the gridlines are hidden
+   * if (fWorkSheet.hasHiddenGridLines()) {
+   *    console.log('Gridlines are hidden');
+   * }
+   * ```
    */
   hasHiddenGridLines() {
-    return this._worksheet.getConfig().showGridlines === m.FALSE;
+    return this._worksheet.getConfig().showGridlines === u.FALSE;
   }
   /**
    * Hides or reveals the sheet gridlines.
    * @param {boolean} hidden If `true`, hide gridlines in this sheet; otherwise show the gridlines.
+   * @example
+   * ``` ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * // hide the gridlines
+   * fWorkSheet.setHiddenGridlines(true);
+   * ```
    */
   setHiddenGridlines(e) {
-    return this._commandService.executeCommand(Ke.id, {
+    return this._commandService.executeCommand(lt.id, {
+      unitId: this._workbook.getUnitId(),
+      subUnitId: this._worksheet.getSheetId(),
+      showGridlines: e ? u.FALSE : u.TRUE
+    });
+  }
+  /**
+   * Set the color of the gridlines in the sheet.
+   * @param {string|undefined} color The color to set for the gridlines.Undefined or null to reset to the default color.
+   * @returns {Promise<boolean>} True if the command was successful, false otherwise.
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * // set the gridlines color to red
+   * fWorkSheet.setGridLinesColor('#ff0000');
+   * ```
+   */
+  setGridLinesColor(e) {
+    return this._commandService.executeCommand(gt.id, {
       unitId: this._workbook.getUnitId(),
       subUnitId: this._worksheet.getSheetId(),
-      showGridlines: e ? m.FALSE : m.TRUE
+      color: e
     });
   }
+  /**
+   * Get the color of the gridlines in the sheet.
+   * @returns {string | undefined} The color of the gridlines in the sheet or undefined. The default color is 'rgb(214, 216, 219)'.
+   */
+  getGridLinesColor() {
+    return this._worksheet.getGridlinesColor();
+  }
+  /**
+   * Sets the sheet tab color.
+   * @param {string|null|undefined} color A color code in CSS notation (like '#ffffff' or 'white'), or null to reset the tab color.
+   * @returns {Promise<boolean>} True if the command was successful, false otherwise.
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * // set the tab color to red
+   * fWorkSheet.setTabColor('#ff0000');
+   * ```
+   */
+  setTabColor(e) {
+    return this._commandService.executeCommand(_t.id, {
+      unitId: this._workbook.getUnitId(),
+      subUnitId: this._worksheet.getSheetId(),
+      color: e
+    });
+  }
+  /**
+   * Get the tab color of the sheet.
+   * @returns {string} The tab color of the sheet or undefined.
+   * The default color is css style property 'unset'.
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * // get the tab color of the sheet
+   * console.log(fWorkSheet.getTabColor());
+   * ```
+   */
+  getTabColor() {
+    return this._worksheet.getTabColor();
+  }
   /**
    * Subscribe to the cell data change event.
    * @param callback - The callback function to be executed when the cell data changes.
    * @returns - A disposable object to unsubscribe from the event.
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * // subscribe to the cell data change event
+   * const disposable = fWorkSheet.onCellDataChange((cellValue) => {
+   *  console.log(cellValue.toArray());
+   * });
+   * // unsubscribe from the event
+   * disposable.dispose();
+   * ```
    */
   onCellDataChange(e) {
-    return this._injector.get(v).onCommandExecuted((o) => {
-      if (o.id === se.id) {
-        const s = o.params;
-        s.unitId === this._workbook.getUnitId() && s.subUnitId === this._worksheet.getSheetId() && s.cellValue && e(new P(s.cellValue));
+    return this._injector.get(l).onCommandExecuted((n) => {
+      if (n.id === ge.id) {
+        const s = n.params;
+        s.unitId === this._workbook.getUnitId() && s.subUnitId === this._worksheet.getSheetId() && s.cellValue && e(new j(s.cellValue));
       }
     });
   }
@@ -1565,47 +2332,384 @@ let g = class extends b {
    * Subscribe to the cell data change event.
    * @param callback - The callback function to be executed before the cell data changes.
    * @returns - A disposable object to unsubscribe from the event.
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * // subscribe to the cell data change event
+   * const disposable = fWorkSheet.onBeforeCellDataChange((cellValue) => {
+   *   console.log(cellValue.toArray());
+   * });
+   * // unsubscribe from the event
+   * disposable.dispose();
+   * ```
    */
   onBeforeCellDataChange(e) {
-    return this._injector.get(v).beforeCommandExecuted((o) => {
-      if (o.id === se.id) {
-        const s = o.params;
-        s.unitId === this._workbook.getUnitId() && s.subUnitId === this._worksheet.getSheetId() && s.cellValue && e(new P(s.cellValue));
+    return this._injector.get(l).beforeCommandExecuted((n) => {
+      if (n.id === ge.id) {
+        const s = n.params;
+        s.unitId === this._workbook.getUnitId() && s.subUnitId === this._worksheet.getSheetId() && s.cellValue && e(new j(s.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.
+   * @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)
+      throw new Error("Cannot hide the only visible sheet");
+    e.executeCommand(wt.id, {
+      unitId: this._workbook.getUnitId(),
+      subUnitId: this._worksheet.getSheetId()
+    });
+  }
+  /**
+   * Shows this sheet. Has no effect if the sheet is already visible.
+   * @returns {Promise<boolean>} True if the command was successful, false otherwise.
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheets = fWorkbook.getSheets();
+   * // show the last sheet
+   * fWorkSheets[fWorkSheets.length - 1].showSheet();
+   * ```
+   */
+  showSheet() {
+    return this._injector.get(l).executeCommand(kt.id, {
+      unitId: this._workbook.getUnitId(),
+      subUnitId: this._worksheet.getSheetId()
+    });
+  }
+  /**
+   * Returns true if the sheet is currently hidden.
+   * @returns {boolean} True if the sheet is hidden; otherwise, false.
+   */
+  isSheetHidden() {
+    return this._worksheet.isSheetHidden() === u.TRUE;
+  }
+  /**
+   * Sets the sheet name.
+   * @param {string} name The new name for the sheet.
+   * @returns {Promise<boolean>} True if the command was successful, false otherwise.
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * // set the sheet name to 'Sheet1'
+   * fWorkSheet.setName('Sheet1');
+   * ```
+   */
+  setName(e) {
+    return this._commandService.executeCommand(St.id, {
+      unitId: this._workbook.getUnitId(),
+      subUnitId: this._worksheet.getSheetId(),
+      name: e
+    });
+  }
+  /**
+   * Activates this sheet. Does not alter the sheet itself, only the parent's notion of the active sheet.
+   * @returns Current sheet, for chaining.
+   */
+  activate() {
+    return this._fWorkbook.setActiveSheet(this), this;
+  }
+  /**
+   * Gets the position of the sheet in its parent spreadsheet. Starts at 0.
+   * @returns {number} The position of the sheet in its parent spreadsheet.
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * // get the position of the active sheet
+   * const position = fWorkSheet.getIndex();
+   * console.log(position); // 0
+   * ```
+   */
+  getIndex() {
+    return this._workbook.getSheetIndex(this._worksheet);
+  }
+  /**
+   * Clears the sheet of content and formatting information.Or Optionally clears only the contents or only the formatting.
+   * @param {IFacadeClearOptions} [options] Options for clearing the sheet. If not provided, the contents and formatting are cleared both.
+   * @param {boolean} [options.contentsOnly] If true, the contents of the sheet are cleared. If false, the contents and formatting are cleared. Default is false.
+   * @param {boolean} [options.formatOnly] If true, the formatting of the sheet is cleared. If false, the contents and formatting are cleared. Default is false.
+   * @returns  {Promise<boolean>} True if the command was successful, false otherwise.
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * // clear the sheet of content and formatting information
+   * fWorkSheet.clear();
+   * // clear the sheet of content only
+   * fWorkSheet.clear({ contentsOnly: true });
+   * ```
+   */
+  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 = {
+      startRow: 0,
+      endRow: this._worksheet.getRowCount() - 1,
+      startColumn: 0,
+      endColumn: this._worksheet.getColumnCount() - 1
+    };
+    return s.executeCommand(Ct.id, {
+      unitId: t,
+      subUnitId: n,
+      ranges: [r],
+      options: e
+    });
+  }
+  /**
+   * Clears the sheet of contents, while preserving formatting information.
+   * @returns {Promise<boolean>} True if the command was successful, false otherwise.
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * // clear the sheet of content only
+   * fWorkSheet.clearContents();
+   * ```
+   */
+  clearContents() {
+    const e = this._workbook.getUnitId(), t = this._worksheet.getSheetId(), n = this._injector.get(l), s = {
+      startRow: 0,
+      endRow: this._worksheet.getRowCount() - 1,
+      startColumn: 0,
+      endColumn: this._worksheet.getColumnCount() - 1
+    };
+    return n.executeCommand(It.id, {
+      unitId: e,
+      subUnitId: t,
+      ranges: [s]
+    });
+  }
+  /**
+   * Clears the sheet of formatting, while preserving contents.
+   * @returns {Promise<boolean>} True if the command was successful, false otherwise.
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * // clear the sheet of formatting only
+   * fWorkSheet.clearFormats();
+   * ```
+   */
+  clearFormats() {
+    const e = this._workbook.getUnitId(), t = this._worksheet.getSheetId(), n = this._injector.get(l), s = {
+      startRow: 0,
+      endRow: this._worksheet.getRowCount() - 1,
+      startColumn: 0,
+      endColumn: this._worksheet.getColumnCount() - 1
+    };
+    return n.executeCommand(ft.id, {
+      unitId: e,
+      subUnitId: t,
+      ranges: [s]
+    });
+  }
+  /**
+   * Returns a Range corresponding to the dimensions in which data is present.
+   * This is functionally equivalent to creating a Range bounded by A1 and (Sheet.getLastColumns(), Sheet.getLastRows()).
+   * @returns {FRange} The range of the data in the sheet.
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * // the sheet is a empty sheet
+   * const cellRange = fWorkSheet.getRange(200, 10, 1, 1);
+   * cellRange.setValue('Hello World');
+   * console.log(fWorkSheet.getDataRange().getA1Notation()); // A1:J200
+   * ```
+   */
+  getDataRange() {
+    const e = this.getLastRows(), t = this.getLastColumns();
+    return this.getRange(0, 0, e + 1, t + 1);
+  }
+  /**
+   * Returns the position of the last column that has content.
+   * @returns {number} the last column of the sheet that contains content.
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * const fRange = fWorkSheet.getRange(100, 20, 1, 1);
+   * console.log(fWorkSheet.getLastColumns()); // 20
+   * ```
+   */
+  getLastColumns() {
+    return this._worksheet.getLastColumnWithContent();
+  }
+  /**
+   * 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
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * const fRange = fWorkSheet.getRange(100, 20, 1, 1);
+   * console.log(fWorkSheet.getLastColumn());
+   * ```
+   */
+  getLastColumn() {
+    return this._worksheet.getLastColumnWithContent();
+  }
+  /**
+   * Returns the position of the last row that has content.
+   * @returns {number} the last row of the sheet that contains content.
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * const fRange = fWorkSheet.getRange(100,1,1,1);
+   * fRange.setValue('Hello World');
+   * console.log(fWorkSheet.getLastRows()); // 100
+   */
+  getLastRows() {
+    return this._worksheet.getLastRowWithContent();
+  }
+  /**
+   * Returns the position of the last row that has content, same as getLastRows().
+   * @returns {number} the last row of the sheet that contains content.
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * const fRange = fWorkSheet.getRange(100,1,1,1);
+   * fRange.setValue('Hello World');
+   * console.log(fWorkSheet.getLastRow());
+   */
+  getLastRow() {
+    return this._worksheet.getLastRowWithContent();
+  }
+  /**
+   * Judge whether provided FWorksheet is equal to current.
+   * @param {FWorksheet} other the FWorksheet to compare with.
+   * @returns {boolean} true if the FWorksheet is equal to the current FWorksheet, false otherwise.
+   * @example
+   * ```ts
+   * const fWorkbook = univerAPI.getActiveWorkbook();
+   * const fWorkSheet = fWorkbook.getActiveSheet();
+   * const fWorkSheet2 = fWorkbook.getSheetByName('Sheet1');
+   * console.log(fWorkSheet.equals(fWorkSheet2)); // true, if the active sheet is 'Sheet1'
+   * ```
+   */
+  equalTo(e) {
+    return e instanceof _ ? this._worksheet.getSheetId() === e.getSheetId() && this._workbook.getUnitId() === e.getWorkbook().getUnitId() : !1;
+  }
+  /*
+  * Insert a defined name for worksheet.
+   * @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
+   * @example
+   * ```ts
+   * // The code below inserts a defined name
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const sheet1 = activeSpreadsheet.getSheetByName('Sheet1');
+   * sheet1.insertDefinedName('MyDefinedName', 'Sheet1!A1');
+   * ```
+   */
+  insertDefinedName(e, t) {
+    const s = this._injector.createInstance(A).setName(e).setRef(t).build();
+    s.localSheetId = this.getSheetId(), this._fWorkbook.insertDefinedNameBuilder(s);
+  }
+  /**
+   * Get all the defined names in the worksheet.
+   * @returns {FDefinedName[]} All the defined names in the worksheet
+   * @example
+   * ```ts
+   * // The code below gets all the defined names in the worksheet
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const sheet1 = activeSpreadsheet.getSheetByName('Sheet1');
+   * const definedNames = sheet1.getDefinedNames();
+   * ```
+   */
+  getDefinedNames() {
+    return this._fWorkbook.getDefinedNames().filter((t) => t.getLocalSheetId() === this.getSheetId());
+  }
 };
-g = Ct([
-  j(3, u(R)),
-  j(4, u(ue)),
-  j(5, v)
-], g);
-var It = Object.defineProperty, vt = Object.getOwnPropertyDescriptor, Rt = (n, e, t, o) => {
-  for (var s = o > 1 ? void 0 : o ? vt(e, t) : e, r = n.length - 1, i; r >= 0; r--)
-    (i = n[r]) && (s = (o ? i(e, t, s) : i(s)) || s);
-  return o && s && It(e, t, s), s;
-}, k = (n, e) => (t, o) => e(t, o, n);
-let U = class extends b {
-  constructor(e, t, o, s, r, i, a, h) {
+_ = Gt([
+  M(3, m(v)),
+  M(4, m(Ne)),
+  M(5, m(Ce)),
+  M(6, l)
+], _);
+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;
+}, k = (o, e) => (t, n) => e(t, n, o);
+let I = class extends p {
+  constructor(e, t, n, s, r, i, a, h, c, d) {
     super();
-    E(this, "id");
-    this._workbook = e, this._injector = t, this._resourceLoaderService = o, this._selectionManagerService = s, this._univerInstanceService = r, this._commandService = i, this._permissionService = a, this._logService = h, this.id = this._workbook.getUnitId();
+    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();
   }
+  /**
+   * Get the id of the workbook.
+   * @returns {string} The id of the workbook.
+   * @example
+   * ```ts
+   * // The code below gets the id of the workbook
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const id = activeSpreadsheet.getId();
+   * ```
+   */
   getId() {
     return this.id;
   }
+  /**
+   * Get the name of the workbook.
+   * @returns {string} The name of the workbook.
+   * @example
+   * ```ts
+   * // The code below gets the name of the workbook
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const name = activeSpreadsheet.getName();
+   * ```
+   */
   getName() {
-    return this._workbook.getName();
+    return this._workbook.name;
+  }
+  /**
+   * Set the name of the workbook.
+   * @param {string} name The new name of the workbook.
+   * @example
+   * ```ts
+   * // The code below sets the name of the workbook
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * activeSpreadsheet.setName('MyWorkbook');
+   * ```
+   */
+  setName(e) {
+    this._workbook.setName(e);
   }
   /**
    * save workbook snapshot data, including conditional formatting, data validation, and other plugin data.
+   * @return Workbook snapshot data
+   * @example
+   * ```ts
+   * // The code below saves the workbook snapshot data
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const snapshot = activeSpreadsheet.save();
+   * ```
    */
   save() {
     return this._resourceLoaderService.saveUnit(this._workbook.getUnitId());
   }
   /**
    * @deprecated use 'save' instead.
-   * @return {*}  {IWorkbookData}
+   * @return {*}  {IWorkbookData} Workbook snapshot data
    * @memberof FWorkbook
    */
   getSnapshot() {
@@ -1614,17 +2718,29 @@ let U = class extends b {
   /**
    * Get the active sheet of the workbook.
    * @returns The active sheet of the workbook
+   * @example
+   * ```ts
+   * // The code below gets the active sheet of the workbook
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const activeSheet = activeSpreadsheet.getActiveSheet();
+   * ```
    */
   getActiveSheet() {
     const e = this._workbook.getActiveSheet();
-    return this._injector.createInstance(g, this, this._workbook, e);
+    return this._injector.createInstance(_, this, this._workbook, e);
   }
   /**
    * Gets all the worksheets in this workbook
    * @returns An array of all the worksheets in the workbook
+   * @example
+   * ```ts
+   * // The code below gets all the worksheets in the workbook
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const sheets = activeSpreadsheet.getSheets();
+   * ```
    */
   getSheets() {
-    return this._workbook.getSheets().map((e) => this._injector.createInstance(g, this, this._workbook, e));
+    return this._workbook.getSheets().map((e) => this._injector.createInstance(_, this, this._workbook, e));
   }
   /**
    * Create a new worksheet and returns a handle to it.
@@ -1632,47 +2748,72 @@ let U = class extends b {
    * @param rows How may rows would the new sheet have
    * @param column How many columns would the new sheet have
    * @returns The new created sheet
-   */
-  create(e, t, o) {
-    const s = ve({});
-    s.rowCount = t, s.columnCount = o, s.name = e, s.id = e.toLowerCase().replace(/ /g, "-"), this._commandService.syncExecuteCommand(re.id, {
+   * @example
+   * ```ts
+   * // The code below creates a new sheet
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const newSheet = activeSpreadsheet.create('MyNewSheet', 10, 10);
+   * ```
+   */
+  create(e, t, n) {
+    const s = Fe({});
+    s.rowCount = t, s.columnCount = n, s.name = e, s.id = e.toLowerCase().replace(/ /g, "-"), this._commandService.syncExecuteCommand(z.id, {
       unitId: this.id,
       index: this._workbook.getSheets().length,
       sheet: s
-    }), this._commandService.syncExecuteCommand(F.id, {
+    }), this._commandService.syncExecuteCommand(V.id, {
       unitId: this.id,
       subUnitId: this._workbook.getSheets()[this._workbook.getSheets().length - 1].getSheetId()
     });
     const r = this._workbook.getActiveSheet();
     if (!r)
       throw new Error("No active sheet found");
-    return this._injector.createInstance(g, this, this._workbook, r);
+    return this._injector.createInstance(_, this, this._workbook, r);
   }
   /**
    * Get a worksheet by sheet id.
    * @param sheetId The id of the sheet to get.
    * @return The worksheet with given sheet id
+   * @example
+   * ```ts
+   * // The code below gets a worksheet by sheet id
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const sheet = activeSpreadsheet.getSheetBySheetId('sheetId');
+   * ```
    */
   getSheetBySheetId(e) {
     const t = this._workbook.getSheetBySheetId(e);
-    return t ? this._injector.createInstance(g, this, this._workbook, t) : null;
+    return t ? this._injector.createInstance(_, this, this._workbook, t) : null;
   }
   /**
    * Get a worksheet by sheet name.
    * @param name The name of the sheet to get.
    * @returns The worksheet with given sheet name
+   * @example
+   * ```ts
+   * // The code below gets a worksheet by sheet name
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const sheet = activeSpreadsheet.getSheetByName('Sheet1');
+   * ```
    */
   getSheetByName(e) {
     const t = this._workbook.getSheetBySheetName(e);
-    return t ? this._injector.createInstance(g, this, this._workbook, t) : null;
+    return t ? this._injector.createInstance(_, this, this._workbook, t) : null;
   }
   /**
    * Sets the given worksheet to be the active worksheet in the workbook.
    * @param sheet The worksheet to set as the active worksheet.
    * @returns The active worksheet
+   * @example
+   * ```ts
+   * // The code below sets the given worksheet to be the active worksheet
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const sheet = activeSpreadsheet.getSheetByName('Sheet1');
+   * activeSpreadsheet.setActiveSheet(sheet);
+   * ```
    */
   setActiveSheet(e) {
-    return this._commandService.syncExecuteCommand(F.id, {
+    return this._commandService.syncExecuteCommand(V.id, {
       unitId: this.id,
       subUnitId: e.getSheetId()
     }), e;
@@ -1680,64 +2821,138 @@ let U = class extends b {
   /**
    * Inserts a new worksheet into the workbook.
    * Using a default sheet name. The new sheet becomes the active sheet
+   * @param sheetName - (optional) The name of the new sheet
    * @returns The new sheet
-   */
-  insertSheet() {
-    this._commandService.syncExecuteCommand(re.id);
-    const e = this.id, t = this._workbook.getSheets()[this._workbook.getSheets().length - 1].getSheetId();
-    this._commandService.syncExecuteCommand(F.id, {
-      unitId: e,
-      subUnitId: t
+   * @example
+   * ```ts
+   * // The code below inserts a new sheet into the workbook
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * activeSpreadsheet.insertSheet();
+   *
+   * // The code below inserts a new sheet into the workbook, using a custom name
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * activeSpreadsheet.insertSheet('MyNewSheet');
+   * ```
+   */
+  insertSheet(e) {
+    e != null ? this._commandService.syncExecuteCommand(z.id, { sheet: { name: e } }) : this._commandService.syncExecuteCommand(z.id);
+    const t = this.id, n = this._workbook.getSheets()[this._workbook.getSheets().length - 1].getSheetId();
+    this._commandService.syncExecuteCommand(V.id, {
+      unitId: t,
+      subUnitId: n
     });
-    const o = this._workbook.getActiveSheet();
-    if (!o)
+    const s = this._workbook.getActiveSheet();
+    if (!s)
       throw new Error("No active sheet found");
-    return this._injector.createInstance(g, this, this._workbook, o);
+    return this._injector.createInstance(_, this, this._workbook, s);
   }
   /**
    * Deletes the specified worksheet.
    * @param sheet The worksheet to delete.
+   * @example
+   * ```ts
+   * // The code below deletes the specified worksheet
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const sheet = activeSpreadsheet.getSheetByName('Sheet1');
+   * activeSpreadsheet.deleteSheet(sheet);
+   * ```
    */
   deleteSheet(e) {
-    const t = this.id, o = e.getSheetId();
-    this._commandService.executeCommand(Qe.id, {
+    const t = this.id, n = e.getSheetId();
+    return this._commandService.executeCommand(vt.id, {
       unitId: t,
-      subUnitId: o
+      subUnitId: n
     });
   }
   // #region editing
+  /**
+   * Undo the last action.
+   * @returns A promise that resolves to true if the undo was successful, false otherwise.
+   * @example
+   * ```ts
+   * // The code below undoes the last action
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * activeSpreadsheet.undo();
+   * ```
+   */
   undo() {
-    return this._univerInstanceService.focusUnit(this.id), this._commandService.executeCommand(Re.id);
+    return this._univerInstanceService.focusUnit(this.id), this._commandService.executeCommand(Ae.id);
   }
+  /**
+   * Redo the last undone action.
+   * @returns A promise that resolves to true if the redo was successful, false otherwise.
+   * @example
+   * ```ts
+   * // The code below redoes the last undone action
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * activeSpreadsheet.redo();
+   * ```
+   */
   redo() {
-    return this._univerInstanceService.focusUnit(this.id), this._commandService.executeCommand(fe.id);
+    return this._univerInstanceService.focusUnit(this.id), this._commandService.executeCommand(Te.id);
   }
+  /**
+   * Callback for command execution.
+   * @callback onBeforeCommandExecuteCallback
+   * @param {ICommandInfo<ISheetCommandSharedParams>} command The command that was executed.
+   */
   /**
    * Register a callback that will be triggered before invoking a command targeting the Univer sheet.
-   * @param callback the callback.
+   * @param {onBeforeCommandExecuteCallback} callback the callback.
    * @returns A function to dispose the listening.
+   * @example
+   * ```ts
+   * // The code below registers a callback that will be triggered before invoking a command targeting the Univer sheet
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * activeSpreadsheet.onBeforeCommandExecute((command) => {
+   *    console.log('Command executed:', command);
+   * });
+   * ```
    */
   onBeforeCommandExecute(e) {
     return this._commandService.beforeCommandExecuted((t) => {
-      var o;
-      ((o = t.params) == null ? void 0 : o.unitId) === this.id && e(t);
+      var n;
+      ((n = t.params) == null ? void 0 : n.unitId) === this.id && e(t);
     });
   }
+  /**
+   * Callback for command execution.
+   * @callback onCommandExecutedCallback
+   * @param {ICommandInfo<ISheetCommandSharedParams>} command The command that was executed
+   */
   /**
    * Register a callback that will be triggered when a command is invoked targeting the Univer sheet.
-   * @param callback the callback.
+   * @param {onCommandExecutedCallback} callback the callback.
    * @returns A function to dispose the listening.
+   * @example
+   * ```ts
+   * // The code below registers a callback that will be triggered when a command is invoked targeting the Univer sheet
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * activeSpreadsheet.onCommandExecuted((command) => {
+   *   console.log('Command executed:', command);
+   * });
    */
   onCommandExecuted(e) {
     return this._commandService.onCommandExecuted((t) => {
-      var o;
-      ((o = t.params) == null ? void 0 : o.unitId) === this.id && e(t);
+      var n;
+      ((n = t.params) == null ? void 0 : n.unitId) === this.id && e(t);
     });
   }
+  /**
+   * Callback for selection changes.
+   *
+   * @callback onSelectionChangeCallback
+   * @param {IRange[]} selections The new selection.
+   */
+  /**
+   * Register a callback that will be triggered when the selection changes.
+   * @param {onSelectionChangeCallback} callback The callback.
+   * @returns A function to dispose the listening
+   */
   onSelectionChange(e) {
-    return be(
+    return Ie(
       this._selectionManagerService.selectionMoveEnd$.subscribe((t) => {
-        this._univerInstanceService.getCurrentUnitForType(O.UNIVER_SHEET).getUnitId() === this.id && (t != null && t.length ? e(t.map((o) => o.range)) : e([]));
+        this._univerInstanceService.getCurrentUnitForType(U.UNIVER_SHEET).getUnitId() === this.id && (t != null && t.length ? e(t.map((n) => n.range)) : e([]));
       })
     );
   }
@@ -1746,7 +2961,7 @@ let U = class extends b {
    * @param {boolean} value  editable value want to set
    */
   setEditable(e) {
-    const t = new de(this._workbook.getUnitId());
+    const t = new ye(this._workbook.getUnitId());
     this._permissionService.getPermissionPoint(t.id) || this._permissionService.addPermissionPoint(t), this._permissionService.updatePermissionPoint(t.id, e);
   }
   /**
@@ -1754,67 +2969,314 @@ let U = class extends b {
    * @param range The range to set as the active selection.
    */
   setActiveRange(e) {
-    const t = this.getActiveSheet(), o = e.getRange().sheetId || t.getSheetId(), s = o ? this._workbook.getSheetBySheetId(o) : this._workbook.getActiveSheet(!0);
+    const t = this.getActiveSheet(), n = e.getRange().sheetId || t.getSheetId(), s = n ? this._workbook.getSheetBySheetId(n) : this._workbook.getActiveSheet(!0);
     if (!s)
       throw new Error("No active sheet found");
-    s.getSheetId() !== t.getSheetId() && this.setActiveSheet(this._injector.createInstance(g, this, this._workbook, s));
+    s.getSheetId() !== t.getSheetId() && this.setActiveSheet(this._injector.createInstance(_, this, this._workbook, s));
     const r = {
       unitId: this.getId(),
-      subUnitId: o,
-      selections: [e].map((i) => ({ range: i.getRange(), primary: Xe(i.getRange(), s), style: null }))
+      subUnitId: n,
+      selections: [e].map((i) => ({ range: i.getRange(), primary: Y(i.getRange(), s), style: null }))
     };
-    this._commandService.syncExecuteCommand(Ze.id, r);
+    this._commandService.syncExecuteCommand(Ue.id, r);
   }
   /**
    * Returns the selected range in the active sheet, or null if there is no active range.
    * @returns the active range
    */
   getActiveRange() {
-    const e = this._workbook.getActiveSheet(), o = this._selectionManagerService.getCurrentSelections().find((s) => !!s.primary);
-    return o ? this._injector.createInstance(S, this._workbook, e, o.range) : null;
+    const e = this._workbook.getActiveSheet(), n = this._selectionManagerService.getCurrentSelections().find((s) => !!s.primary);
+    return n ? this._injector.createInstance(S, this._workbook, e, n.range) : null;
+  }
+  /**
+   * Deletes the currently active sheet.
+   * @example
+   * ```ts
+   * // The code below deletes the currently active sheet and stores the new active
+   * // sheet in a variable
+   * const sheet = univerAPI.getActiveWorkbook().deleteActiveSheet();
+   * ```
+   */
+  deleteActiveSheet() {
+    const e = this.getActiveSheet();
+    return this.deleteSheet(e);
+  }
+  /**
+   * Duplicates the given worksheet.
+   * @param {FWorksheet} sheet The worksheet to duplicate.
+   * @returns {Promise<boolean>} true if the sheet was duplicated, false otherwise
+   * @example
+   * ```ts
+   * // The code below duplicates the given worksheet
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const activeSheet = activeSpreadsheet.getActiveSheet();
+   * activeSpreadsheet.duplicateSheet(activeSheet);
+   * ```
+   */
+  duplicateSheet(e) {
+    return this._commandService.executeCommand(Rt.id, {
+      unitId: e.getWorkbook().getUnitId(),
+      subUnitId: e.getSheetId()
+    });
+  }
+  /**
+   * Duplicates the active sheet.
+   * @returns {Promise<boolean>} true if the sheet was duplicated, false otherwise
+   * @example
+   * ```ts
+   * // The code below duplicates the active sheet
+   *  const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   *  activeSpreadsheet.duplicateActiveSheet();
+   * ```
+   */
+  duplicateActiveSheet() {
+    const e = this.getActiveSheet();
+    return this.duplicateSheet(e);
+  }
+  /**
+   * Get the number of sheets in the workbook.
+   * @returns The number of sheets in the workbook
+   * @example
+   * ```ts
+   * // The code below gets the number of sheets in the workbook
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const numSheets = activeSpreadsheet.getNumSheets();
+   * ```
+   */
+  getNumSheets() {
+    return this._workbook.getSheets().length;
+  }
+  /**
+   * Get the locale of the workbook.
+   * @returns {LocaleType} The locale of the workbook
+   * @example
+   * ```ts
+   * // The code below gets the locale of the workbook
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const locale = activeSpreadsheet.getLocale();
+   * ```
+   */
+  getLocale() {
+    return this._localeService.getCurrentLocale();
+  }
+  /**
+   * Set the locale of the workbook.
+   * @param {LocaleType} locale The locale to set
+   * @example
+   * ```ts
+   * // The code below sets the locale of the workbook
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * activeSpreadsheet.setLocale(LocaleType.EN_US);
+   * ```
+   */
+  setLocale(e) {
+    this._localeService.setLocale(e);
+  }
+  /**
+   * Get the URL of the workbook.
+   * @returns {string} The URL of the workbook
+   * @example
+   * ```ts
+   * // The code below gets the URL of the workbook
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const url = activeSpreadsheet.getUrl();
+   * ```
+   */
+  getUrl() {
+    return location.href;
+  }
+  /**
+   * Move the sheet to the specified index.
+   * @param {FWorksheet} sheet The sheet to move
+   * @param {number} index The index to move the sheet to
+   * @returns {Promise<boolean>} true if the sheet was moved, false otherwise
+   * @example
+   * ```ts
+   * // The code below moves the sheet to the specified index
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const sheet = activeSpreadsheet.getActiveSheet();
+   * activeSpreadsheet.moveSheet(sheet, 1);
+   * ```
+   */
+  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.executeCommand(bt.id, {
+      unitId: e.getWorkbook().getUnitId(),
+      order: n,
+      subUnitId: e.getSheetId()
+    });
+  }
+  /**
+   * Move the active sheet to the specified index.
+   * @param {number} index The index to move the active sheet to
+   * @returns {Promise<boolean>} true if the sheet was moved, false otherwise
+   * @example
+   * ```ts
+   * // The code below moves the active sheet to the specified index
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * activeSpreadsheet.moveActiveSheet(1);
+   * ```
+   */
+  moveActiveSheet(e) {
+    const t = this.getActiveSheet();
+    return this.moveSheet(t, e);
+  }
+  /**
+   * Get the PermissionInstance.
+   *
+   * @returns {FPermission} - The PermissionInstance.
+   */
+  getPermission() {
+    return this._injector.createInstance(O);
+  }
+  /**
+   * Get the defined name by name.
+   * @param {string} name The name of the defined name to get
+   * @returns {FDefinedName | null} The defined name with the given name
+   * @example
+   * ```ts
+   * // The code below gets the defined name by name
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const definedName = activeSpreadsheet.getDefinedName('MyDefinedName');
+   * ```
+   */
+  getDefinedName(e) {
+    const t = this._definedNamesService.getValueByName(this.id, e);
+    return t ? this._injector.createInstance(W, { ...t, unitId: this.id }) : null;
+  }
+  /**
+   * Get all the defined names in the workbook.
+   * @returns {FDefinedName[]} All the defined names in the workbook
+   * @example
+   * ```ts
+   * // The code below gets all the defined names in the workbook
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const definedNames = activeSpreadsheet.getDefinedNames();
+   * ```
+   */
+  getDefinedNames() {
+    const e = this._definedNamesService.getDefinedNameMap(this.id);
+    return e ? Object.values(e).map((t) => this._injector.createInstance(W, { ...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
+   * @example
+   * ```ts
+   * // The code below inserts a defined name
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * activeSpreadsheet.insertDefinedName('MyDefinedName', 'Sheet1!A1');
+   * ```
+   */
+  insertDefinedName(e, t) {
+    const s = this._injector.createInstance(A).setName(e).setRef(t).build();
+    s.localSheetId = K, this.insertDefinedNameBuilder(s);
+  }
+  /**
+   * Delete the defined name with the given name.
+   * @param {string} name The name of the defined name to delete
+   * @returns {boolean} true if the defined name was deleted, false otherwise
+   * @example
+   * ```ts
+   * // The code below deletes the defined name with the given name
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const deleted = activeSpreadsheet.deleteDefinedName('MyDefinedName');
+   * ```
+   */
+  deleteDefinedName(e) {
+    const t = this.getDefinedName(e);
+    return t ? (t.delete(), !0) : !1;
+  }
+  /**
+   * insert a defined name by builder param
+   * @param {ISetDefinedNameMutationParam} param The param to insert the defined name
+   * @example
+   * ```ts
+   * // The code below inserts a defined name by builder param
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const builder = univerAPI.newDefinedName();
+   * const param = builder.setName('MyDefinedName').setRef('Sheet1!A1').build();
+   * activeSpreadsheet.insertDefinedNameBuilder(param);
+   * ```
+   */
+  insertDefinedNameBuilder(e) {
+    e.unitId = this.getId(), this._commandService.syncExecuteCommand(q.id, e);
+  }
+  /**
+   * Update the defined name with the given name.
+   * @param {ISetDefinedNameMutationParam} param The param to insert the defined name
+   * @example
+   * ```ts
+   * // The code below updates the defined name with the given name
+   * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+   * const builder = activeSpreadsheet.getDefinedName('MyDefinedName').toBuilder();
+   * builder.setRef('Sheet1!A2').setName('MyDefinedName1').build();
+   * activeSpreadsheet.updateDefinedNameBuilder(param);
+   *
+   * ```
+   */
+  updateDefinedNameBuilder(e) {
+    this._commandService.syncExecuteCommand(q.id, e);
   }
 };
-U = Rt([
-  k(1, u(R)),
-  k(2, u(Ie)),
-  k(3, u(ue)),
-  k(4, he),
-  k(5, v),
-  k(6, ae),
-  k(7, pe)
-], U);
-class ft extends ce {
+I = Yt([
+  k(1, m(v)),
+  k(2, m(Oe)),
+  k(3, m(Ne)),
+  k(4, fe),
+  k(5, l),
+  k(6, Q),
+  k(7, Ce),
+  k(8, m(ke)),
+  k(9, Re)
+], I);
+class Jt extends ve {
   createUniverSheet(e) {
-    const o = this._injector.get(he).createUnit(O.UNIVER_SHEET, e);
-    return this._injector.createInstance(U, o);
+    const n = this._injector.get(fe).createUnit(U.UNIVER_SHEET, e);
+    return this._injector.createInstance(I, n);
   }
   getActiveWorkbook() {
-    const e = this._univerInstanceService.getCurrentUnitForType(O.UNIVER_SHEET);
-    return e ? this._injector.createInstance(U, e) : null;
+    const e = this._univerInstanceService.getCurrentUnitForType(U.UNIVER_SHEET);
+    return e ? this._injector.createInstance(I, e) : null;
+  }
+  getUniverSheet(e) {
+    const t = this._univerInstanceService.getUnit(e, U.UNIVER_SHEET);
+    return t ? this._injector.createInstance(I, t) : null;
   }
   getPermission() {
-    return this._injector.createInstance(V);
+    return this._injector.createInstance(O);
+  }
+  onUniverSheetCreated(e) {
+    const t = this._univerInstanceService.getTypeOfUnitAdded$(U.UNIVER_SHEET).subscribe((n) => {
+      const s = this._injector.createInstance(I, n);
+      e(s);
+    });
+    return Ie(t);
+  }
+  newDefinedName() {
+    return this._injector.createInstance(A);
   }
 }
-ce.extend(ft);
-var bt = Object.defineProperty, pt = Object.getOwnPropertyDescriptor, yt = (n, e, t, o) => {
-  for (var s = o > 1 ? void 0 : o ? pt(e, t) : e, r = n.length - 1, i; r >= 0; r--)
-    (i = n[r]) && (s = (o ? i(e, t, s) : i(s)) || s);
-  return o && s && bt(e, t, s), s;
-}, Pt = (n, e) => (t, o) => e(t, o, n);
-let ie = class extends b {
-  constructor(n) {
-    super(), this._injector = n;
+ve.extend(Jt);
+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;
+}, en = (o, e) => (t, n) => e(t, n, o);
+let _e = class extends p {
+  constructor(o) {
+    super(), this._injector = o;
   }
 };
-ie = yt([
-  Pt(0, u(R))
-], ie);
+_e = Zt([
+  en(0, m(v))
+], _e);
 export {
-  V as FPermission,
+  O as FPermission,
   S as FRange,
-  L as FSelection,
-  ie as FSheetHooks,
-  U as FWorkbook,
-  g as FWorksheet
+  F as FSelection,
+  _e as FSheetHooks,
+  I as FWorkbook,
+  _ as FWorksheet
 };