@univerjs/sheets 0.5.4 → 0.5.5-nightly.202501201336

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

@@ -1,4 +1,4 @@
-import { CellValue, CustomData, ICellData, IDocumentData, IObjectMatrixPrimitiveType, IRange, IStyleData, Nullable, Workbook, Worksheet, FBaseInitialable, ICommandService, Injector, RichTextValue, WrapStrategy } from '@univerjs/core';
+import { BorderStyleTypes, BorderType, CellValue, CustomData, ICellData, IDocumentData, IObjectMatrixPrimitiveType, IRange, IStyleData, Nullable, Workbook, Worksheet, FBaseInitialable, ICommandService, Injector, RichTextValue, TextStyleValue, WrapStrategy } from '@univerjs/core';
 import { SplitDelimiterEnum } from '@univerjs/sheets';
 import { FHorizontalAlignment, FVerticalAlignment } from './utils';
 import { FormulaDataModel } from '@univerjs/engine-formula';
@@ -15,70 +15,202 @@ 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
-     * @returns 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
-     * @returns 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 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
-     * @returns 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
-     * @returns 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
-     * @returns 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
-     * @returns 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
-     * @returns The height of the area
+     * @returns {number} The height of the area
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getHeight()
+     * ```
      */
     getHeight(): number;
     /**
      * 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 {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 {CellValue | null} The value of the cell.
+     * Return first cell style in this range
+     * @returns {TextStyleValue | null} The cell style
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getCellStyle()
+     * ```
+     */
+    getCellStyle(): TextStyleValue | null;
+    /**
+     * Returns the cell styles for the cells in the range.
+     * @returns {Array<Array<TextStyleValue | null>>} A two-dimensional array of cell styles.
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getCellStyles()
+     * ```
+     */
+    getCellStyles(): Array<Array<TextStyleValue | null>>;
+    /**
+     * Return first cell value in this range
+     * @returns {CellValue | null} The cell value
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getValue()
+     * ```
      */
     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 {Nullable<CellValue>[][]} A two-dimensional array of values.
+     * Return first cell value in this range
+     * @param {boolean} includeRichText Should the returns of this func to include rich text
+     * @returns {CellValue | RichTextValue | null} The cell value
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getValue(true)
+     * ```
+     */
+    getValue(includeRichText: true): Nullable<CellValue | RichTextValue>;
+    /**
+     * Returns the cell values for the cells in the range.
+     * @returns {Nullable<CellValue>[][]} A two-dimensional array of cell values.
+     * @example
+     * ```ts
+     * // Get plain values
+     * const values = range.getValues();
+     * ```
      */
     getValues(): Nullable<CellValue>[][];
+    /**
+     * Returns the cell values for the cells in the range.
+     * @param {boolean} includeRichText Should the returns of this func to include rich text
+     * @returns {Nullable<RichTextValue | CellValue>[][]} A two-dimensional array of cell values.
+     * @example
+     * ```ts
+     * // Get values with rich text if available
+     * const richTextValues = univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getValues(true)
+     * ```
+     */
+    getValues(includeRichText: true): (Nullable<RichTextValue | CellValue>)[][];
     /**
      * Return first cell model data in this range
      * @returns {ICellData | null} The cell model data
      * @example
-     * ```
+     * ```ts
      * univerAPI.getActiveWorkbook()
      *  .getActiveSheet()
      *  .getActiveRange()
@@ -87,10 +219,10 @@ export declare class FRange extends FBaseInitialable {
      */
     getCellData(): ICellData | null;
     /**
-     * Returns the cell data for the cells in the range.
+     * Alias for getCellDataGrid.
      * @returns {Nullable<ICellData>[][]} A two-dimensional array of cell data.
      * @example
-     * ```
+     * ```ts
      * univerAPI.getActiveWorkbook()
      *  .getActiveSheet()
      *  .getActiveRange()
@@ -99,50 +231,64 @@ export declare class FRange extends FBaseInitialable {
      */
     getCellDatas(): Nullable<ICellData>[][];
     /**
-     * @deprecated use `getCellDatas` instead.
+     * Returns the cell data for the cells in the range.
+     * @returns {Nullable<ICellData>[][]} A two-dimensional array of cell data.
+     * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .getCellDataGrid()
+     * ```
      */
     getCellDataGrid(): Nullable<ICellData>[][];
     /**
      * Returns the rich text value for the cell at the start of this range.
      * @returns {Nullable<RichTextValue>} The rich text value
+     * @internal
+     * @beta
      * @example
-     * ```
+     * ```ts
      * univerAPI.getActiveWorkbook()
      *  .getActiveSheet()
      *  .getActiveRange()
      *  .getRichTextValue()
      * ```
      */
