@univerjs/engine-render 0.2.8 → 0.2.9

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

@@ -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;

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/sheet-skeleton.d.ts

@@ -35,6 +35,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;
     /**
@@ -106,6 +110,10 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     calculate(bounds?: IViewportInfo): this;
     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.
+     * @returns this
+     */
     private _updateLayout;
     private _dynamicallyUpdateRowHeaderWidth;
     getRowColumnSegment(bounds?: IViewportInfo): IRange;
@@ -275,7 +283,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/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,19 +60,23 @@ 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;
+    /**
+     * Add object to Layer (Layer is specified by zIndex).
+     * @param o
+     * @param zIndex layer index
+     * @returns scene
+     */
     addObject(o: BaseObject, zIndex?: number): this;
     /**
      * make object parent to scene

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/viewport.d.ts

@@ -195,10 +195,6 @@ export declare class Viewport {
     set preCacheBound(val: IBoundRectNoAngle | null);
     enable(): void;
     disable(): void;
-    /**
-     * invoked when canvas element size change
-     * engineResizeObserver --> engine.resizeBySize --> scene._setTransForm
-     */
     resetCanvasSizeAndUpdateScroll(): void;
     setScrollBar(instance: BaseScrollBar): void;
     removeScrollBar(): void;
@@ -216,32 +212,8 @@ export declare class Viewport {
     setPadding(param: IPosition): void;
     resetPadding(): void;
     /**
-     * There are serval cases to call this method.
-     * the most common case is scrolling. Other situations include:
-     * 1. changing the frozen row & col settings
-     * 2. changing curr skeleton
-     * 3. changing selection which cross viewport
-     * 4. changing the viewport size (also include change window size)
-     * 5. changing the scroll bar position
-     *
-     * when scrolling by trackpad:
-     * scene.input-manager@_onMouseWheel --> scene@triggerMouseWheel --> sheet-render.controller@scene.onMouseWheel$.add -->
-     * set-scroll.command.ts --> scroll.operation.ts -->
-     * scrollManagerService.setScrollInfoAndEmitEvent
-     *
-     * when change skelenton:
-     * _currentSkeletonBefore$ ---> scroll.render-controller@_updateSceneSize --> setSearchParam --> scene@_setTransForm ---> viewport.resetCanvasSizeAndUpdateScrollBar ---> scrollToXX
-     * --> onScrollAfterObserver.notifyObservers --> scroll.render-controller@onScrollAfterObserver ---> setScrollInfoToCurrSheetWithoutNotify  ---> sms._setScrollInfo
-     *
-     * _currentSkeleton$ ---> selection.render-controller ---> formula@_autoScroll ---> viewport.resize ---> get scrollXY by viewportScrollXY ---> scrollTo
-     * _currentSkeleton$ ---> selection.render-controller ---> setCurrentSelection ---> formula@_autoScroll ---> scrollTo
-     * _currentSkeleton$ ---> freeze.render-controller@_refreshFreeze --> viewport.resize ---> scrollTo  ---> _scroll
-     *
-     * Debug
-     * window.scene.getViewports()[0].scrollTo({x: 14.2, y: 1.8}, true)
-     *
-     * @param pos
-     *
+     * ScrollBar scroll to certain position.
+     * @param pos position of scrollBar
      */
     scrollToBarPos(pos: Partial<IScrollBarPosition>): {
         scrollX: number;
@@ -262,6 +234,12 @@ export declare class Viewport {
         isLimitedY: boolean;
     } | undefined;
     scrollByBar(delta: Partial<IScrollBarPosition>, isTrigger?: boolean): void;
+    /**
+     * Viewport scroll to certain position.
+     * @param pos
+     * @param isTrigger
+     * @returns IViewportScrollPosition
+     */
     scrollToViewportPos(pos: Partial<IViewportScrollPosition>, isTrigger?: boolean): {
         viewportScrollX: number;
         viewportScrollY: number;
@@ -303,12 +281,16 @@ export declare class Viewport {
         y: number;
     };
     getScrollBar(): Nullable<BaseScrollBar>;
+    /**
+     * Just record state of scroll. This method won't scroll viewport and scrollbar.
+     * @param current
+     * @returns Viewport
+     */
     updateScrollVal(current: Partial<IScrollObserverParam>): this;
     getScrollBarTransForm(): Transform;
     shouldIntoRender(): boolean;
     /**
-     * call stack: engine.renderLoop ---> scene.render ---> layer.render ---> viewport.render
-     * that means each layer call all viewports to render
+     * Render function in each render loop.
      * @param parentCtx parentCtx is cacheCtx from layer when layer._allowCache is true
      * @param objects
      * @param isMaxLayer
@@ -365,7 +347,7 @@ export declare class Viewport {
      */
     private _resizeCacheCanvas;
     /**
-     * This method will be invoked when viewport is resizing and removing rol & col
+     * Update scroll when viewport is resizing and removing rol & col
      */
     private _updateScrollByViewportScrollValue;
     private _getViewPortSize;