@univerjs/sheets 0.5.1 → 0.5.2-nightly.202412281605

package/lib/types/basics/cell-position.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 interface ICellOverGridPosition {
+    column: number;
+    columnOffset: number;
+    row: number;
+    rowOffset: number;
+}
+export interface ISheetOverGridPosition {
+    from: ICellOverGridPosition;
+    to: ICellOverGridPosition;
+}

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

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export * from './cell-position';
 export * from './const/index';
 export * from './interfaces/index';
 export * from './selection';

package/lib/types/basics/selection.d.ts

@@ -120,7 +120,7 @@ export interface ISelectionWithStyle extends ISelection {
      * if primary is not defined, means not keep current primary cell.
      */
     primary: Nullable<ISelectionCell>;
-    style: Nullable<Partial<ISelectionStyle>>;
+    style?: Nullable<Partial<ISelectionStyle>>;
 }
 export interface ISheetRangeLocation {
     range: IRange;

package/lib/types/basics/split-range-text.d.ts

@@ -0,0 +1,42 @@
+import { IRange, Worksheet } from '@univerjs/core';
+/**
+ * The default delimiter to split the text.
+ */
+export declare enum SplitDelimiterEnum {
+    /**
+     * The tab character
+     */
+    Tab = 1,
+    /**
+     * The comma character
+     */
+    Comma = 2,
+    /**
+     * The semicolon character
+     */
+    Semicolon = 4,
+    /**
+     * The space character
+     */
+    Space = 8,
+    /**
+     * The custom delimiter
+     */
+    Custom = 16
+}
+interface ISplitRangeTextResult {
+    rs: (string[] | undefined)[];
+    maxLength: number;
+    lastRow: number;
+}
+/**
+ * Split the text in the range into a two-dimensional array.
+ * @param {Worksheet} sheet The worksheet which range belongs to.
+ * @param {IRange} range The range to split.
+ * @param {SplitDelimiterEnum} [delimiter] The delimiter to split the text.
+ * @param {string} [customDelimiter] The custom delimiter to split the text. An error will be thrown if customDelimiter is not a character.
+ * @param {boolean} [treatMultipleDelimitersAsOne] split multiple delimiters as one.
+ * @returns {ISplitRangeTextResult} The two-dimensional array of the split text and max column length.
+ */
+export declare function splitRangeText(sheet: Worksheet, range: IRange, delimiter?: SplitDelimiterEnum, customDelimiter?: string, treatMultipleDelimitersAsOne?: boolean): ISplitRangeTextResult;
+export {};

package/lib/types/commands/commands/__tests__/set-gridlines-command.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/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[]): Promise<void>;
+export declare function addMergeCellsUtil(injector: Injector, unitId: string, subUnitId: string, ranges: IRange[], defaultMerge: boolean): Promise<void>;

package/lib/types/commands/commands/set-gridlines-color.command.d.ts

@@ -0,0 +1,7 @@
+import { ICommand } from '@univerjs/core';
+export interface ISetGridlinesColorCommandParams {
+    color: string | undefined;
+    unitId?: string;
+    subUnitId?: string;
+}
+export declare const SetGridlinesColorCommand: ICommand;

package/lib/types/commands/commands/set-worksheet-show.command.d.ts

@@ -2,6 +2,5 @@ import { ICommand } from '@univerjs/core';
 export interface ISetWorksheetShowCommandParams {
     unitId: string;
     subUnitId: string;
-    value?: string;
 }
 export declare const SetWorksheetShowCommand: ICommand;

package/lib/types/commands/commands/split-text-to-columns.command.d.ts

