@univerjs/engine-render 0.2.4-alpha.0 → 0.2.5

package/lib/types/basics/i-document-skeleton-cached.d.ts

@@ -12,13 +12,18 @@ export interface ISkeletonResourceReference {
     skeHeaders: Map<string, Map<number, IDocumentSkeletonHeaderFooter>>;
     skeFooters: Map<string, Map<number, IDocumentSkeletonHeaderFooter>>;
     skeListLevel?: Map<string, IDocumentSkeletonBullet[]>;
-    drawingAnchor?: Map<number, IDocumentSkeletonDrawingAnchor>;
+    drawingAnchor?: Map<string, Map<number, IDocumentSkeletonDrawingAnchor>>;
 }
 export interface IDocumentSkeletonDrawingAnchor {
     elements: IDocumentSkeletonLine[];
     paragraphIndex: number;
     top: number;
 }
+export declare enum DocumentSkeletonPageType {
+    BODY = 0,
+    HEADER = 1,
+    FOOTER = 2
+}
 export interface IDocumentSkeletonPage {
     sections: IDocumentSkeletonSection[];
     headerId: string;
@@ -42,6 +47,8 @@ export interface IDocumentSkeletonPage {
     st: number;
     ed: number;
     skeDrawings: Map<string, IDocumentSkeletonDrawing>;
+    segmentId: string;
+    type: DocumentSkeletonPageType;
     renderConfig?: IDocumentRenderConfig;
     parent?: IDocumentSkeletonCached;
 }

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

@@ -1,6 +1,6 @@
 import { BooleanNumber, GridType, IDocStyleBase, IDocumentLayout, IOffset, IParagraphStyle, IReferenceSource, IScale, ISectionBreakBase, ISize, ITextStyle, ITransformState, LocaleService } from '@univerjs/core';
 import { DocumentViewModel } from '../components/docs/view-model/document-view-model';
-import { IDocumentSkeletonBullet, IDocumentSkeletonDrawing, IDocumentSkeletonDrawingAnchor, IDocumentSkeletonFontStyle, IDocumentSkeletonGlyph, IDocumentSkeletonHeaderFooter } from './i-document-skeleton-cached';
+import { DocumentSkeletonPageType, IDocumentSkeletonBullet, IDocumentSkeletonDrawing, IDocumentSkeletonDrawingAnchor, IDocumentSkeletonFontStyle, IDocumentSkeletonGlyph, IDocumentSkeletonHeaderFooter } from './i-document-skeleton-cached';
 import { Vector2 } from './vector2';
 import { ITransformerConfig } from './transformer-config';
 
@@ -64,7 +64,7 @@ export interface IParagraphConfig {
     paragraphStyle?: IParagraphStyle;
     skeHeaders: Map<string, Map<number, IDocumentSkeletonHeaderFooter>>;
     skeFooters: Map<string, Map<number, IDocumentSkeletonHeaderFooter>>;
-    drawingAnchor?: Map<number, IDocumentSkeletonDrawingAnchor>;
+    pDrawingAnchor?: Map<number, IDocumentSkeletonDrawingAnchor>;
 }
 export interface IFontCreateConfig {
     fontStyle: IDocumentSkeletonFontStyle;
@@ -89,7 +89,7 @@ export interface INodeSearch {
     section: number;
     page: number;
     segmentPage: number;
-    isInBody: boolean;
+    pageType: DocumentSkeletonPageType;
 }
 export interface INodePosition extends INodeSearch {
     isBack: boolean;

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

@@ -11,6 +11,11 @@ export declare enum DocumentSkeletonState {
     READY = "ready",
     INVALID = "invalid"
 }
+export interface IFindNodeRestrictions {
+    strict: boolean;
+    segmentId: string;
+    segmentPage: number;
+}
 export declare class DocumentSkeleton extends Skeleton {
     private _docViewModel;
     private _skeletonData;
@@ -39,7 +44,8 @@ export declare class DocumentSkeleton extends Skeleton {
         pageNumber: number;
         page: Nullable<IDocumentSkeletonPage>;
     };
-    findNodeByCoord(coord: Vector2, pageLayoutType: PageLayoutType, pageMarginLeft: number, pageMarginTop: number): Nullable<INodeInfo>;
+    findNodeByCoord(coord: Vector2, pageLayoutType: PageLayoutType, pageMarginLeft: number, pageMarginTop: number, restrictions?: IFindNodeRestrictions): Nullable<INodeInfo>;
+    private _collectNearestNode;
     private _getNearestNode;
     private _getPageBoundingBox;
     private _translatePage;

package/lib/types/components/docs/layout/line-breaker/line-breaker.d.ts

@@ -14,6 +14,7 @@ export declare class LineBreaker implements IBreakPoints {
     private _lastPos;
     private _curClass;
     private _codePoint;
+    private _lastCodePoint;
     private _nextClass;
     private _LB8a;
     private _LB21a;

package/lib/types/components/docs/layout/line-breaker/rule.d.ts

@@ -1,23 +1,10 @@
-/**
- * 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 { Nullable } from '@univerjs/core';
+
 export interface ILineBreakRule {
-    (codePoint: number, className: number): boolean;
+    (codePoint: number, lastCodePoint: Nullable<number>, className: number): boolean;
 }
 export declare class Rule {
     private _rules;
     add(key: string, rule: ILineBreakRule): void;
-    shouldBreak(codePoint: number, className: number): boolean;
+    shouldBreak(codePoint: number, lastCodePoint: Nullable<number>, className: number): boolean;
 }

package/lib/types/components/docs/layout/model/line.d.ts

@@ -1,4 +1,5 @@
-import { IDocumentSkeletonDivide, IDocumentSkeletonDrawing, IDocumentSkeletonDrawingAnchor, IDocumentSkeletonLine, LineType } from '../../../../basics/i-document-skeleton-cached';
+import { Nullable } from '@univerjs/core';
+import { IDocumentSkeletonDivide, IDocumentSkeletonDrawing, IDocumentSkeletonDrawingAnchor, IDocumentSkeletonLine, IDocumentSkeletonPage, LineType } from '../../../../basics/i-document-skeleton-cached';
 
 interface ILineBoundingBox {
     lineHeight: number;
@@ -11,8 +12,8 @@ interface ILineBoundingBox {
     marginTop?: number;
     spaceBelowApply?: number;
 }
-export declare function createSkeletonLine(paragraphIndex: number, lineType: LineType, lineBoundingBox: ILineBoundingBox, columnWidth: number, lineIndex?: number, isParagraphStart?: boolean, pageSkeDrawings?: Map<string, IDocumentSkeletonDrawing>, headersDrawings?: Map<string, IDocumentSkeletonDrawing>, footersDrawings?: Map<string, IDocumentSkeletonDrawing>): IDocumentSkeletonLine;
-export declare function calculateLineTopByDrawings(lineHeight?: number, lineTop?: number, pageSkeDrawings?: Map<string, IDocumentSkeletonDrawing>, headersDrawings?: Map<string, IDocumentSkeletonDrawing>, footersDrawings?: Map<string, IDocumentSkeletonDrawing>): number;
+export declare function createSkeletonLine(paragraphIndex: number, lineType: LineType, lineBoundingBox: ILineBoundingBox, columnWidth: number, lineIndex: number | undefined, isParagraphStart: boolean | undefined, page: IDocumentSkeletonPage, headerPage: Nullable<IDocumentSkeletonPage>, footerPage: Nullable<IDocumentSkeletonPage>): IDocumentSkeletonLine;
+export declare function calculateLineTopByDrawings(lineHeight: number | undefined, lineTop: number | undefined, page: IDocumentSkeletonPage, headerPage: Nullable<IDocumentSkeletonPage>, footerPage: Nullable<IDocumentSkeletonPage>): number;
 export declare function updateDivideInfo(divide: IDocumentSkeletonDivide, states: Partial<IDocumentSkeletonDivide>): void;
 export declare function setLineMarginBottom(line: IDocumentSkeletonLine, marginBottom: number): void;
 export declare function collisionDetection(drawing: IDocumentSkeletonDrawing, lineHeight: number, lineTop: number, columnLeft: number, columnWidth: number): boolean;

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

@@ -81,9 +81,7 @@ export interface ILayoutContext {
     dataModel: DocumentDataModel;
     docsConfig: IDocsConfig;
     skeleton: IDocumentSkeletonCached;
-    layoutStartPointer: {
-        paragraphIndex: Nullable<number>;
-    };
+    layoutStartPointer: Record<string, Nullable<number>>;
     isDirty: boolean;
     skeletonResourceReference: ISkeletonResourceReference;
     drawingsCache: Map<string, {
@@ -91,7 +89,7 @@ export interface ILayoutContext {
         page: IDocumentSkeletonPage;
         drawing: IDocumentSkeletonDrawing;
     }>;
-    paragraphConfigCache: Map<number, IParagraphConfig>;
+    paragraphConfigCache: Map<string, Map<number, IParagraphConfig>>;
     sectionBreakConfigCache: Map<number, ISectionBreakConfig>;
     paragraphsOpenNewPage: Set<number>;
     hyphen: Hyphen;
@@ -102,4 +100,5 @@ export declare const DEFAULT_PAGE_SIZE: {
     height: number;
 };
 export declare function prepareSectionBreakConfig(ctx: ILayoutContext, nodeIndex: number): ISectionBreakConfig;
+export declare function resetContext(ctx: ILayoutContext): void;
 export {};

package/lib/types/components/docs/text-selection/convert-cursor.d.ts

@@ -51,6 +51,7 @@ export declare class NodePositionConvertToCursor {
         contentBoxPointGroup: IPoint[][];
         cursorList: ITextRange[];
     };
+    private _isValidPosition;
     private _resetCurrentNodePositionState;
     private _setNodePositionState;
     private _checkPreviousNodePositionState;

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

@@ -53,6 +53,7 @@ export interface ITextSelectionRenderManager {
     enableSelection(): void;
     disableSelection(): void;
     setSegment(id: string): void;
+    getSegment(): string;
     setSegmentPage(pageIndex: number): void;
     getSegmentPage(): number;
     setStyle(style: ITextSelectionStyle): void;
@@ -67,6 +68,8 @@ export interface ITextSelectionRenderManager {
     hasFocus(): boolean;
     focus(): void;
     blur(): void;
+    focusEditor(): void;
+    blurEditor(): void;
     changeRuntime(docSkeleton: DocumentSkeleton, scene: Scene, document: Documents): void;
     dispose(): void;
     handleDblClick(evt: IPointerEvent | IMouseEvent): void;
@@ -125,6 +128,7 @@ export declare class TextSelectionRenderManager extends RxDisposable implements
     private _document;
     private _scenePointerMoveSubs;
     private _scenePointerUpSubs;
+    private _editorFocusing;
     constructor(_logService: ILogService);
     __getEditorContainer(): HTMLElement;
     getViewPort(): Viewport;
@@ -145,6 +149,8 @@ export declare class TextSelectionRenderManager extends RxDisposable implements
     hasFocus(): boolean;
     focus(): void;
     blur(): void;
+    focusEditor(): void;
+    blurEditor(): void;
     deactivate(): void;
     changeRuntime(docSkeleton: DocumentSkeleton, scene: Scene, document: Documents): void;
     handleDblClick(evt: IPointerEvent | IMouseEvent): void;
@@ -175,6 +181,7 @@ export declare class TextSelectionRenderManager extends RxDisposable implements
     private _eventHandle;
     private _getTransformCoordForDocumentOffset;
     private _findNodeByCoord;
+    private _getNodeIndex;
     private _detachEvent;
     private _activeSelectionRefresh;
 }

package/lib/types/scene.d.ts

@@ -85,7 +85,7 @@ export declare class Scene extends ThinScene {
     getAllObjectsByOrderForPick(isDesc?: boolean): BaseObject[];
     getObject(oKey: string): BaseObject | undefined;
     getObjectIncludeInGroup(oKey: string): BaseObject | undefined;
-    fuzzyMathObjects(oKey: string): BaseObject[];
+    fuzzyMathObjects(oKey: string, matchStart?: boolean): BaseObject[];
     addViewport(...viewport: Viewport[]): this;
     removeViewport(key: string): Viewport | undefined;
     getViewports(): Viewport[];

package/lib/types/scroll-timer.d.ts

@@ -12,8 +12,6 @@ export declare class ScrollTimer {
     private _scene;
     private _scrollTimerType;
     private _padding?;
-    private _smoothRatioX;
-    private _smoothRatioY;
     private _requestNewFrameNumber;
     private _viewport;
     private _offsetX;
@@ -23,7 +21,7 @@ export declare class ScrollTimer {
     private _scrollX;
     private _scrollY;
     private _scrollFunction;
-    constructor(_scene: Scene, _scrollTimerType?: ScrollTimerType, _padding?: IPaddingData | undefined, _smoothRatioX?: number, _smoothRatioY?: number);
+    constructor(_scene: Scene, _scrollTimerType?: ScrollTimerType, _padding?: IPaddingData | undefined);
     static create(scene: any, scrollTimerType?: ScrollTimerType, padding?: IPaddingData): ScrollTimer;
     set scrollTimerType(type: ScrollTimerType);
     get scrollTimerType(): ScrollTimerType;

package/lib/types/viewport.d.ts

@@ -32,22 +32,30 @@ export interface IScrollObserverParam {
     /**
      * scrollX for scrollbar
      */
-    scrollX?: number;
-    scrollY?: number;
-    x?: number;
-    y?: number;
+    scrollX: number;
+    scrollY: number;
+    /**
+     * scrollXY before limit function
+     * why need this value?
+     */
+    rawScrollX?: number;
+    rawScrollY?: number;
     /**
      * scrollX for viewport
      */
-    viewportScrollX?: number;
-    viewportScrollY?: number;
+    viewportScrollX: number;
+    viewportScrollY: number;
     limitX?: number;
     limitY?: number;
     isTrigger?: boolean;
 }
 interface IScrollBarPosition {
-    x?: number;
-    y?: number;
+    x: number;
+    y: number;
+}
+interface IViewportScrollPosition {
+    viewportScrollX: number;
+    viewportScrollY: number;
 }
 export declare class Viewport {
     /**
@@ -69,14 +77,21 @@ export declare class Viewport {
     private _deltaViewportScrollX;
     private _deltaViewportScrollY;
     /**
-     * physcal scene size (scene width * scale)
+     * scene size in current viewport port with scale
+     * scene size relative to row col settings.
+     * if AB col has set to be freeze, then scene size in viewMain will be smaller compared to no freeze state.
+     */
+    private _sceneWCurrVpAfterScale;
+    private _sceneHCurrVpAfterScale;
+    /**
+     * scene size with scale
      */
-    private _physicalSceneWidth;
-    private _physicalSceneHeight;
+    private _sceneWidthAfterScale;
+    private _sceneHeightAfterScale;
     onMouseWheel$: EventSubject<IWheelEvent>;
     onScrollAfter$: EventSubject<IScrollObserverParam>;
     onScrollBefore$: EventSubject<IScrollObserverParam>;
-    onScrollStop$: EventSubject<IScrollObserverParam>;
+    onScrollEnd$: EventSubject<IScrollObserverParam>;
     onScrollByBar$: EventSubject<IScrollObserverParam>;
     private _viewportKey;
     /**
@@ -105,7 +120,13 @@ export declare class Viewport {
     private _clipViewport;
     private _active;
     private _paddingStartX;
+    /**
+     * after create a freeze column, there is a "padding distace" from row header to curr viewport.
+     */
     private _paddingEndX;
+    /**
+     * after create a freeze row, there is a "padding distace" from column header to curr viewport.
+     */
     private _paddingStartY;
     private _paddingEndY;
     private _isRelativeX;
@@ -179,7 +200,7 @@ export declare class Viewport {
      * invoked when canvas element size change
      * engineResizeObserver --> engine.resizeBySize --> scene._setTransForm
      */
-    resetCanvasSizeAndUpdateScrollBar(): void;
+    resetCanvasSizeAndUpdateScroll(): void;
     setScrollBar(instance: BaseScrollBar): void;
     removeScrollBar(): void;
     /**
@@ -196,69 +217,74 @@ export declare class Viewport {
     setPadding(param: IPosition): void;
     resetPadding(): void;
     /**
-     * set scrollXY and viewportScrollXY, and update scrollInfo without notify listeners of scrollInfo$
-     * mainly call by scroll.render-controller and viewport.resize ...
-     * only viewMain would call scrollTo, other views did not call scroll, see scroll.render-controller
-     * @param pos
+     * 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.onMouseWheelObserver.add --> scrollManagerService.setScrollInfo -->
-     * scroll.render-controller@_scrollManagerService.scrollInfo$.subscribe --> scrollTo
-     * scroll-manager.service@_scrollInfo$.next -->scroll.render-controller@_scrollManagerService.scrollInfo$.subscribe -->
-     * viewportMain.scrollTo(config);
-     *
+     * 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 ---> scrollTo ---> _scroll
+     * _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
      *
-     *
-     *
-     * TODO: @lumix many side effects in scrollTo, it would update scrollXY & viewportScrollXY, and notify listeners of scrollInfo$
-     *
-     * TODO: @lumix Other controller should call scrollManagerService to set scrollInfo$
-     * example in scroll.operation.ts
-     *
      * Debug
      * window.scene.getViewports()[0].scrollTo({x: 14.2, y: 1.8}, true)
+     *
+     * @param pos
+     *
      */
-    scrollTo(pos: IScrollBarPosition): {
+    scrollToBarPos(pos: Partial<IScrollBarPosition>): {
+        scrollX: number;
+        scrollY: number;
         isLimitedX: boolean;
         isLimitedY: boolean;
     } | undefined;
     /**
-     * current position plus offset, relative
-     * normally triggered by scroll-timer(in sheet)
-     * @param pos
+     * scrolling by current position plus offset
+     * the most common case is triggered by scroll-timer(in sheet)
+     * @param delta
      * @returns isLimited
      */
-    scrollBy(pos: IScrollBarPosition, isTrigger?: boolean): {
+    scrollByBarDeltaValue(delta: Partial<IScrollBarPosition>, isTrigger?: boolean): {
+        scrollX: number;
+        scrollY: number;
+        isLimitedX: boolean;
+        isLimitedY: boolean;
+    } | undefined;
+    scrollByBar(delta: Partial<IScrollBarPosition>, isTrigger?: boolean): void;
+    scrollToViewportPos(pos: Partial<IViewportScrollPosition>, isTrigger?: boolean): {
+        viewportScrollX: number;
+        viewportScrollY: number;
+        isLimitedX: boolean;
+        isLimitedY: boolean;
+    } | undefined;
+    scrollByViewportDeltaVal(delta: IViewportScrollPosition, isTrigger?: boolean): {
+        viewportScrollX: number;
+        viewportScrollY: number;
         isLimitedX: boolean;
         isLimitedY: boolean;
     } | undefined;
-    /**
-     *
-     * @param pos
-     * @param isTrigger
-     */
-    scrollByBar(pos: IScrollBarPosition, isTrigger?: boolean): void;
-    scrollByViewportScroll({ deltaX, deltaY }: {
-        deltaX?: number | undefined;
-        deltaY?: number | undefined;
-    }): void;
     /**
      * current position plus offset relatively
      * the caller no need to deal with the padding when frozen
      * @param offsetX
      * @param offsetY
      * @param isTrigger
-     * @returns
      */
     scrollByOffset(offsetX?: number, offsetY?: number, isTrigger?: boolean): {
+        scrollX: number;
+        scrollY: number;
         isLimitedX: boolean;
         isLimitedY: boolean;
     } | undefined;
@@ -272,23 +298,21 @@ export declare class Viewport {
     };
     /**
      * get actual scroll value by scrollXY
-     * @returns
      */
-    getViewportScrollByScroll(): {
+    getViewportScrollByScrollXY(): {
         x: number;
         y: number;
     };
     getScrollBar(): Nullable<BaseScrollBar>;
-    updateScroll(current: IScrollObserverParam): this;
+    updateScrollVal(current: Partial<IScrollObserverParam>): this;
     getScrollBarTransForm(): Transform;
     shouldIntoRender(): boolean;
     /**
-     * engine.renderLoop ---> scene.render ---> layer.render ---> viewport.render
+     * call stack: engine.renderLoop ---> scene.render ---> layer.render ---> viewport.render
      * that means each layer call all viewports to render
-     * @param parentCtx 如果 layer._allowCache true, 那么 parentCtx 是 layer 中的 cacheCtx
+     * @param parentCtx parentCtx is cacheCtx from layer when layer._allowCache is true
      * @param objects
      * @param isMaxLayer
-     * @param isLast last viewport would
      */
     render(parentCtx?: UniverRenderingContext, objects?: BaseObject[], isMaxLayer?: boolean): void;
     private _makeDefaultViewport;
@@ -313,10 +337,24 @@ export declare class Viewport {
     openClip(): void;
     closeClip(): void;
     dispose(): void;
-    limitedScroll(): {
+    limitedScroll(scrollX: Nullable<number>, scrollY: Nullable<number>): {
+        scrollX: number;
+        scrollY: number;
         isLimitedX: boolean;
         isLimitedY: boolean;
-    } | undefined;
+    };
+    /**
+     * Still in working progress, do not use it now.
+     * @param viewportScrollX
+     * @param viewportScrollY
+     * @returns
+     */
+    _limitViewportScroll(viewportScrollX: number, viewportScrollY: number): {
+        viewportScrollX: number;
+        viewportScrollY: number;
+        isLimitedX: boolean;
+        isLimitedY: boolean;
+    };
     markDirty(state?: boolean): void;
     get isDirty(): boolean;
     private _isForceDirty;
@@ -328,26 +366,29 @@ export declare class Viewport {
      */
     private _resizeCacheCanvas;
     /**
-     * This method will be invoked whenever the viewport is resized.
+     * This method will be invoked when viewport is resizing and removing rol & col
      */
-    private _updateScrollBarPosByViewportScroll;
+    private _updateScrollByViewportScrollValue;
     private _getViewPortSize;
     /**
      * update pre scroll value has handled in updateScroll()
      */
     private _afterRender;
-    private _triggerScrollStop;
+    private _emitScrollEnd$;
+    /**
+     *
+     * When scroll just in X direction, there is no y definition in scrollXY. So scrollXY is Partial<IScrollBarPosition>
+     * @param rawScrollXY Partial<IViewportScrollPosition>
+     * @param isTrigger
+     */
+    private _scrollToBarPosCore;
     /**
-     * Scroll Viewport
-     * This function called by viewMain only, other viewports will not.
      *
-     * caller: scroll.render-controller viewportMain.scrollTo({x, y}))
-     * this._scrollManagerService.scrollInfo$.subscribe --> scrollTo --> _scroll
-     * @param scrollType
-     * @param scrollBarPos viewMain 滚动条的位置
+     * When scroll just in X direction, there is no y definition in scrollVpPos. So scrollVpPos is Partial<IViewportScrollPosition>
+     * @param scrollVpPos Partial<IViewportScrollPosition>
      * @param isTrigger
      */
-    private _scrollCore;
+    private _scrollToViewportPosCore;
     expandBounds(value: {
         top: number;
         left: number;