@univerjs/sheets 0.5.3 → 0.5.4-experimental.20250114-7c09c35

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

@@ -1,4 +1,4 @@
-import { CellValue, ICellData, IObjectMatrixPrimitiveType, IRange, IStyleData, Nullable, Workbook, Worksheet, FBaseInitialable, ICommandService, Injector, WrapStrategy } from '@univerjs/core';
+import { CellValue, CustomData, ICellData, IDocumentData, IObjectMatrixPrimitiveType, IRange, IStyleData, Nullable, Workbook, Worksheet, FBaseInitialable, ICommandService, Injector, RichTextValue, WrapStrategy } from '@univerjs/core';
 import { SplitDelimiterEnum } from '@univerjs/sheets';
 import { FHorizontalAlignment, FVerticalAlignment } from './utils';
 import { FormulaDataModel } from '@univerjs/engine-formula';
@@ -15,206 +15,634 @@ export declare class FRange extends FBaseInitialable {
     constructor(_workbook: Workbook, _worksheet: Worksheet, _range: IRange, _injector: Injector, _commandService: ICommandService, _formulaDataModel: FormulaDataModel);
     /**
      * Get the unit ID of the current workbook
-     *
-     * @return The unit ID of the workbook
+     * @returns {string} The unit ID of the workbook
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getUnitId()
+     * ```
      */
     getUnitId(): string;
     /**
      * Gets the name of the worksheet
-     *
-     * @return The name of the worksheet
+     * @returns {string} The name of the worksheet
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getSheetName()
+     * ```
      */
     getSheetName(): string;
+    /**
+     * Gets the ID of the worksheet
+     * @returns {string} The ID of the worksheet
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getSheetId()
+     * ```
+     */
+    getSheetId(): string;
     /**
      * Gets the area where the statement is applied
-     *
-     * @return The area where the statement is applied
+     * @returns {IRange} The area where the statement is applied
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getRange()
+     * ```
      */
     getRange(): IRange;
     /**
      * Gets the starting row number of the applied area
-     *
-     * @return The starting row number of the area
+     * @returns {number} The starting row number of the area
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getRow()
+     * ```
      */
     getRow(): number;
     /**
      * Gets the starting column number of the applied area
-     *
-     * @return The starting column number of the area
+     * @returns {number} The starting column number of the area
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getColumn()
+     * ```
      */
     getColumn(): number;
     /**
      * Gets the width of the applied area
-     *
-     * @return The width of the area
+     * @returns {number} The width of the area
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getWidth()
+     * ```
      */
     getWidth(): number;
     /**
      * Gets the height of the applied area
-     *
-     * @return The height of the area
+     * @returns {number} The height of the area
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getHeight()
+     * ```
      */
     getHeight(): number;
-    /**
-     * Return first cell model data in this range
-     * @returns The cell model data
-     */
-    getCellData(): ICellData | null;
     /**
      * Return range whether this range is merged
-     * @returns if true is merged
+     * @returns {boolean} if true is merged
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .isMerged()
+     * ```
      */
     isMerged(): boolean;
     /**
      * Return first cell style data in this range
-     * @returns The cell style data
+     * @returns {IStyleData | null} The cell style data
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getCellStyleData()
+     * ```
      */
     getCellStyleData(): IStyleData | null;
     /**
-     * Returns the value of the cell at the start of this range.
-     * @returns The value of the cell.
+     * @deprecated use `getValueAndRichTextValue` instead. This api can't return rich text value.
      */
     getValue(): CellValue | null;
     /**
-     * Returns the rectangular grid of values for this range.
-     * Returns a two-dimensional array of values, indexed by row, then by column.
-     * @returns A two-dimensional array of values.
+     * @deprecated use `getValueAndRichTextValues` instead. This api can't return rich text value.
      */
     getValues(): Nullable<CellValue>[][];
+    /**
+     * Return first cell model data in this range
+     * @returns {ICellData | null} The cell model data
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getCellData()
+     * ```
+     */
+    getCellData(): ICellData | null;
     /**
      * Returns the cell data for the cells in the range.
-     * @returns A two-dimensional array of cell data.
+     * @returns {Nullable<ICellData>[][]} A two-dimensional array of cell data.
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getCellDatas()
+     * ```
+     */
+    getCellDatas(): Nullable<ICellData>[][];
+    /**
+     * @deprecated use `getCellDatas` instead.
      */
     getCellDataGrid(): Nullable<ICellData>[][];
+    /**
+     * Returns the rich text value for the cell at the start of this range.
+     * @returns {Nullable<RichTextValue>} The rich text value
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getRichTextValue()
+     * ```
+     */
+    getRichTextValue(): Nullable<RichTextValue>;
+    /**
+     * Returns the rich text value for the cells in the range.
+     * @returns {Nullable<RichTextValue>[][]} A two-dimensional array of RichTextValue objects.
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getRichTextValues()
+     * ```
+     */
+    getRichTextValues(): Nullable<RichTextValue>[][];
+    /**
+     * Returns the value and rich text value for the cell at the start of this range.
+     * @returns {Nullable<CellValue | RichTextValue>} The value and rich text value
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getValueAndRichTextValue()
+     * ```
+     */
+    getValueAndRichTextValue(): Nullable<CellValue | RichTextValue>;
+    /**
+     * Returns the value and rich text value for the cells in the range.
+     * @returns {Nullable<CellValue | RichTextValue>[][]} A two-dimensional array of value and rich text value
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getValueAndRichTextValues()
+     * ```
+     */
+    getValueAndRichTextValues(): Nullable<CellValue | RichTextValue>[][];
     /**
      * Returns the formulas (A1 notation) for the cells in the range. Entries in the 2D array are empty strings for cells with no formula.
-     * @returns A two-dimensional array of formulas in string format.
+     * @returns {string[][]} A two-dimensional array of formulas in string format.
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getFormulas()
+     * ```
      */
     getFormulas(): string[][];
+    /**
+     * Returns true if the cell wrap is enabled
+     * @returns {boolean} True if the cell wrap is enabled
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getWrap()
+     * ```
+     */
     getWrap(): boolean;
+    /**
+     * Returns the text wrapping strategy for the top left cell of the range.
+     * @returns {WrapStrategy} The text wrapping strategy
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getWrapStrategy()
+     * ```
+     */
     getWrapStrategy(): WrapStrategy;
+    /**
+     * Returns the horizontal alignment for the top left cell of the range.
+     * @returns {string} The horizontal alignment
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getHorizontalAlignment()
+     * ```
+     */
     getHorizontalAlignment(): string;
+    /**
+     * Returns the vertical alignment for the top left cell of the range.
+     * @returns {string} The vertical alignment
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getVerticalAlignment()
+     * ```
+     */
     getVerticalAlignment(): string;
     /**
-     * Set background color for current range.
-     * @param color {string}
+     * Set custom meta data for first cell in current range.
+     * @param {CustomData} data The custom meta data
+     * @returns {FRange} This range, for chaining
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .setCustomMetaData({ key: 'value' });
+     * ```
+     */
+    setCustomMetaData(data: CustomData): FRange;
+    /**
+     * Set custom meta data for current range.
+     * @param {CustomData[][]} datas The custom meta data
+     * @returns {FRange} This range, for chaining
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .setCustomMetaDatas([[{ key: 'value' }]]);
+     * ```
+     */
+    setCustomMetaDatas(datas: CustomData[][]): FRange;
+    /**
+     * Returns the custom meta data for the cell at the start of this range.
+     * @returns {CustomData | null} The custom meta data
      * @example
      * ```
-     * univerAPI.getActiveWorkbook().getActiveSheet().getActiveRange().setBackgroundColor('red')
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getCustomMetaData()
      * ```
      */
-    setBackgroundColor(color: string): FRange;
+    getCustomMetaData(): CustomData | null;
+    /**
+     * Returns the custom meta data for the cells in the range.
+     * @returns {CustomData[][]} A two-dimensional array of custom meta data
+     * @example
+     * ```
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getCustomMetaDatas()
+     * ```
+     */
+    getCustomMetaDatas(): Nullable<CustomData>[][];
     /**
      * Set background color for current range.
+     * @param {string} color The background color
+     * @returns {FRange} This range, for chaining
      * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .setBackgroundColor('red')
      * ```
+     */
+    setBackgroundColor(color: string): FRange;
+    /**
+     * Set background color for current range.
+     * @param {string} color The background color
+     * @returns {FRange} This range, for chaining
+     * @example
+     * ```typescript
      * univerAPI.getActiveWorkbook().getActiveSheet().getActiveRange().setBackground('red')
      * ```
-     * @param color {string}
      */
     setBackground(color: string): FRange;
     /**
-     * The value can be a number, string, boolean, or standard cell format. If it begins with `=`, it is interpreted as a formula. The value is tiled to all cells in the range.
-     * @param value
+     * Set new value for current cell, first cell in this range.
+     * @param {CellValue | ICellData} value 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.
+     * @returns {FRange} This range, for chaining
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .setValue(1);
+     * ```
      */
     setValue(value: CellValue | ICellData): FRange;
+    /**
+     * Set new value for current cell, first cell in this range.
+     * @param {CellValue | ICellData} value  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.
+     * @returns {FRange} This range, for chaining
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .setValueForCell(1);
+     * ```
+     */
+    setValueForCell(value: CellValue | ICellData): FRange;
+    /**
+     * Set the rich text value for the cell at the start of this range.
+     * @param {RichTextValue | IDocumentData} value The rich text value
+     * @returns {FRange} The range
+     * @example
+     * ```
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .setRichTextValueForCell(new RichTextValue().insertText('Hello'));
+     * ```
+     */
+    setRichTextValueForCell(value: RichTextValue | IDocumentData): FRange;
+    /**
+     * Set the rich text value for the cells in the range.
+     * @param {RichTextValue[][]} values The rich text value
+     * @returns {FRange} The range
+     * @example
+     * ```ts
+     * univerAPI
+     *  .getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .setRichTextValues([[new RichTextValue().insertText('Hello')]]);
+     * ```
+     */
+    setRichTextValues(values: (RichTextValue | IDocumentData)[][]): FRange;
     /**
      * Set the cell wrap of the given range.
      * Cells with wrap enabled (the default) resize to display their full content. Cells with wrap disabled display as much as possible in the cell without resizing or running to multiple lines.
+     * @param {boolean} isWrapEnabled Whether to enable wrap
+     * @returns {FRange} this range, for chaining
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .setWrap(true);
+     * ```
      */
     setWrap(isWrapEnabled: boolean): FRange;
     /**
      * Sets the text wrapping strategy for the cells in the range.
+     * @param {WrapStrategy} strategy The text wrapping strategy
+     * @returns {FRange} this range, for chaining
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .setWrapStrategy(WrapStrategy.WRAP);
+     * ```
      */
     setWrapStrategy(strategy: WrapStrategy): FRange;
     /**
      * Set the vertical (top to bottom) alignment for the given range (top/middle/bottom).
+     * @param {"top" | "middle" | "bottom"} alignment The vertical alignment
+     * @returns {FRange} this range, for chaining
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .setVerticalAlignment('top');
+     * ```
      */
     setVerticalAlignment(alignment: FVerticalAlignment): FRange;
     /**
      * Set the horizontal (left to right) alignment for the given range (left/center/right).
+     * @param {"left" | "center" | "normal"} alignment The horizontal alignment
+     * @returns {FRange} this range, for chaining
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .setHorizontalAlignment('left');
+     * ```
      */
     setHorizontalAlignment(alignment: FHorizontalAlignment): FRange;
     /**
      * Sets a different value for each cell in the range. The value can be a two-dimensional array or a standard range matrix (must match the dimensions of this range), consisting of numbers, strings, Boolean values or Composed of standard cell formats. If a value begins with `=`, it is interpreted as a formula.
-     * @param value
+     * @param {CellValue[][] | IObjectMatrixPrimitiveType<CellValue> | ICellData[][] | IObjectMatrixPrimitiveType<ICellData>} value The value can be a two-dimensional array or a standard range matrix (must match the dimensions of this range), consisting of numbers, strings, Boolean values or Composed of standard cell formats.
+     * @returns {FRange} This range, for chaining
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .setValues([[1, 2], [3, 4]]);
+     * ```
      */
     setValues(value: CellValue[][] | IObjectMatrixPrimitiveType<CellValue> | ICellData[][] | IObjectMatrixPrimitiveType<ICellData>): FRange;
     /**
      * Sets the font weight for the given range (normal/bold),
-     * @param fontWeight The font weight, either 'normal' or 'bold'; a null value resets the font weight.
+     * @param {FontWeight|null} fontWeight The font weight, either 'normal' or 'bold'; a null value resets the font weight.
+     * @returns {FRange} This range, for chaining
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .setFontWeight('bold');
+     * ```
      */
     setFontWeight(fontWeight: FontWeight | null): this;
     /**
      * Sets the font style for the given range ('italic' or 'normal').
-     * @param fontStyle The font style, either 'italic' or 'normal'; a null value resets the font style.
+     * @param {FontStyle|null} fontStyle The font style, either 'italic' or 'normal'; a null value resets the font style.
+     * @returns {FRange} This range, for chaining
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .setFontStyle('italic');
+     * ```
      */
     setFontStyle(fontStyle: FontStyle | null): this;
     /**
      * Sets the font line style of the given range ('underline', 'line-through', or 'none').
-     * @param fontLine The font line style, either 'underline', 'line-through', or 'none'; a null value resets the font line style.
+     * @param {FontLine|null} fontLine The font line style, either 'underline', 'line-through', or 'none'; a null value resets the font line style.
+     * @returns {FRange} This range, for chaining
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .setFontLine('underline');
+     * ```
      */
     setFontLine(fontLine: FontLine | null): this;
     /**
      * Sets the font underline style of the given ITextDecoration
+     * @param {ITextDecoration|null} value The font underline style of the given ITextDecoration; a null value resets the font underline style
+     * @returns {void}
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .setFontLine('underline');
+     * ```
      */
     private _setFontUnderline;
     /**
      * Sets the font strikethrough style of the given ITextDecoration
+     * @param {ITextDecoration|null} value The font strikethrough style of the given ITextDecoration; a null value resets the font strikethrough style
+     * @returns {void}
      */
     private _setFontStrikethrough;
     /**
      * Sets the font family, such as "Arial" or "Helvetica".
-     * @param fontFamily The font family to set; a null value resets the font family.
+     * @param {string|null} fontFamily The font family to set; a null value resets the font family.
+     * @returns {FRange} This range, for chaining
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .setFontFamily('Arial');
+     * ```
      */
     setFontFamily(fontFamily: string | null): this;
     /**
      * Sets the font size, with the size being the point size to use.
-     * @param size A font size in point size. A null value resets the font size.
+     * @param {number|null} size A font size in point size. A null value resets the font size.
+     * @returns {FRange} This range, for chaining
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .setFontSize(12);
+     * ```
      */
     setFontSize(size: number | null): this;
     /**
      * Sets the font color in CSS notation (such as '#ffffff' or 'white').
-     * @param color The font color in CSS notation (such as '#ffffff' or 'white'); a null value resets the color.
+     * @param {string|null} color The font color in CSS notation (such as '#ffffff' or 'white'); a null value resets the color.
+     * @returns {FRange} This range, for chaining
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .setFontColor('#ff0000');
+     * ```
      */
     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
+     * @param {boolean} [defaultMerge] - If true, only the value in the upper left cell is retained.
+     * @returns {FRange} This range, for chaining
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const worksheet = workbook.getActiveSheet();
+     * const range = worksheet.getRange(0, 0, 2, 2);
+     * const merge = range.merge();
+     * const isMerged = merge.isMerged();
+     * console.log('debugger', isMerged);
+     * ```
      */
     merge(defaultMerge?: boolean): 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
+     * @param {boolean} [defaultMerge] - If true, only the value in the upper left cell is retained.
+     * @returns {FRange} This range, for chaining
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const worksheet = workbook.getActiveSheet();
+     * const range = worksheet.getRange(2, 2, 2, 2);
+     * const merge = range.mergeAcross();
+     * const allMerge = worksheet.getMergeData();
+     * console.log(allMerge.length); // There will be two merged cells.
+     * ```
      */
     mergeAcross(defaultMerge?: boolean): 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
+     * @param {boolean} [defaultMerge] - If true, only the value in the upper left cell is retained.
+     * @returns {FRange} This range, for chaining
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const worksheet = workbook.getActiveSheet();
+     * const range = worksheet.getRange(4, 4, 2, 2);
+     * const merge = range.mergeVertically();
+     * const allMerge = worksheet.getMergeData();
+     * console.log(allMerge.length); // There will be two merged cells.
+     * ```
      */
     mergeVertically(defaultMerge?: boolean): FRange;
     /**
      * Returns true if cells in the current range overlap a merged cell.
      * @returns {boolean} is overlap with a merged cell
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const worksheet = workbook.getActiveSheet();
+     * const range = worksheet.getRange(0,0,2,2);
+     * const merge = range.merge();
+     * const anchor = worksheet.getRange(0,0);
+     * const isPartOfMerge = anchor.isPartOfMerge();
+     * console.log('debugger, isPartOfMerge) // true
+     * ```
      */
     isPartOfMerge(): boolean;
     /**
      * Break all horizontally- or vertically-merged cells contained within the range list into individual cells again.
-     * @returns This range, for chaining
+     * @returns {FRange} This range, for chaining
+     * @example
+     * ```ts
+     * const workbook = univerAPI.getActiveWorkbook();
+     * const worksheet = workbook.getActiveSheet();
+     * const range = worksheet.getRange(0,0,2,2);
+     * const merge = range.merge();
+     * const anchor = worksheet.getRange(0,0);
+     * const isPartOfMergeFirst = anchor.isPartOfMerge();
+     * console.log('debugger' isPartOfMergeFirst) // true
+     * range.breakApart();
+     * const isPartOfMergeSecond = anchor.isPartOfMerge();
+     * console.log('debugger' isPartOfMergeSecond) // false
+     * ```
      */
     breakApart(): FRange;
     /**
      * Iterate cells in this range. Merged cells will be respected.
-     * @param callback the callback function to be called for each cell in the range
+     * @param {Function} 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
@@ -230,6 +658,7 @@ export declare class FRange extends FBaseInitialable {
     forEach(callback: (row: number, col: number, cell: ICellData) => void): void;
     /**
      * Returns a string description of the range, in A1 notation.
+     * @param {boolean} [withSheet] - If true, the sheet name is included in the A1 notation.
      * @returns {string} The A1 notation of the range.
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();