@univerjs/engine-render 0.6.0-alpha.0 → 0.6.0-experimental.20250212-dbe9830

package/lib/types/components/sheets/{sheet-skeleton.d.ts → sheet.render-skeleton.d.ts}

@@ -1,14 +1,8 @@
-import { ICellData, ICellDataForSheetInterceptor, ICellInfo, ICellWithCoord, IColAutoWidthInfo, IColumnRange, IPaddingData, IPosition, IRange, IRowAutoHeightInfo, IRowRange, ISize, IStyleData, ITextRotation, IWorksheetData, Nullable, Styles, VerticalAlign, Worksheet, BooleanNumber, DocumentDataModel, HorizontalAlign, IConfigService, IContextService, ImageCacheMap, Injector, LocaleService, ObjectMatrix, WrapStrategy } from '@univerjs/core';
+import { DocumentDataModel, ICellData, ICellDataForSheetInterceptor, ICellInfo, ICellWithCoord, IColAutoWidthInfo, IColumnRange, IGetRowColByPosOptions, IPaddingData, IRange, IRowAutoHeightInfo, IRowRange, ISize, IStyleData, ITextRotation, Nullable, Styles, VerticalAlign, Worksheet, BooleanNumber, HorizontalAlign, IConfigService, IContextService, Injector, LocaleService, ObjectMatrix, SheetSkeleton, WrapStrategy } from '@univerjs/core';
 import { IBoundRectNoAngle, IPoint, IViewportInfo } from '../../basics/vector2';
-import { DocumentSkeleton } from '../docs/layout/doc-skeleton';
-import { Skeleton } from '../skeleton';
+import { Scene } from '../../scene';
 import { IFontCacheItem, IStylesCache, SHEET_VIEWPORT_KEY } from './interfaces';
