@univerjs/engine-render 0.2.8 → 0.2.10

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

@@ -7,6 +7,8 @@ import { IViewportInfo, Vector2 } from './basics/vector2';
 import { UniverRenderingContext } from './context';
 import { Layer } from './layer';
 import { ITransformerConfig } from './basics/transformer-config';
+import { Scene } from './scene';
+import { Engine } from './engine';
 export declare const BASE_OBJECT_ARRAY: string[];
 export declare enum ObjectType {
     UNKNOWN = 0,
@@ -161,10 +163,10 @@ export declare abstract class BaseObject extends Disposable {
     triggerDrop(evt: IDragEvent | IMouseEvent): boolean;
     dispose(): void;
     toJson(): IKeyValue;
-    getScene(): any;
+    getScene(): Nullable<Scene>;
     resetCursor(): void;
     setCursor(val: CURSOR_TYPE): void;
-    getEngine(): any;
+    getEngine(): Nullable<Engine>;
     getObjects(): BaseObject[];
     getLayerIndex(): number;
     applyTransform(): void;

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

@@ -3,7 +3,6 @@ import { IDocumentSkeletonPage } from '../../basics/i-document-skeleton-cached';
 import { Transform } from '../../basics/transform';
 import { IViewportInfo } from '../../basics/vector2';
 import { UniverRenderingContext } from '../../context';
-import { Scene } from '../../scene';
 import { IDocumentsConfig, IPageMarginLayout, DocComponent } from './doc-component';
 import { DocumentSkeleton } from './layout/doc-skeleton';
 export interface IPageRenderConfig {
@@ -27,7 +26,7 @@ export declare class Documents extends DocComponent {
     static create(oKey: string, documentSkeleton?: DocumentSkeleton, config?: IDocumentsConfig): Documents;
     dispose(): void;
     getOffsetConfig(): IDocumentOffsetConfig;
-    getEngine(): Nullable<import('../..').ThinEngine<Scene>>;
+    getEngine(): Nullable<import('../..').Engine>;
     changeSkeleton(newSkeleton: DocumentSkeleton): this;
     protected _draw(ctx: UniverRenderingContext, bounds?: IViewportInfo): void;
     draw(ctx: UniverRenderingContext, bounds?: IViewportInfo): void;

package/lib/types/components/docs/layout/block/paragraph/language-ruler.d.ts

@@ -1,20 +1,20 @@
-import { IParagraphStyle } from '@univerjs/core';
+import { IParagraph } from '@univerjs/core';
 import { ISectionBreakConfig } from '../../../../../basics/interfaces';
 import { DataStreamTreeNode } from '../../../view-model/data-stream-tree-node';
 import { DocumentViewModel } from '../../../view-model/document-view-model';
-export declare function otherHandler(index: number, charArray: string, viewModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraphStyle: IParagraphStyle): {
+export declare function otherHandler(index: number, charArray: string, viewModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraph: IParagraph): {
     step: number;
     glyphGroup: import('../../../../..').IDocumentSkeletonGlyph[];
 };
-export declare function ArabicHandler(index: number, charArray: string, viewModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraphStyle: IParagraphStyle): {
+export declare function ArabicHandler(index: number, charArray: string, viewModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraph: IParagraph): {
     step: number;
     glyphGroup: import('../../../../..').IDocumentSkeletonGlyph[];
 };
-export declare function emojiHandler(index: number, charArray: string, viewModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraphStyle: IParagraphStyle): {
+export declare function emojiHandler(index: number, charArray: string, viewModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraph: IParagraph): {
     step: number;
     glyphGroup: import('../../../../..').IDocumentSkeletonGlyph[];
 };
-export declare function TibetanHandler(index: number, charArray: string, viewModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraphStyle: IParagraphStyle): {
+export declare function TibetanHandler(index: number, charArray: string, viewModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraph: IParagraph): {
     step: number;
     glyphGroup: import('../../../../..').IDocumentSkeletonGlyph[];
 };

package/lib/types/components/docs/layout/block/paragraph/layout-ruler.d.ts

@@ -2,5 +2,5 @@ import { IDocumentSkeletonDrawing, IDocumentSkeletonGlyph, IDocumentSkeletonLine
 import { IParagraphConfig, ISectionBreakConfig } from '../../../../../basics/interfaces';
 import { ILayoutContext } from '../../tools';
 import { BreakPointType } from '../../line-breaker/break';
-export declare function layoutParagraph(ctx: ILayoutContext, glyphGroup: IDocumentSkeletonGlyph[], pages: IDocumentSkeletonPage[], sectionBreakConfig: ISectionBreakConfig, paragraphConfig: IParagraphConfig, paragraphStart?: boolean, breakPointType?: BreakPointType): IDocumentSkeletonPage[];
+export declare function layoutParagraph(ctx: ILayoutContext, glyphGroup: IDocumentSkeletonGlyph[], pages: IDocumentSkeletonPage[], sectionBreakConfig: ISectionBreakConfig, paragraphConfig: IParagraphConfig, isParagraphFirstShapedText: boolean, breakPointType?: BreakPointType): IDocumentSkeletonPage[];
 export declare function updateInlineDrawingPosition(line: IDocumentSkeletonLine, paragraphInlineSkeDrawings?: Map<string, IDocumentSkeletonDrawing>, blockAnchorTop?: number): void;

package/lib/types/components/docs/layout/doc-skeleton.d.ts

@@ -17,6 +17,8 @@ export interface IFindNodeRestrictions {
 }
 export declare class DocumentSkeleton extends Skeleton {
     private _docViewModel;
+    private _dirty$;
+    readonly dirty$: import('rxjs').Observable<boolean>;
     private _skeletonData;
     private _findLiquid;
     private _hyphen;

package/lib/types/components/docs/layout/tools.d.ts

@@ -1,4 +1,4 @@
-import { DocumentDataModel, INumberUnit, IObjectPositionH, IObjectPositionV, IParagraphStyle, ITextStyle, Nullable, BooleanNumber, GridType, SpacingRule } from '@univerjs/core';
+import { DocumentDataModel, INumberUnit, IObjectPositionH, IObjectPositionV, IParagraph, IParagraphStyle, ITextStyle, Nullable, BooleanNumber, GridType, SpacingRule } from '@univerjs/core';
 import { IDocumentSkeletonCached, IDocumentSkeletonColumn, IDocumentSkeletonDivide, IDocumentSkeletonDrawing, IDocumentSkeletonFontStyle, IDocumentSkeletonGlyph, IDocumentSkeletonLine, IDocumentSkeletonPage, IDocumentSkeletonSection, ISkeletonResourceReference } from '../../../basics/i-document-skeleton-cached';
 import { IDocsConfig, IParagraphConfig, ISectionBreakConfig } from '../../../basics/interfaces';
 import { DataStreamTreeNode } from '../view-model/data-stream-tree-node';
@@ -72,7 +72,7 @@ export declare function getFontConfigFromLastGlyph(glyph: IDocumentSkeletonGlyph
     snapToGrid: BooleanNumber;
     pageWidth: number;
 };
-export declare function getFontCreateConfig(index: number, viewModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraphStyle: IParagraphStyle): IFontCreateConfig;
+export declare function getFontCreateConfig(index: number, viewModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraph: IParagraph): IFontCreateConfig;
 export declare function getNullSkeleton(): IDocumentSkeletonCached;
 export declare function setPageParent(pages: IDocumentSkeletonPage[], parent: IDocumentSkeletonCached): void;
 export interface ILayoutContext {

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

@@ -24,7 +24,7 @@ export declare class Liquid {
         x: number;
         y: number;
     };
-    translateLine(line: IDocumentSkeletonLine, isDraw?: boolean): {
+    translateLine(line: IDocumentSkeletonLine, includeMarginTop?: boolean, includePaddingTop?: boolean): {
         x: number;
         y: number;
     };

package/lib/types/components/docs/text-selection/text-selection-render-manager.d.ts

@@ -1,11 +1,11 @@
 import { Nullable, ILogService, RxDisposable } from '@univerjs/core';
 import { Observable } from 'rxjs';
 import { IMouseEvent, IPointerEvent } from '../../../basics/i-events';
-import { INodeInfo, INodePosition } from '../../../basics/interfaces';
+import { INodePosition } from '../../../basics/interfaces';
 import { ISuccinctDocRangeParam, ITextRangeWithStyle, ITextSelectionStyle, RANGE_DIRECTION } from '../../../basics/range';
 import { Scene } from '../../../scene';
 import { Viewport } from '../../../viewport';
-import { DocumentSkeleton, IFindNodeRestrictions } from '../layout/doc-skeleton';
+import { DocumentSkeleton } from '../layout/doc-skeleton';
 import { Documents } from '../document';
 import { TextRange } from './text-range';
 import { RectRange } from './rect-range';
@@ -177,7 +177,7 @@ export declare class TextSelectionRenderManager extends RxDisposable implements
     private _addTextRange;
     private _addRectRangesToCache;
     private _addRectRanges;
-    private _updateTextRangeAnchorPosition;
+    private _createTextRangeByAnchorPosition;
     private _updateActiveRangePosition;
     private _isEmpty;
     private _getCanvasOffset;
@@ -187,9 +187,7 @@ export declare class TextSelectionRenderManager extends RxDisposable implements
     private _initInputEvents;
     private _eventHandle;
     private _getTransformCoordForDocumentOffset;
-    findNodeByCoord(evtOffsetX: number, evtOffsetY: number, restrictions: IFindNodeRestrictions): Nullable<INodeInfo>;
-    private _getNodeIndex;
+    private _findNodeByCoord;
     private _detachEvent;
-    private _activeSelectionRefresh;
 }
 export declare const ITextSelectionRenderManager: import('@univerjs/core').IdentifierDecorator<TextSelectionRenderManager>;

package/lib/types/components/docs/view-model/document-view-model.d.ts

@@ -25,6 +25,8 @@ export declare class DocumentViewModel implements IDisposable {
     readonly editAreaChange$: import('rxjs').Observable<Nullable<DocumentEditArea>>;
     headerTreeMap: Map<string, DocumentViewModel>;
     footerTreeMap: Map<string, DocumentViewModel>;
+    private readonly _segmentViewModels$;
+    readonly segmentViewModels$: import('rxjs').Observable<DocumentViewModel[]>;
     constructor(_documentDataModel: DocumentDataModel);
     registerCustomRangeInterceptor(interceptor: ICustomRangeInterceptor): IDisposable;
     dispose(): void;

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

@@ -24,5 +24,9 @@ export declare class SpreadsheetColumnHeader extends SpreadsheetHeader {
     draw(ctx: UniverRenderingContext, bounds?: IViewportInfo): void;
     isHit(coord: Vector2): boolean;
     private _initialDefaultExtension;
+    /**
+     * Custimize column header, such as custom header text and background.
+     * @param cfg
+     */
     setCustomHeader(cfg: IColumnsHeaderCfgParam): void;
 }

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

@@ -7,6 +7,9 @@ export interface IColumnsHeaderCfgParam {
     headerStyle?: Partial<IColumnStyleCfg>;
     columnsCfg?: IAColumnCfg[];
 }
+/**
+ * Column Header Bar, include a lot of columns header
+ */
 export declare class ColumnHeaderLayout extends SheetExtension {
     uKey: string;
     Z_INDEX: number;

package/lib/types/components/sheets/extensions/sheet-extension.d.ts

@@ -6,6 +6,16 @@ export declare enum SHEET_EXTENSION_TYPE {
 }
 export declare class SheetExtension extends ComponentExtension<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]> {
     type: SHEET_EXTENSION_TYPE;
+    /**
+     * Get ISelectionCellWithMergeInfo by cell rowIndex and cell columnIndex.
+     * The startXY in return value does not include rowHeader and columnHeader.
+     * @param rowIndex
+     * @param columnIndex
+     * @param rowHeightAccumulation
+     * @param columnWidthAccumulation
+     * @param dataMergeCache
+     * @returns ISelectionCellWithMergeInfo
+     */
     getCellIndex(rowIndex: number, columnIndex: number, rowHeightAccumulation: number[], columnWidthAccumulation: number[], dataMergeCache: IRange[]): import('@univerjs/core').ISelectionCellWithMergeInfo;
     isRenderDiffRangesByCell(rangeP: IRange, diffRanges?: IRange[]): boolean;
     isRenderDiffRangesByColumn(curStartColumn: number, curEndColumn: number, diffRanges?: IRange[]): boolean;

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

@@ -1,4 +1,4 @@
-import { BooleanNumber, DocumentDataModel, HorizontalAlign, IContextService, LocaleService, ObjectMatrix, VerticalAlign, WrapStrategy, ICellData, IPaddingData, IRange, IRowAutoHeightInfo, ISelectionCellWithMergeInfo, ITextRotation, IWorksheetData, Nullable, Styles, Worksheet } from '@univerjs/core';
+import { BooleanNumber, DocumentDataModel, HorizontalAlign, IContextService, LocaleService, ObjectMatrix, VerticalAlign, WrapStrategy, ICellData, IColumnRange, IPaddingData, IPosition, IRange, IRowAutoHeightInfo, ISelectionCellWithMergeInfo, ISize, ITextRotation, IWorksheetData, Nullable, Styles, Worksheet } from '@univerjs/core';
 import { IBoundRectNoAngle, IViewportInfo } from '../../basics/vector2';
 import { DocumentSkeleton } from '../docs/layout/doc-skeleton';
 import { Skeleton } from '../skeleton';
@@ -8,10 +8,7 @@ import { IStylesCache } from './interfaces';
  * @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): {
-    width: number;
-    height: number;
-} | undefined;
+export declare function getDocsSkeletonPageSize(documentSkeleton: DocumentSkeleton, angleInDegree?: number): Nullable<Required<ISize>>;
 interface IRowColumnSegment {
     startRow: number;
     endRow: number;
@@ -35,6 +32,10 @@ export declare const DEFAULT_PADDING_DATA: {
     r: number;
 };
 export declare const RENDER_RAW_FORMULA_KEY = "RENDER_RAW_FORMULA";
+export interface ICacheItem {
+    bg: boolean;
+    border: boolean;
+}
 export declare class SpreadsheetSkeleton extends Skeleton {
     readonly worksheet: Worksheet;
     /**
@@ -101,11 +102,14 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     setOverflowCache(value: ObjectMatrix<IRange>): void;
     setMarginLeft(left: number): void;
     setMarginTop(top: number): void;
-    calculateSegment(bounds?: IViewportInfo): true | undefined;
-    calculateWithoutClearingCache(bounds?: IViewportInfo): this | undefined;
-    calculate(bounds?: IViewportInfo): this;
+    calculateSegment(bounds?: IViewportInfo): boolean;
+    calculateWithoutClearingCache(bounds?: IViewportInfo): Nullable<SpreadsheetSkeleton>;
+    calculate(bounds?: IViewportInfo): Nullable<SpreadsheetSkeleton>;
     calculateAutoHeightInRange(ranges: Nullable<IRange[]>): IRowAutoHeightInfo[];
     private _calculateRowAutoHeight;
+    /**
+     * Calculate data for row col & cell position, then update position value to this._rowHeaderWidth & this._rowHeightAccumulation & this._columnHeaderHeight & this._columnWidthAccumulation.
+     */
     private _updateLayout;
     private _dynamicallyUpdateRowHeaderWidth;
     getRowColumnSegment(bounds?: IViewportInfo): IRange;
@@ -119,27 +123,11 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     appendToOverflowCache(row: number, column: number, startColumn: number, endColumn: number): void;
     getColumnCount(): number;
     getRowCount(): number;
-    getOverflowPosition(contentSize: {
-        width: number;
-        height: number;
-    }, horizontalAlign: HorizontalAlign, row: number, column: number, columnCount: number): {
-        startColumn: number;
-        endColumn: number;
-    };
-    getNoMergeCellPositionByIndex(rowIndex: number, columnIndex: number): {
-        startY: number;
-        endY: number;
-        startX: number;
-        endX: number;
-    };
-    getNoMergeCellPositionByIndexWithNoHeader(rowIndex: number, columnIndex: number): {
-        startY: number;
-        endY: number;
-        startX: number;
-        endX: 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).
      * @param offsetX HTML coordinate system, mouse position x.
      * @param offsetY HTML coordinate system, mouse position y.
      * @param scaleX render scene scale x-axis, scene.getAncestorScale
@@ -210,31 +198,7 @@ export declare class SpreadsheetSkeleton extends Skeleton {
      * @param column Specified Column Coordinate
      */
     getCellByIndex(row: number, column: number): ISelectionCellWithMergeInfo;
-    getCellByIndexWithNoHeader(row: number, column: number): {
-        actualRow: number;
-        actualColumn: number;
-        startY: number;
-        endY: number;
-        startX: number;
-        endX: number;
-        isMerged: boolean;
-        isMergedMainCell: boolean;
-        mergeInfo: {
-            startX: number;
-            startY: number;
-            endX: number;
-            endY: number;
-            rangeType?: import('@univerjs/core').RANGE_TYPE;
-            startAbsoluteRefType?: import('@univerjs/core').AbsoluteRefType;
-            endAbsoluteRefType?: import('@univerjs/core').AbsoluteRefType;
-            startRow: number;
-            endRow: number;
-            unitId?: string;
-            sheetId?: string;
-            startColumn: number;
-            endColumn: number;
-        };
-    };
+    getCellByIndexWithNoHeader(row: number, column: number): ISelectionCellWithMergeInfo;
     convertTransformToOffsetX(offsetX: number, scaleX: number, scrollXY: {
         x: number;
         y: number;
@@ -275,7 +239,7 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     private _resetCache;
     resetCache(): void;
     private _makeDocumentSkeletonDirty;
-    private _setCellCache;
+    private _setCellStylesCache;
     private _updateConfigAndGetDocumentModel;
     private _getDocumentDataByStyle;
     /**

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

@@ -32,8 +32,6 @@ export declare class Spreadsheet extends SheetComponent {
     dispose(): void;
     /**
      * draw by viewport
-     * cacheBound ---> viewBound
-     * diffCacheBounds ---> diffRange
      * @param ctx
      * @param viewportInfo
      */

package/lib/types/engine.d.ts

@@ -38,7 +38,7 @@ export declare class Engine extends ThinEngine<Scene> {
     private _dropEvent;
     private _remainCapture;
     /** previous pointer position */
-    private pointer;
+    private _pointer;
     private _mouseId;
     private _isUsingFirefox;
     private _previousWidth;

package/lib/types/layer.d.ts

@@ -17,21 +17,29 @@ export declare class Layer extends Disposable {
     disableCache(): void;
     isAllowCache(): boolean;
     /**
-     * get objects which is visible and not in a group.
-     * @returns BaseObject[]
+     * Get direct visible children in order. (direct means object is not in group), default order is ascending by z-index.
+     * @returns {BaseObject[]} objects
      */
     getObjectsByOrder(): BaseObject[];
+    /**
+     * Get visible and evented objects.
+     * @returns {BaseObject[]} objects
+     */
     getObjectsByOrderForPick(): BaseObject[];
     getObjects(): BaseObject[];
     /**
-     * insert o to _objects[]
-     * if o is a group, insert all its children and group itself to _objects[]
+     * Insert object to this._objects, if object is a group, insert all its children and group itself to _objects[]
      * @param o
-     * @returns this
+     * @returns {Layer} this
      */
-    addObject(o: BaseObject): this;
+    addObject(o: BaseObject): Layer;
     removeObject(object: BaseObject | string): void;
-    addObjects(objects: BaseObject[]): this;
+    /**
+     * Insert objects to this._objects, if object is a group, insert all its children and group itself to _objects[]
+     * @param objects
+     * @returns {Layer} this
+     */
+    addObjects(objects: BaseObject[]): Layer;
     removeObjects(objects: BaseObject[] | string[]): void;
     makeDirty(state?: boolean): this;
     makeDirtyWithDebounce(state?: boolean): void;

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

@@ -43,7 +43,7 @@ export interface IRenderManagerService extends IDisposable {
     /**
      * add dep to _renderDependencies(type, dep)
      * @param type
-     * @param depCtor
+     * @param dep
      */
     registerRenderModule<T extends UnitModel>(type: UnitType, dep: Dependency<T>): IDisposable;
 }
@@ -103,13 +103,13 @@ export declare class RenderManagerService extends Disposable implements IRenderM
      * @returns renderUnit:IRender
      */
     private _createRender;
-    addRender(unitId: string, item: IRender): void;
+    addRender(unitId: string, renderUnit: IRender): void;
     private _addRenderUnit;
     removeRender(unitId: string): void;
     has(unitId: string): boolean;
     setCurrent(unitId: string): void;
-    getCurrent(): IRender | undefined;
-    getFirst(): IRender;
+    getCurrent(): Nullable<IRender>;
+    getFirst(): Nullable<IRender>;
     /**
      * get RenderUnit from this._renderMap
      * @param unitId

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

@@ -2,6 +2,11 @@ import { Dependency, DependencyIdentifier, IDisposable, Nullable, UnitModel, Uni
 import { Engine } from '../engine';
 import { Scene } from '../scene';
 import { RenderComponentType } from './render-manager.service';
+/**
+ * Public interface of a {@link RenderUnit}.
+ *
+ * @property {string} unitId - The id of the RenderUnit.
+ */
 export interface IRender {
     unitId: string;
     type: UniverInstanceType;
@@ -13,17 +18,22 @@ export interface IRender {
     isThumbNail?: boolean;
     with<T>(dependency: DependencyIdentifier<T>): T;
 }
+/**
+ * Every render module should implement this interface.
+ */
 export interface IRenderModule extends IDisposable {
 }
 /**
- * This object encapsulates methods or properties to render each element.
+ * Necessary context for a render module.This interface would be the first argument of render modules' constructor
+ * functions.
  */
 export interface IRenderContext<T extends UnitModel = UnitModel> extends Omit<IRender, 'with'> {
     unit: T;
     type: UnitType;
 }
 /**
- * RenderUnit impl IRender
+ * This class is necessary for Univer to render several units in the same webpage. It encapsulates the rendering
+ * context and rendering modules for a specific unit.
  */
 export declare class RenderUnit extends Disposable implements IRender {
     readonly isRenderUnit: boolean;
@@ -43,9 +53,13 @@ export declare class RenderUnit extends Disposable implements IRender {
     constructor(init: Pick<IRenderContext, 'engine' | 'scene' | 'isMainScene' | 'unit'>, parentInjector: Injector);
     dispose(): void;
     /**
-     * Get render controller hold by this render unit.
+     * Get a dependency from the RenderUnit's injector.
      */
     with<T>(dependency: DependencyIdentifier<T>): T;
+    /**
+     * Add render dependencies to the RenderUnit's injector. Note that the dependencies would be initialized immediately
+     * after being added.
+     */
     addRenderDependencies(dependencies: Dependency[]): void;
     private _initDependencies;
 }

package/lib/types/scene.d.ts

@@ -12,6 +12,7 @@ import { ThinEngine } from './thin-engine';
 import { ThinScene } from './thin-scene';
 import { Viewport } from './viewport';
 import { ITransformerConfig } from './basics/transformer-config';
+import { Engine } from './engine';
 export declare class Scene extends ThinScene {
     private _parent;
     private _layers;
@@ -48,8 +49,10 @@ export declare class Scene extends ThinScene {
     resize(width?: number, height?: number): this;
     setScaleValue(scaleX: number, scaleY: number): void;
     /**
-     * scale to value, absolute
-     * setTransform ---> viewport._updateScrollBarPosByViewportScroll --->  scrollTo
+     * Set scale, and then emit event to update Viewport scroll state.
+     * @param scaleX
+     * @param scaleY
+     * @returns Scene
      */
     scale(scaleX?: number, scaleY?: number): this;
     /**
@@ -57,42 +60,65 @@ export declare class Scene extends ThinScene {
      */
     scaleBy(scaleX?: number, scaleY?: number): this;
     /**
-     * This sequence will initiate a series of updates:
-     * scene._setTransForm --> viewport@resetCanvasSizeAndUpdateScrollBar ---> scrollTo ---> limitedScroll ---> onScrollBeforeObserver ---> setScrollInfo
-     * scrollInfo needs accurate scene width & height, limitedScroll depends on scene & engine's width & height
+     * Reset canvas size and update scroll
      * @param state
      */
     transformByState(state: ISceneTransformState): void;
     getParent(): ThinEngine<Scene> | SceneViewer;
-    getEngine(): Nullable<ThinEngine<Scene>>;
+    getEngine(): Nullable<Engine>;
     getLayers(): Layer[];
     getLayer(zIndex?: number): Layer;
     getLayerMaxZIndex(): number;
     addLayer(...argument: Layer[]): void;
-    addObjects(objects: BaseObject[], zIndex?: number): this;
-    addObject(o: BaseObject, zIndex?: number): this;
     /**
-     * make object parent to scene
+     * Add objects to Layer( Layer is specfied by zIndex)
+     * If object is a group, insert all its children and group itself to _objects[].
+     * @param objects
+     * @param zIndex
+     * @returns {Scene} this
+     */
+    addObjects(objects: BaseObject[], zIndex?: number): Scene;
+    /**
+     * Add object to Layer (Layer is specified by zIndex).
+     * If object is a group, insert all its children and group itself to _objects[].
+     * @param o
+     * @param zIndex layer index
+     * @returns {Scene} scene
+     */
+    addObject(o: BaseObject, zIndex?: number): Scene;
+    /**
+     * Set Scene as object parent, if object has no parent.
      * @param o
+     * @returns {void}
      */
     setObjectBehavior(o: BaseObject): void;
-    removeObject(object?: BaseObject | string): this | undefined;
-    removeObjects(objects?: BaseObject[] | string[]): this | undefined;
+    removeObject(object?: BaseObject | string): Nullable<Scene>;
+    removeObjects(objects?: BaseObject[] | string[]): Nullable<Scene>;
     getObjectsByLayer(zIndex: number): BaseObject[];
     /**
-     * get objects which is visible and not in a group in each layer.
-     * @returns BaseObject[]
+     * Get all objects of each Layer.
+     * @returns {BaseObject[]} objects
      */
     getAllObjects(): BaseObject[];
+    /**
+     * Get objects which is visible and not in a group in each layer.
+     * @returns BaseObject[]
+     */
+    getAllObjectsByOrder(): BaseObject[];
     /**
      * get objects which is visible and not in a group.
      * @param isDesc
      * @returns BaseObject[]
      */
-    getAllObjectsByOrder(isDesc?: boolean): BaseObject[];
+    getAllObjectsByDescOrder(isDesc?: boolean): BaseObject[];
+    /**
+     * Get visible and evented objects.
+     * @param isDesc
+     * @returns {BaseObject[]} objects
+     */
     getAllObjectsByOrderForPick(isDesc?: boolean): BaseObject[];
-    getObject(oKey: string): BaseObject | undefined;
-    getObjectIncludeInGroup(oKey: string): BaseObject | undefined;
+    getObject(oKey: string): Nullable<BaseObject>;
+    getObjectIncludeInGroup(oKey: string): Nullable<BaseObject>;
     fuzzyMathObjects(oKey: string, matchStart?: boolean): BaseObject[];
     addViewport(...viewport: Viewport[]): this;
     removeViewport(key: string): Viewport | undefined;

package/lib/types/shape/rich-text.d.ts

@@ -90,11 +90,7 @@ export declare class RichText extends BaseObject {
     private _convertToDocumentData;
     private _initialProps;
     /**
-     *
-     * it should be invoked when _documentData changed.
-     * _documentData changed ---> update _documentSkeleton & _documentSkeleton
-     *
-     * now it is invoked when transformByState(change editor size) & end of editing
+     * After changing editor size & end of editing, update skeleton of doc.
      */
     refreshDocumentByDocData(): void;
     /**

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

@@ -102,7 +102,11 @@ export declare abstract class Shape<T extends IShapeProps> extends BaseObject {
     private static _setFillStyles;
     private static _setStrokeStyles;
     render(mainCtx: UniverRenderingContext, bounds?: IViewportInfo): this;
-    setProps(props?: T): this | undefined;
+    /**
+     * this[_key] = props[key]
+     * @param props
+     */
+    setProps(props?: T): Shape<T>;
     toJson(): {
         [x: string]: any;
     };