@@ -0,0 +1,15 @@
+import { IAccessor, IRange, CommandType } from '@univerjs/core';
+import { SplitDelimiterEnum } from '../../basics/split-range-text';
+export interface ISplitTextToColumnsCommandParams {
+    unitId: string;
+    subUnitId: string;
+    range: IRange;
+    delimiter?: SplitDelimiterEnum;
+    customDelimiter?: string;
+    treatMultipleDelimitersAsOne?: boolean;
+}
+export declare const SplitTextToColumnsCommand: {
+    type: CommandType;
+    id: string;
+    handler: (accessor: IAccessor, params: ISplitTextToColumnsCommandParams) => Promise<boolean>;
+};

package/lib/types/commands/mutations/set-gridlines-color.mutation.d.ts

@@ -0,0 +1,12 @@
+import { IAccessor, IMutation } from '@univerjs/core';
+export interface ISetGridlinesColorMutationParams {
+    color: string | undefined;
+    unitId: string;
+    subUnitId: string;
+}
+export declare const SetGridlinesColorUndoMutationFactory: (accessor: IAccessor, params: ISetGridlinesColorMutationParams) => {
+    unitId: string;
+    subUnitId: string;
+    color: string | undefined;
+};
+export declare const SetGridlinesColorMutation: IMutation<ISetGridlinesColorMutationParams>;

package/lib/types/controllers/defined-name-data.controller.d.ts

@@ -1,5 +1,6 @@
 import { Disposable, IResourceManagerService } from '@univerjs/core';
 import { IDefinedNamesService } from '@univerjs/engine-formula';