-/**
- * Obtain the height and width of a cell's text, taking into account scenarios with rotated text.
- * @param documentSkeleton Data of the document's ViewModel
- * @param angleInDegree The rotation angle of an Excel cell, it's **degree**
- */
-export declare function getDocsSkeletonPageSize(documentSkeleton: DocumentSkeleton, angleInDegree?: number): Nullable<Required<ISize>>;
+import { DocumentSkeleton } from '../docs/layout/doc-skeleton';
 interface IRowColumnRange extends IRowRange, IColumnRange {
 }
 export interface IDocumentLayoutObject {
@@ -32,15 +26,6 @@ export interface ICacheItem {
     bg: boolean;
     border: boolean;
 }
-export interface IGetRowColByPosOptions {
-    closeFirst?: boolean;
-    /**
-     * For searchArray(rowHeightAccumulation) & searchArray(colWidthAccumulation)
-     * true means return first matched index in matched sequence.
-     * default return last index in matched sequence.
-     */
-    firstMatch?: boolean;
-}
 export interface IGetPosByRowColOptions {
     closeFirst?: boolean;
     /**
@@ -49,18 +34,7 @@ export interface IGetPosByRowColOptions {
      */
     firstMatch?: boolean;
 }
-export declare class SpreadsheetSkeleton extends Skeleton {
-    readonly worksheet: Worksheet;
-    private _styles;
-    private readonly _contextService;
-    private readonly _configService;
-    private _injector;
-    private _rowHeightAccumulation;
-    private _columnWidthAccumulation;
-    private _rowTotalHeight;
-    private _columnTotalWidth;
-    private _rowHeaderWidth;
-    private _columnHeaderHeight;
+export declare class SpreadsheetSkeleton extends SheetSkeleton {
     /**
      * Range viewBounds. only update by viewBounds.
      * It would change multiple times in one frame if there is multiple viewport (after freeze row&col)
@@ -76,35 +50,11 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     private _handleFontMatrix;
     private _showGridlines;
     private _gridlinesColor;
-    private _marginTop;
-    private _marginLeft;
-    private _imageCacheMap;
-    /**
-     * Whether the row style precedes the column style.
-     */
-    private _isRowStylePrecedeColumnStyle;
-    /**
-     * Whether auto height for merged cells
-     */
-    private _skipAutoHeightForMergedCells;
-    private _renderRawFormula;
-    /**
-     * @deprecated avoid use `IWorksheetData` directly, use API provided by `Worksheet`, otherwise
-     * `ViewModel` will be not working.
-     */
-    private _worksheetData;
-    private _cellData;
+    private _scene;
     constructor(worksheet: Worksheet, _styles: Styles, _localeService: LocaleService, _contextService: IContextService, _configService: IConfigService, _injector: Injector);
     initConfig(): void;
-    get rowHeightAccumulation(): number[];
-    get rowTotalHeight(): number;
-    get columnWidthAccumulation(): number[];
-    get columnTotalWidth(): number;
-    get rowHeaderWidth(): number;
-    get columnHeaderHeight(): number;
-    set columnHeaderHeight(value: number);
-    set rowHeaderWidth(value: number);
-    get imageCacheMap(): ImageCacheMap;
+    setScene(scene: Scene): void;
+    _updateLayout(): void;
     /**
      * Range of visible area(range in viewBounds)
      */
@@ -119,23 +69,12 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     get overflowCache(): ObjectMatrix<IRange>;
     get showGridlines(): BooleanNumber;
     get gridlinesColor(): string | undefined;
-    get mergeData(): IRange[];
-    get rowHeaderWidthAndMarginLeft(): number;
-    get columnHeaderHeightAndMarginTop(): number;
     dispose(): void;
     /**
      * @deprecated should never expose a property that is provided by another module!
      */
-    getsStyles(): Styles;
-    /**
-     * Get which Workbook and Worksheet this skeleton is attached to.
-     * @returns [unitId, sheetId]
-     */
-    getLocation(): [string, string];
-    private _initContextListener;
+    getStyles(): Styles;
     setOverflowCache(value: ObjectMatrix<IRange>): void;
-    setMarginLeft(left: number): void;
-    setMarginTop(top: number): void;
     getFont(rowIndex: number, columnIndex: number): Nullable<IFontCacheItem>;
     /**
      * Get range in visible area (range in view bounds) and set into this._rowColumnSegment.
@@ -150,12 +89,6 @@ export declare class SpreadsheetSkeleton extends Skeleton {
      * @param vpInfo viewBounds
      */
     setStylesCache(vpInfo?: IViewportInfo): Nullable<SpreadsheetSkeleton>;
-    /**
-     * Refresh cache after markDirty by SheetSkeletonManagerService.reCalculate()
-     * @param bounds
-     */
-    calculate(): Nullable<SpreadsheetSkeleton>;
-    private _hasUnMergedCellInRow;
     /**
      * Calc all auto height by getDocsSkeletonPageSize in ranges
      * @param ranges
@@ -176,16 +109,9 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     /**
      * For _calculateColMaxWidth
      * @param cell
-     * @returns {number} width
+     * @returns {number} currColWidth
      */
     _getMeasuredWidthByCell(cell: ICellDataForSheetInterceptor, currColWidth: number): number;
-    /**
-     * Calculate data for row col & cell position.
-     * This method should be called whenever a sheet is dirty.
-     * Update position value to this._rowHeaderWidth & this._rowHeightAccumulation & this._columnHeaderHeight & this._columnWidthAccumulation.
-     */
-    private _updateLayout;
-    private _dynamicallyUpdateRowHeaderWidth;
     /**
      * @deprecated use `getRangeByViewport` instead.
      * @param bounds
@@ -194,24 +120,8 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     getRangeByViewport(vpInfo?: IViewportInfo): IRange;
     getCacheRangeByViewport(vpInfo?: IViewportInfo): IRange;
     getRangeByViewBound(bound?: IBoundRectNoAngle): IRange;
-    /**
-     * @deprecated should never expose a property that is provided by another module!
-     * @returns
-     */
-    getWorksheetConfig(): IWorksheetData;
-    getMergeBounding(startRow: number, startColumn: number, endRow: number, endColumn: number): IRange;
-    /**
-     * expand curr range if it's intersect with merge range.
-     * @param range
-     * @returns {IRange} expanded range because merge info.
-     */
-    expandRangeByMerge(range: IRange): IRange;
     appendToOverflowCache(row: number, column: number, startColumn: number, endColumn: number): void;
-    getColumnCount(): number;
-    getRowCount(): number;
     getOverflowPosition(contentSize: Required<ISize>, horizontalAlign: HorizontalAlign, row: number, column: number, columnCount: number): IColumnRange;
-    getNoMergeCellPositionByIndex(rowIndex: number, columnIndex: number): IPosition;
-    getNoMergeCellPositionByIndexWithNoHeader(rowIndex: number, columnIndex: number): IPosition;
     /**
      * Get cell by pos(offsetX, offsetY).
      * @deprecated Please use `getCellWithCoordByOffset` instead.
@@ -220,22 +130,6 @@ export declare class SpreadsheetSkeleton extends Skeleton {
         x: number;
         y: number;
     }): Nullable<ICellWithCoord>;
-    /**
-     * Get cell by pos(offsetX, offsetY).
-     *
-     * options.matchFirst true means get cell would skip all invisible cells.
-     * @param offsetX position X in viewport.
-     * @param offsetY position Y in viewport.
-     * @param scaleX render scene scale x-axis, scene.getAncestorScale
-     * @param scaleY render scene scale y-axis, scene.getAncestorScale
-     * @param scrollXY render viewportScroll {x, y}
-     * @param options {IGetRowColByPosOptions}
-     * @returns {ICellWithCoord} Selection data with coordinates
-     */
-    getCellWithCoordByOffset(offsetX: number, offsetY: number, scaleX: number, scaleY: number, scrollXY: {
-        x: number;
-        y: number;
-    }, options?: IGetRowColByPosOptions): ICellWithCoord;
     /**
      * This method has the same implementation as `getCellIndexByOffset`,
      * but uses a different name to maintain backward compatibility with previous calls.
@@ -249,28 +143,6 @@ export declare class SpreadsheetSkeleton extends Skeleton {
         row: number;
         column: number;
     };
-    /**
-     * Get cell index by offset(o)
-     * @param offsetX position X in viewport.
-     * @param offsetY position Y in viewport.
-     * @param scaleX render scene scale x-axis, scene.getAncestorScale
-     * @param scaleY render scene scale y-axis, scene.getAncestorScale
-     * @param scrollXY  render viewport scroll {x, y}, scene.getScrollXYByRelativeCoords, scene.getScrollXY
-     * @param scrollXY.x
-     * @param scrollXY.y
-     * @returns cell index
-     */
-    getCellIndexByOffset(offsetX: number, offsetY: number, scaleX: number, scaleY: number, scrollXY: {
-        x: number;
-        y: number;
-    }, options?: IGetRowColByPosOptions): {
-        row: number;
-        column: number;
-    };
-    getCellByOffset(offsetX: number, offsetY: number, scaleX: number, scaleY: number, scrollXY: {
-        x: number;
-        y: number;
-    }): Nullable<ICellInfo>;
     getCellWithMergeInfoByIndex(row: number, column: number): Nullable<ICellInfo>;
     /**
      * Same as getColumnIndexByOffsetX
@@ -280,17 +152,6 @@ export declare class SpreadsheetSkeleton extends Skeleton {
         x: number;
         y: number;
     }, options?: IGetRowColByPosOptions): number;
-    /**
-     * Get column index by offset x.
-     * @param offsetX scaled offset x
-     * @param scaleX scale x
-     * @param scrollXY scrollXY
-     * @returns column index
-     */
-    getColumnIndexByOffsetX(evtOffsetX: number, scaleX: number, scrollXY: {
-        x: number;
-        y: number;
-    }, options?: IGetRowColByPosOptions): number;
     /**
      * Same as getRowIndexByOffsetY
      * @deprecated Please use `getRowIndexByOffsetY` method instead.
@@ -299,28 +160,6 @@ export declare class SpreadsheetSkeleton extends Skeleton {
         x: number;
         y: number;
     }, options?: IGetRowColByPosOptions): number;
-    /**
-     *
-     * @param offsetY scaled offset y
-     * @param scaleY scale y
-     * @param scrollXY
-     * @param scrollXY.x
-     * @param scrollXY.y
-     */
-    getRowIndexByOffsetY(offsetY: number, scaleY: number, scrollXY: {
-        x: number;
-        y: number;
-    }, options?: IGetRowColByPosOptions): number;
-    getTransformOffsetX(offsetX: number, scaleX: number, scrollXY: {
-        x: number;
-        y: number;
-    }): number;
-    getTransformOffsetY(offsetY: number, scaleY: number, scrollXY: {
-        x: number;
-        y: number;
-    }): number;
-    getOffsetByPositionX(column: number): number;
-    getOffsetByPositionY(row: number): number;
     /**
      * Same as getCellWithCoordByIndex, but uses a different name to maintain backward compatibility with previous calls.
      * @deprecated Please use `getCellWithCoordByIndex` instead.
@@ -332,33 +171,6 @@ export declare class SpreadsheetSkeleton extends Skeleton {
      * @param column
      */
     getCellByIndexWithNoHeader(row: number, column: number): ICellWithCoord;
-    /**
-     * Return cell information corresponding to the current coordinates, including the merged cell object.
-     *
-     * @param row Specified Row Coordinate
-     * @param column Specified Column Coordinate
-     */
-    getCellWithCoordByIndex(row: number, column: number, header?: boolean): ICellWithCoord;
-    /**
-     * convert canvas content position to physical position in screen
-     * @param offsetX
-     * @param scaleX
-     * @param scrollXY
-     */
-    convertTransformToOffsetX(offsetX: number, scaleX: number, scrollXY: {
-        x: number;
-        y: number;
-    }): number;
-    /**
-     * convert canvas content position to physical position in screen
-     * @param offsetY
-     * @param scaleY
-     * @param scrollXY
-     */
-    convertTransformToOffsetY(offsetY: number, scaleY: number, scrollXY: {
-        x: number;
-        y: number;
-    }): number;
     /**
      * Only used for cell edit, and no need to rotate text when edit cell content!
      * @deprecated use same method in worksheet.
@@ -381,12 +193,6 @@ export declare class SpreadsheetSkeleton extends Skeleton {
      * @param options
      */
     private _getCellDocumentModel;
-    getDecomposedOffset(offsetX: number, offsetY: number): {
-        row: number;
-        column: number;
-        columnOffset: number;
-        rowOffset: number;
-    };
     /**
      * Calculate the overflow of cell text. If there is no value on either side of the cell,
      * the text content of this cell can be drawn to both sides, not limited by the cell's width.
@@ -401,16 +207,6 @@ export declare class SpreadsheetSkeleton extends Skeleton {
      * @returns The range cell index of the canvas visible area
      */
     protected _getRangeByViewBounding(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;
     /**
      * Get the current row and column segment visible merge data.
      * @returns {IRange} The visible merge data
@@ -420,7 +216,7 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     /**
      * Any changes to sheet model would reset cache.
      */
-    private _resetCache;
+    _resetCache(): void;
     _setBorderStylesCache(row: number, col: number, style: Nullable<IStyleData>, options: {
         mergeRange?: IRange;
         cacheItem?: ICacheItem;
@@ -429,7 +225,7 @@ export declare class SpreadsheetSkeleton extends Skeleton {
         mergeRange?: IRange;
         cacheItem?: ICacheItem;
     } | undefined): void;
-    _setFontStylesCache(row: number, col: number, cell: Nullable<ICellDataForSheetInterceptor>): void;
+    _setFontStylesCache(row: number, col: number, cellData: Nullable<ICellDataForSheetInterceptor>): void;
     /**
      * Set border background and font to this._stylesCache cell by cell.
      * @param row {number}
@@ -437,32 +233,56 @@ export declare class SpreadsheetSkeleton extends Skeleton {
      * @param options {{ mergeRange: IRange; cacheItem: ICacheItem } | undefined}
      */
     private _setStylesCacheForOneCell;
-    private _updateConfigAndGetDocumentModel;
     /**
      * pro/issues/344
      * In Excel, for the border rendering of merged cells to take effect, the outermost cells need to have the same border style.
      */
     private _setMergeBorderProps;
     private _setBorderProps;
-    /**
-     * New version to get merge data.
-     * @param row
-     * @param column
-     * @returns {ISelectionCell} The cell info with merge data
-     */
-    private _getCellMergeInfo;
     getDistanceFromTopLeft(row: number, col: number): IPoint;
+    colStartX(col: number): number;
+    rowStartY(row: number): number;
+    getHiddenRowsInRange(range: IRowRange): number[];
+    getHiddenColumnsInRange(range: IColumnRange): number[];
     /**
-     * Distance from top left to row
-     * @param row
+     * @deprecated use function `convertTransformToOffsetX` in same package.
      */
-    private _offsetYToRow;
+    convertTransformToOffsetX(offsetX: number, scaleX: number, scrollXY: {
+        x: number;
+        y: number;
+    }): number;
     /**
-     * Distance from top left to col
-     * @param col
+     * @deprecated use function `convertTransformToOffsetY` in same package.
      */
-    private _offsetXToCol;
-    getHiddenRowsInRange(range: IRowRange): number[];
-    getHiddenColumnsInRange(range: IColumnRange): number[];
+    convertTransformToOffsetY(offsetY: number, scaleY: number, scrollXY: {
+        x: number;
+        y: number;
+    }): number;
 }
+/**
+ * convert canvas content position to physical position in screen
+ * @param offsetX
+ * @param scaleX
+ * @param scrollXY
+ */
+export declare function convertTransformToOffsetX(offsetX: number, scaleX: number, scrollXY: {
+    x: number;
+    y: number;
+}): number;
+/**
+ * convert canvas content position to physical position in screen
+ * @param offsetY
+ * @param scaleY
+ * @param scrollXY
+ */
+export declare function convertTransformToOffsetY(offsetY: number, scaleY: number, scrollXY: {
+    x: number;
+    y: number;
+}): number;
+/**
+ * Obtain the height and width of a cell's text, taking into account scenarios with rotated text.
+ * @param documentSkeleton Data of the document's ViewModel
+ * @param angleInDegree The rotation angle of an Excel cell, it's **degree**
+ */
+export declare function getDocsSkeletonPageSize(documentSkeleton: DocumentSkeleton, angleInDegree?: number): Nullable<Required<ISize>>;
 export {};

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

@@ -1,4 +1,4 @@
-import { IRange } from '@univerjs/core';
+import { IPosition, IRange } from '@univerjs/core';
 import { IBoundRectNoAngle, IViewportInfo, Vector2 } from '../../basics/vector2';
 import { Canvas } from '../../canvas';
 import { UniverRenderingContext2D } from '../../context';
@@ -7,7 +7,7 @@ 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 { SpreadsheetSkeleton } from './sheet.render-skeleton';
 import { Documents } from '../docs/document';
 import { SheetComponent } from './sheet-component';
 export declare class Spreadsheet extends SheetComponent {
@@ -42,12 +42,7 @@ export declare class Spreadsheet extends SheetComponent {
      */
     getScene(): Scene;
     isHit(coord: Vector2): boolean;
-    getNoMergeCellPositionByIndex(rowIndex: number, columnIndex: number): {
-        startY: number;
-        endY: number;
-        startX: number;
-        endX: number;
-    } | undefined;
+    getNoMergeCellPositionByIndex(rowIndex: number, columnIndex: number): IPosition;
     getScrollXYByRelativeCoords(coord: Vector2): {
         x: number;
         y: number;

package/lib/types/components/slides/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2023-present DreamNum Inc.
+ * Copyright 2023-present DreamNum Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

package/lib/types/controllers/config.schema.d.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2023-present DreamNum Inc.
+ * Copyright 2023-present DreamNum Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
-import { BaseObject } from '../base-object';
 import { IViewportInfo, Vector2 } from '../basics/vector2';
 import { UniverRenderingContext } from '../context';
+import { BaseObject } from '../base-object';
 export declare class CustomObject extends BaseObject {
     private _render;
     private _isHitCustom?;

package/lib/types/custom/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2023-present DreamNum Inc.
+ * Copyright 2023-present DreamNum Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

package/lib/types/engine.d.ts

@@ -1,10 +1,10 @@
+import { CURSOR_TYPE, RENDER_CLASS_TYPE } from './basics/const';
 import { IEvent } from './basics/i-events';
 import { ITimeMetric, ITransformChangeState } from './basics/interfaces';
 import { IBasicFrameInfo } from './basics/performance-monitor';
 import { Scene } from './scene';
 import { Disposable, EventSubject } from '@univerjs/core';
 import { Observable, Subject } from 'rxjs';
-import { CURSOR_TYPE, RENDER_CLASS_TYPE } from './basics/const';
 import { Canvas, CanvasRenderMode } from './canvas';
 export interface IEngineOption {
     elementWidth: number;
@@ -101,7 +101,25 @@ export declare class Engine extends Disposable {
      */
     setCapture(): void;
     getPixelRatio(): number;
-    setContainer(elem: HTMLElement, resize?: boolean): void;
+    private _resizeListenerDisposable;
+    /**
+     * Mount the canvas to the element so it would be rendered on UI.
+     * @param {HTMLElement} element - The element the canvas will mount on.
+     * @param {true} [resize] If should perform resize when mounted and observe resize event.
+     */
+    mount(element: HTMLElement, resize?: boolean): void;
+    /**
+     * Unmount the canvas without disposing it so it can be mounted again.
+     */
+    unmount(): void;
+    /**
+     * Mount the canvas to the element so it would be rendered on UI.
+     * @deprecated Please use `mount` instead.
+     * @param {HTMLElement} element - The element the canvas will mount on.
+     * @param {true} [resize] If should perform resize when mounted and observe resize event.
+     */
+    setContainer(element: HTMLElement, resize?: boolean): void;
+    private _clearResizeListener;
     resize(): void;
     dprChange(): void;
     /**

package/lib/types/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2023-present DreamNum Inc.
+ * Copyright 2023-present DreamNum Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -33,7 +33,7 @@ export { DocumentViewModel } from './components/docs/view-model/document-view-mo
 export { DocumentEditArea } from './components/docs/view-model/document-view-model';
 export { parseDataStreamToTree } from './components/docs/view-model/document-view-model';
 export { getLastColumn } from './components/docs/layout/tools';
-export { DEFAULT_PADDING_DATA } from './components/sheets/sheet-skeleton';
+export { DEFAULT_PADDING_DATA } from './components/sheets/sheet.render-skeleton';
 export * from './context';
 export * from './custom';
 export * from './engine';
@@ -47,5 +47,4 @@ export { type IChangeObserverConfig } from './scene.transformer';
 export * from './scene-viewer';
 export * from './scroll-timer';
 export * from './shape';
-export { ThinEngine } from './thin-engine';
 export * from './viewport';

package/lib/types/render-manager/render-manager.service.d.ts

@@ -4,12 +4,12 @@ import { BaseObject } from '../base-object';
 import { DocComponent } from '../components/docs/doc-component';
 import { SheetComponent } from '../components/sheets/sheet-component';
 import { Slide } from '../components/slides/slide';
-import { Engine } from '../engine';
 import { IRender, RenderUnit } from './render-unit';
+import { Engine } from '../engine';
 export type RenderComponentType = SheetComponent | DocComponent | Slide | BaseObject;
 export interface IRenderManagerService extends IDisposable {
-    /** @deprecated */
     currentRender$: Observable<Nullable<string>>;
+    getCurrent(): Nullable<IRender>;
     addRender(unitId: string, renderer: IRender): void;
     /**
      * create renderUnit & init deps from renderDependencies by renderUnit's type.
@@ -39,8 +39,6 @@ export interface IRenderManagerService extends IDisposable {
     create(unitId: string): void;
     created$: Observable<IRender>;
     disposed$: Observable<string>;
-    /** @deprecated There will be multi units to render at the same time, so there is no *current*. */
-    getCurrent(): Nullable<IRender>;
     /** @deprecated There will be multi units to render at the same time, so there is no *first*. */
     getFirst(): Nullable<IRender>;
     has(unitId: string): boolean;

package/lib/types/render-manager/render-unit.d.ts

@@ -1,4 +1,5 @@
 import { Dependency, DependencyIdentifier, IDisposable, Nullable, UnitModel, UnitType, UniverInstanceType, Disposable, Injector } from '@univerjs/core';
+import { Observable } from 'rxjs';
 import { Engine } from '../engine';
 import { Scene } from '../scene';
 import { RenderComponentType } from './render-manager.service';
@@ -16,8 +17,23 @@ export interface IRender {
     components: Map<string, RenderComponentType>;
     isMainScene: boolean;
     isThumbNail?: boolean;
+    /**
+     * Whether the render unit is activated. It should emit value when subscribed immediately.
+     * When created, the render unit is activated by default.
+     */
+    activated$: Observable<boolean>;
     with<T>(dependency: DependencyIdentifier<T>): T;
     getRenderContext?(): IRenderContext;
+    /**
+     * Deactivate the render unit, means the render unit would be freezed and not updated,
+     * even removed from the webpage. However, the render unit is still in the memory and
+     * could be activated again.
+     */
+    deactivate(): void;
+    /**
+     * Activate the render unit, means the render unit would be updated and rendered.
+     */
+    activate(): void;
 }
 /**
  * Every render module should implement this interface.
@@ -38,6 +54,8 @@ export interface IRenderContext<T extends UnitModel = UnitModel> extends Omit<IR
  */
 export declare class RenderUnit extends Disposable implements IRender {
     readonly isRenderUnit: boolean;
+    private readonly _activated$;
+    readonly activated$: Observable<boolean>;
     get unitId(): string;
     get type(): UnitType;
     private readonly _injector;
@@ -64,4 +82,6 @@ export declare class RenderUnit extends Disposable implements IRender {
     addRenderDependencies(dependencies: Dependency[]): void;
     private _initDependencies;
     getRenderContext(): IRenderContext;
+    activate(): void;
+    deactivate(): void;
 }