@univerjs/sheets 0.5.2 → 0.5.3

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

@@ -1,4 +1,4 @@
-import { CustomData, ICellData, IDisposable, IFreeze, IObjectArrayPrimitiveType, IStyleData, Nullable, Workbook, Worksheet, FBase, ICommandService, ILogService, Injector, ObjectMatrix } from '@univerjs/core';
+import { CustomData, ICellData, IDisposable, IFreeze, IObjectArrayPrimitiveType, IStyleData, Nullable, Workbook, Worksheet, FBaseInitialable, ICommandService, ILogService, Injector, ObjectMatrix } from '@univerjs/core';
 import { FDefinedName } from './f-defined-name';
 import { FWorkbook } from './f-workbook';
 import { SheetsSelectionsService } from '@univerjs/sheets';
@@ -11,7 +11,7 @@ interface IFacadeClearOptions {
 /**
  * Represents a worksheet facade api instance. Which provides a set of methods to interact with the worksheet.
  */
-export declare class FWorksheet extends FBase {
+export declare class FWorksheet extends FBaseInitialable {
     protected readonly _fWorkbook: FWorkbook;
     protected readonly _workbook: Workbook;
     protected readonly _worksheet: Worksheet;
@@ -67,23 +67,23 @@ export declare class FWorksheet extends FBase {
     /**
      * Set the default style of the worksheet
      * @param {StyleDataInfo} style default style
-     * @returns {Promise<FWorksheet>} This sheet, for chaining.
+     * @returns {FWorksheet} This sheet, for chaining.
      */
-    setDefaultStyle(style: string): Promise<FWorksheet>;
+    setDefaultStyle(style: string): FWorksheet;
     /**
      * 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.
+     * @returns {FWorksheet} This sheet, for chaining.
      */
-    setColumnDefaultStyle(index: number, style: string | Nullable<IStyleData>): Promise<FWorksheet>;
+    setColumnDefaultStyle(index: number, style: string | Nullable<IStyleData>): FWorksheet;
     /**
      * 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.
+     * @returns {FWorksheet} This sheet, for chaining.
      */
-    setRowDefaultStyle(index: number, style: string | Nullable<IStyleData>): Promise<FWorksheet>;
+    setRowDefaultStyle(index: number, style: string | Nullable<IStyleData>): FWorksheet;
     /**
      * Returns a Range object representing a single cell at the specified row and column.
      * @param row The row index of the cell.
@@ -129,87 +129,87 @@ export declare class FWorksheet extends FBase {
      * @param afterPosition The row after which the new row should be added, starting at 0 for the first row.
      * @returns This sheet, for chaining.
      */
-    insertRowAfter(afterPosition: number): Promise<FWorksheet>;
+    insertRowAfter(afterPosition: number): FWorksheet;
     /**
      * Inserts a row before the given row position.
      * @param beforePosition The row before which the new row should be added, starting at 0 for the first row.
      * @returns This sheet, for chaining.
      */
-    insertRowBefore(beforePosition: number): Promise<FWorksheet>;
+    insertRowBefore(beforePosition: number): FWorksheet;
     /**
      * Inserts one or more consecutive blank rows in a sheet starting at the specified location.
      * @param rowIndex The index indicating where to insert a row, starting at 0 for the first row.
      * @param numRows The number of rows to insert.
      * @returns This sheet, for chaining.
      */
-    insertRows(rowIndex: number, numRows?: number): Promise<FWorksheet>;
+    insertRows(rowIndex: number, numRows?: number): FWorksheet;
     /**
      * Inserts a number of rows after the given row position.
      * @param afterPosition The row after which the new rows should be added, starting at 0 for the first row.
      * @param howMany The number of rows to insert.
      * @returns This sheet, for chaining.
      */
-    insertRowsAfter(afterPosition: number, howMany: number): Promise<FWorksheet>;
+    insertRowsAfter(afterPosition: number, howMany: number): FWorksheet;
     /**
      * Inserts a number of rows before the given row position.
      * @param beforePosition The row before which the new rows should be added, starting at 0 for the first row.
      * @param howMany The number of rows to insert.
      * @returns This sheet, for chaining.
      */
-    insertRowsBefore(beforePosition: number, howMany: number): Promise<FWorksheet>;
+    insertRowsBefore(beforePosition: number, howMany: number): FWorksheet;
     /**
      * Deletes the row at the given row position.
      * @param rowPosition The position of the row, starting at 0 for the first row.
      * @returns This sheet, for chaining.
      */
-    deleteRow(rowPosition: number): Promise<FWorksheet>;
+    deleteRow(rowPosition: number): FWorksheet;
     /**
      * Deletes a number of rows starting at the given row position.
      * @param rowPosition The position of the first row to delete, starting at 0 for the first row.
      * @param howMany The number of rows to delete.
      * @returns This sheet, for chaining.
      */
-    deleteRows(rowPosition: number, howMany: number): Promise<FWorksheet>;
+    deleteRows(rowPosition: number, howMany: number): FWorksheet;
     /**
      * Moves the rows selected by the given range to the position indicated by the destinationIndex. The rowSpec itself does not have to exactly represent an entire row or group of rows to move—it selects all rows that the range spans.
      * @param rowSpec A range spanning the rows that should be moved.
      * @param destinationIndex The index that the rows should be moved to. Note that this index is based on the coordinates before the rows are moved. Existing data is shifted down to make room for the moved rows while the source rows are removed from the grid. Therefore, the data may end up at a different index than originally specified. Use 0-index for this method.
      * @returns This sheet, for chaining.
      */
-    moveRows(rowSpec: FRange, destinationIndex: number): Promise<FWorksheet>;
+    moveRows(rowSpec: FRange, destinationIndex: number): FWorksheet;
     /**
      * Hides the rows in the given range.
      * @param row The row range to hide.
      * @returns This sheet, for chaining.
      */
-    hideRow(row: FRange): Promise<FWorksheet>;
+    hideRow(row: FRange): FWorksheet;
     /**
      * Hides one or more consecutive rows starting at the given index. Use 0-index for this method.
      * @param rowIndex The starting index of the rows to hide.
      * @param numRows The number of rows to hide.
      * @returns This sheet, for chaining.
      */
-    hideRows(rowIndex: number, numRows?: number): Promise<FWorksheet>;
+    hideRows(rowIndex: number, numRows?: number): FWorksheet;
     /**
      * Unhides the row in the given range.
      * @param row The range to unhide, if hidden.
      * @returns This sheet, for chaining.
      */
-    unhideRow(row: FRange): Promise<FWorksheet>;
+    unhideRow(row: FRange): FWorksheet;
     /**
      * Unhides one or more consecutive rows starting at the given index. Use 0-index for this method.
      * @param rowIndex The starting index of the rows to unhide.
      * @param numRows The number of rows to unhide.
      * @returns This sheet, for chaining.
      */
-    showRows(rowIndex: number, numRows?: number): Promise<FWorksheet>;
+    showRows(rowIndex: number, numRows?: number): FWorksheet;
     /**
      * Sets the row height of the given row in pixels. By default, rows grow to fit cell contents. If you want to force rows to a specified height, use setRowHeightsForced(startRow, numRows, height).
      * @param rowPosition The row position to change.
      * @param height The height in pixels to set it to.
      * @returns This sheet, for chaining.
      */
-    setRowHeight(rowPosition: number, height: number): Promise<FWorksheet>;
+    setRowHeight(rowPosition: number, height: number): FWorksheet;
     /**
      * Sets the height of the given rows in pixels. By default, rows grow to fit cell contents. If you want to force rows to a specified height, use setRowHeightsForced(startRow, numRows, height).
      * @param startRow The starting row position to change.
@@ -217,7 +217,7 @@ export declare class FWorksheet extends FBase {
      * @param height The height in pixels to set it to.
      * @returns This sheet, for chaining.
      */
-    setRowHeights(startRow: number, numRows: number, height: number): Promise<FWorksheet>;
+    setRowHeights(startRow: number, numRows: number, height: number): FWorksheet;
     /**
      * Sets the height of the given rows in pixels. By default, rows grow to fit cell contents. When you use setRowHeightsForced, rows are forced to the specified height even if the cell contents are taller than the row height.
      * @param startRow The starting row position to change.
@@ -225,99 +225,99 @@ export declare class FWorksheet extends FBase {
      * @param height The height in pixels to set it to.
      * @returns This sheet, for chaining.
      */
-    setRowHeightsForced(startRow: number, numRows: number, height: number): Promise<FWorksheet>;
+    setRowHeightsForced(startRow: number, numRows: number, height: number): FWorksheet;
     /**
      * Set custom properties for given rows.
      * @param custom The custom properties to set.
      * @returns This sheet, for chaining.
      */
-    setRowCustom(custom: IObjectArrayPrimitiveType<CustomData>): Promise<FWorksheet>;
+    setRowCustom(custom: IObjectArrayPrimitiveType<CustomData>): FWorksheet;
     /**
      * Inserts a column after the given column position.
      * @param afterPosition The column after which the new column should be added, starting at 0 for the first column.
      * @returns This sheet, for chaining.
      */
-    insertColumnAfter(afterPosition: number): Promise<FWorksheet>;
+    insertColumnAfter(afterPosition: number): FWorksheet;
     /**
      * Inserts a column before the given column position.
      * @param beforePosition The column before which the new column should be added, starting at 0 for the first column.
      * @returns This sheet, for chaining.
      */
-    insertColumnBefore(beforePosition: number): Promise<FWorksheet>;
+    insertColumnBefore(beforePosition: number): FWorksheet;
     /**
      * Inserts one or more consecutive blank columns in a sheet starting at the specified location.
      * @param columnIndex The index indicating where to insert a column, starting at 0 for the first column.
      * @param numColumns The number of columns to insert.
      * @returns This sheet, for chaining.
      */
-    insertColumns(columnIndex: number, numColumns?: number): Promise<FWorksheet>;
+    insertColumns(columnIndex: number, numColumns?: number): FWorksheet;
     /**
      * Inserts a given number of columns after the given column position.
      * @param afterPosition The column after which the new column should be added, starting at 0 for the first column.
      * @param howMany The number of columns to insert.
      * @returns This sheet, for chaining.
      */
-    insertColumnsAfter(afterPosition: number, howMany: number): Promise<FWorksheet>;
+    insertColumnsAfter(afterPosition: number, howMany: number): FWorksheet;
     /**
      * Inserts a number of columns before the given column position.
      * @param beforePosition The column before which the new column should be added, starting at 0 for the first column.
      * @param howMany The number of columns to insert.
      * @returns This sheet, for chaining.
      */
-    insertColumnsBefore(beforePosition: number, howMany: number): Promise<FWorksheet>;
+    insertColumnsBefore(beforePosition: number, howMany: number): FWorksheet;
     /**
      * Deletes the column at the given column position.
      * @param columnPosition The position of the column, starting at 0 for the first column.
      * @returns This sheet, for chaining.
      */
-    deleteColumn(columnPosition: number): Promise<FWorksheet>;
+    deleteColumn(columnPosition: number): FWorksheet;
     /**
      * Deletes a number of columns starting at the given column position.
      * @param columnPosition The position of the first column to delete, starting at 0 for the first column.
      * @param howMany The number of columns to delete.
      * @returns This sheet, for chaining.
      */
-    deleteColumns(columnPosition: number, howMany: number): Promise<FWorksheet>;
+    deleteColumns(columnPosition: number, howMany: number): FWorksheet;
     /**
      * Moves the columns selected by the given range to the position indicated by the destinationIndex. The columnSpec itself does not have to exactly represent an entire column or group of columns to move—it selects all columns that the range spans.
      * @param columnSpec A range spanning the columns that should be moved.
      * @param destinationIndex The index that the columns should be moved to. Note that this index is based on the coordinates before the columns are moved. Existing data is shifted right to make room for the moved columns while the source columns are removed from the grid. Therefore, the data may end up at a different index than originally specified. Use 0-index for this method.
      * @returns This sheet, for chaining.
      */
-    moveColumns(columnSpec: FRange, destinationIndex: number): Promise<FWorksheet>;
+    moveColumns(columnSpec: FRange, destinationIndex: number): FWorksheet;
     /**
      * Hides the column or columns in the given range.
      * @param column The column range to hide.
      * @returns This sheet, for chaining.
      */
-    hideColumn(column: FRange): Promise<FWorksheet>;
+    hideColumn(column: FRange): FWorksheet;
     /**
      * Hides one or more consecutive columns starting at the given index. Use 0-index for this method.
      * @param columnIndex The starting index of the columns to hide.
      * @param numColumns The number of columns to hide.
      * @returns This sheet, for chaining.
      */
-    hideColumns(columnIndex: number, numColumns?: number): Promise<FWorksheet>;
+    hideColumns(columnIndex: number, numColumns?: number): FWorksheet;
     /**
      * Unhides the column in the given range.
      * @param column The range to unhide, if hidden.
      * @returns This sheet, for chaining.
      */
-    unhideColumn(column: FRange): Promise<FWorksheet>;
+    unhideColumn(column: FRange): FWorksheet;
     /**
      * Unhides one or more consecutive columns starting at the given index. Use 0-index for this method.
      * @param columnIndex The starting index of the columns to unhide.
      * @param numColumns The number of columns to unhide.
      * @returns This sheet, for chaining.
      */
-    showColumns(columnIndex: number, numColumns?: number): Promise<FWorksheet>;
+    showColumns(columnIndex: number, numColumns?: number): FWorksheet;
     /**
      * Sets the width of the given column in pixels.
      * @param columnPosition The position of the given column to set.
      * @param width The width in pixels to set it to.
      * @returns This sheet, for chaining.
      */
-    setColumnWidth(columnPosition: number, width: number): Promise<FWorksheet>;
+    setColumnWidth(columnPosition: number, width: number): FWorksheet;
     /**
      * Sets the width of the given columns in pixels.
      * @param startColumn The starting column position to change.
@@ -325,13 +325,13 @@ export declare class FWorksheet extends FBase {
      * @param width The width in pixels to set it to.
      * @returns This sheet, for chaining.
      */
-    setColumnWidths(startColumn: number, numColumns: number, width: number): Promise<FWorksheet>;
+    setColumnWidths(startColumn: number, numColumns: number, width: number): FWorksheet;
     /**
      * Set custom properties for given columns.
      * @param custom The custom properties to set.
      * @returns This sheet, for chaining.
      */
-    setColumnCustom(custom: IObjectArrayPrimitiveType<CustomData>): Promise<FWorksheet>;
+    setColumnCustom(custom: IObjectArrayPrimitiveType<CustomData>): FWorksheet;
     /**
      * Get all merged cells in the current sheet
      * @returns all merged cells
@@ -367,12 +367,12 @@ export declare class FWorksheet extends FBase {
      * @deprecated use `setFrozenRows` and `setFrozenColumns` instead.
      * @returns True if the command was successful, false otherwise.
      */
-    setFreeze(freeze: IFreeze): boolean;
+    setFreeze(freeze: IFreeze): FWorksheet;
     /**
      * Cancels the frozen state of the current sheet.
      * @returns True if the command was successful, false otherwise.
      */
-    cancelFreeze(): boolean;
+    cancelFreeze(): FWorksheet;
     /**
      * Get the freeze state of the current sheet.
      * @returns The freeze state of the current sheet.
@@ -401,7 +401,7 @@ export declare class FWorksheet extends FBase {
      * @param startColumn
      * @param endColumn
      */
-    setFrozenColumns(startColumn: number, endColumn: number): void;
+    setFrozenColumns(startColumn: number, endColumn: number): FWorksheet;
     /**
      * Set the number of frozen rows.
      * @param rows The number of rows to freeze.
@@ -423,7 +423,7 @@ export declare class FWorksheet extends FBase {
      * fWorkSheet.setFrozenRows(0, 2);
      * ```
      */
-    setFrozenRows(startColumn: number, endColumn: number): void;
+    setFrozenRows(startColumn: number, endColumn: number): FWorksheet;
     /**
      * Get the number of frozen columns.
      * @returns The number of frozen columns.
@@ -475,11 +475,11 @@ export declare class FWorksheet extends FBase {
      * fWorkSheet.setHiddenGridlines(true);
      * ```
      */
-    setHiddenGridlines(hidden: boolean): Promise<boolean>;
+    setHiddenGridlines(hidden: boolean): FWorksheet;
     /**
      * 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.
+     * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -488,7 +488,7 @@ export declare class FWorksheet extends FBase {
      * fWorkSheet.setGridLinesColor('#ff0000');
      * ```
      */
-    setGridLinesColor(color: string | undefined): Promise<boolean>;
+    setGridLinesColor(color: string | undefined): FWorksheet;
     /**
      * 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)'.
@@ -497,7 +497,7 @@ export declare class FWorksheet extends FBase {
     /**
      * 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.
+     * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -506,7 +506,7 @@ export declare class FWorksheet extends FBase {
      * fWorkSheet.setTabColor('#ff0000');
      * ```
      */
-    setTabColor(color: string): Promise<boolean>;
+    setTabColor(color: string): FWorksheet;
     /**
      * Get the tab color of the sheet.
      * @returns {string} The tab color of the sheet or undefined.
@@ -564,10 +564,10 @@ export declare class FWorksheet extends FBase {
      * fWorkSheet.hideSheet();
      * ``
      */
-    hideSheet(): void;
+    hideSheet(): FWorksheet;
     /**
      * Shows this sheet. Has no effect if the sheet is already visible.
-     * @returns {Promise<boolean>} True if the command was successful, false otherwise.
+     * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -576,7 +576,7 @@ export declare class FWorksheet extends FBase {
      * fWorkSheets[fWorkSheets.length - 1].showSheet();
      * ```
      */
-    showSheet(): Promise<boolean>;
+    showSheet(): FWorksheet;
     /**
      * Returns true if the sheet is currently hidden.
      * @returns {boolean} True if the sheet is hidden; otherwise, false.
@@ -585,7 +585,7 @@ export declare class FWorksheet extends FBase {
     /**
      * Sets the sheet name.
      * @param {string} name The new name for the sheet.
-     * @returns {Promise<boolean>} True if the command was successful, false otherwise.
+     * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -594,7 +594,7 @@ export declare class FWorksheet extends FBase {
      * fWorkSheet.setName('Sheet1');
      * ```
      */
-    setName(name: string): Promise<boolean>;
+    setName(name: string): FWorksheet;
     /**
      * Activates this sheet. Does not alter the sheet itself, only the parent's notion of the active sheet.
      * @returns Current sheet, for chaining.
@@ -618,7 +618,7 @@ export declare class FWorksheet extends FBase {
      * @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.
+     * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -629,10 +629,10 @@ export declare class FWorksheet extends FBase {
      * fWorkSheet.clear({ contentsOnly: true });
      * ```
      */
-    clear(options?: IFacadeClearOptions): Promise<boolean>;
+    clear(options?: IFacadeClearOptions): FWorksheet;
     /**
      * Clears the sheet of contents, while preserving formatting information.
-     * @returns {Promise<boolean>} True if the command was successful, false otherwise.
+     * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -641,10 +641,10 @@ export declare class FWorksheet extends FBase {
      * fWorkSheet.clearContents();
      * ```
      */
-    clearContents(): Promise<boolean>;
+    clearContents(): FWorksheet;
     /**
      * Clears the sheet of formatting, while preserving contents.
-     * @returns {Promise<boolean>} True if the command was successful, false otherwise.
+     * @returns {FWorksheet} Returns the current worksheet instance for method chaining
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
@@ -653,7 +653,7 @@ export declare class FWorksheet extends FBase {
      * fWorkSheet.clearFormats();
      * ```
      */
-    clearFormats(): Promise<boolean>;
+    clearFormats(): FWorksheet;
     /**
      * 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()).

package/lib/types/facade/index.d.ts

@@ -14,11 +14,12 @@
  * limitations under the License.
  */
 import './f-univer';
+export * from './f-event';
 export { FPermission } from './f-permission';
 export { FRange } from './f-range';
 export type { FontLine, FontStyle, FontWeight } from './f-range';
 export { FSelection } from './f-selection';
 export { FSheetHooks } from './f-sheet-hooks';
 export { FWorkbook } from './f-workbook';
-export { FWorksheet } from './f-worksheet';
 export type * from './f-univer';
+export { FWorksheet } from './f-worksheet';

package/lib/types/index.d.ts

@@ -15,12 +15,13 @@
  */
 export { UniverSheetsPlugin } from './sheets-plugin';
 export { COMMAND_LISTENER_SKELETON_CHANGE, COMMAND_LISTENER_VALUE_CHANGE } from './basics/const/command-listener-const';
-export { type IAddWorksheetMergeMutationParams, type IDeleteRangeMutationParams, type IInsertColMutationParams, type IInsertRangeMutationParams, type IInsertRowMutationParams, type IInsertSheetMutationParams, type IRemoveColMutationParams, type IRemoveRowsMutationParams, type IRemoveSheetMutationParams, type IRemoveWorksheetMergeMutationParams, } from './basics/interfaces/mutation-interface';
+export { type IAddWorksheetMergeMutationParams, type IDeleteRangeMutationParams, type IInsertColMutationParams, type IInsertRangeMutationParams, type IInsertRowMutationParams, type IInsertSheetMutationParams, type IRemoveColMutationParams, type IRemoveRowsMutationParams, type IRemoveSheetMutationParams, type IRemoveWorksheetMergeMutationParams, type IWorksheetRangeThemeStyleMutationParams, } from './basics/interfaces/mutation-interface';
 export { convertPrimaryWithCoordToPrimary, convertSelectionDataToRange, type ISelectionStyle, type ISelectionWidgetConfig, type ISelectionWithCoord, type ISelectionWithStyle, type ISheetRangeLocation, SELECTION_CONTROL_BORDER_BUFFER_COLOR, SELECTION_CONTROL_BORDER_BUFFER_WIDTH, } from './basics/selection';
 export { createTopMatrixFromMatrix, createTopMatrixFromRanges, findAllRectangle, rangeMerge, RangeMergeUtil } from './basics/rangeMerge';
 export { type IUniverSheetsConfig } from './controllers/config.schema';
 export { MAX_CELL_PER_SHEET_KEY } from './controllers/config/config';
 export { BorderStyleManagerService, type IBorderInfo } from './services/border-style-manager.service';
+export { SheetRangeThemeService } from './services/range-theme-service';
 export * from './services/permission/permission-point';
 export { WorksheetPermissionService } from './services/permission/worksheet-permission/worksheet-permission.service';
 export { WorkbookPermissionService } from './services/permission/workbook-permission/workbook-permission.service';
@@ -76,11 +77,14 @@ export { getInsertRangeMutations, getRemoveRangeMutations } from './commands/uti
 export { handleInsertRangeMutation } from './commands/utils/handle-range-mutation';
 export { type ISheetCommandSharedParams } from './commands/utils/interface';
 export { copyRangeStyles } from './commands/commands/utils/selection-utils';
+export { RangeThemeStyle } from './model/range-theme-util';
 export { AddRangeProtectionCommand, type IAddRangeProtectionCommandParams } from './commands/commands/add-range-protection.command';
 export { AddWorksheetProtectionCommand } from './commands/commands/add-worksheet-protection.command';
 export { SetWorksheetProtectionCommand } from './commands/commands/set-worksheet-protection.command';
 export { DeleteWorksheetProtectionCommand } from './commands/commands/delete-worksheet-protection.command';
 export { addMergeCellsUtil, AddWorksheetMergeAllCommand, AddWorksheetMergeCommand, AddWorksheetMergeHorizontalCommand, AddWorksheetMergeVerticalCommand, } from './commands/commands/add-worksheet-merge.command';
+export { SetWorksheetRangeThemeStyleCommand } from './commands/commands/add-worksheet-range-theme.command';
+export { DeleteWorksheetRangeThemeStyleCommand } from './commands/commands/delete-worksheet-range-theme.command';
 export { ClearSelectionAllCommand } from './commands/commands/clear-selection-all.command';
 export { ClearSelectionContentCommand } from './commands/commands/clear-selection-content.command';
 export { ClearSelectionFormatCommand } from './commands/commands/clear-selection-format.command';
@@ -98,12 +102,12 @@ export { type ISetRowDataMutationParams, SetRowDataMutation, SetRowDataMutationF
 export { type ISetRowDataCommandParams, SetRowDataCommand } from './commands/commands/set-row-data.command';
 export { type ISetColDataMutationParams, SetColDataMutation, SetColDataMutationFactory } from './commands/mutations/set-col-data.mutation';
 export { type ISetColDataCommandParams, SetColDataCommand } from './commands/commands/set-col-data.command';
-export { type IInsertColCommandParams, type IInsertRowCommandParams, InsertColAfterCommand, InsertColBeforeCommand, InsertColCommand, InsertRowAfterCommand, InsertRowBeforeCommand, InsertRowCommand, } from './commands/commands/insert-row-col.command';
+export { type IInsertColCommandParams, type IInsertRowCommandParams, InsertColAfterCommand, InsertColBeforeCommand, InsertColByRangeCommand, InsertColCommand, InsertRowAfterCommand, InsertRowBeforeCommand, InsertRowByRangeCommand, InsertRowCommand, } from './commands/commands/insert-row-col.command';
 export { type IInsertSheetCommandParams, InsertSheetCommand } from './commands/commands/insert-sheet.command';
 export { getMoveRangeUndoRedoMutations, type IMoveRangeCommandParams, MoveRangeCommand } from './commands/commands/move-range.command';
 export { type IMoveColsCommandParams, type IMoveRowsCommandParams, MoveColsCommand, MoveRowsCommand, } from './commands/commands/move-rows-cols.command';
 export { RemoveDefinedNameCommand } from './commands/commands/remove-defined-name.command';
-export { type IRemoveRowColCommandInterceptParams, type IRemoveRowColCommandParams, RemoveColCommand, RemoveRowCommand } from './commands/commands/remove-row-col.command';
+export { type IRemoveColByRangeCommandParams, type IRemoveRowByRangeCommandParams, type IRemoveRowColCommandInterceptParams, type IRemoveRowColCommandParams, RemoveColByRangeCommand, RemoveColCommand, RemoveRowByRangeCommand, RemoveRowCommand } from './commands/commands/remove-row-col.command';
 export { type IRemoveSheetCommandParams, RemoveSheetCommand } from './commands/commands/remove-sheet.command';
 export { RemoveWorksheetMergeCommand } from './commands/commands/remove-worksheet-merge.command';
 export { type IReorderRangeCommandParams, ReorderRangeCommand } from './commands/commands/reorder-range.command';
@@ -130,6 +134,12 @@ export { DeltaRowHeightCommand, type IDeltaRowHeightCommand, type ISetWorksheetR
 export { SetWorksheetShowCommand } from './commands/commands/set-worksheet-show.command';
 export { SplitTextToColumnsCommand } from './commands/commands/split-text-to-columns.command';
 export type { ISplitTextToColumnsCommandParams } from './commands/commands/split-text-to-columns.command';
+export { UnregisterWorksheetRangeThemeStyleCommand } from './commands/commands/unregister-range-theme.command';
+export type { IUnregisterWorksheetRangeThemeStyleCommandParams } from './commands/commands/unregister-range-theme.command';
+export { RegisterWorksheetRangeThemeStyleCommand } from './commands/commands/register-range-theme.command';
+export type { IRegisterWorksheetRangeThemeStyleCommandParams } from './commands/commands/register-range-theme.command';
+export { type IRegisterWorksheetRangeThemeStyleMutationParams, RegisterWorksheetRangeThemeStyleMutation } from './commands/mutations/register-range-theme.mutation';
+export { type IUnregisterWorksheetRangeThemeStyleMutationParams, UnregisterWorksheetRangeThemeStyleMutation } from './commands/mutations/unregister-range-theme-style.mutation';
 export type { ISetWorksheetShowCommandParams } from './commands/commands/set-worksheet-show.command';
 export { AddRangeProtectionMutation, FactoryAddRangeProtectionMutation, type IAddRangeProtectionMutationParams } from './commands/mutations/add-range-protection.mutation';
 export { SetProtectionCommand } from './commands/commands/set-protection.command';
@@ -161,6 +171,8 @@ export { type ISetWorksheetColWidthMutationParams, SetWorksheetColWidthMutation,
 export { type ISetWorksheetHideMutationParams, SetWorksheetHideMutation } from './commands/mutations/set-worksheet-hide.mutation';
 export { type ISetWorksheetNameMutationParams, SetWorksheetNameMutation } from './commands/mutations/set-worksheet-name.mutation';
 export { type ISetWorksheetOrderMutationParams, SetWorksheetOrderMutation } from './commands/mutations/set-worksheet-order.mutation';
+export { SetWorksheetRangeThemeStyleMutation, SetWorksheetRangeThemeStyleMutationFactory } from './commands/mutations/add-worksheet-range-theme.mutation';
+export { DeleteWorksheetRangeThemeStyleMutation, DeleteWorksheetRangeThemeStyleMutationFactory } from './commands/mutations/delete-worksheet-range-theme.mutation';
 export { SetWorksheetPermissionPointsMutation } from './commands/mutations/set-worksheet-permission-points.mutation';
 export type { ISetWorksheetPermissionPointsMutationParams } from './commands/mutations/set-worksheet-permission-points.mutation';
 export { SetWorksheetProtectionMutation } from './commands/mutations/set-worksheet-protection.mutation';

package/lib/types/model/range-theme-model.d.ts

@@ -0,0 +1,66 @@
+import { IRange, Nullable, Disposable, IResourceManagerService } from '@univerjs/core';
+import { IRangeThemeStyleItem, IRangeThemeStyleJSON, RangeThemeStyle } from './range-theme-util';
+import { SheetInterceptorService } from '../services/sheet-interceptor/sheet-interceptor.service';
+export interface IRangeThemeRangeInfo {
+    range: IRange;
+    unitId: string;
+    subUnitId: string;
+}
+export interface IRangeThemeStyleRule {
+    rangeInfo: IRangeThemeRangeInfo;
+    themeName: string;
+}
+interface ISheetRangeThemeModelJSON {
+    rangeThemeStyleRuleMap: Record<string, IRangeThemeStyleRule>;
+    rangeThemeStyleMapJson: Record<string, IRangeThemeStyleJSON>;
+}
+export declare class SheetRangeThemeModel extends Disposable {
+    private _sheetInterceptorService;
+    private _resourceManagerService;
+    private _rangeThemeStyleMap;
+    private _rangeThemeStyleRuleMap;
+    private _rTreeCollection;
+    private _defaultRangeThemeMap;
+    constructor(_sheetInterceptorService: SheetInterceptorService, _resourceManagerService: IResourceManagerService);
+    private _initDefaultTheme;
+    private _ensureRangeThemeStyleMap;
+    private _ensureRangeThemeStyleRuleMap;
+    private _ensureRTreeCollection;
+    getDefaultRangeThemeStyle(name: string): RangeThemeStyle;
+    /**
+     * Register range theme styles
+     * @param {string} themeName
+     * @param {IRangeThemeRangeInfo} rangeInfo
+     */
+    registerRangeThemeRule(themeName: string, rangeInfo: IRangeThemeRangeInfo): void;
+    getRegisteredRangeThemeStyle(rangeInfo: IRangeThemeRangeInfo): string | undefined;
+    removeRangeThemeRule(themeName: string, rangeInfo: IRangeThemeRangeInfo): void;
+    registerDefaultRangeTheme(rangeThemeStyle: RangeThemeStyle): void;
+    getRegisteredRangeThemes(): string[];
+    /**
+     * Register custom range theme style.
+     * @param {string} unitId The unit id.
+     * @param {RangeThemeStyle} rangeThemeStyle The range theme style.
+     */
+    registerRangeThemeStyle(unitId: string, rangeThemeStyle: RangeThemeStyle): void;
+    /**
+     *  Unregister custom range theme style.
+     * @param {string} unitId The unit id.
+     * @param {string} name The name of the range theme style.
+     */
+    unregisterRangeThemeStyle(unitId: string, name: string): void;
+    /**
+     * Gets all custom register themes
+     * @return {string[]} The array of all custom registered themes.
+     */
+    getALLRegisteredTheme(): string[];
+    getRangeThemeStyle(unitId: string, name: string): RangeThemeStyle;
+    getCellStyle(unitId: string, subUnitId: string, row: number, col: number): Nullable<IRangeThemeStyleItem>;
+    private _registerIntercept;
+    toJson(unitId: string): string;
+    fromJSON(json: ISheetRangeThemeModelJSON): void;
+    deleteUnitId(unitId: string): void;
+    private _initSnapshot;
+    dispose(): void;
+}
+export {};