@univerjs/sheets 0.5.2 → 0.5.3-experimental.20250106-e3b7a39

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

@@ -1,11 +1,11 @@
-import { CellValue, ICellData, IObjectMatrixPrimitiveType, IRange, IStyleData, Nullable, Workbook, Worksheet, FBase, ICommandService, Injector, WrapStrategy } from '@univerjs/core';
+import { CellValue, ICellData, IObjectMatrixPrimitiveType, IRange, IStyleData, Nullable, Workbook, Worksheet, FBaseInitialable, ICommandService, Injector, WrapStrategy } from '@univerjs/core';
 import { SplitDelimiterEnum } from '@univerjs/sheets';
 import { FHorizontalAlignment, FVerticalAlignment } from './utils';
 import { FormulaDataModel } from '@univerjs/engine-formula';
 export type FontLine = 'none' | 'underline' | 'line-through';
 export type FontStyle = 'normal' | 'italic';
 export type FontWeight = 'normal' | 'bold';
-export declare class FRange extends FBase {
+export declare class FRange extends FBaseInitialable {
     protected readonly _workbook: Workbook;
     protected readonly _worksheet: Worksheet;
     protected readonly _range: IRange;
@@ -15,44 +15,37 @@ export declare class FRange extends FBase {
     constructor(_workbook: Workbook, _worksheet: Worksheet, _range: IRange, _injector: Injector, _commandService: ICommandService, _formulaDataModel: FormulaDataModel);
     /**
      * Get the unit ID of the current workbook
-     *
-     * @return The unit ID of the workbook
+     * @returns The unit ID of the workbook
      */
     getUnitId(): string;
     /**
      * Gets the name of the worksheet
-     *
-     * @return The name of the worksheet
+     * @returns The name of the worksheet
      */
     getSheetName(): string;
     /**
      * Gets the area where the statement is applied
-     *
-     * @return The area where the statement is applied
+     * @returns The area where the statement is applied
      */
     getRange(): IRange;
     /**
      * Gets the starting row number of the applied area
-     *
-     * @return The starting row number of the area
+     * @returns The starting row number of the area
      */
     getRow(): number;
     /**
      * Gets the starting column number of the applied area
-     *
-     * @return The starting column number of the area
+     * @returns The starting column number of the area
      */
     getColumn(): number;
     /**
      * Gets the width of the applied area
-     *
-     * @return The width of the area
+     * @returns The width of the area
      */
     getWidth(): number;
     /**
      * Gets the height of the applied area
-     *
-     * @return The height of the area
+     * @returns The height of the area
      */
     getHeight(): number;
     /**
@@ -97,46 +90,53 @@ export declare class FRange extends FBase {
     getVerticalAlignment(): string;
     /**
      * Set background color for current range.
+     * @param color {string}
      * @example
-     * ```
+     * ```typescript
      * univerAPI.getActiveWorkbook().getActiveSheet().getActiveRange().setBackgroundColor('red')
      * ```
-     * @param color {string}
      */
-    setBackgroundColor(color: string): Promise<boolean>;
+    setBackgroundColor(color: string): FRange;
     /**
      * Set background color for current range.
-     * e.g. `univerAPI.getActiveWorkbook().getActiveSheet().getActiveRange().setBackground('red')`
+     * @example
+     * ```typescript
+     * univerAPI.getActiveWorkbook().getActiveSheet().getActiveRange().setBackground('red')
+     * ```
      * @param color {string}
      */
-    setBackground(color: string): Promise<boolean>;
+    setBackground(color: string): FRange;
     /**
      * 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(value: CellValue | ICellData): Promise<boolean>;
+    setValue(value: CellValue | ICellData): FRange;
     /**
      * Set the cell wrap of the given range.
      * Cells with wrap enabled (the default) resize to display their full content. Cells with wrap disabled display as much as possible in the cell without resizing or running to multiple lines.
+     * @param isWrapEnabled
      */
-    setWrap(isWrapEnabled: boolean): Promise<boolean>;
+    setWrap(isWrapEnabled: boolean): FRange;
     /**
      * Sets the text wrapping strategy for the cells in the range.
+     * @param strategy
      */
-    setWrapStrategy(strategy: WrapStrategy): Promise<boolean>;
+    setWrapStrategy(strategy: WrapStrategy): FRange;
     /**
      * Set the vertical (top to bottom) alignment for the given range (top/middle/bottom).
+     * @param alignment
      */
-    setVerticalAlignment(alignment: FVerticalAlignment): Promise<boolean>;
+    setVerticalAlignment(alignment: FVerticalAlignment): FRange;
     /**
      * Set the horizontal (left to right) alignment for the given range (left/center/right).
+     * @param alignment
      */
-    setHorizontalAlignment(alignment: FHorizontalAlignment): Promise<boolean>;
+    setHorizontalAlignment(alignment: FHorizontalAlignment): FRange;
     /**
      * 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(value: CellValue[][] | IObjectMatrixPrimitiveType<CellValue> | ICellData[][] | IObjectMatrixPrimitiveType<ICellData>): Promise<boolean>;
+    setValues(value: CellValue[][] | IObjectMatrixPrimitiveType<CellValue> | ICellData[][] | IObjectMatrixPrimitiveType<ICellData>): FRange;
     /**
      * 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.
@@ -154,10 +154,12 @@ export declare class FRange extends FBase {
     setFontLine(fontLine: FontLine | null): this;
     /**
      * Sets the font underline style of the given ITextDecoration
+     * @param value
      */
     private _setFontUnderline;
     /**
      * Sets the font strikethrough style of the given ITextDecoration
+     * @param value
      */
     private _setFontStrikethrough;
     /**
@@ -177,36 +179,80 @@ export declare class FRange extends FBase {
     setFontColor(color: string | null): this;
     /**
      * 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
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const worksheet = workbook.getActiveSheet();
+     * const range = worksheet.getRange(0, 0, 2, 2);
+     * const merge = range.merge();
+     * const isMerged = merge.isMerged();
+     * console.log('debugger', isMerged);
+     * ```
      */
-    merge(defaultMerge?: boolean): Promise<FRange>;
+    merge(defaultMerge?: boolean): FRange;
     /**
      * 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
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const worksheet = workbook.getActiveSheet();
+     * const range = worksheet.getRange(2, 2, 2, 2);
+     * const merge = range.mergeAcross();
+     * const allMerge = worksheet.getMergeData();
+     * console.log(allMerge.length); // There will be two merged cells.
+     * ```
      */
-    mergeAcross(defaultMerge?: boolean): Promise<FRange>;
+    mergeAcross(defaultMerge?: boolean): FRange;
     /**
      * 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
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const worksheet = workbook.getActiveSheet();
+     * const range = worksheet.getRange(4, 4, 2, 2);
+     * const merge = range.mergeVertically();
+     * const allMerge = worksheet.getMergeData();
+     * console.log(allMerge.length); // There will be two merged cells.
+     * ```
      */
-    mergeVertically(defaultMerge?: boolean): Promise<FRange>;
+    mergeVertically(defaultMerge?: boolean): FRange;
     /**
      * Returns true if cells in the current range overlap a merged cell.
      * @returns {boolean} is overlap with a merged cell
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const worksheet = workbook.getActiveSheet();
+     * const range = worksheet.getRange(0,0,2,2);
+     * const merge = range.merge();
+     * const anchor = worksheet.getRange(0,0);
+     * const isPartOfMerge = anchor.isPartOfMerge();
+     * console.log('debugger, isPartOfMerge) // true
+     * ```
      */
     isPartOfMerge(): boolean;
     /**
      * Break all horizontally- or vertically-merged cells contained within the range list into individual cells again.
      * @returns This range, for chaining
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const worksheet = workbook.getActiveSheet();
+     * const range = worksheet.getRange(0,0,2,2);
+     * const merge = range.merge();
+     * const anchor = worksheet.getRange(0,0);
+     * const isPartOfMergeFirst = anchor.isPartOfMerge();
+     * console.log('debugger' isPartOfMergeFirst) // true
+     * range.breakApart();
+     * const isPartOfMergeSecond = anchor.isPartOfMerge();
+     * console.log('debugger' isPartOfMergeSecond) // false
+     * ```
      */
     breakApart(): FRange;
     /**
@@ -227,6 +273,7 @@ export declare class FRange extends FBase {
     forEach(callback: (row: number, col: number, cell: ICellData) => void): void;
     /**
      * Returns a string description of the range, in A1 notation.
+     * @param withSheet
      * @returns {string} The A1 notation of the range.
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -281,4 +328,42 @@ export declare class FRange extends FBase {
      * @returns {void}
      */
     splitTextToColumns(treatMultipleDelimitersAsOne?: boolean, delimiter?: SplitDelimiterEnum): void;
+    /**
+     * Set the theme style for the range.
+     * @param {string|undefined} themeName The name of the theme style to apply.If a undefined value is passed, the theme style will be removed if it exist.
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:E20');
+     * fRange.useThemeStyle('default');
+     * ```
+     */
+    useThemeStyle(themeName: string | undefined): void;
+    /**
+     * Remove the theme style for the range.
+     * @param {string} themeName The name of the theme style to remove.
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:E20');
+     * fRange.removeThemeStyle('default');
+     * ```
+     */
+    removeThemeStyle(themeName: string): void;
+    /**
+     * Gets the theme style applied to the range.
+     * @returns {string | undefined} The name of the theme style applied to the range or not exist.
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:E20');
+     * fRange.useThemeStyle('default');
+     * const themeStyle = fRange.getUsedThemeStyle();
+     * console.log(themeStyle); // 'default'
+     * ```
+     */
+    getUsedThemeStyle(): string | undefined;
 }

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

@@ -61,7 +61,7 @@ export declare class FSelection {
      * console.log(newSelection.getActiveRange().getA1Notation()); // A1
      * ```
      */
-    updatePrimaryCell(cell: FRange): Promise<FSelection>;
+    updatePrimaryCell(cell: FRange): FSelection;
     /**
      *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).

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

@@ -1,4 +1,4 @@
-import { IDisposable, IWorkbookData, FUniver } from '@univerjs/core';
+import { IDisposable, Injector, IWorkbookData, FUniver } from '@univerjs/core';
 import { FDefinedNameBuilder } from './f-defined-name';
 import { FPermission } from './f-permission';
 import { FWorkbook } from './f-workbook';
@@ -8,12 +8,23 @@ export interface IFUniverSheetsMixin {
      *
      * @param {Partial<IWorkbookData>} data The snapshot of the spreadsheet.
      * @returns {FWorkbook} FWorkbook API instance.
+     * @example
+     * ```ts
+     * univerAPI.createUniverSheet({ id: 'Sheet1', name: 'Sheet1' });
+     * ```
      */
     createUniverSheet(data: Partial<IWorkbookData>): FWorkbook;
     /**
      * Get the currently focused Univer spreadsheet.
-     *
      * @returns {FWorkbook | null} The currently focused Univer spreadsheet.
+     * @example
+     * ```ts
+     * univerAPI.getActiveUniverSheet();
+     * ```
+     */
+    getActiveUniverSheet(): FWorkbook | null;
+    /**
+     * @deprecated use `getActiveUniverSheet` as instead.
      */
     getActiveWorkbook(): FWorkbook | null;
     /**
@@ -25,23 +36,28 @@ export interface IFUniverSheetsMixin {
     getUniverSheet(id: string): FWorkbook | null;
     /**
      * Get the PermissionInstance.
-     * @deprecated This function is deprecated and will be removed in version 0.6.0.
-     *             Please use the function with the same name on the `FWorkbook` instance instead.
-     * @returns {FPermission} - The PermissionInstance.
+     * @deprecated This function is deprecated and will be removed in version 0.6.0. Please use the function with the same name on the `FWorkbook` instance instead.
      */
     getPermission(): FPermission;
     /**
-     * Register a callback that will be triggered when a Univer Sheet is created.
+     * @deprecated Use `univerAPI.addEvent(univerAPI.Event.UnitCreated, () => {})`
      */
     onUniverSheetCreated(callback: (workbook: FWorkbook) => void): IDisposable;
     /**
      * Create a new defined name builder.
      * @returns {FDefinedNameBuilder} - The defined name builder.
+     *
+     * @example
+     * ```ts
+     * univerAPI.newDefinedName();
+     * ```
      */
     newDefinedName(): FDefinedNameBuilder;
 }
 export declare class FUniverSheetsMixin extends FUniver implements IFUniverSheetsMixin {
+    _initialize(injector: Injector): void;
     createUniverSheet(data: Partial<IWorkbookData>): FWorkbook;
+    getActiveUniverSheet(): FWorkbook | null;
     getActiveWorkbook(): FWorkbook | null;
     getUniverSheet(id: string): FWorkbook | null;
     getPermission(): FPermission;

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

@@ -1,11 +1,11 @@
-import { CommandListener, IDisposable, IRange, IWorkbookData, LocaleType, Workbook, FBase, ICommandService, ILogService, Injector, IPermissionService, IResourceLoaderService, IUniverInstanceService, LocaleService } from '@univerjs/core';
+import { CommandListener, IDisposable, IRange, IWorkbookData, LocaleType, Workbook, FBaseInitialable, ICommandService, ILogService, Injector, IPermissionService, IResourceLoaderService, IUniverInstanceService, LocaleService } from '@univerjs/core';
 import { ISetDefinedNameMutationParam, IDefinedNamesService } from '@univerjs/engine-formula';
-import { SheetsSelectionsService } from '@univerjs/sheets';
+import { RangeThemeStyle, SheetsSelectionsService } from '@univerjs/sheets';
 import { FDefinedName } from './f-defined-name';
 import { FPermission } from './f-permission';
 import { FRange } from './f-range';
 import { FWorksheet } from './f-worksheet';
-export declare class FWorkbook extends FBase {
+export declare class FWorkbook extends FBaseInitialable {
     protected readonly _workbook: Workbook;
     protected readonly _injector: Injector;
     protected readonly _resourceLoaderService: IResourceLoaderService;
@@ -52,8 +52,8 @@ export declare class FWorkbook extends FBase {
      */
     setName(name: string): void;
     /**
-     * save workbook snapshot data, including conditional formatting, data validation, and other plugin data.
-     * @return Workbook snapshot data
+     * Save workbook snapshot data, including conditional formatting, data validation, and other plugin data.
+     * @returns {IWorkbookData} Workbook snapshot data
      * @example
      * ```ts
      * // The code below saves the workbook snapshot data
@@ -64,13 +64,13 @@ export declare class FWorkbook extends FBase {
     save(): IWorkbookData;
     /**
      * @deprecated use 'save' instead.
-     * @return {*}  {IWorkbookData} Workbook snapshot data
+     * @returns {*}  {IWorkbookData} Workbook snapshot data
      * @memberof FWorkbook
      */
     getSnapshot(): IWorkbookData;
     /**
      * Get the active sheet of the workbook.
-     * @returns The active sheet of the workbook
+     * @returns {FWorksheet} The active sheet of the workbook
      * @example
      * ```ts
      * // The code below gets the active sheet of the workbook
@@ -81,7 +81,7 @@ export declare class FWorkbook extends FBase {
     getActiveSheet(): FWorksheet;
     /**
      * Gets all the worksheets in this workbook
-     * @returns An array of all the worksheets in the workbook
+     * @returns {FWorksheet[]} An array of all the worksheets in the workbook
      * @example
      * ```ts
      * // The code below gets all the worksheets in the workbook
@@ -107,7 +107,7 @@ export declare class FWorkbook extends FBase {
     /**
      * Get a worksheet by sheet id.
      * @param sheetId The id of the sheet to get.
-     * @return The worksheet with given sheet id
+     * @returns The worksheet with given sheet id
      * @example
      * ```ts
      * // The code below gets a worksheet by sheet id
@@ -161,6 +161,7 @@ export declare class FWorkbook extends FBase {
     /**
      * Deletes the specified worksheet.
      * @param sheet The worksheet to delete.
+     * @returns {boolean} True if the worksheet was deleted, false otherwise.
      * @example
      * ```ts
      * // The code below deletes the specified worksheet
@@ -169,10 +170,10 @@ export declare class FWorkbook extends FBase {
      * activeSpreadsheet.deleteSheet(sheet);
      * ```
      */
-    deleteSheet(sheet: FWorksheet): Promise<boolean>;
+    deleteSheet(sheet: FWorksheet): boolean;
     /**
      * Undo the last action.
-     * @returns A promise that resolves to true if the undo was successful, false otherwise.
+     * @returns {FWorkbook} A promise that resolves to true if the undo was successful, false otherwise.
      * @example
      * ```ts
      * // The code below undoes the last action
@@ -180,7 +181,7 @@ export declare class FWorkbook extends FBase {
      * activeSpreadsheet.undo();
      * ```
      */
-    undo(): Promise<boolean>;
+    undo(): FWorkbook;
     /**
      * Redo the last undone action.
      * @returns A promise that resolves to true if the redo was successful, false otherwise.
@@ -191,7 +192,7 @@ export declare class FWorkbook extends FBase {
      * activeSpreadsheet.redo();
      * ```
      */
-    redo(): Promise<boolean>;
+    redo(): FWorkbook;
     /**
      * Callback for command execution.
      * @callback onBeforeCommandExecuteCallback
@@ -231,7 +232,6 @@ export declare class FWorkbook extends FBase {
     onCommandExecuted(callback: CommandListener): IDisposable;
     /**
      * Callback for selection changes.
-     *
      * @callback onSelectionChangeCallback
      * @param {IRange[]} selections The new selection.
      */
@@ -244,13 +244,15 @@ export declare class FWorkbook extends FBase {
     /**
      * Used to modify the editing permissions of the workbook. When the value is false, editing is not allowed.
      * @param {boolean} value  editable value want to set
+     * @returns {FWorkbook} FWorkbook instance
      */
-    setEditable(value: boolean): void;
+    setEditable(value: boolean): FWorkbook;
     /**
-     * Sets the active selection region for this sheet.
+     * Sets the selection region for active sheet.
      * @param range The range to set as the active selection.
+     * @returns {FWorkbook} FWorkbook instance
      */
-    setActiveRange(range: FRange): void;
+    setActiveRange(range: FRange): FWorkbook;
     /**
      * Returns the selected range in the active sheet, or null if there is no active range.
      * @returns the active range
@@ -258,6 +260,7 @@ export declare class FWorkbook extends FBase {
     getActiveRange(): FRange | null;
     /**
      * Deletes the currently active sheet.
+     * @returns {boolean} true if the sheet was deleted, false otherwise
      * @example
      * ```ts
      * // The code below deletes the currently active sheet and stores the new active
@@ -265,11 +268,11 @@ export declare class FWorkbook extends FBase {
      * const sheet = univerAPI.getActiveWorkbook().deleteActiveSheet();
      * ```
      */
-    deleteActiveSheet(): Promise<boolean>;
+    deleteActiveSheet(): boolean;
     /**
      * Duplicates the given worksheet.
      * @param {FWorksheet} sheet The worksheet to duplicate.
-     * @returns {Promise<boolean>} true if the sheet was duplicated, false otherwise
+     * @returns {FWorksheet} The duplicated worksheet
      * @example
      * ```ts
      * // The code below duplicates the given worksheet
@@ -278,10 +281,10 @@ export declare class FWorkbook extends FBase {
      * activeSpreadsheet.duplicateSheet(activeSheet);
      * ```
      */
-    duplicateSheet(sheet: FWorksheet): Promise<boolean>;
+    duplicateSheet(sheet: FWorksheet): FWorksheet;
     /**
      * Duplicates the active sheet.
-     * @returns {Promise<boolean>} true if the sheet was duplicated, false otherwise
+     * @returns {FWorksheet} The duplicated worksheet
      * @example
      * ```ts
      * // The code below duplicates the active sheet
@@ -289,7 +292,7 @@ export declare class FWorkbook extends FBase {
      *  activeSpreadsheet.duplicateActiveSheet();
      * ```
      */
-    duplicateActiveSheet(): Promise<boolean>;
+    duplicateActiveSheet(): FWorksheet;
     /**
      * Get the number of sheets in the workbook.
      * @returns The number of sheets in the workbook
@@ -312,9 +315,15 @@ export declare class FWorkbook extends FBase {
      * ```
      */
     getLocale(): LocaleType;
+    /**
+     * @deprecated use setSpreadsheetLocale instead.
+     * @param {LocaleType} locale - The locale to set
+     */
+    setLocale(locale: LocaleType): void;
     /**
      * Set the locale of the workbook.
      * @param {LocaleType} locale The locale to set
+     * @returns {FWorkbook} This workbook, for chaining
      * @example
      * ```ts
      * // The code below sets the locale of the workbook
@@ -322,7 +331,7 @@ export declare class FWorkbook extends FBase {
      * activeSpreadsheet.setLocale(LocaleType.EN_US);
      * ```
      */
-    setLocale(locale: LocaleType): void;
+    setSpreadsheetLocale(locale: LocaleType): FWorkbook;
     /**
      * Get the URL of the workbook.
      * @returns {string} The URL of the workbook
@@ -338,7 +347,7 @@ export declare class FWorkbook extends FBase {
      * 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
+     * @returns {FWorkbook} This workbook, for chaining
      * @example
      * ```ts
      * // The code below moves the sheet to the specified index
@@ -347,11 +356,11 @@ export declare class FWorkbook extends FBase {
      * activeSpreadsheet.moveSheet(sheet, 1);
      * ```
      */
-    moveSheet(sheet: FWorksheet, index: number): Promise<boolean>;
+    moveSheet(sheet: FWorksheet, index: number): FWorkbook;
     /**
      * 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
+     * @returns {FWorkbook} This workbook, for chaining
      * @example
      * ```ts
      * // The code below moves the active sheet to the specified index
@@ -359,10 +368,9 @@ export declare class FWorkbook extends FBase {
      * activeSpreadsheet.moveActiveSheet(1);
      * ```
      */
-    moveActiveSheet(index: number): Promise<boolean>;
+    moveActiveSheet(index: number): FWorkbook;
     /**
      * Get the PermissionInstance.
-     *
      * @returns {FPermission} - The PermissionInstance.
      */
     getPermission(): FPermission;
@@ -393,6 +401,7 @@ export declare class FWorkbook extends FBase {
      * Insert a defined name.
      * @param {string} name The name of the defined name to insert
      * @param {string} formulaOrRefString The formula(=sum(A2:b10)) or reference(A1) string of the defined name to insert
+     * @returns {FWorkbook} The current FWorkbook instance
      * @example
      * ```ts
      * // The code below inserts a defined name
@@ -400,7 +409,7 @@ export declare class FWorkbook extends FBase {
      * activeSpreadsheet.insertDefinedName('MyDefinedName', 'Sheet1!A1');
      * ```
      */
-    insertDefinedName(name: string, formulaOrRefString: string): void;
+    insertDefinedName(name: string, formulaOrRefString: string): FWorkbook;
     /**
      * Delete the defined name with the given name.
      * @param {string} name The name of the defined name to delete
@@ -414,7 +423,7 @@ export declare class FWorkbook extends FBase {
      */
     deleteDefinedName(name: string): boolean;
     /**
-     * insert a defined name by builder param
+     * Insert a defined name by builder param.
      * @param {ISetDefinedNameMutationParam} param The param to insert the defined name
      * @example
      * ```ts
@@ -436,8 +445,46 @@ export declare class FWorkbook extends FBase {
      * const builder = activeSpreadsheet.getDefinedName('MyDefinedName').toBuilder();
      * builder.setRef('Sheet1!A2').setName('MyDefinedName1').build();
      * activeSpreadsheet.updateDefinedNameBuilder(param);
-     *
      * ```
      */
     updateDefinedNameBuilder(param: ISetDefinedNameMutationParam): void;
+    /**
+     * Gets the registered range themes.
+     * @returns {string[]} The name list of registered range themes.
+     * @example
+     * ```ts
+     * // The code below gets the registered range themes
+     * const activeSpreadsheet = univerAPI.getActiveWorkbook();
+     * const themes = activeSpreadsheet.getRegisteredRangeThemes();
+     * console.log(themes);
+     * ```
+     */
+    getRegisteredRangeThemes(): string[];
+    /**
+     * Register a custom range theme style.
+     * @param rangeThemeStyle
+     * @example
+     * ```ts
+     * // import {RangeThemeStyle} from '@univerjs/sheets';
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const rangeThemeStyle = new RangeThemeStyle('MyTheme');
+     * rangeThemeStyle.setSecondRowStyle({
+     *    bg: {
+     *       rgb: 'rgb(214,231,241)',
+     *    },
+     * });
+     * fWorkbook.registerRangeTheme(rangeThemeStyle);
+     * ```
+     */
+    registerRangeTheme(rangeThemeStyle: RangeThemeStyle): void;
+    /**
+     * Unregister a custom range theme style.
+     * @param themeName
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * fWorkbook.unregisterRangeTheme('MyTheme');
+     * ```
+     */
+    unregisterRangeTheme(themeName: string): void;
 }