@univerjs/sheets 0.5.1 → 0.5.2

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

@@ -1,16 +1,25 @@
-import { CustomData, ICellData, IDisposable, IFreeze, IObjectArrayPrimitiveType, IStyleData, Nullable, Workbook, Worksheet, FBase, ICommandService, Injector, ObjectMatrix } from '@univerjs/core';
+import { CustomData, ICellData, IDisposable, IFreeze, IObjectArrayPrimitiveType, IStyleData, Nullable, Workbook, Worksheet, FBase, ICommandService, ILogService, Injector, ObjectMatrix } from '@univerjs/core';
+import { FDefinedName } from './f-defined-name';
 import { FWorkbook } from './f-workbook';
 import { SheetsSelectionsService } from '@univerjs/sheets';
 import { FRange } from './f-range';
 import { FSelection } from './f-selection';
+interface IFacadeClearOptions {
+    contentsOnly?: boolean;
+    formatOnly?: boolean;
+}
+/**
+ * Represents a worksheet facade api instance. Which provides a set of methods to interact with the worksheet.
+ */
 export declare class FWorksheet extends FBase {
     protected readonly _fWorkbook: FWorkbook;
     protected readonly _workbook: Workbook;
     protected readonly _worksheet: Worksheet;
     protected readonly _injector: Injector;
     protected readonly _selectionManagerService: SheetsSelectionsService;
+    protected readonly _logService: ILogService;
     protected readonly _commandService: ICommandService;
-    constructor(_fWorkbook: FWorkbook, _workbook: Workbook, _worksheet: Worksheet, _injector: Injector, _selectionManagerService: SheetsSelectionsService, _commandService: ICommandService);
+    constructor(_fWorkbook: FWorkbook, _workbook: Workbook, _worksheet: Worksheet, _injector: Injector, _selectionManagerService: SheetsSelectionsService, _logService: ILogService, _commandService: ICommandService);
     /**
      * Returns the injector
      * @returns The injector
@@ -18,23 +27,27 @@ export declare class FWorksheet extends FBase {
     getInject(): Injector;
     /**
      * Returns the workbook
-     * @returns The workbook
+     * @returns {Workbook} The workbook instance.
      */
     getWorkbook(): Workbook;
     /**
-     * Returns the worksheet id
-     * @returns The id of the worksheet
+     * Returns the worksheet id.
+     * @returns {string} The id of the worksheet.
      */
     getSheetId(): string;
     /**
-     * Returns the worksheet name
-     * @returns The name of the worksheet
+     * Returns the worksheet name.
+     * @returns {string} The name of the worksheet.
      */
     getSheetName(): string;
+    /**
+     * 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(): FSelection | null;
     /**
      * Get the default style of the worksheet
-     * @returns Default style
+     * @returns {IStyleData} Default style of the worksheet.
      */
     getDefaultStyle(): Nullable<IStyleData> | string;
     /**
@@ -53,20 +66,22 @@ export declare class FWorksheet extends FBase {
     getColumnDefaultStyle(index: number, keepRaw?: boolean): Nullable<IStyleData> | string;
     /**
      * 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.
      */
     setDefaultStyle(style: string): Promise<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.
      */
     setColumnDefaultStyle(index: number, style: string | Nullable<IStyleData>): Promise<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.
      */
     setRowDefaultStyle(index: number, style: string | Nullable<IStyleData>): Promise<FWorksheet>;
     /**
@@ -346,7 +361,10 @@ export declare class FWorksheet extends FBase {
     setActiveSelection: (range: FRange) => void;
     /**
      * 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(freeze: IFreeze): boolean;
@@ -358,6 +376,8 @@ export declare class FWorksheet extends FBase {
     /**
      * Get the freeze state of the current sheet.
      * @returns The freeze state of the current sheet.
+     *
+     * @deprecated use `getRowFreezeStatus` and `getColumnFreezeStatus` instead.
      */
     getFreeze(): IFreeze;
     /**
@@ -366,12 +386,44 @@ export declare class FWorksheet extends FBase {
      * To unfreeze all columns, set this value to 0.
      */
     setFrozenColumns(columns: number): void;
+    /**
+     * Set freeze column, then the range from startColumn to endColumn will be fixed.
+     * e.g. setFrozenColumns(0, 2) will fix the column range from 0 to 2.
+     * e.g. setFrozenColumns(2, 3) will fix the column range from 2 to 3, And column from 0 to 1 will be invisible.
+     *
+     * @example
+     * ``` ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * // freeze the first too columns.
+     * fWorkSheet.setFrozenColumns(0, 2);
+     * ```
+     * @param startColumn
+     * @param endColumn
+     */
+    setFrozenColumns(startColumn: number, endColumn: number): void;
     /**
      * Set the number of frozen rows.
      * @param rows The number of rows to freeze.
      * To unfreeze all rows, set this value to 0.
      */
     setFrozenRows(rows: number): void;
+    /**
+     * Set freeze row, then the range from startRow to endRow will be fixed.
+     * e.g. setFrozenRows(0, 2) will fix the row range from 0 to 2.
+     * e.g. setFrozenRows(2, 3) will fix the row range from 2 to 3, And row from 0 to 1 will be invisible.
+     * @param startRow
+     * @param endRow
+     *
+     * @example
+     * ``` ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorkSheet = fWorkbook.getActiveSheet();
+     * // freeze the first too rows.
+     * fWorkSheet.setFrozenRows(0, 2);
+     * ```
+     */
+    setFrozenRows(startColumn: number, endColumn: number): void;
     /**
      * Get the number of frozen columns.
      * @returns The number of frozen columns.
@@ -384,25 +436,312 @@ export declare class FWorksheet extends FBase {
      * Returns 0 if no rows are frozen.
      */
     getFrozenRows(): number;
+    /**
+     * Get freezed rows.
+     */
+    getFrozenRowRange(): {
+        startRow: number;
+        endRow: number;
+    };
+    /**
+     * Get freezed columns
+     */
+    getFrozenColumnRange(): {
+        startColumn: number;
+        endColumn: number;
+    };
     /**
      * 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(): boolean;
     /**
      * 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(hidden: boolean): Promise<boolean>;
+    /**
+     * 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(color: string | undefined): Promise<boolean>;
+    /**
+     * 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(): string | undefined;
+    /**
+     * 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(color: string): Promise<boolean>;
+    /**
+     * 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(): string | undefined;
     /**
      * 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(callback: (cellValue: ObjectMatrix<Nullable<ICellData>>) => void): IDisposable;
     /**
      * 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(callback: (cellValue: ObjectMatrix<Nullable<ICellData>>) => void): IDisposable;
+    /**
+     * 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(): void;
+    /**
+     * 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(): Promise<boolean>;
+    /**
+     * Returns true if the sheet is currently hidden.
+     * @returns {boolean} True if the sheet is hidden; otherwise, false.
+     */
+    isSheetHidden(): boolean;
+    /**
+     * 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(name: string): Promise<boolean>;
+    /**
+     * Activates this sheet. Does not alter the sheet itself, only the parent's notion of the active sheet.
+     * @returns Current sheet, for chaining.
+     */
+    activate(): FWorksheet;
+    /**
+     * 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(): number;
+    /**
+     * 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(options?: IFacadeClearOptions): Promise<boolean>;
+    /**
+     * 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(): Promise<boolean>;
+    /**
+     * 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(): Promise<boolean>;
+    /**
+     * 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(): FRange;
+    /**
+     * 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(): number;
+    /**
+     * 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(): number;
+    /**
+     * 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(): number;
+    /**
+     * 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(): number;
+    /**
+     * 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(other: FWorksheet): boolean;
+    insertDefinedName(name: string, formulaOrRefString: string): void;
+    /**
+     * 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(): FDefinedName[];
 }
+export {};

package/lib/types/index.d.ts

@@ -24,7 +24,7 @@ export { BorderStyleManagerService, type IBorderInfo } from './services/border-s
 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';
-export { DISABLE_NORMAL_SELECTIONS, IRefSelectionsService, RefSelectionsService, SelectionMoveType, SheetsSelectionsService, WorkbookSelectionModel, } from './services/selections';
+export * from './services/selections';
 export { getAddMergeMutationRangeByType } from './controllers/merge-cell.controller';
 export { NumfmtService } from './services/numfmt/numfmt.service';
 export type { INumfmtItem, INumfmtItemWithCache } from './services/numfmt/type';
@@ -33,7 +33,8 @@ export { RefRangeService } from './services/ref-range/ref-range.service';
 export type { EffectRefRangeParams, IOperator } from './services/ref-range/type';
 export { EffectRefRangId, OperatorType } from './services/ref-range/type';
 export { DefinedNameDataController } from './controllers/defined-name-data.controller';
-export { getSeparateEffectedRangesOnCommand, handleBaseInsertRange, handleBaseMoveRowsCols, handleBaseRemoveRange, handleCommonDefaultRangeChangeWithEffectRefCommands, handleCommonRangeChangeWithEffectRefCommandsSkipNoInterests, handleDefaultRangeChangeWithEffectRefCommands, handleDefaultRangeChangeWithEffectRefCommandsSkipNoInterests, handleDeleteRangeMoveLeft, handleDeleteRangeMoveUp, handleInsertCol, handleInsertRangeMoveDown, handleInsertRangeMoveRight, handleInsertRow, handleIRemoveCol, handleIRemoveRow, handleMoveCols, handleMoveRange, handleMoveRows, rotateRange, runRefRangeMutations, } from './services/ref-range/util';
+export { adjustRangeOnMutation, getSeparateEffectedRangesOnCommand, handleBaseInsertRange, handleBaseMoveRowsCols, handleBaseRemoveRange, handleCommonDefaultRangeChangeWithEffectRefCommands, handleCommonRangeChangeWithEffectRefCommandsSkipNoInterests, handleDefaultRangeChangeWithEffectRefCommands, handleDefaultRangeChangeWithEffectRefCommandsSkipNoInterests, handleDeleteRangeMoveLeft, handleDeleteRangeMoveUp, handleInsertCol, handleInsertRangeMoveDown, handleInsertRangeMoveRight, handleInsertRow, handleIRemoveCol, handleIRemoveRow, handleMoveCols, handleMoveRange, handleMoveRows, rotateRange, runRefRangeMutations, } from './services/ref-range/util';
+export type { MutationsAffectRange } from './services/ref-range/util';
 export { InterceptCellContentPriority, INTERCEPTOR_POINT } from './services/sheet-interceptor/interceptor-const';
 export { AFTER_CELL_EDIT, AFTER_CELL_EDIT_ASYNC, BEFORE_CELL_EDIT, SheetInterceptorService } from './services/sheet-interceptor/sheet-interceptor.service';
 export type { ISheetLocation, ISheetLocationBase, ISheetRowLocation } from './services/sheet-interceptor/utils/interceptor';
@@ -41,12 +42,16 @@ export { MERGE_CELL_INTERCEPTOR_CHECK, MergeCellController } from './controllers
 export { AddMergeRedoSelectionsOperationFactory, AddMergeUndoSelectionsOperationFactory } from './commands/utils/handle-merge-operation';
 export type { FormatType } from './services/numfmt/type';
 export { expandToContinuousRange } from './basics/expand-range';
+export { splitRangeText } from './basics/split-range-text';
+export type { SplitDelimiterEnum } from './basics/split-range-text';
+export { getNextPrimaryCell } from './services/selections/move-active-cell-util';
 export { ExclusiveRangeService, IExclusiveRangeService } from './services/exclusive-range/exclusive-range-service';
 export { defaultWorksheetPermissionPoint, getAllWorksheetPermissionPoint, getAllWorksheetPermissionPointByPointPanel } from './services/permission';
 export type { IWorksheetProtectionRule } from './services/permission/type';
 export { WorksheetProtectionPointModel, WorksheetProtectionRuleModel } from './services/permission/worksheet-permission';
 export { defaultWorkbookPermissionPoints, getAllWorkbookPermissionPoint } from './services/permission/workbook-permission';
 export { WorkbookCommentPermission, WorkbookCopyPermission, WorkbookCreateProtectPermission, WorkbookCreateSheetPermission, WorkbookDeleteSheetPermission, WorkbookDuplicatePermission, WorkbookEditablePermission, WorkbookExportPermission, WorkbookHideSheetPermission, WorkbookHistoryPermission, WorkbookManageCollaboratorPermission, WorkbookMoveSheetPermission, WorkbookPrintPermission, WorkbookRecoverHistoryPermission, WorkbookRenameSheetPermission, WorkbookSharePermission, WorkbookViewHistoryPermission, WorkbookViewPermission, WorksheetCopyPermission, WorksheetDeleteColumnPermission, WorksheetDeleteProtectionPermission, WorksheetDeleteRowPermission, WorksheetEditExtraObjectPermission, WorksheetEditPermission, WorksheetFilterPermission, WorksheetInsertColumnPermission, WorksheetInsertHyperlinkPermission, WorksheetInsertRowPermission, WorksheetManageCollaboratorPermission, WorksheetPivotTablePermission, WorksheetSelectProtectedCellsPermission, WorksheetSelectUnProtectedCellsPermission, WorksheetSetCellStylePermission, WorksheetSetCellValuePermission, WorksheetSetColumnStylePermission, WorksheetSetRowStylePermission, WorksheetSortPermission, WorksheetViewPermission, } from './services/permission/permission-point';
+export { PermissionPointsDefinitions } from './services/permission/permission-point/const';
 export { UnitAction, UnitObject } from '@univerjs/protocol';
 export { checkRangesEditablePermission } from './services/permission/util';
 export { type ICellPermission, RangeProtectionRenderModel } from './model/range-protection-render.model';
@@ -108,6 +113,7 @@ export { SetDefinedNameCommand } from './commands/commands/set-defined-name.comm
 export { type ICancelFrozenCommandParams, type ISetFrozenCommandParams } from './commands/commands/set-frozen.command';
 export { CancelFrozenCommand, SetFrozenCommand } from './commands/commands/set-frozen.command';
 export { type IToggleGridlinesCommandParams, ToggleGridlinesCommand } from './commands/commands/toggle-gridlines.command';
+export { type ISetGridlinesColorCommandParams, SetGridlinesColorCommand } from './commands/commands/set-gridlines-color.command';
 export { type ISetRangeValuesCommandParams, SetRangeValuesCommand } from './commands/commands/set-range-values.command';
 export { type ISetSpecificRowsVisibleCommandParams, SetRowHiddenCommand, SetSelectedRowsVisibleCommand, SetSpecificRowsVisibleCommand, } from './commands/commands/set-row-visible.command';
 export { type ISetColorCommandParams, type ISetFontFamilyCommandParams, type ISetFontSizeCommandParams, type ISetHorizontalTextAlignCommandParams, type ISetStyleCommandParams, type ISetTextRotationCommandParams, type ISetTextWrapCommandParams, type ISetVerticalTextAlignCommandParams, type IStyleTypeValue, ResetBackgroundColorCommand, ResetTextColorCommand, SetBackgroundColorCommand, SetBoldCommand, SetFontFamilyCommand, SetFontSizeCommand, SetHorizontalTextAlignCommand, SetItalicCommand, SetOverlineCommand, SetStrikeThroughCommand, SetStyleCommand, SetTextColorCommand, SetTextRotationCommand, SetTextWrapCommand, SetUnderlineCommand, SetVerticalTextAlignCommand, } from './commands/commands/set-style.command';
@@ -122,6 +128,8 @@ export { SetWorksheetPermissionPointsCommand } from './commands/commands/set-wor
 export { SetWorksheetRightToLeftCommand } from './commands/commands/set-worksheet-right-to-left.command';
 export { DeltaRowHeightCommand, type IDeltaRowHeightCommand, type ISetWorksheetRowIsAutoHeightCommandParams, SetRowHeightCommand, SetWorksheetRowIsAutoHeightCommand, } from './commands/commands/set-worksheet-row-height.command';
 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 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';
@@ -143,6 +151,7 @@ export { type IReorderRangeMutationParams, ReorderRangeMutation, ReorderRangeUnd
 export { type ISetColHiddenMutationParams, type ISetColVisibleMutationParams, SetColHiddenMutation, SetColVisibleMutation, } from './commands/mutations/set-col-visible.mutation';
 export { type ISetFrozenMutationParams, SetFrozenMutation, SetFrozenMutationFactory, } from './commands/mutations/set-frozen.mutation';
 export { type IToggleGridlinesMutationParams, ToggleGridlinesMutation } from './commands/mutations/toggle-gridlines.mutation';
+export { type ISetGridlinesColorMutationParams, SetGridlinesColorMutation } from './commands/mutations/set-gridlines-color.mutation';
 export { FactorySetRangeProtectionMutation, type ISetRangeProtectionMutationParams, SetRangeProtectionMutation } from './commands/mutations/set-range-protection.mutation';
 export { type ISetRangeValuesMutationParams, type ISetRangeValuesRangeMutationParams, SetRangeValuesMutation, SetRangeValuesUndoMutationFactory, } from './commands/mutations/set-range-values.mutation';
 export { type ISetRowHiddenMutationParams, type ISetRowVisibleMutationParams, SetRowHiddenMutation, SetRowVisibleMutation, } from './commands/mutations/set-row-visible.mutation';
@@ -162,3 +171,5 @@ export { ScrollToCellOperation } from './commands/operations/scroll-to-cell.oper
 export { type ISetSelectionsOperationParams, SetSelectionsOperation } from './commands/operations/selection.operation';
 export { type ISetWorksheetActiveOperationParams, SetWorksheetActiveOperation } from './commands/operations/set-worksheet-active.operation';
 export { type IToggleCellCheckboxCommandParams, ToggleCellCheckboxCommand } from './commands/commands/toggle-checkbox.command';
+export { SCOPE_WORKBOOK_VALUE_DEFINED_NAME } from './controllers/defined-name-data.controller';
+export type { ICellOverGridPosition, ISheetOverGridPosition } from './basics/cell-position';

package/lib/types/services/__tests__/move-active-cell.spec.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/services/exclusive-range/exclusive-range-service.d.ts

@@ -1,10 +1,16 @@
 import { IRange, Disposable } from '@univerjs/core';
+import { Observable } from 'rxjs';
 import { ISelectionWithStyle } from '../../basics/selection';
 interface IFeatureRange {
     groupId: string;
     range: IRange;
 }
 export interface IExclusiveRangeService {
+    exclusiveRangesChange$: Observable<{
+        unitId: string;
+        subUnitId: string;
+        ranges: IRange[];
+    }>;
     /**
      * @description Add an exclusive range to the service
      * @param {string} unitId The unitId of the exclusive range
@@ -48,6 +54,12 @@ export declare class ExclusiveRangeService extends Disposable implements IExclus
      * Exclusive range data structure is as follows: unitId -> sheetId -> feature -> range
      */
     private _exclusiveRanges;
+    private _exclusiveRangesChange$;
+    exclusiveRangesChange$: Observable<{
+        unitId: string;
+        subUnitId: string;
+        ranges: IRange[];
+    }>;
     private _ensureUnitMap;
     private _ensureSubunitMap;
     private _ensureFeature;

package/lib/types/services/permission/permission-point/const.d.ts

@@ -0,0 +1,82 @@
+import { RangeProtectionPermissionEditPoint } from './range/edit';
+import { RangeProtectionPermissionViewPoint } from './range/view';
+import { WorkbookCommentPermission } from './workbook/comment';
+import { WorkbookCopyPermission } from './workbook/copy';
+import { WorkbookCreateProtectPermission } from './workbook/create-permission';
+import { WorkbookCreateSheetPermission } from './workbook/create-sheet';
+import { WorkbookDeleteSheetPermission } from './workbook/delete-sheet';
+import { WorkbookDuplicatePermission } from './workbook/duplicate';
+import { WorkbookEditablePermission } from './workbook/editable';
+import { WorkbookExportPermission } from './workbook/export';
+import { WorkbookHideSheetPermission } from './workbook/hide-sheet';
+import { WorkbookHistoryPermission } from './workbook/history';
+import { WorkbookManageCollaboratorPermission } from './workbook/manage-collaborator';
+import { WorkbookMoveSheetPermission } from './workbook/move-sheet';
+import { WorkbookPrintPermission } from './workbook/print';
+import { WorkbookRecoverHistoryPermission } from './workbook/recover-history';
+import { WorkbookRenameSheetPermission } from './workbook/rename-sheet';
+import { WorkbookSharePermission } from './workbook/share';
+import { WorkbookViewPermission } from './workbook/view';
+import { WorkbookViewHistoryPermission } from './workbook/view-history';
+import { WorksheetCopyPermission } from './worksheet/copy';
+import { WorksheetDeleteColumnPermission } from './worksheet/delete-column';
+import { WorksheetDeleteProtectionPermission } from './worksheet/delete-protection';
+import { WorksheetDeleteRowPermission } from './worksheet/delete-row';
+import { WorksheetEditPermission } from './worksheet/edit';
+import { WorksheetEditExtraObjectPermission } from './worksheet/edit-extra-object';
+import { WorksheetFilterPermission } from './worksheet/filter';
+import { WorksheetInsertColumnPermission } from './worksheet/insert-column';
+import { WorksheetInsertHyperlinkPermission } from './worksheet/insert-hyperlink';
+import { WorksheetInsertRowPermission } from './worksheet/insert-row';
+import { WorksheetManageCollaboratorPermission } from './worksheet/manage-collaborator';
+import { WorksheetPivotTablePermission } from './worksheet/pivot-table';
+import { WorksheetSelectProtectedCellsPermission } from './worksheet/select-protected-cells';
+import { WorksheetSelectUnProtectedCellsPermission } from './worksheet/select-un-protected-cells';
+import { WorksheetSetCellStylePermission } from './worksheet/set-cell-style';
+import { WorksheetSetCellValuePermission } from './worksheet/set-cell-value';
+import { WorksheetSetColumnStylePermission } from './worksheet/set-column-style';
+import { WorksheetSetRowStylePermission } from './worksheet/set-row-style';
+import { WorksheetSortPermission } from './worksheet/sort';
+import { WorksheetViewPermission } from './worksheet/view';
+export declare const PermissionPointsDefinitions: {
+    WorkbookCommentPermission: typeof WorkbookCommentPermission;
+    WorkbookCopyPermission: typeof WorkbookCopyPermission;
+    WorkbookCreateProtectPermission: typeof WorkbookCreateProtectPermission;
+    WorkbookCreateSheetPermission: typeof WorkbookCreateSheetPermission;
+    WorkbookDeleteSheetPermission: typeof WorkbookDeleteSheetPermission;
+    WorkbookDuplicatePermission: typeof WorkbookDuplicatePermission;
+    WorkbookEditablePermission: typeof WorkbookEditablePermission;
+    WorkbookExportPermission: typeof WorkbookExportPermission;
+    WorkbookHideSheetPermission: typeof WorkbookHideSheetPermission;
+    WorkbookHistoryPermission: typeof WorkbookHistoryPermission;
+    WorkbookManageCollaboratorPermission: typeof WorkbookManageCollaboratorPermission;
+    WorkbookMoveSheetPermission: typeof WorkbookMoveSheetPermission;
+    WorkbookPrintPermission: typeof WorkbookPrintPermission;
+    WorkbookRecoverHistoryPermission: typeof WorkbookRecoverHistoryPermission;
+    WorkbookRenameSheetPermission: typeof WorkbookRenameSheetPermission;
+    WorkbookSharePermission: typeof WorkbookSharePermission;
+    WorkbookViewHistoryPermission: typeof WorkbookViewHistoryPermission;
+    WorkbookViewPermission: typeof WorkbookViewPermission;
+    WorksheetCopyPermission: typeof WorksheetCopyPermission;
+    WorksheetDeleteColumnPermission: typeof WorksheetDeleteColumnPermission;
+    WorksheetDeleteProtectionPermission: typeof WorksheetDeleteProtectionPermission;
+    WorksheetDeleteRowPermission: typeof WorksheetDeleteRowPermission;
+    WorksheetEditExtraObjectPermission: typeof WorksheetEditExtraObjectPermission;
+    WorksheetEditPermission: typeof WorksheetEditPermission;
+    WorksheetFilterPermission: typeof WorksheetFilterPermission;
+    WorksheetInsertColumnPermission: typeof WorksheetInsertColumnPermission;
+    WorksheetInsertHyperlinkPermission: typeof WorksheetInsertHyperlinkPermission;
+    WorksheetInsertRowPermission: typeof WorksheetInsertRowPermission;
+    WorksheetManageCollaboratorPermission: typeof WorksheetManageCollaboratorPermission;
+    WorksheetPivotTablePermission: typeof WorksheetPivotTablePermission;
+    WorksheetSelectProtectedCellsPermission: typeof WorksheetSelectProtectedCellsPermission;
+    WorksheetSelectUnProtectedCellsPermission: typeof WorksheetSelectUnProtectedCellsPermission;
+    WorksheetSetCellStylePermission: typeof WorksheetSetCellStylePermission;
+    WorksheetSetCellValuePermission: typeof WorksheetSetCellValuePermission;
+    WorksheetSetColumnStylePermission: typeof WorksheetSetColumnStylePermission;
+    WorksheetSetRowStylePermission: typeof WorksheetSetRowStylePermission;
+    WorksheetSortPermission: typeof WorksheetSortPermission;
+    WorksheetViewPermission: typeof WorksheetViewPermission;
+    RangeProtectionPermissionEditPoint: typeof RangeProtectionPermissionEditPoint;
+    RangeProtectionPermissionViewPoint: typeof RangeProtectionPermissionViewPoint;
+};