@univerjs/engine-render 0.4.1 → 0.4.2

package/lib/types/base-object.d.ts

@@ -1,14 +1,14 @@
 import { IKeyValue, ITransformState, Nullable, Disposable, EventSubject } from '@univerjs/core';
-import { CURSOR_TYPE, RENDER_CLASS_TYPE } from './basics/const';
 import { IDragEvent, IMouseEvent, IPointerEvent, IWheelEvent } from './basics/i-events';
 import { IObjectFullState, ITransformChangeState } from './basics/interfaces';
-import { Transform } from './basics/transform';
+import { ITransformerConfig } from './basics/transformer-config';
 import { IViewportInfo, Vector2 } from './basics/vector2';
 import { UniverRenderingContext } from './context';
+import { Engine } from './engine';
 import { Layer } from './layer';
-import { ITransformerConfig } from './basics/transformer-config';
 import { Scene } from './scene';
-import { Engine } from './engine';
+import { CURSOR_TYPE, RENDER_CLASS_TYPE } from './basics/const';
+import { Transform } from './basics/transform';
 export declare const BASE_OBJECT_ARRAY: string[];
 export declare enum ObjectType {
     UNKNOWN = 0,
@@ -16,7 +16,8 @@ export declare enum ObjectType {
     SHAPE = 2,
     IMAGE = 3,
     RECT = 4,
-    CIRCLE = 5
+    CIRCLE = 5,
+    CHART = 6
 }
 export declare abstract class BaseObject extends Disposable {
     groupKey?: string;

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

@@ -117,6 +117,7 @@ export declare enum RENDER_CLASS_TYPE {
     TEXT = "Text"
 }
 export declare const MAXIMUM_ROW_HEIGHT = 2000;
+export declare const MAXIMUM_COL_WIDTH = 2000;
 export declare const FIX_ONE_PIXEL_BLUR_OFFSET = 0.5;
 export declare const DRAWING_OBJECT_LOWER_LAYER_INDEX = 3;
 export declare const DRAWING_OBJECT_LAYER_INDEX = 4;

package/lib/types/components/docs/document.d.ts

@@ -19,8 +19,6 @@ export interface IDocumentOffsetConfig extends IPageMarginLayout {
 export declare class Documents extends DocComponent {
     private readonly _pageRender$;
     readonly pageRender$: import('rxjs').Observable<IPageRenderConfig>;
-    docsLeft: number;
-    docsTop: number;
     private _drawLiquid;
     constructor(oKey: string, documentSkeleton?: DocumentSkeleton, config?: IDocumentsConfig);
     static create(oKey: string, documentSkeleton?: DocumentSkeleton, config?: IDocumentsConfig): Documents;

package/lib/types/components/sheets/column-header.d.ts

@@ -2,8 +2,8 @@ import { Nullable } from '@univerjs/core';
 import { IViewportInfo, Vector2 } from '../../basics/vector2';
 import { UniverRenderingContext } from '../../context';
 import { ColumnHeaderLayout, IColumnsHeaderCfgParam } from './extensions/column-header-layout';
-import { SpreadsheetHeader } from './sheet-component';
 import { SpreadsheetSkeleton } from './sheet-skeleton';
+import { SpreadsheetHeader } from './sheet-component';
 export declare class SpreadsheetColumnHeader extends SpreadsheetHeader {
     getDocuments(): void;
     getNoMergeCellPositionByIndex(rowIndex: number, columnIndex: number): Nullable<{

package/lib/types/components/sheets/constants.d.ts

@@ -1,20 +1,8 @@
-/**
- * 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.
- */
+import { SHEET_VIEWPORT_KEY } from './interfaces';
 export declare const BORDER_Z_INDEX = 50;
 export declare const FONT_EXTENSION_Z_INDEX = 45;
 export declare const BG_Z_INDEX = 21;
 export declare const PRINTING_BG_Z_INDEX = 21;
 export declare const EXPAND_SIZE_FOR_RENDER_OVERFLOW = 20;
+export declare const sheetContentViewportKeys: SHEET_VIEWPORT_KEY[];
+export declare const sheetHeaderViewportKeys: SHEET_VIEWPORT_KEY[];

package/lib/types/components/sheets/extensions/row-header-layout.d.ts

@@ -1,8 +1,8 @@
 import { IScale } from '@univerjs/core';
-import { SheetExtension } from './sheet-extension';
 import { UniverRenderingContext } from '../../../context';
 import { IARowCfg, IARowCfgObj, IColumnStyleCfg, IRowStyleCfg } from '../interfaces';
 import { SpreadsheetSkeleton } from '../sheet-skeleton';
+import { SheetExtension } from './sheet-extension';
 export interface IRowsHeaderCfgParam {
     headerStyle?: Partial<IRowStyleCfg>;
     rowsCfg?: IARowCfg[];

package/lib/types/components/sheets/row-header.d.ts

@@ -1,9 +1,9 @@
 import { Nullable } from '@univerjs/core';
-import { SpreadsheetHeader } from './sheet-component';
 import { IViewportInfo, Vector2 } from '../../basics/vector2';
 import { UniverRenderingContext } from '../../context';
 import { IRowsHeaderCfgParam, RowHeaderLayout } from './extensions/row-header-layout';
 import { SpreadsheetSkeleton } from './sheet-skeleton';
+import { SpreadsheetHeader } from './sheet-component';
 export declare class SpreadsheetRowHeader extends SpreadsheetHeader {
     getDocuments(): void;
     getNoMergeCellPositionByIndex(rowIndex: number, columnIndex: number): Nullable<{

package/lib/types/components/sheets/sheet-component.d.ts

@@ -1,9 +1,9 @@
 import { IRange, Nullable } from '@univerjs/core';
 import { IViewportInfo, Vector2 } from '../../basics/vector2';
 import { UniverRenderingContext } from '../../context';
-import { RenderComponent } from '../component';
 import { SHEET_EXTENSION_TYPE } from './extensions/sheet-extension';
 import { SpreadsheetSkeleton } from './sheet-skeleton';
+import { RenderComponent } from '../component';
 export declare abstract class SheetComponent extends RenderComponent<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]> {
     private _skeleton?;
     constructor(oKey: string, _skeleton?: SpreadsheetSkeleton | undefined);

package/lib/types/components/sheets/sheet-skeleton.d.ts

@@ -1,6 +1,6 @@
-import { ICellData, IColumnRange, IPaddingData, IPosition, IRange, IRowAutoHeightInfo, IRowRange, ISelectionCellWithMergeInfo, ISize, IStyleData, ITextRotation, IWorksheetData, Nullable, Styles, Worksheet, BooleanNumber, DocumentDataModel, HorizontalAlign, IContextService, LocaleService, ObjectMatrix, VerticalAlign, WrapStrategy } from '@univerjs/core';
+import { ICellData, ICellDataForSheetInterceptor, IColAutoWidthInfo, IColumnRange, IPaddingData, IPosition, IRange, IRowAutoHeightInfo, IRowRange, ISelectionCellWithMergeInfo, ISize, IStyleData, ITextRotation, IWorksheetData, Nullable, Styles, Worksheet, BooleanNumber, DocumentDataModel, HorizontalAlign, IConfigService, IContextService, LocaleService, ObjectMatrix, VerticalAlign, WrapStrategy } from '@univerjs/core';
 import { IBoundRectNoAngle, IViewportInfo } from '../../basics/vector2';
-import { IFontCacheItem, IStylesCache } from './interfaces';
+import { IFontCacheItem, IStylesCache, SHEET_VIEWPORT_KEY } from './interfaces';
 import { DocumentSkeleton } from '../docs/layout/doc-skeleton';
 import { Skeleton } from '../skeleton';
 /**
@@ -42,6 +42,7 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     private _cellData;
     private _styles;
     private readonly _contextService;
+    private readonly _configService;
     private _rowHeightAccumulation;
     private _columnWidthAccumulation;
     private _rowTotalHeight;
@@ -49,9 +50,11 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     private _rowHeaderWidth;
     private _columnHeaderHeight;
     /**
-     * Range of visible area(range in viewBounds)
+     * Range viewBounds. only update by viewBounds.
+     * It would change multiple times in one frame if there is multiple viewport (after freeze row&col)
      */
     private _visibleRange;
+    private _visibleRangeMap;
     private _overflowCache;
     private _stylesCache;
     /** A matrix to store if a (row, column) position has render cache. */
@@ -61,13 +64,17 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     private _showGridlines;
     private _marginTop;
     private _marginLeft;
+    /**
+     * Whether the row style precedes the column style.
+     */
+    private _isRowStylePrecedeColumnStyle;
     private _renderRawFormula;
     constructor(worksheet: Worksheet, 
     /**
      * @deprecated avoid use `IWorksheetData` directly, use API provided by `Worksheet`, otherwise
      * `ViewModel` will be not working.
      */
-    _worksheetData: IWorksheetData, _cellData: ObjectMatrix<Nullable<ICellData>>, _styles: Styles, _localeService: LocaleService, _contextService: IContextService);
+    _worksheetData: IWorksheetData, _cellData: ObjectMatrix<Nullable<ICellData>>, _styles: Styles, _localeService: LocaleService, _contextService: IContextService, _configService: IConfigService);
     get rowHeightAccumulation(): number[];
     get rowTotalHeight(): number;
     get columnWidthAccumulation(): number[];
@@ -78,7 +85,7 @@ export declare class SpreadsheetSkeleton extends Skeleton {
      * Range of visible area(range in viewBounds)
      */
     get rowColumnSegment(): IRowColumnRange;
-    get visibleArea(): IRowColumnRange;
+    visibleRangeByViewportKey(viewportKey: SHEET_VIEWPORT_KEY): Nullable<IRowColumnRange>;
     get stylesCache(): IStylesCache;
     get overflowCache(): ObjectMatrix<IRange>;
     get showGridlines(): BooleanNumber;
@@ -105,12 +112,35 @@ export declare class SpreadsheetSkeleton extends Skeleton {
      * @param bounds
      * @returns boolean
      */
-    calculateSegment(bounds?: IViewportInfo): boolean;
-    calculateWithoutClearingCache(bounds?: IViewportInfo): Nullable<SpreadsheetSkeleton>;
+    updateVisibleRange(bounds?: IViewportInfo): boolean;
+    /**
+     * Set border background and font to this._stylesCache by visible range, which derives from bounds)
+     * @param bounds viewBounds
+     */
+    setStylesCache(bounds?: IViewportInfo): Nullable<SpreadsheetSkeleton>;
     calculate(bounds?: IViewportInfo): Nullable<SpreadsheetSkeleton>;
-    calculateAutoHeightInRange(ranges: Nullable<IRange[]>): IRowAutoHeightInfo[];
     private _hasUnMergedCellInRow;
+    /**
+     * Calc all auto height by getDocsSkeletonPageSize in ranges
+     * @param ranges
+     * @returns {IRowAutoHeightInfo[]} result
+     */
+    calculateAutoHeightInRange(ranges: Nullable<IRange[]>): IRowAutoHeightInfo[];
     private _calculateRowAutoHeight;
+    calculateAutoWidthInRange(ranges: Nullable<IRange[]>): IColAutoWidthInfo[];
+    /**
+     * Iterate rows in visible area(and rows around it) and return column width of the specified column(by column index)
+     *
+     * @param colIndex
+     * @returns {number} width
+     */
+    private _calculateColWidth;
+    /**
+     * For _calculateColMaxWidth
+     * @param cell
+     * @returns {number} width
+     */
+    _getMeasuredWidthByCell(cell: ICellDataForSheetInterceptor, currColWidth: number): number;
     /**
      * Calculate data for row col & cell position, then update position value to this._rowHeaderWidth & this._rowHeightAccumulation & this._columnHeaderHeight & this._columnWidthAccumulation.
      */
@@ -249,6 +279,12 @@ export declare class SpreadsheetSkeleton extends Skeleton {
      */
     protected _getBounding(rowHeightAccumulation: number[], columnWidthAccumulation: number[], viewBound?: IBoundRectNoAngle): IRange;
     private _generateRowMatrixCache;
+    /**
+     * Calc columnWidthAccumulation by columnData
+     * @param colCount
+     * @param columnData
+     * @param defaultColumnWidth
+     */
     private _generateColumnMatrixCache;
     private _getOverflowBound;
     intersectMergeRange(row: number, column: number): boolean;
@@ -257,7 +293,6 @@ export declare class SpreadsheetSkeleton extends Skeleton {
      * @returns {IRange} The visible merge data
      */
     getCurrentRowColumnSegmentMergeData(range?: IRange): IRange[];
-    private _calculateStylesCache;
     resetCache(): void;
     /**
      * Any changes to sheet model would reset cache.
@@ -274,12 +309,12 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     } | undefined): void;
     _setFontStylesCache(row: number, col: number, cell: Nullable<ICellData>): void;
     /**
-     * Set border background and font to this._stylesCache
+     * Set border background and font to this._stylesCache cell by cell.
      * @param row {number}
      * @param col {number}
      * @param options {{ mergeRange: IRange; cacheItem: ICacheItem } | undefined}
      */
-    private _setStylesCache;
+    private _setStylesCacheForOneCell;
     private _updateConfigAndGetDocumentModel;
     private _getDocumentDataByStyle;
     /**

package/lib/types/components/sheets/spreadsheet.d.ts

@@ -6,9 +6,9 @@ import { Scene } from '../../scene';
 import { Background } from './extensions/background';
 import { Border } from './extensions/border';
 import { Font } from './extensions/font';
+import { IPaintForRefresh, IPaintForScrolling } from './interfaces';
 import { SpreadsheetSkeleton } from './sheet-skeleton';
 import { Documents } from '../docs/document';
-import { IPaintForRefresh, IPaintForScrolling, SHEET_VIEWPORT_KEY } from './interfaces';
 import { SheetComponent } from './sheet-component';
 export declare class Spreadsheet extends SheetComponent {
     private _allowCache;
@@ -27,9 +27,6 @@ export declare class Spreadsheet extends SheetComponent {
     getDocuments(): Documents;
     get allowCache(): boolean;
     get forceDisableGridlines(): boolean;
-    /**
-     * TODO: DR-Univer, fix as unknown as
-     */
     dispose(): void;
     /**
      * draw by viewport
@@ -104,8 +101,6 @@ export declare class Spreadsheet extends SheetComponent {
      */
     private _clearRectangle;
     private _clearBackground;
-    sheetContentViewport(): SHEET_VIEWPORT_KEY[];
-    sheetHeaderViewport(): SHEET_VIEWPORT_KEY[];
     testShowRuler(cacheCtx: UniverRenderingContext2D, viewportInfo: IViewportInfo): void;
     testGetRandomLightColor(): string;
 }

package/lib/types/context.d.ts

@@ -1,28 +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.
- */
+import { IRenderConfig } from './services/render-config';
 export declare class UniverRenderingContext2D implements CanvasRenderingContext2D {
     __mode: string;
-    private _system;
-    private _browser;
     private _transformCache;
     readonly canvas: HTMLCanvasElement;
     _context: CanvasRenderingContext2D;
     private _systemType;
     private _browserType;
+    renderConfig: Readonly<IRenderConfig>;
     constructor(context: CanvasRenderingContext2D);
+    private _id;
+    getId(): string;
+    setId(id: string): void;
     isContextLost(): boolean;
     get globalAlpha(): number;
     set globalAlpha(val: number);
@@ -77,7 +65,14 @@ export declare class UniverRenderingContext2D implements CanvasRenderingContext2
     set textAlign(val: CanvasTextAlign);
     get textBaseline(): CanvasTextBaseline;
     set textBaseline(val: CanvasTextBaseline);
-    private _getScale;
+    /**
+     * Get scale from ctx.
+     * DOMMatrix.a DOMMatrix.d would affect by ctx.rotate()
+     */
+    protected _getScale(): {
+        scaleX: number;
+        scaleY: number;
+    };
     getScale(): {
         scaleX: number;
         scaleY: number;
@@ -266,6 +261,7 @@ export declare class UniverRenderingContext2D implements CanvasRenderingContext2
      * @method
      */
     moveToByPrecision(x: number, y: number): void;
+    moveToByPrecisionLog(x: number, y: number): void;
     /**
      * rect function.
      * @method
@@ -352,21 +348,10 @@ export declare class UniverRenderingContext2D implements CanvasRenderingContext2
     clearRectForTexture(x: number, y: number, width: number, height: number): void;
     setGlobalCompositeOperation(val: GlobalCompositeOperation): void;
 }
-/**
- * TODO
- */
-export declare class UniverRenderingContextWebGL {
-}
-/**
- * TODO
- */
-export declare class UniverRenderingContextWebGPU {
-}
 export declare class UniverRenderingContext extends UniverRenderingContext2D {
 }
 export declare class UniverPrintingContext extends UniverRenderingContext2D {
     __mode: string;
-    private __getScale;
     clearRect(x: number, y: number, width: number, height: number): void;
     clearRectForTexture(x: number, y: number, width: number, height: number): void;
     setGlobalCompositeOperation(val: GlobalCompositeOperation): void;

package/lib/types/index.d.ts

@@ -18,6 +18,7 @@ export * from './basics';
 export { getOffsetRectForDom } from './basics/position';
 export * from './canvas';
 export * from './components';
+export { UniverRenderConfigService } from './services/render-config.service';
 export { DocBackground } from './components/docs/doc-background';
 export { Documents } from './components/docs/document';
 export type { IPageRenderConfig } from './components/docs/document';
@@ -37,7 +38,7 @@ export * from './custom';
 export * from './engine';
 export * from './group';
 export * from './layer';
-export { IRenderingEngine, UniverRenderEnginePlugin } from './render-engine';
+export { IRenderingEngine, UniverRenderEnginePlugin } from './plugin';
 export { IRenderManagerService, type RenderComponentType, RenderManagerService } from './render-manager/render-manager.service';
 export { type IRender, type IRenderContext, type IRenderModule, RenderUnit } from './render-manager/render-unit';
 export * from './scene';

package/lib/types/layer.d.ts

@@ -1,7 +1,7 @@
-import { Disposable } from '@univerjs/core';
-import { BaseObject } from './base-object';
 import { UniverRenderingContext } from './context';
 import { Scene } from './scene';
+import { Disposable } from '@univerjs/core';
+import { BaseObject } from './base-object';
 export declare class Layer extends Disposable {
     private _scene;
     private _zIndex;

package/lib/types/scene.transformer.d.ts

@@ -1,8 +1,8 @@
 import { Nullable, Disposable } from '@univerjs/core';
-import { BaseObject } from './base-object';
 import { IMouseEvent, IPointerEvent } from './basics/i-events';
 import { ITransformerConfig } from './basics/transformer-config';
 import { Scene } from './scene';
+import { BaseObject } from './base-object';
 import { Group } from './group';
 declare enum MoveObserverType {
     MOVE_START = 0,
@@ -147,6 +147,11 @@ export declare class Transformer extends Disposable implements ITransformerConfi
     private _hideControl;
     private _attachHover;
     private _clearControls;
+    /**
+     * @description Clear the control of the object with the specified id
+     * @param {string[]} ids the id of the object to be cleared
+     */
+    clearControlByIds(ids: string[]): void;
     private _clearControlMap;
     private _createControl;
     private _getTopScene;

package/lib/types/services/render-config.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 IRenderConfig {
+    [key: string]: any;
+}

package/lib/types/services/render-config.service.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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.
+ */
+/**
+ * This service carries managers render config that would be passed
+ * to every widget, so some rendering could be optimized.
+ */
+export declare class UniverRenderConfigService {
+    private readonly _renderConfig;
+    private readonly _updateSignal$;
+    readonly updateSignal$: import('rxjs').Observable<void>;
+    setRenderConfig(key: string, value: any): void;
+    getRenderConfig(): Readonly<Record<string, any>>;
+}

package/lib/types/shape/rect.d.ts

@@ -20,6 +20,7 @@ export declare class Rect<T extends IRectProps = IRectProps> extends Shape<T> {
     get visualHeight(): Nullable<number>;
     get visualWidth(): Nullable<number>;
     get radius(): number;
+    setObjectType(type: ObjectType): void;
     static drawWith(ctx: UniverRenderingContext, props: IRectProps): void;
     toJson(): {
         [x: string]: any;

package/lib/types/shape/shape.d.ts

@@ -9,6 +9,7 @@ export type PaintFirst = 'fill' | 'stroke';
 export interface IShapeProps extends IObjectFullState, ISize, IOffset, IScale {
     rotateEnabled?: boolean;
     resizeEnabled?: boolean;
+    borderEnabled?: boolean;
     hoverCursor?: Nullable<string>;
     moveCursor?: string | null;
     fillRule?: string;

package/lib/types/viewport.d.ts

@@ -6,6 +6,7 @@ import { UniverRenderingContext } from './context';
 import { BaseScrollBar } from './shape/base-scroll-bar';
 import { ThinScene } from './thin-scene';
 import { Transform } from './basics/transform';
+import { Canvas as UniverCanvas } from './canvas';
 interface IViewPosition {
     top?: number;
     left?: number;
@@ -204,6 +205,7 @@ export declare class Viewport {
     get _deltaScrollY(): number;
     get _deltaViewportScrollX(): number;
     get _deltaViewportScrollY(): number;
+    get canvas(): UniverCanvas | null;
     enable(): void;
     disable(): void;
     resetCanvasSizeAndUpdateScroll(): void;