@univerjs/sheets 0.5.2 → 0.5.3

package/lib/types/basics/interfaces/mutation-interface.d.ts

@@ -64,3 +64,10 @@ export interface IAddWorksheetMergeMutationParams {
     subUnitId: string;
     ranges: IRange[];
 }
+/** Params of AddWorksheetMergeMutation */
+export interface IWorksheetRangeThemeStyleMutationParams {
+    unitId: string;
+    subUnitId: string;
+    range: IRange;
+    themeName: string;
+}

package/lib/types/commands/commands/__tests__/range-template-command.sepc.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/lib/types/commands/commands/add-worksheet-merge.command.d.ts

@@ -9,4 +9,4 @@ export declare const AddWorksheetMergeCommand: ICommand;
 export declare const AddWorksheetMergeAllCommand: ICommand;
 export declare const AddWorksheetMergeVerticalCommand: ICommand;
 export declare const AddWorksheetMergeHorizontalCommand: ICommand;
-export declare function addMergeCellsUtil(injector: Injector, unitId: string, subUnitId: string, ranges: IRange[], defaultMerge: boolean): Promise<void>;
+export declare function addMergeCellsUtil(injector: Injector, unitId: string, subUnitId: string, ranges: IRange[], defaultMerge: boolean): void;

package/lib/types/commands/commands/add-worksheet-range-theme.command.d.ts

@@ -0,0 +1,2 @@
+import { ICommand } from '@univerjs/core';
+export declare const SetWorksheetRangeThemeStyleCommand: ICommand;

package/lib/types/commands/commands/delete-worksheet-range-theme.command.d.ts

@@ -0,0 +1,2 @@
+import { ICommand } from '@univerjs/core';
+export declare const DeleteWorksheetRangeThemeStyleCommand: ICommand;

package/lib/types/commands/commands/insert-row-col.command.d.ts

@@ -21,6 +21,7 @@ export declare const InsertRowCommandId = "sheet.command.insert-row";
  * @internal
  */
 export declare const InsertRowCommand: ICommand;