+export declare const SCOPE_WORKBOOK_VALUE_DEFINED_NAME = "AllDefaultWorkbook";
 export declare class DefinedNameDataController extends Disposable {
     private readonly _definedNamesService;
     private _resourceManagerService;

package/lib/types/facade/f-defined-name.d.ts

@@ -0,0 +1,294 @@
+import { FWorksheet } from './f-worksheet';
+import { FBase, IAuthzIoService, ICommandService, Injector, IPermissionService, LocaleService } from '@univerjs/core';
+import { IDefinedNamesService, ISetDefinedNameMutationParam } from '@univerjs/engine-formula';
+import { RangeProtectionRuleModel, WorksheetProtectionPointModel, WorksheetProtectionRuleModel } from '@univerjs/sheets';
+export declare class FDefinedNameBuilder {
+    private _definedNameParam;
+    constructor();
+    /**
+     * Sets the name of the defined name builder.
+     * @param name  The name of the defined name.
+     * @returns The defined name builder.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedNameBuilder = UniverAPI.newDefinedName()
+     *    .setName('MyDefinedName')
+     *  .build();
+     * workbook.insertDefinedNameBuilder(definedNameBuilder);
+     * ```
+     */
+    setName(name: string): FDefinedNameBuilder;
+    /**
+     * Sets the formula of the defined name builder.
+     * @param formula The formula of the defined name.
+     * @returns The defined name builder.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedNameBuilder = UniverAPI.newDefinedName()
+     *  .setFormula('SUM(Sheet1!$A$1)')
+     * .setName('MyDefinedName')
+     * .build();
+     * workbook.insertDefinedNameBuilder(definedNameBuilder);
+     * ```
+     */
+    setFormula(formula: string): FDefinedNameBuilder;
+    /**
+     * Sets the reference of the defined name builder.
+     * @param refString The reference of the defined name.
+     * @returns The defined name builder.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedNameBuilder = UniverAPI.newDefinedName()
+     *  .setRef('Sheet1!$A$1')
+     * .build();
+     * workbook.insertDefinedNameBuilder(definedNameBuilder);
+     * ```
+     */
+    setRef(a1Notation: string): FDefinedNameBuilder;
+    /**
+     * Sets the reference of the defined name builder by range .
+     * @param row The start row of the range.
+     * @param column The start column of the range.
+     * @param numRows The number of rows in the range.
+     * @param numColumns The number of columns in the range.
+     * @returns The defined name builder.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedNameBuilder = UniverAPI.newDefinedName()
+     *  .setRefByRange(1, 3, 2, 5)
+     * .build();
+     * workbook.insertDefinedNameBuilder(definedNameBuilder);
+     * ```
+     */
+    setRefByRange(row: number, column: number, numRows: number, numColumns: number): FDefinedNameBuilder;
+    /**
+     * Sets the comment of the defined name builder.
+     * @param comment The comment of the defined name.
+     * @returns The defined name builder.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedNameBuilder = UniverAPI.newDefinedName()
+     *  .setComment('This is a comment')
+     * .build();
+     * workbook.insertDefinedNameBuilder(definedNameBuilder);
+     * ```
+     */
+    setComment(comment: string): FDefinedNameBuilder;
+    /**
+     * Sets the hidden status of the defined name builder.
+     * @param hidden The hidden status of the defined name.
+     * @returns The defined name builder.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedNameBuilder = UniverAPI.newDefinedName()
+     *  .setHidden(true)
+     * .build();
+     * workbook.insertDefinedNameBuilder(definedNameBuilder);
+     * ```
+     */
+    setHidden(hidden: boolean): FDefinedNameBuilder;
+    /**
+     * Builds the defined name.
+     * @returns The defined name mutation parameter.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedNameBuilder = UniverAPI.newDefinedName()
+     *  .setRef('Sheet1!$A$1')
+     *  .setName('MyDefinedName')
+     *  .build();
+     * workbook.insertDefinedNameBuilder(definedNameBuilder);
+     * ```
+     */
+    build(): ISetDefinedNameMutationParam;
+    load(param: ISetDefinedNameMutationParam): FDefinedNameBuilder;
+}
+export declare class FDefinedName extends FBase {
+    protected _definedNameParam: ISetDefinedNameMutationParam;
+    protected readonly _injector: Injector;
+    protected readonly _commandService: ICommandService;
+    protected readonly _permissionService: IPermissionService;
+    protected readonly _worksheetProtectionRuleModel: WorksheetProtectionRuleModel;
+    protected readonly _rangeProtectionRuleModel: RangeProtectionRuleModel;
+    protected readonly _worksheetProtectionPointRuleModel: WorksheetProtectionPointModel;
+    protected readonly _authzIoService: IAuthzIoService;
+    protected readonly _localeService: LocaleService;
+    protected readonly _definedNamesService: IDefinedNamesService;
+    constructor(_definedNameParam: ISetDefinedNameMutationParam, _injector: Injector, _commandService: ICommandService, _permissionService: IPermissionService, _worksheetProtectionRuleModel: WorksheetProtectionRuleModel, _rangeProtectionRuleModel: RangeProtectionRuleModel, _worksheetProtectionPointRuleModel: WorksheetProtectionPointModel, _authzIoService: IAuthzIoService, _localeService: LocaleService, _definedNamesService: IDefinedNamesService);
+    private _apply;
+    /**
+     * Gets the name of the defined name.
+     * @returns The name of the defined name.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedName = workbook.getDefinedNames[0];
+     * console.log(definedName.getName());
+     * ```
+     */
+    getName(): string;
+    /**
+     * Sets the name of the defined name.
+     * @param name The name of the defined name.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedName = workbook.getDefinedName('MyDefinedName');
+     * definedName.setName('NewDefinedName');
+     * ```
+     */
+    setName(name: string): void;
+    /**
+     * Sets the formula of the defined name.
+     * @param formula The formula of the defined name.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedName = workbook.getDefinedName('MyDefinedName');
+     * definedName.setFormula('SUM(Sheet1!$A$1)');
+     * ```
+     */
+    setFormula(formula: string): void;
+    /**
+     * Sets the reference of the defined name.
+     * @param refString The reference of the defined name.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedName = workbook.getDefinedNames[0];
+     * definedName.setRef('Sheet1!$A$1');
+     * ```
+     */
+    setRef(refString: string): void;
+    /**
+     * Gets the reference of the defined name.
+     * @returns The reference of the defined name.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedName = workbook.getDefinedNames[0];
+     * console.log(definedName.getFormulaOrRefString());
+     * ```
+     */
+    getFormulaOrRefString(): string;
+    /**
+     * Sets the reference of the defined name by range.
+     * @param row The start row of the range.
+     * @param column The start column of the range.
+     * @param numRows The number of rows in the range.
+     * @param numColumns The number of columns in the range.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedName = workbook.getDefinedNames[0];
+     * definedName.setRefByRange(1, 3, 2, 5);
+     * ```
+     */
+    setRefByRange(row: number, column: number, numRows: number, numColumns: number): void;
+    /**
+     * Gets the comment of the defined name.
+     * @returns The comment of the defined name.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedName = workbook.getDefinedNames[0];
+     * console.log(definedName.getComment());
+     * ```
+     */
+    getComment(): string | undefined;
+    /**
+     * Sets the comment of the defined name.
+     * @param comment The comment of the defined name.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedName = workbook.getDefinedNames[0];
+     * definedName.setComment('This is a comment');
+     * ```
+     */
+    setComment(comment: string): void;
+    /**
+     * Sets the scope of the defined name to the worksheet.
+     * @param worksheet The worksheet to set the scope to.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const worksheet = workbook.getWorksheets[0];
+     * const definedName = workbook.getDefinedNames[0];
+     * definedName.setScopeToWorksheet(worksheet);
+     * ```
+     */
+    setScopeToWorksheet(worksheet: FWorksheet): void;
+    /**
+     * Sets the scope of the defined name to the workbook.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedName = workbook.getDefinedNames[0];
+     * definedName.setScopeToWorkbook();
+     * ```
+     */
+    setScopeToWorkbook(): void;
+    /**
+     * Sets the hidden status of the defined name.
+     * @param hidden The hidden status of the defined name.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedName = workbook.getDefinedNames[0];
+     * definedName.setHidden(true);
+     * ```
+     */
+    setHidden(hidden: boolean): void;
+    /**
+     * Deletes the defined name.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedName = workbook.getDefinedNames[0];
+     * definedName.delete();
+     * ```
+     */
+    delete(): void;
+    /**
+     * Gets the local sheet id of the defined name.
+     * @returns The local sheet id of the defined name.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedName = workbook.getDefinedNames[0];
+     * console.log(definedName.getLocalSheetId());
+     * ```
+     */
+    getLocalSheetId(): string | undefined;
+    /**
+     * Checks if the defined name is in the workbook scope.
+     * @returns True if the defined name is in the workbook scope, false otherwise.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedName = workbook.getDefinedNames[0];
+     * console.log(definedName.isWorkbookScope());
+     * ```
+     */
+    isWorkbookScope(): boolean;
+    /**
+     * Converts the defined name to a defined name builder.
+     * @returns The defined name builder.
+     * @example
+     * ```ts
+     * const workbook = UniverAPI.getActiveWorkbook();
+     * const definedName = workbook.getDefinedNames[0];
+     * const definedNameBuilder = definedName.toBuilder();
+     * const param definedNameBuilder.setName('NewDefinedName').setFormula('SUM(Sheet1!$A$1)').build();
+     * workbook.updateDefinedNameBuilder(param);
+     * ```
+     */
+    toBuilder(): FDefinedNameBuilder;
+}

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

@@ -1,5 +1,5 @@
 import { IRange, RangePermissionPointConstructor, WorkbookPermissionPointConstructor, WorkSheetPermissionPointConstructor, FBase, IAuthzIoService, ICommandService, Injector, IPermissionService } from '@univerjs/core';
-import { RangeProtectionRuleModel, WorksheetProtectionPointModel, WorksheetProtectionRuleModel } from '@univerjs/sheets';
+import { RangeProtectionRuleModel, WorkbookEditablePermission, WorksheetEditPermission, WorksheetProtectionPointModel, WorksheetProtectionRuleModel, WorksheetViewPermission } from '@univerjs/sheets';
 export declare class FPermission extends FBase {
     protected readonly _injector: Injector;
     protected readonly _commandService: ICommandService;
@@ -8,6 +8,48 @@ export declare class FPermission extends FBase {
     protected readonly _rangeProtectionRuleModel: RangeProtectionRuleModel;
     protected readonly _worksheetProtectionPointRuleModel: WorksheetProtectionPointModel;
     protected readonly _authzIoService: IAuthzIoService;
+    permissionPointsDefinition: {
+        WorkbookCommentPermission: typeof import('@univerjs/sheets').WorkbookCommentPermission;
+        WorkbookCopyPermission: typeof import('@univerjs/sheets').WorkbookCopyPermission;
+        WorkbookCreateProtectPermission: typeof import('@univerjs/sheets').WorkbookCreateProtectPermission;
+        WorkbookCreateSheetPermission: typeof import('@univerjs/sheets').WorkbookCreateSheetPermission;
+        WorkbookDeleteSheetPermission: typeof import('@univerjs/sheets').WorkbookDeleteSheetPermission;
+        WorkbookDuplicatePermission: typeof import('@univerjs/sheets').WorkbookDuplicatePermission;
+        WorkbookEditablePermission: typeof WorkbookEditablePermission;
+        WorkbookExportPermission: typeof import('@univerjs/sheets').WorkbookExportPermission;
+        WorkbookHideSheetPermission: typeof import('@univerjs/sheets').WorkbookHideSheetPermission;
+        WorkbookHistoryPermission: typeof import('@univerjs/sheets').WorkbookHistoryPermission;
+        WorkbookManageCollaboratorPermission: typeof import('@univerjs/sheets').WorkbookManageCollaboratorPermission;
+        WorkbookMoveSheetPermission: typeof import('@univerjs/sheets').WorkbookMoveSheetPermission;
+        WorkbookPrintPermission: typeof import('@univerjs/sheets').WorkbookPrintPermission;
+        WorkbookRecoverHistoryPermission: typeof import('@univerjs/sheets').WorkbookRecoverHistoryPermission;
+        WorkbookRenameSheetPermission: typeof import('@univerjs/sheets').WorkbookRenameSheetPermission;
+        WorkbookSharePermission: typeof import('@univerjs/sheets').WorkbookSharePermission;
+        WorkbookViewHistoryPermission: typeof import('@univerjs/sheets').WorkbookViewHistoryPermission;
+        WorkbookViewPermission: typeof import('@univerjs/sheets').WorkbookViewPermission;
+        WorksheetCopyPermission: typeof import('@univerjs/sheets').WorksheetCopyPermission;
+        WorksheetDeleteColumnPermission: typeof import('@univerjs/sheets').WorksheetDeleteColumnPermission;
+        WorksheetDeleteProtectionPermission: typeof import('@univerjs/sheets').WorksheetDeleteProtectionPermission;
+        WorksheetDeleteRowPermission: typeof import('@univerjs/sheets').WorksheetDeleteRowPermission;
+        WorksheetEditExtraObjectPermission: typeof import('@univerjs/sheets').WorksheetEditExtraObjectPermission;
+        WorksheetEditPermission: typeof WorksheetEditPermission;
+        WorksheetFilterPermission: typeof import('@univerjs/sheets').WorksheetFilterPermission;
+        WorksheetInsertColumnPermission: typeof import('@univerjs/sheets').WorksheetInsertColumnPermission;
+        WorksheetInsertHyperlinkPermission: typeof import('@univerjs/sheets').WorksheetInsertHyperlinkPermission;
+        WorksheetInsertRowPermission: typeof import('@univerjs/sheets').WorksheetInsertRowPermission;
+        WorksheetManageCollaboratorPermission: typeof import('@univerjs/sheets').WorksheetManageCollaboratorPermission;
+        WorksheetPivotTablePermission: typeof import('@univerjs/sheets').WorksheetPivotTablePermission;
+        WorksheetSelectProtectedCellsPermission: typeof import('@univerjs/sheets').WorksheetSelectProtectedCellsPermission;
+        WorksheetSelectUnProtectedCellsPermission: typeof import('@univerjs/sheets').WorksheetSelectUnProtectedCellsPermission;
+        WorksheetSetCellStylePermission: typeof import('@univerjs/sheets').WorksheetSetCellStylePermission;
+        WorksheetSetCellValuePermission: typeof import('@univerjs/sheets').WorksheetSetCellValuePermission;
+        WorksheetSetColumnStylePermission: typeof import('@univerjs/sheets').WorksheetSetColumnStylePermission;
+        WorksheetSetRowStylePermission: typeof import('@univerjs/sheets').WorksheetSetRowStylePermission;
+        WorksheetSortPermission: typeof import('@univerjs/sheets').WorksheetSortPermission;
+        WorksheetViewPermission: typeof WorksheetViewPermission;
+        RangeProtectionPermissionEditPoint: typeof import('@univerjs/sheets').RangeProtectionPermissionEditPoint;
+        RangeProtectionPermissionViewPoint: typeof import('@univerjs/sheets').RangeProtectionPermissionViewPoint;
+    };
     constructor(_injector: Injector, _commandService: ICommandService, _permissionService: IPermissionService, _worksheetProtectionRuleModel: WorksheetProtectionRuleModel, _rangeProtectionRuleModel: RangeProtectionRuleModel, _worksheetProtectionPointRuleModel: WorksheetProtectionPointModel, _authzIoService: IAuthzIoService);
     /**
      * Configures a specific permission point for a workbook.
@@ -103,4 +145,10 @@ export declare class FPermission extends FBase {
      * @param {IRange[]} ranges - The array of new ranges to be set for the range protection rule.
      */
     setRangeProtectionRanges(unitId: string, subUnitId: string, ruleId: string, ranges: IRange[]): void;
+    /**
+     * Set visibility of unauthorized pop-up window
+     *
+     * @param {boolean} visible
+     */
+    setPermissionDialogVisible(visible: boolean): void;
 }

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

@@ -1,4 +1,5 @@
 import { CellValue, ICellData, IObjectMatrixPrimitiveType, IRange, IStyleData, Nullable, Workbook, Worksheet, FBase, 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';
@@ -94,7 +95,24 @@ export declare class FRange extends FBase {
     getWrapStrategy(): WrapStrategy;
     getHorizontalAlignment(): string;
     getVerticalAlignment(): string;
+    /**
+     * Set background color for current range.
+     * @param color {string}
+     * @example
+     * ```
+     * univerAPI.getActiveWorkbook().getActiveSheet().getActiveRange().setBackgroundColor('red')
+     * ```
+     */
     setBackgroundColor(color: string): Promise<boolean>;
+    /**
+     * Set background color for current range.
+     * @example
+     * ```
+     * univerAPI.getActiveWorkbook().getActiveSheet().getActiveRange().setBackground('red')
+     * ```
+     * @param color {string}
+     */
+    setBackground(color: string): Promise<boolean>;
     /**
      * 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
@@ -162,32 +180,108 @@ export declare class FRange extends FBase {
     setFontColor(color: string | null): this;
     /**
      * Merge cells in a range into one merged cell
+     *
+     * @param [defaultMerge] - If true, only the value in the upper left cell is retained.
+     *
      * @returns This range, for chaining
      */
-    merge(): Promise<FRange>;
+    merge(defaultMerge?: boolean): Promise<FRange>;
     /**
      * Merges cells in a range horizontally.
+     *
+     * @param [defaultMerge] - If true, only the value in the upper left cell is retained.
+     *
      * @returns This range, for chaining
      */
-    mergeAcross(): Promise<FRange>;
+    mergeAcross(defaultMerge?: boolean): Promise<FRange>;
     /**
      * Merges cells in a range vertically.
+     *
+     * @param [defaultMerge] - If true, only the value in the upper left cell is retained.
+     *
      * @returns This range, for chaining
      */
-    mergeVertically(): Promise<FRange>;
+    mergeVertically(defaultMerge?: boolean): Promise<FRange>;
     /**
      * Returns true if cells in the current range overlap a merged cell.
      * @returns {boolean} is overlap with a merged cell
      */
     isPartOfMerge(): boolean;
     /**
-     * Unmerge cells in the range
+     * Break all horizontally- or vertically-merged cells contained within the range list into individual cells again.
      * @returns This range, for chaining
      */
     breakApart(): FRange;
     /**
      * Iterate cells in this range. Merged cells will be respected.
-     * @param callback
+     * @param callback the callback function to be called for each cell in the range
+     * @param {number} callback.row the row number of the cell
+     * @param {number} callback.col the column number of the cell
+     * @param {ICellData} callback.cell the cell data
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:B2');
+     * fRange.forEach((row, col, cell) => {
+     *    console.log(row, col, cell);
+     * });
+     * ```
      */
     forEach(callback: (row: number, col: number, cell: ICellData) => void): void;
+    /**
+     * Returns a string description of the range, in A1 notation.
+     * @returns {string} The A1 notation of the range.
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:B2');
+     * console.log(fRange.getA1Notation()); // A1:B2
+     * ```
+     */
+    getA1Notation(withSheet?: boolean): string;
+    /**
+     * Sets the specified range as the active range, with the top left cell in the range as the current cell.
+     * @returns {FRange}  This range, for chaining.
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('A1:B2');
+     * fRange.activate(); // the active cell will be A1
+     * ```
+     */
+    activate(): FRange;
+    /**
+     * Sets the specified cell as the current cell.
+     * If the specified cell is present in an existing range, then that range becomes the active range with the cell as the current cell.
+     * If the specified cell is not part of an existing range, then a new range is created with the cell as the active range and the current cell.
+     * @returns {FRange}  This range, for chaining.
+     * @description If the range is not a single cell, an error will be thrown.
+     */
+    activateAsCurrentCell(): FRange;
+    /**
+     * Splits a column of text into multiple columns based on an auto-detected delimiter.
+     * @param {boolean} [treatMultipleDelimitersAsOne] Whether to treat multiple continuous delimiters as one. The default value is false.
+     * @example
+     * // A1:A3 has following values:
+     * //     A  | B | C
+     * //  1,2,3 |   |
+     * //  4,,5,6 |   |
+     * // After calling splitTextToColumns(true), the range will be:
+     * //  A | B | C
+     * //  1 | 2 | 3
+     * //  4 | 5 | 6
+     * // After calling splitTextToColumns(false), the range will be:
+     * //  A | B | C | D
+     * //  1 | 2 | 3 |
+     * //  4 |   | 5 | 6
+     */
+    splitTextToColumns(treatMultipleDelimitersAsOne?: boolean): void;
+    /**
+     * Splits a column of text into multiple columns based on a specified delimiter.
+     * @param {boolean} [treatMultipleDelimitersAsOne] Whether to treat multiple continuous delimiters as one. The default value is false.
+     * @param {SplitDelimiterEnum} [delimiter] The delimiter to use to split the text. The default delimiter is Tab(1)、Comma(2)、Semicolon(4)、Space(8)、Custom(16).A delimiter like 6 (SplitDelimiterEnum.Comma|SplitDelimiterEnum.Semicolon) means using Comma and Semicolon to split the text.
+     * @returns {void}
+     */
+    splitTextToColumns(treatMultipleDelimitersAsOne?: boolean, delimiter?: SplitDelimiterEnum): void;
 }