-    getRichTextValue(): Nullable<RichTextValue>;
+    private getRichTextValue;
     /**
      * Returns the rich text value for the cells in the range.
      * @returns {Nullable<RichTextValue>[][]} A two-dimensional array of RichTextValue objects.
+     * @internal
+     * @beta
      * @example
-     * ```
+     * ```ts
      * univerAPI.getActiveWorkbook()
      *  .getActiveSheet()
      *  .getActiveRange()
      *  .getRichTextValues()
      * ```
      */
-    getRichTextValues(): Nullable<RichTextValue>[][];
+    private getRichTextValues;
     /**
      * 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
+     * @internal
+     * @beta
      * @example
-     * ```
+     * ```ts
      * univerAPI.getActiveWorkbook()
      *  .getActiveSheet()
      *  .getActiveRange()
      *  .getValueAndRichTextValue()
      * ```
      */
-    getValueAndRichTextValue(): Nullable<CellValue | RichTextValue>;
+    private getValueAndRichTextValue;
     /**
      * 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()
@@ -162,9 +308,53 @@ export declare class FRange extends FBaseInitialable {
      * ```
      */
     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 custom meta data for first cell in current range.
@@ -215,10 +405,26 @@ export declare class FRange extends FBaseInitialable {
      */
     getCustomMetaDatas(): Nullable<CustomData>[][];
     /**
-     * Set background color for current range.
-     * @param color {string}
+     * Sets basic border properties for the current range.
+     * @param {BorderType} type The type of border to apply
+     * @param {BorderStyleTypes} style The border style
+     * @param {string} [color] Optional border color in CSS notation
+     * @returns {FRange} This range, for chaining
      * @example
+     * ```ts
+     * univerAPI.getActiveWorkbook()
+     *  .getActiveSheet()
+     *  .getActiveRange()
+     *  .setBorder(BorderType.ALL, BorderStyleType.THIN, '#ff0000');
      * ```
+     */
+    setBorder(type: BorderType, style: BorderStyleTypes, color?: string): FRange;
+    /**
+     * Set background color for current range.
+     * @param {string} color The background color
+     * @returns {FRange} This range, for chaining
+     * @example
+     * ```ts
      * univerAPI.getActiveWorkbook()
      *  .getActiveSheet()
      *  .getActiveRange()
@@ -228,21 +434,30 @@ export declare class FRange extends FBaseInitialable {
     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;
     /**
      * 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()
@@ -281,73 +496,170 @@ export declare class FRange extends FBaseInitialable {
     /**
      * 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 isWrapEnabled
+     * @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 strategy
+     * @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 alignment
+     * @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 alignment
+     * @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 value
+     * @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 value
+     * @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();
@@ -361,8 +673,8 @@ export declare class FRange extends FBaseInitialable {
     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();
@@ -376,8 +688,8 @@ export declare class FRange extends FBaseInitialable {
     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();
@@ -406,7 +718,7 @@ export declare class FRange extends FBaseInitialable {
     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();
@@ -424,7 +736,7 @@ export declare class FRange extends FBaseInitialable {
     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
@@ -440,7 +752,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 withSheet
+     * @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();

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

@@ -22,16 +22,40 @@ export declare class FSelection {
     /**
      * Represents the active selection in the sheet. Which means the selection contains the active cell.
      * @returns {FRange | null} The active selection.
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fSelection = fWorksheet.getSelection();
+     * const activeRange = fSelection.getActiveRange();
+     * console.log(activeRange);
+     * ```
      */
     getActiveRange(): FRange | null;
     /**
      * Represents the active selection list in the sheet.
      * @returns {FRange[]} The active selection list.
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fSelection = fWorksheet.getSelection();
+     * const activeRangeList = fSelection.getActiveRangeList();
+     * console.log(activeRangeList);
+     * ```
      */
     getActiveRangeList(): FRange[];
     /**
      * Represents the current select cell in the sheet.
      * @returns {ISelectionCell} The current select cell info.Pay attention to the type of the return value.
+     * @example
+     * ```ts
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fSelection = fWorksheet.getSelection();
+     * const currentCell = fSelection.getCurrentCell();
+     * console.log(currentCell);
+     * ```
      */
     getCurrentCell(): Nullable<ISelectionCell>;
     /**