@univerjs/core 0.4.1 → 0.4.2-nightly.202410301606

package/lib/types/sheets/column-manager.d.ts

@@ -1,5 +1,6 @@
 import { IObjectArrayPrimitiveType } from '../shared/object-matrix';
 import { Nullable } from '../shared/types';
+import { IStyleData } from '../types/interfaces';
 import { IColumnData, IRange, IWorksheetData } from './typedef';
 /**
  * Manage configuration information of all columns, get column width, column length, set column width, etc.
@@ -14,6 +15,18 @@ export declare class ColumnManager {
      */
     getColumnData(): IObjectArrayPrimitiveType<Partial<IColumnData>>;
     getColVisible(colPos: number): boolean;
+    /**
+     * Get the column style
+     * @param {number} col Column index
+     * @returns {string | Nullable<IStyleData>} Style data, may be undefined
+     */
+    getColumnStyle(col: number): Nullable<string | IStyleData>;
+    /**
+     * Set the set column  default style
+     * @param {number} col Column index
+     * @param {string | Nullable<IStyleData>} style Style data
+     */
+    setColumnStyle(col: number, style: string | Nullable<IStyleData>): void;
     /**
      * Get all hidden columns
      * @param start Start index
@@ -43,13 +56,17 @@ export declare class ColumnManager {
     /**
      * get given column data
      * @param columnPos column index
-     * @returns
      */
     getColumn(columnPos: number): Nullable<Partial<IColumnData>>;
+    /**
+     * Remove column data of given column
+     * @param columnPos
+     */
+    removeColumn(columnPos: number): void;
     /**
      * get given column data or create a column data when it's null
      * @param columnPos column index
-     * @returns
+     * @returns {Partial<IColumnData>} columnData
      */
     getColumnOrCreate(columnPos: number): Partial<IColumnData>;
 }

package/lib/types/sheets/row-manager.d.ts

@@ -1,7 +1,8 @@
-import { IObjectArrayPrimitiveType } from '../shared/object-matrix';
-import { IRange, IRowData, IWorksheetData } from './typedef';
 import { Nullable } from '../shared/types';
+import { IStyleData } from '../types/interfaces';
 import { SheetViewModel } from './view-model';
+import { IObjectArrayPrimitiveType } from '../shared/object-matrix';
+import { IRange, IRowData, IWorksheetData } from './typedef';
 /**
  * Manage configuration information of all rows, get row height, row length, set row height, etc.
  */