+export declare const InsertRowByRangeCommand: ICommand;
 export declare const InsertRowBeforeCommand: ICommand;
 export declare const InsertRowAfterCommand: ICommand;
 export interface IInsertColCommandParams {
@@ -32,5 +33,6 @@ export interface IInsertColCommandParams {
 }
 export declare const InsertColCommandId = "sheet.command.insert-col";
 export declare const InsertColCommand: ICommand<IInsertColCommandParams>;
+export declare const InsertColByRangeCommand: ICommand<IInsertColCommandParams>;
 export declare const InsertColBeforeCommand: ICommand;
 export declare const InsertColAfterCommand: ICommand;

package/lib/types/commands/commands/register-range-theme.command.d.ts

@@ -0,0 +1,7 @@
+import { ICommand } from '@univerjs/core';
+import { RangeThemeStyle } from '../../model/range-theme-util';
+export interface IRegisterWorksheetRangeThemeStyleCommandParams {
+    unitId: string;
+    rangeThemeStyle: RangeThemeStyle;
+}
+export declare const RegisterWorksheetRangeThemeStyleCommand: ICommand<IRegisterWorksheetRangeThemeStyleCommandParams>;

package/lib/types/commands/commands/remove-row-col.command.d.ts

@@ -5,12 +5,24 @@ export interface IRemoveRowColCommandParams {
 export interface IRemoveRowColCommandInterceptParams extends IRemoveRowColCommandParams {
     ranges?: IRange[];
 }
+export interface IRemoveRowByRangeCommandParams {
+    range: IRange;
+    unitId: string;
+    subUnitId: string;
+}
+export interface IRemoveColByRangeCommandParams {
+    range: IRange;
+    unitId: string;
+    subUnitId: string;
+}
 export declare const RemoveRowCommandId = "sheet.command.remove-row";
+export declare const RemoveRowByRangeCommand: ICommand<IRemoveRowByRangeCommandParams>;
 /**
  * This command would remove the selected rows. These selected rows can be non-continuous.
  */
 export declare const RemoveRowCommand: ICommand<IRemoveRowColCommandParams>;
 export declare const RemoveColCommandId = "sheet.command.remove-col";
+export declare const RemoveColByRangeCommand: ICommand<IRemoveColByRangeCommandParams>;
 /**
  * This command would remove the selected columns. These selected rows can be non-continuous.
  */

package/lib/types/commands/commands/unregister-range-theme.command.d.ts

@@ -0,0 +1,6 @@
+import { ICommand } from '@univerjs/core';
+export interface IUnregisterWorksheetRangeThemeStyleCommandParams {
+    unitId: string;
+    themeName: string;
+}
+export declare const UnregisterWorksheetRangeThemeStyleCommand: ICommand<IUnregisterWorksheetRangeThemeStyleCommandParams>;

package/lib/types/commands/mutations/add-worksheet-range-theme.mutation.d.ts

@@ -0,0 +1,9 @@
+import { IAccessor, IMutation } from '@univerjs/core';
+import { IWorksheetRangeThemeStyleMutationParams } from '../../basics/interfaces/mutation-interface';
+export declare const SetWorksheetRangeThemeStyleMutation: IMutation<IWorksheetRangeThemeStyleMutationParams>;
+export declare const SetWorksheetRangeThemeStyleMutationFactory: (accessor: IAccessor, params: IWorksheetRangeThemeStyleMutationParams) => {
+    unitId: string;
+    subUnitId: string;
+    range: import('@univerjs/core').IRange;
+    themeName: string;
+};

package/lib/types/commands/mutations/delete-worksheet-range-theme.mutation.d.ts

@@ -0,0 +1,9 @@
+import { IAccessor, IMutation } from '@univerjs/core';
+import { IWorksheetRangeThemeStyleMutationParams } from '../../basics/interfaces/mutation-interface';
+export declare const DeleteWorksheetRangeThemeStyleMutation: IMutation<IWorksheetRangeThemeStyleMutationParams>;
+export declare const DeleteWorksheetRangeThemeStyleMutationFactory: (accessor: IAccessor, params: IWorksheetRangeThemeStyleMutationParams) => {
+    unitId: string;
+    subUnitId: string;
+    range: import('@univerjs/core').IRange;
+    themeName: string;
+};

package/lib/types/commands/mutations/register-range-theme.mutation.d.ts

@@ -0,0 +1,8 @@
+import { IMutation } from '@univerjs/core';
+import { IRangeThemeStyleJSON } from '../../model/range-theme-util';
+export interface IRegisterWorksheetRangeThemeStyleMutationParams {
+    unitId: string;
+    themeName: string;
+    rangeThemeStyleJson: IRangeThemeStyleJSON;
+}
+export declare const RegisterWorksheetRangeThemeStyleMutation: IMutation<IRegisterWorksheetRangeThemeStyleMutationParams>;

package/lib/types/commands/mutations/unregister-range-theme-style.mutation.d.ts

@@ -0,0 +1,6 @@
+import { IMutation } from '@univerjs/core';
+export interface IUnregisterWorksheetRangeThemeStyleMutationParams {
+    unitId: string;
+    themeName: string;
+}
+export declare const UnregisterWorksheetRangeThemeStyleMutation: IMutation<IUnregisterWorksheetRangeThemeStyleMutationParams>;

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

@@ -0,0 +1,30 @@
+import { IEventBase, IWorksheetData, FEventName } from '@univerjs/core';
+import { FWorkbook } from './f-workbook';
+import { FWorksheet } from './f-worksheet';
+export interface IFSheetEventMixin {
+    get SheetCreated(): 'SheetCreated';
+    get BeforeSheetCreate(): 'BeforeSheetCreate';
+}
+export declare class FSheetEventName extends FEventName implements IFSheetEventMixin {
+    get SheetCreated(): 'SheetCreated';
+    get BeforeSheetCreate(): 'BeforeSheetCreate';
+}
+export interface IBeforeSheetCreateEventParams extends IEventBase {
+    workbook: FWorkbook;
+    index?: number;
+    sheet?: IWorksheetData;
+}
+export interface ISheetCreatedEventParams extends IEventBase {
+    workbook: FWorkbook;
+    worksheet: FWorksheet;
+}
+export interface ISheetEventParamConfig {
+    SheetCreated: ISheetCreatedEventParams;
+    BeforeSheetCreate: IBeforeSheetCreateEventParams;
+}
+declare module '@univerjs/core' {
+    interface FEventName extends IFSheetEventMixin {
+    }
+    interface IEventParamConfig extends ISheetEventParamConfig {
+    }
+}

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;
@@ -97,46 +97,49 @@ export declare class FRange extends FBase {
     getVerticalAlignment(): string;
     /**
      * Set background color for current range.
+     * @param color {string}
      * @example
      * ```
      * 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
+     * ```
+     * 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.
      */
-    setWrap(isWrapEnabled: boolean): Promise<boolean>;
+    setWrap(isWrapEnabled: boolean): FRange;
     /**
      * Sets the text wrapping strategy for the cells in the range.
      */
-    setWrapStrategy(strategy: WrapStrategy): Promise<boolean>;
+    setWrapStrategy(strategy: WrapStrategy): FRange;
     /**
      * Set the vertical (top to bottom) alignment for the given range (top/middle/bottom).
      */
-    setVerticalAlignment(alignment: FVerticalAlignment): Promise<boolean>;
+    setVerticalAlignment(alignment: FVerticalAlignment): FRange;
     /**
      * Set the horizontal (left to right) alignment for the given range (left/center/right).
      */
-    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.
@@ -182,7 +185,7 @@ export declare class FRange extends FBase {
      *
      * @returns This range, for chaining
      */
-    merge(defaultMerge?: boolean): Promise<FRange>;
+    merge(defaultMerge?: boolean): FRange;
     /**
      * Merges cells in a range horizontally.
      *
@@ -190,7 +193,7 @@ export declare class FRange extends FBase {
      *
      * @returns This range, for chaining
      */
-    mergeAcross(defaultMerge?: boolean): Promise<FRange>;
+    mergeAcross(defaultMerge?: boolean): FRange;
     /**
      * Merges cells in a range vertically.
      *
@@ -198,7 +201,7 @@ export declare class FRange extends FBase {
      *
      * @returns This range, for chaining
      */
-    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
@@ -281,4 +284,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;
@@ -169,7 +169,7 @@ 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.
@@ -180,7 +180,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 +191,7 @@ export declare class FWorkbook extends FBase {
      * activeSpreadsheet.redo();
      * ```
      */
-    redo(): Promise<boolean>;
+    redo(): FWorkbook;
     /**
      * Callback for command execution.
      * @callback onBeforeCommandExecuteCallback
@@ -265,11 +265,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 +278,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 +289,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
@@ -338,7 +338,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 +347,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,7 +359,7 @@ export declare class FWorkbook extends FBase {
      * activeSpreadsheet.moveActiveSheet(1);
      * ```
      */
-    moveActiveSheet(index: number): Promise<boolean>;
+    moveActiveSheet(index: number): FWorkbook;
     /**
      * Get the PermissionInstance.
      *
@@ -436,8 +436,44 @@ 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.
+     * @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.
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * fWorkbook.unregisterRangeTheme('MyTheme');
+     * ```
+     */
+    unregisterRangeTheme(themeName: string): void;
 }