@univerjs/sheets 0.5.5 → 0.6.0-alpha.0

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

@@ -5,6 +5,12 @@ import { FormulaDataModel } from '@univerjs/engine-formula';
 export type FontLine = 'none' | 'underline' | 'line-through';
 export type FontStyle = 'normal' | 'italic';
 export type FontWeight = 'normal' | 'bold';
+/**
+ * Represents a range of cells in a sheet. You can call methods on this Facade API object
+ * to read contents or manipulate the range.
+ *
+ * @hideconstructor
+ */
 export declare class FRange extends FBaseInitialable {
     protected readonly _workbook: Workbook;
     protected readonly _worksheet: Worksheet;
@@ -19,9 +25,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getUnitId()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getUnitId()
      * ```
      */
     getUnitId(): string;
@@ -31,9 +37,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getSheetName()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getSheetName()
      * ```
      */
     getSheetName(): string;
@@ -43,9 +49,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getSheetId()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getSheetId()
      * ```
      */
     getSheetId(): string;
@@ -55,9 +61,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getRange()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getRange()
      * ```
      */
     getRange(): IRange;
@@ -67,9 +73,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getRow()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getRow()
      * ```
      */
     getRow(): number;
@@ -79,9 +85,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getColumn()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getColumn()
      * ```
      */
     getColumn(): number;
@@ -91,9 +97,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getWidth()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getWidth()
      * ```
      */
     getWidth(): number;
@@ -103,9 +109,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getHeight()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getHeight()
      * ```
      */
     getHeight(): number;
@@ -115,9 +121,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .isMerged()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .isMerged()
      * ```
      */
     isMerged(): boolean;
@@ -127,9 +133,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getCellStyleData()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getCellStyleData()
      * ```
      */
     getCellStyleData(): IStyleData | null;
@@ -139,9 +145,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getCellStyle()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getCellStyle()
      * ```
      */
     getCellStyle(): TextStyleValue | null;
@@ -151,9 +157,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getCellStyles()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getCellStyles()
      * ```
      */
     getCellStyles(): Array<Array<TextStyleValue | null>>;
@@ -163,9 +169,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getValue()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getValue()
      * ```
      */
     getValue(): CellValue | null;
@@ -176,9 +182,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getValue(true)
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getValue(true)
      * ```
      */
     getValue(includeRichText: true): Nullable<CellValue | RichTextValue>;
@@ -200,9 +206,9 @@ export declare class FRange extends FBaseInitialable {
      * ```ts
      * // Get values with rich text if available
      * const richTextValues = univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getValues(true)
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getValues(true)
      * ```
      */
     getValues(includeRichText: true): (Nullable<RichTextValue | CellValue>)[][];
@@ -212,9 +218,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getCellData()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getCellData()
      * ```
      */
     getCellData(): ICellData | null;
@@ -224,9 +230,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getCellDatas()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getCellDatas()
      * ```
      */
     getCellDatas(): Nullable<ICellData>[][];
@@ -236,9 +242,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getCellDataGrid()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getCellDataGrid()
      * ```
      */
     getCellDataGrid(): Nullable<ICellData>[][];
@@ -250,9 +256,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getRichTextValue()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getRichTextValue()
      * ```
      */
     private getRichTextValue;
@@ -264,9 +270,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getRichTextValues()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getRichTextValues()
      * ```
      */
     private getRichTextValues;
@@ -278,9 +284,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getValueAndRichTextValue()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getValueAndRichTextValue()
      * ```
      */
     private getValueAndRichTextValue;
@@ -290,9 +296,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getValueAndRichTextValues()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getValueAndRichTextValues()
      * ```
      */
     getValueAndRichTextValues(): Nullable<CellValue | RichTextValue>[][];
@@ -302,9 +308,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getFormulas()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getFormulas()
      * ```
      */
     getFormulas(): string[][];
@@ -314,9 +320,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getWrap()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getWrap()
      * ```
      */
     getWrap(): boolean;
@@ -326,9 +332,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getWrapStrategy()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getWrapStrategy()
      * ```
      */
     getWrapStrategy(): WrapStrategy;
@@ -338,9 +344,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getHorizontalAlignment()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getHorizontalAlignment()
      * ```
      */
     getHorizontalAlignment(): string;
@@ -350,9 +356,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getVerticalAlignment()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getVerticalAlignment()
      * ```
      */
     getVerticalAlignment(): string;
@@ -362,9 +368,9 @@ export declare class FRange extends FBaseInitialable {
      * @returns {FRange} This range, for chaining
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .setCustomMetaData({ key: 'value' });
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .setCustomMetaData({ key: 'value' });
      * ```
      */
     setCustomMetaData(data: CustomData): FRange;
@@ -374,9 +380,9 @@ export declare class FRange extends FBaseInitialable {
      * @returns {FRange} This range, for chaining
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .setCustomMetaDatas([[{ key: 'value' }]]);
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .setCustomMetaDatas([[{ key: 'value' }]]);
      * ```
      */
     setCustomMetaDatas(datas: CustomData[][]): FRange;
@@ -386,9 +392,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getCustomMetaData()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getCustomMetaData()
      * ```
      */
     getCustomMetaData(): CustomData | null;
@@ -398,9 +404,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .getCustomMetaDatas()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .getCustomMetaDatas()
      * ```
      */
     getCustomMetaDatas(): Nullable<CustomData>[][];
@@ -413,9 +419,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .setBorder(BorderType.ALL, BorderStyleType.THIN, '#ff0000');
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .setBorder(BorderType.ALL, BorderStyleType.THIN, '#ff0000');
      * ```
      */
     setBorder(type: BorderType, style: BorderStyleTypes, color?: string): FRange;
@@ -426,9 +432,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .setBackgroundColor('red')
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .setBackgroundColor('red')
      * ```
      */
     setBackgroundColor(color: string): FRange;
@@ -448,9 +454,9 @@ export declare class FRange extends FBaseInitialable {
      * @returns {FRange} This range, for chaining
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .setValue(1);
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .setValue(1);
      * ```
      */
     setValue(value: CellValue | ICellData): FRange;
@@ -460,9 +466,9 @@ export declare class FRange extends FBaseInitialable {
      * @returns {FRange} This range, for chaining
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .setValueForCell(1);
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .setValueForCell(1);
      * ```
      */
     setValueForCell(value: CellValue | ICellData): FRange;
@@ -473,9 +479,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .setRichTextValueForCell(new RichTextValue().insertText('Hello'));
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .setRichTextValueForCell(new RichTextValue().insertText('Hello'));
      * ```
      */
     setRichTextValueForCell(value: RichTextValue | IDocumentData): FRange;
@@ -486,10 +492,10 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI
-     *  .getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .setRichTextValues([[new RichTextValue().insertText('Hello')]]);
+     *   .getActiveWorkbook()
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .setRichTextValues([[new RichTextValue().insertText('Hello')]]);
      * ```
      */
     setRichTextValues(values: (RichTextValue | IDocumentData)[][]): FRange;
@@ -501,9 +507,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .setWrap(true);
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .setWrap(true);
      * ```
      */
     setWrap(isWrapEnabled: boolean): FRange;
@@ -514,9 +520,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .setWrapStrategy(WrapStrategy.WRAP);
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .setWrapStrategy(WrapStrategy.WRAP);
      * ```
      */
     setWrapStrategy(strategy: WrapStrategy): FRange;
@@ -527,9 +533,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .setVerticalAlignment('top');
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .setVerticalAlignment('top');
      * ```
      */
     setVerticalAlignment(alignment: FVerticalAlignment): FRange;
@@ -540,9 +546,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .setHorizontalAlignment('left');
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .setHorizontalAlignment('left');
      * ```
      */
     setHorizontalAlignment(alignment: FHorizontalAlignment): FRange;
@@ -553,9 +559,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .setValues([[1, 2], [3, 4]]);
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .setValues([[1, 2], [3, 4]]);
      * ```
      */
     setValues(value: CellValue[][] | IObjectMatrixPrimitiveType<CellValue> | ICellData[][] | IObjectMatrixPrimitiveType<ICellData>): FRange;
@@ -566,9 +572,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .setFontWeight('bold');
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .setFontWeight('bold');
      * ```
      */
     setFontWeight(fontWeight: FontWeight | null): this;
@@ -579,9 +585,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .setFontStyle('italic');
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .setFontStyle('italic');
      * ```
      */
     setFontStyle(fontStyle: FontStyle | null): this;
@@ -592,9 +598,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .setFontLine('underline');
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .setFontLine('underline');
      * ```
      */
     setFontLine(fontLine: FontLine | null): this;
@@ -605,9 +611,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .setFontLine('underline');
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .setFontLine('underline');
      * ```
      */
     private _setFontUnderline;
@@ -624,9 +630,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .setFontFamily('Arial');
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .setFontFamily('Arial');
      * ```
      */
     setFontFamily(fontFamily: string | null): this;
@@ -637,9 +643,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .setFontSize(12);
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .setFontSize(12);
      * ```
      */
     setFontSize(size: number | null): this;
@@ -650,9 +656,9 @@ export declare class FRange extends FBaseInitialable {
      * @example
      * ```ts
      * univerAPI.getActiveWorkbook()
-     *  .getActiveSheet()
-     *  .getActiveRange()
-     *  .setFontColor('#ff0000');
+     *   .getActiveSheet()
+     *   .getActiveRange()
+     *   .setFontColor('#ff0000');
      * ```
      */
     setFontColor(color: string | null): this;
@@ -745,7 +751,7 @@ export declare class FRange extends FBaseInitialable {
      * const fWorksheet = fWorkbook.getActiveSheet();
      * const fRange = fWorksheet.getRange('A1:B2');
      * fRange.forEach((row, col, cell) => {
-     *    console.log(row, col, cell);
+     *   console.log(row, col, cell);
      * });
      * ```
      */

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

@@ -3,7 +3,8 @@ import { ISelectionWithStyle } from '@univerjs/sheets';
 import { FRange } from './f-range';
 import { FWorksheet } from './f-worksheet';
 /**
- * @description Represents the active selection in the sheet.
+ * Represents the active selection in the sheet.
+ *
  * @example
  * ```ts
  * const fWorkbook = univerAPI.getActiveWorkbook()
@@ -12,6 +13,7 @@ import { FWorksheet } from './f-worksheet';
  * const activeRange = fSelection.getActiveRange();
  * console.log(activeRange);
  * ```
+ * @hideconstructor
  */
 export declare class FSelection {
     private readonly _workbook;

package/lib/types/facade/f-sheet-hooks.d.ts

@@ -1,4 +1,7 @@
 import { FBase, Injector } from '@univerjs/core';
+/**
+ * @hideconstructor
+ */
 export declare class FSheetHooks extends FBase {
     protected readonly _injector: Injector;
     constructor(_injector: Injector);