@@ -15,6 +16,18 @@ export declare class RowManager {
      * @returns
      */
     getRowData(): IObjectArrayPrimitiveType<Partial<IRowData>>;
+    /**
+     * Get the row style
+     * @param {number} row Row index
+     * @returns {string | Nullable<IStyleData>} Style data, may be undefined
+     */
+    getRowStyle(row: number): Nullable<string | IStyleData>;
+    /**
+     * Set row default style
+     * @param {number} row The row index
+     * @param {string | Nullable<IStyleData>} style The style data
+     */
+    setRowStyle(row: number, style: string | Nullable<IStyleData>): void;
     getRowDatas(rowPos: number, numRows: number): IObjectArrayPrimitiveType<Partial<IRowData>>;
     getRowHeight(rowPos: number): number;
     getRowHeight(rowPos: number, count: number): number;
@@ -24,10 +37,15 @@ export declare class RowManager {
      * @returns {Nullable<Partial<IRowData>>} rowData
      */
     getRow(rowPos: number): Nullable<Partial<IRowData>>;
+    /**
+     * Remove row data of given row
+     * @param rowPos
+     */
+    removeRow(rowPos: number): void;
     /**
      * Get given row data or create a row data when it's null
      * @param rowPos row index
-     * @returns
+     * @returns {Partial<IRowData>} rowData
      */
     getRowOrCreate(rowPos: number): Partial<IRowData>;
     /**
@@ -47,7 +65,7 @@ export declare class RowManager {
     getRowRawVisible(row: number): boolean;
     /**
      * Get count of row in the sheet
-     * @returns
+     * @returns {number} row count
      */
     getSize(): number;
 }

package/lib/types/sheets/typedef.d.ts

@@ -1,4 +1,3 @@
-import { BooleanNumber, CellValueType } from '../types/enum';
 import { IResources } from '../services/resource-manager/type';
 import { IObjectArrayPrimitiveType, IObjectMatrixPrimitiveType, Nullable } from '../shared';
 import { LocaleType } from '../types/enum/locale-type';
@@ -6,6 +5,7 @@ import { IDocumentData } from '../types/interfaces';
 import { ICellCustomRender } from '../types/interfaces/i-cell-custom-render';
 import { ICellValidationData } from '../types/interfaces/i-cell-validation-data';
 import { IStyleData } from '../types/interfaces/i-style-data';
+import { BooleanNumber, CellValueType } from '../types/enum';
 /**
  * Snapshot of a workbook.
  */
@@ -43,6 +43,10 @@ export interface IWorkbookData {
     sheets: {
         [sheetId: string]: Partial<IWorksheetData>;
     };
+    /**
+     * @property {string|Nullable<IStyleData>} [defaultStyle] - Default style id or style data of Workbook.
+     */
+    defaultStyle?: Nullable<IStyleData> | string;
     /**
      * Resources of the Univer Sheet. It is used to store the data of other plugins.
      */
@@ -85,6 +89,10 @@ export interface IWorksheetData {
     cellData: IObjectMatrixPrimitiveType<ICellData>;
     rowData: IObjectArrayPrimitiveType<Partial<IRowData>>;
     columnData: IObjectArrayPrimitiveType<Partial<IColumnData>>;
+    /**
+     * @property {string|Nullable<IStyleData>} [defaultStyle] - Default style id or style data of Worksheet.
+     */
+    defaultStyle?: Nullable<IStyleData> | string;
     rowHeader: {
         width: number;
         hidden?: BooleanNumber;
@@ -96,6 +104,7 @@ export interface IWorksheetData {
     showGridlines: BooleanNumber;
     rightToLeft: BooleanNumber;
 }
+export type CustomData = Nullable<Record<string, any>>;
 /**
  * Properties of row data
  */
@@ -116,6 +125,14 @@ export interface IRowData {
      * hidden
      */
     hd?: BooleanNumber;
+    /**
+     * style id
+     */
+    s?: Nullable<IStyleData | string>;
+    /**
+     * User stored custom fields
+     */
+    custom?: CustomData;
 }
 export interface IRowAutoHeightInfo {
     row: number;
@@ -133,6 +150,18 @@ export interface IColumnData {
      * hidden
      */
     hd?: BooleanNumber;
+    /**
+     * style id
+     */
+    s?: Nullable<IStyleData | string>;
+    /**
+     * User stored custom fields
+     */
+    custom?: CustomData;
+}
+export interface IColAutoWidthInfo {
+    col: number;
+    width?: number;
 }
 /**
  * Cell value type
@@ -165,7 +194,7 @@ export interface ICellData {
     /**
      * User stored custom fields
      */
-    custom?: Nullable<Record<string, any>>;
+    custom?: CustomData;
 }
 export interface ICellMarksStyle {
     color: string;
@@ -185,6 +214,7 @@ export interface ICellDataForSheetInterceptor extends ICellData {
     markers?: ICellMarks;
     customRender?: Nullable<ICellCustomRender[]>;
     interceptorAutoHeight?: () => number | undefined;
+    interceptorAutoWidth?: () => number | undefined;
     /**
      * can cell be covered when sibling is overflow
      */

package/lib/types/sheets/util.d.ts

@@ -1,3 +1,38 @@
+import { Nullable } from '../shared';
 import { IRange, IUnitRange } from './typedef';
+import { DocumentDataModel } from '../docs';
+import { CellValueType, HorizontalAlign, TextDirection, VerticalAlign, WrapStrategy } from '../types/enum';
+import { IPaddingData, IStyleBase, IStyleData, ITextRotation, ITextStyle } from '../types/interfaces';
 export declare const isRangesEqual: (oldRanges: IRange[], ranges: IRange[]) => boolean;
 export declare const isUnitRangesEqual: (oldRanges: IUnitRange[], ranges: IUnitRange[]) => boolean;
+export declare const DEFAULT_PADDING_DATA: {
+    t: number;
+    b: number;
+    l: number;
+    r: number;
+};
+export declare const getDefaultBaselineOffset: (fontSize: number) => {
+    sbr: number;
+    sbo: number;
+    spr: number;
+    spo: number;
+};
+export interface ICellStyle {
+    textRotation?: ITextRotation;
+    textDirection?: Nullable<TextDirection>;
+    horizontalAlign?: HorizontalAlign;
+    verticalAlign?: VerticalAlign;
+    wrapStrategy?: WrapStrategy;
+    paddingData?: IPaddingData;
+    cellValueType?: CellValueType;
+}
+export declare const VERTICAL_ROTATE_ANGLE = 90;
+export declare function createDocumentModelWithStyle(content: string, textStyle: ITextStyle, config?: ICellStyle): DocumentDataModel;
+export declare function extractOtherStyle(style?: Nullable<IStyleData>): ICellStyle;
+/**
+ * Pick font style from cell style.
+ * @param format
+ * @returns {IStyleBase} style
+ */
+export declare function getFontFormat(format?: Nullable<IStyleData>): IStyleBase;
+export declare function addLinkToDocumentModel(documentModel: DocumentDataModel, linkUrl: string, linkId: string): void;

package/lib/types/sheets/view-model.d.ts

@@ -1,8 +1,8 @@
-import { InterceptorEffectEnum } from '../common/interceptor';
-import { Disposable } from '../shared/lifecycle';
 import { IDisposable } from '../common/di';
 import { Nullable } from '../shared/types';
 import { ICellData, ICellDataForSheetInterceptor } from './typedef';
+import { InterceptorEffectEnum } from '../common/interceptor';
+import { Disposable } from '../shared/lifecycle';
 /**
  * @internal
  */

package/lib/types/sheets/worksheet.d.ts

@@ -1,12 +1,38 @@
 import { Nullable, ObjectMatrix } from '../shared';
+import { IPaddingData, IStyleData, ITextRotation } from '../types/interfaces';
 import { Styles } from './styles';
 import { ICellData, ICellDataForSheetInterceptor, IFreeze, IRange, ISelectionCell, IWorksheetData } from './typedef';
-import { BooleanNumber } from '../types/enum';
+import { DocumentDataModel } from '../docs';
+import { BooleanNumber, CellValueType, HorizontalAlign, TextDirection, VerticalAlign, WrapStrategy } from '../types/enum';
 import { ColumnManager } from './column-manager';
 import { Range } from './range';
 import { RowManager } from './row-manager';
 import { SpanModel } from './span-model';
 import { SheetViewModel } from './view-model';
+export interface IDocumentLayoutObject {
+    documentModel: Nullable<DocumentDataModel>;
+    fontString: string;
+    textRotation: ITextRotation;
+    wrapStrategy: WrapStrategy;
+    verticalAlign: VerticalAlign;
+    horizontalAlign: HorizontalAlign;
+    paddingData: IPaddingData;
+    fill?: Nullable<string>;
+}
+export interface ICellOtherConfig {
+    textRotation?: ITextRotation;
+    textDirection?: Nullable<TextDirection>;
+    horizontalAlign?: HorizontalAlign;
+    verticalAlign?: VerticalAlign;
+    wrapStrategy?: WrapStrategy;
+    paddingData?: IPaddingData;
+    cellValueType?: CellValueType;
+}
+export interface ICellDocumentModelOption {
+    isDeepClone?: boolean;
+    displayRawFormula?: boolean;
+    ignoreTextRotation?: boolean;
+}
 /**
  * The model of a Worksheet.
  */
@@ -33,9 +59,54 @@ export declare class Worksheet {
      */
     setMergeData(mergeData: IRange[]): void;
     getSpanModel(): SpanModel;
+    /**
+     * Get the style of the column.
+     * @param {number} column The column index
+     * @param {boolean} [keepRaw] If true, return the raw style data, otherwise return the style data object
+     * @returns {Nullable<IStyleData>|string} The style of the column
+     */
+    getColumnStyle(column: number, keepRaw?: boolean): string | Nullable<IStyleData>;
+    /**
+     * Set the style of the column.
+     * @param {number} column The column index
+     * @param {string|Nullable<IStyleData>} style The style to be set
+     */
+    setColumnStyle(column: number, style: string | Nullable<IStyleData>): void;
+    /**
+     * Get the style of the row.
+     * @param {number} row The row index
+     * @param {boolean} [keepRaw] If true, return the raw style data, otherwise return the style data object
+     * @returns {Nullable<IStyleData>} The style of the row
+     */
+    getRowStyle(row: number, keepRaw?: boolean): string | Nullable<IStyleData>;
+    /**
+     * Set the style of the row.
+     * @param {number} row
+     * @param {string|Nullable<IStyleData>} style The style to be set
+     */
+    setRowStyle(row: number, style: string | Nullable<IStyleData>): void;
+    /**
+     * this function is used to mixin default style to cell raw{number}
+     * @param {number} row The row index
+     * @param {number} col The column index
+     * @param cellRaw The cell raw data
+     * @param {boolean} isRowStylePrecedeColumnStyle The priority of row style and column style
+     */
+    mixinDefaultStyleToCellRaw(row: number, col: number, cellRaw: Nullable<ICellData>, isRowStylePrecedeColumnStyle: boolean): void;
+    /**
+     * Get the default style of the worksheet.
+     * @returns {Nullable<IStyleData>} Default Style
+     */
+    getDefaultCellStyle(): Nullable<IStyleData> | string;
+    getDefaultCellStyleInternal(): Nullable<IStyleData>;
+    /**
+     * Set Default Style, if the style has been set, all cells style will be base on this style.
+     * @param {Nullable<IStyleData>} style The style to be set as default style
+     */
+    setDefaultCellStyle(style: Nullable<IStyleData> | string): void;
     /**
      * Returns WorkSheet Cell Data Matrix
-     * @returns
+     * @returns WorkSheet Cell Data Matrix
      */
     getCellMatrix(): ObjectMatrix<Nullable<ICellData>>;
     /**
@@ -294,6 +365,17 @@ export declare class Worksheet {
      * parameter is set to `false`, the iterator will return cells in the top row.
      */
     iterateByColumn(range: IRange, skipEmpty?: boolean, skipNonTopLeft?: boolean): Iterable<Readonly<ICell>>;
+    /**
+     * This method generates a document model based on the cell's properties and handles the associated styles and configurations.
+     * If the cell does not exist, it will return null.
+     * PS: This method has significant impact on performance.
+     * @param cell
+     * @param options
+     */
+    private _getCellDocumentModel;
+    private _updateConfigAndGetDocumentModel;
+    getBlankCellDocumentModel(cell: Nullable<ICellData>): IDocumentLayoutObject;
+    getCellDocumentModelWithFormula(cell: ICellData): Nullable<IDocumentLayoutObject>;
 }
 /**
  * A cell info including its span (if it is the top-left cell of a merged cell).

package/lib/types/types/enum/data-validation-type.d.ts

@@ -32,5 +32,6 @@ export declare enum DataValidationType {
      * decimal number
      */
     DECIMAL = "decimal",
-    CHECKBOX = "checkbox"
+    CHECKBOX = "checkbox",
+    ANY = "any"
 }

package/lib/types/types/interfaces/i-document-data.d.ts

@@ -330,8 +330,9 @@ export interface IHeaderAndFooterBase {
     evenAndOddHeaders?: BooleanNumber;
 }
 export declare enum DocumentFlavor {
-    TRADITIONAL = 0,
-    MODERN = 1
+    UNSPECIFIED = 0,
+    TRADITIONAL = 1,
+    MODERN = 2
 }
 /**
  * Basics properties of doc style