@univerjs/engine-render 0.1.16 → 0.2.0

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

@@ -65,7 +65,6 @@ export declare class Spreadsheet extends SheetComponent {
     /**
      * Since multiple controllers, not just the sheet-render.controller, invoke spreadsheet.makeDirty() — for instance, the cf.render-controller — it's essential to also call viewport.markDirty() whenever spreadsheet.makeDirty() is triggered.
      * @param state
-     * @returns
      */
     makeDirty(state?: boolean): this;
     setDirtyArea(dirtyBounds: IBoundRectNoAngle[]): void;

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

@@ -1,4 +1,4 @@
-import { Nullable, Observable } from '@univerjs/core';
+import { Nullable, EventSubject } from '@univerjs/core';
 import { UniverRenderingContext } from '../../context';
 import { Scene } from '../../scene';
 import { SceneViewer } from '../../scene-viewer';
@@ -8,7 +8,7 @@ export declare enum SLIDE_NAVIGATION_KEY {
     RIGHT = "__slideNavigationRight__"
 }
 export declare class Slide extends SceneViewer {
-    onSlideChangePageByNavigationObservable: Observable<Nullable<string>>;
+    slideChangePageByNavigation$: EventSubject<Nullable<string>>;
     private _navigationEnabled;
     activeFirstPage(): void;
     addPage(scene: Scene): void;

package/lib/types/engine.d.ts

@@ -1,4 +1,3 @@
-import { Observable } from '@univerjs/core';
 import { CURSOR_TYPE } from './basics/const';
 import { Canvas, CanvasRenderMode } from './canvas';
 import { Scene } from './scene';
@@ -6,14 +5,10 @@ import { ThinEngine } from './thin-engine';
 
 export declare class Engine extends ThinEngine<Scene> {
     renderEvenInBackground: boolean;
-    /**
-     * Observable raised when the engine begins a new frame
-     */
-    onBeginFrameObservable: Observable<Engine>;
-    /**
-     * Observable raised when the engine ends the current frame
-     */
-    onEndFrameObservable: Observable<Engine>;
+    private readonly _beginFrame$;
+    readonly beginFrame$: import('rxjs').Observable<void>;
+    private readonly _endFrame$;
+    readonly endFrame$: import('rxjs').Observable<void>;
     private _container;
     private _canvas;
     private _renderingQueueLaunched;
@@ -29,6 +24,8 @@ export declare class Engine extends ThinEngine<Scene> {
     private _pointerMoveEvent;
     private _pointerDownEvent;
     private _pointerUpEvent;
+    private _pointerOutEvent;
+    private _pointerCancelEvent;
     private _pointerBlurEvent;
     private _pointerWheelEvent;
     private _pointerEnterEvent;
@@ -97,7 +94,6 @@ export declare class Engine extends ThinEngine<Scene> {
     _renderFrame(): void;
     private _cancelFrame;
     private _getHostWindow;
-    /** @hidden */
     private _renderLoop;
     private _measureFps;
     private _handleKeyboardAction;

package/lib/types/index.d.ts

@@ -31,7 +31,7 @@ export * from './scroll-timer';
 export * from './shape';
 export * from './viewport';
 export { DocumentViewModel } from './components/docs/view-model/document-view-model';
-export { getAnchorBounding, TEXT_RANGE_LAYER_INDEX, TextRange } from './components/docs/text-selection/text-range';
+export { getAnchorBounding, TEXT_RANGE_LAYER_INDEX, TextRange, getLineBounding } from './components/docs/text-selection/text-range';
 export { NodePositionConvertToCursor } from './components/docs/text-selection/convert-cursor';
 export { Liquid } from './components/docs/liquid';
 export { ITextSelectionRenderManager, TextSelectionRenderManager, getCanvasOffsetByEngine, } from './components/docs/text-selection/text-selection-render-manager';
@@ -43,3 +43,5 @@ export { DocumentSkeleton } from './components/docs/layout/doc-skeleton';
 export { ThinEngine } from './thin-engine';
 export { getCharSpaceApply, getNumberUnitValue } from './components/docs/layout/tools';
 export { type IChangeObserverConfig } from './scene.transformer';
+export { DEFAULT_PADDING_DATA } from './components/sheets/sheet-skeleton';
+export { DocumentEditArea } from './components/docs/view-model/document-view-model';

package/lib/types/layer.d.ts

@@ -20,6 +20,12 @@ export declare class Layer extends Disposable {
     getObjectsByOrder(): BaseObject[];
     getObjectsByOrderForPick(): BaseObject[];
     getObjects(): BaseObject[];
+    /**
+     * insert o to _objects[]
+     * if o is a group, insert all its children and group itself to _objects[]
+     * @param o
+     * @returns
+     */
     addObject(o: BaseObject): this;
     removeObject(object: BaseObject | string): void;
     addObjects(objects: BaseObject[]): this;

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

@@ -10,8 +10,8 @@ import { IRender, IRenderModuleCtor } from './render-unit';
 
 export type RenderComponentType = SheetComponent | DocComponent | Slide | BaseObject;
 export interface IRenderManagerService extends IDisposable {
+    /** @deprecated */
     currentRender$: Observable<Nullable<string>>;
-    createRender$: Observable<Nullable<string>>;
     addRender(unitId: string, renderer: IRender): void;
     createRender(unitId: string): IRender;
     removeRender(unitId: string): void;
@@ -19,14 +19,17 @@ export interface IRenderManagerService extends IDisposable {
     getRenderById(unitId: string): Nullable<IRender>;
     getRenderAll(): Map<string, IRender>;
     defaultEngine: Engine;
-    create(unitId: Nullable<string>): void;
+    /** @deprecated */
+    createRender$: Observable<string>;
+    /** @deprecated this design is very very weird! Remove it. */
+    create(unitId: string): void;
     /** @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;
     withCurrentTypeOfUnit<T>(type: UniverInstanceType, id: DependencyIdentifier<T>): Nullable<T>;
-    registerRenderController<T extends UnitModel>(type: UnitType, ctor: IRenderModuleCtor<T>): IDisposable;
+    registerRenderModule<T extends UnitModel>(type: UnitType, ctor: IRenderModuleCtor<T>): IDisposable;
 }
 export declare class RenderManagerService extends Disposable implements IRenderManagerService {
     private readonly _injector;
@@ -37,14 +40,15 @@ export declare class RenderManagerService extends Disposable implements IRenderM
     private readonly _currentRender$;
     readonly currentRender$: Observable<Nullable<string>>;
     private readonly _createRender$;
-    readonly createRender$: Observable<Nullable<string>>;
+    /** @deprecated */
+    readonly createRender$: Observable<string>;
     get defaultEngine(): Engine;
     private readonly _renderControllers;
     constructor(_injector: Injector, _univerInstanceService: IUniverInstanceService);
     dispose(): void;
-    registerRenderController(type: UnitType, ctor: IRenderModuleCtor): IDisposable;
+    registerRenderModule(type: UnitType, ctor: IRenderModuleCtor): IDisposable;
     private _getRenderControllersForType;
-    create(unitId: Nullable<string>): void;
+    create(unitId: string): void;
     createRender(unitId: string): IRender;
     withCurrentTypeOfUnit<T>(type: UniverInstanceType, id: DependencyIdentifier<T>): Nullable<T>;
     private _createRender;

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

@@ -29,7 +29,7 @@ export interface IRenderContext<T extends UnitModel = UnitModel> extends Omit<IR
  * This class is responsible
  */
 export declare class RenderUnit extends Disposable implements IRender {
-    readonly isRenderUnit: true;
+    readonly isRenderUnit: boolean;
     get unitId(): string;
     get type(): UnitType;
     private readonly _injector;

package/lib/types/scene-viewer.d.ts

@@ -22,7 +22,7 @@ export declare class SceneViewer extends BaseObject {
     enableSelectedClipElement(): void;
     disableSelectedClipElement(): void;
     allowSelectedClipElement(): boolean;
-    pick(coord: Vector2): Nullable<ThinScene | BaseObject>;
+    pick(coord: Vector2): Nullable<BaseObject | ThinScene>;
     dispose(): void;
     private _initialProps;
 }

package/lib/types/scene.d.ts

@@ -62,7 +62,6 @@ export declare class Scene extends ThinScene {
      * scene._setTransForm --> viewport@resetCanvasSizeAndUpdateScrollBar ---> scrollTo ---> limitedScroll ---> onScrollBeforeObserver ---> setScrollInfo
      * scrollInfo needs accurate scene width & height, limitedScroll depends on scene & engine's width & height
      * @param state
-     * @returns
      */
     transformByState(state: ISceneTransformState): void;
     getParent(): ThinEngine<Scene> | SceneViewer;
@@ -71,11 +70,16 @@ export declare class Scene extends ThinScene {
     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
+     * @param o
+     */
     setObjectBehavior(o: BaseObject): void;
-    addObjects(objects: BaseObject[], zIndex?: number): this;
     removeObject(object?: BaseObject | string): this | undefined;
     removeObjects(objects?: BaseObject[] | string[]): this | undefined;
+    getObjectsByLayer(zIndex: number): BaseObject[];
     getAllObjects(): BaseObject[];
     getAllObjectsByOrder(isDesc?: boolean): BaseObject[];
     getAllObjectsByOrderForPick(isDesc?: boolean): BaseObject[];
@@ -120,7 +124,7 @@ export declare class Scene extends ThinScene {
         scaleY: number;
     };
     dispose(): void;
-    pick(coord: Vector2): Nullable<BaseObject | Scene | ThinScene>;
+    pick(vec: Vector2): Nullable<BaseObject | Scene | ThinScene>;
     triggerKeyDown(evt: IKeyboardEvent): void;
     triggerKeyUp(evt: IKeyboardEvent): void;
     triggerPointerUp(evt: IPointerEvent | IMouseEvent): boolean;

package/lib/types/scene.input-manager.d.ts

@@ -14,10 +14,12 @@ export declare class InputManager extends Disposable {
     static ExclusiveDoubleClickMode: boolean;
     /** This is a defensive check to not allow control attachment prior to an already active one. If already attached, previous control is unattached before attaching the new one. */
     private _alreadyAttached;
-    private _onInputObserver;
+    private _onInput$;
     private _onPointerMove;
     private _onPointerDown;
     private _onPointerUp;
+    private _onPointerOut;
+    private _onPointerCancel;
     private _onPointerEnter;
     private _onPointerLeave;
     private _onMouseWheel;
@@ -42,7 +44,7 @@ export declare class InputManager extends Disposable {
     dispose(): void;
     mouseLeaveEnterHandler(evt: IMouseEvent): void;
     dragLeaveEnterHandler(evt: IMouseEvent): void;
-    attachControl(hasDown?: boolean, hasUp?: boolean, hasMove?: boolean, hasWheel?: boolean, hasEnter?: boolean, hasLeave?: boolean): void;
+    attachControl(hasDown?: boolean, hasUp?: boolean, enableMove?: boolean, hasWheel?: boolean, hasEnter?: boolean, hasLeave?: boolean): void;
     /**
      * Detaches all event handlers
      */

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

@@ -1,4 +1,4 @@
-import { Nullable, Disposable, Observable } from '@univerjs/core';
+import { Nullable, Disposable } from '@univerjs/core';
 import { BaseObject } from './base-object';
 import { IMouseEvent, IPointerEvent } from './basics/i-events';
 import { Group } from './group';
@@ -60,22 +60,27 @@ export declare class Transformer extends Disposable implements ITransformerConfi
     boundBoxFunc: Nullable<(oldBox: BaseObject, newBox: BaseObject) => BaseObject>;
     useSingleNodeRotation: boolean;
     shouldOverdrawWholeArea: boolean;
-    onChangeStartObservable: Observable<IChangeObserverConfig>;
-    onChangingObservable: Observable<IChangeObserverConfig>;
-    onChangeEndObservable: Observable<IChangeObserverConfig>;
-    onClearControlObservable: Observable<boolean>;
-    onCreateControlObservable: Observable<Group>;
+    private readonly _changeStart$;
+    readonly changeStart$: import('rxjs').Observable<IChangeObserverConfig>;
+    private readonly _changing$;
+    readonly changing$: import('rxjs').Observable<IChangeObserverConfig>;
+    private readonly _changeEnd$;
+    readonly changeEnd$: import('rxjs').Observable<IChangeObserverConfig>;
+    private readonly _clearControl$;
+    readonly clearControl$: import('rxjs').Observable<boolean>;
+    private readonly _createControl$;
+    readonly createControl$: import('rxjs').Observable<Group>;
     private _startOffsetX;
     private _startOffsetY;
     private _startStateMap;
     private _viewportScrollX;
     private _viewportScrollY;
-    private _moveObserver;
-    private _upObserver;
-    private _cancelFocusObserver;
+    private _topScenePointerMoveSub;
+    private _topScenePointerUpSub;
+    private _cancelFocusSubscription;
     private _transformerControlMap;
     private _selectedObjectMap;
-    private _observerObjectMap;
+    private _subscriptionObjectMap;
     private _copperControl;
     private _copperSelectedObject;
     private _moveBufferSkip;

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

@@ -0,0 +1,8 @@
+import { IViewportInfo } from '../basics/vector2';
+import { UniverRenderingContext } from '../context';
+import { IRectProps, Rect } from './rect';
+
+export declare class DashedRect extends Rect {
+    static drawWith(ctx: UniverRenderingContext, props: IRectProps | Rect): void;
+    protected _draw(ctx: UniverRenderingContext, viewportInfo?: IViewportInfo): void;
+}

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

@@ -24,3 +24,4 @@ export * from './rich-text';
 export * from './scroll-bar';
 export * from './shape';
 export * from './checkbox';
+export * from './dashedrect';

package/lib/types/shape/scroll-bar.d.ts

@@ -11,10 +11,10 @@ export declare class ScrollBar extends BaseScrollBar {
     private _lastY;
     private _isHorizonMove;
     private _isVerticalMove;
-    private _horizonPointerMoveObserver;
-    private _horizonPointerUpObserver;
-    private _verticalPointerMoveObserver;
-    private _verticalPointerUpObserver;
+    private _horizonPointerMoveSub;
+    private _horizonPointerUpSub;
+    private _verticalPointerMoveSub;
+    private _verticalPointerUpSub;
     barSize: number;
     barBorder: number;
     thumbMargin: number;
@@ -27,6 +27,7 @@ export declare class ScrollBar extends BaseScrollBar {
     thumbActiveBackgroundColor: string;
     barBackgroundColor: string;
     barBorderColor: string;
+    private _eventSub;
     constructor(view: Viewport, props?: IScrollBarProps);
     static attachTo(view: Viewport, props?: IScrollBarProps): ScrollBar;
     dispose(): void;

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

@@ -1,4 +1,4 @@
-import { IScale, Nullable } from '@univerjs/core';
+import { IOffset, IScale, ISize, Nullable } from '@univerjs/core';
 import { BaseObject } from '../base-object';
 import { IObjectFullState } from '../basics/interfaces';
 import { IViewportInfo, Vector2 } from '../basics/vector2';
@@ -7,7 +7,7 @@ import { UniverRenderingContext } from '../context';
 export type LineJoin = 'round' | 'bevel' | 'miter';
 export type LineCap = 'butt' | 'round' | 'square';
 export type PaintFirst = 'fill' | 'stroke';
-export interface IShapeProps extends IObjectFullState {
+export interface IShapeProps extends IObjectFullState, ISize, IOffset, IScale {
     hoverCursor?: Nullable<string>;
     moveCursor?: string | null;
     fillRule?: string;

package/lib/types/thin-engine.d.ts

@@ -1,4 +1,4 @@
-import { Disposable, Observable } from '@univerjs/core';
+import { Disposable, EventSubject } from '@univerjs/core';
 import { IDisposable } from '@wendellhu/redi';
 import { CURSOR_TYPE, RENDER_CLASS_TYPE } from './basics/const';
 import { IEvent } from './basics/i-events';
@@ -6,8 +6,8 @@ import { ITransformChangeState } from './basics/interfaces';
 import { Canvas } from './canvas';
 
 export declare abstract class ThinEngine<T extends IDisposable> extends Disposable {
-    onInputChangedObservable: Observable<IEvent>;
-    onTransformChangeObservable: Observable<ITransformChangeState>;
+    onInputChanged$: EventSubject<IEvent>;
+    onTransformChange$: EventSubject<ITransformChangeState>;
     private _scenes;
     private _activeScene;
     get classType(): RENDER_CLASS_TYPE;

package/lib/types/thin-scene.d.ts

@@ -1,29 +1,33 @@
-import { EventState, Nullable, Observer, Disposable, Observable } from '@univerjs/core';
+import { Nullable, Disposable, EventSubject } from '@univerjs/core';
 import { BaseObject } from './base-object';
-import { CURSOR_TYPE, EVENT_TYPE, RENDER_CLASS_TYPE } from './basics/const';
+import { CURSOR_TYPE, RENDER_CLASS_TYPE } from './basics/const';
 import { IDragEvent, IKeyboardEvent, IMouseEvent, IPointerEvent, IWheelEvent } from './basics/i-events';
 import { ITransformChangeState } from './basics/interfaces';
 import { Transform } from './basics/transform';
 import { Vector2 } from './basics/vector2';
 import { UniverRenderingContext } from './context';
+import { ThinEngine } from './thin-engine';
+import { Scene } from './scene';
 
 export declare abstract class ThinScene extends Disposable {
-    onTransformChangeObservable: Observable<ITransformChangeState>;
-    onFileLoadedObservable: Observable<string>;
-    onPointerDownObserver: Observable<IMouseEvent | IPointerEvent>;
-    onPointerMoveObserver: Observable<IMouseEvent | IPointerEvent>;
-    onPointerUpObserver: Observable<IMouseEvent | IPointerEvent>;
-    onPointerEnterObserver: Observable<IMouseEvent | IPointerEvent>;
-    onPointerLeaveObserver: Observable<IMouseEvent | IPointerEvent>;
-    onDragEnterObserver: Observable<IDragEvent>;
-    onDragOverObserver: Observable<IDragEvent>;
-    onDragLeaveObserver: Observable<IDragEvent>;
-    onDropObserver: Observable<IDragEvent>;
-    onDblclickObserver: Observable<IMouseEvent | IPointerEvent>;
-    onTripleClickObserver: Observable<IMouseEvent | IPointerEvent>;
-    onMouseWheelObserver: Observable<IWheelEvent>;
-    onKeyDownObservable: Observable<IKeyboardEvent>;
-    onKeyUpObservable: Observable<IKeyboardEvent>;
+    onTransformChange$: EventSubject<ITransformChangeState>;
+    onFileLoaded$: EventSubject<string>;
+    onPointerDown$: EventSubject<IMouseEvent | IPointerEvent>;
+    onPointerMove$: EventSubject<IMouseEvent | IPointerEvent>;
+    onPointerUp$: EventSubject<IMouseEvent | IPointerEvent>;
+    onPointerEnter$: EventSubject<IMouseEvent | IPointerEvent>;
+    onPointerOut$: EventSubject<IMouseEvent | IPointerEvent>;
+    onPointerCancel$: EventSubject<IMouseEvent | IPointerEvent>;
+    onPointerLeave$: EventSubject<IMouseEvent | IPointerEvent>;
+    onDragEnter$: EventSubject<IDragEvent>;
+    onDragOver$: EventSubject<IDragEvent>;
+    onDragLeave$: EventSubject<IDragEvent>;
+    onDrop$: EventSubject<IDragEvent>;
+    onDblclick$: EventSubject<IMouseEvent | IPointerEvent>;
+    onTripleClick$: EventSubject<IMouseEvent | IPointerEvent>;
+    onMouseWheel$: EventSubject<IWheelEvent>;
+    onKeyDown$: EventSubject<IKeyboardEvent>;
+    onKeyUp$: EventSubject<IKeyboardEvent>;
     debounceParentTimeout: number;
     private _sceneKey;
     private _width;
@@ -48,9 +52,6 @@ export declare abstract class ThinScene extends Disposable {
     set scaleY(scaleY: number);
     enableEvent(): void;
     disableEvent(): void;
-    on(eventType: EVENT_TYPE, func: (evt: unknown, state: EventState) => void): Nullable<Observer<unknown>>;
-    off(eventType: EVENT_TYPE, observer: Nullable<Observer<unknown>>): void;
-    remove(eventType: EVENT_TYPE): void;
     triggerKeyDown(evt: IKeyboardEvent): void;
     triggerKeyUp(evt: IKeyboardEvent): void;
     abstract triggerPointerUp(evt: IPointerEvent | IMouseEvent): void;
@@ -73,7 +74,7 @@ export declare abstract class ThinScene extends Disposable {
     abstract getObject(oKey: string): Nullable<BaseObject>;
     abstract addObject(o: BaseObject, zIndex?: number): void;
     abstract addObjects(objects: BaseObject[], zIndex?: number): void;
-    abstract getEngine(): any;
+    abstract getEngine(): Nullable<ThinEngine<Scene>>;
     abstract setObjectBehavior(o: BaseObject): void;
     attachTransformerTo(o: BaseObject): void;
     detachTransformerFrom(o: BaseObject): void;

package/lib/types/viewport.d.ts

@@ -1,4 +1,4 @@
-import { EventState, IPosition, Nullable, Observable } from '@univerjs/core';
+import { EventState, IPosition, Nullable, EventSubject } from '@univerjs/core';
 import { BaseObject } from './base-object';
 import { IWheelEvent } from './basics/i-events';
 import { Transform } from './basics/transform';
@@ -73,11 +73,11 @@ export declare class Viewport {
      */
     private _physicalSceneWidth;
     private _physicalSceneHeight;
-    onMouseWheelObserver: Observable<IWheelEvent>;
-    onScrollAfterObserver: Observable<IScrollObserverParam>;
-    onScrollBeforeObserver: Observable<IScrollObserverParam>;
-    onScrollStopObserver: Observable<IScrollObserverParam>;
-    onScrollByBarObserver: Observable<IScrollObserverParam>;
+    onMouseWheel$: EventSubject<IWheelEvent>;
+    onScrollAfter$: EventSubject<IScrollObserverParam>;
+    onScrollBefore$: EventSubject<IScrollObserverParam>;
+    onScrollStop$: EventSubject<IScrollObserverParam>;
+    onScrollByBar$: EventSubject<IScrollObserverParam>;
     private _viewportKey;
     /**
      * viewport top origin value in logic, scale does not affect it.
@@ -102,7 +102,7 @@ export declare class Viewport {
     private _isWheelPreventDefaultX;
     private _isWheelPreventDefaultY;
     private _scrollStopNum;
-    private _renderClipState;
+    private _clipViewport;
     private _active;
     private _paddingStartX;
     private _paddingEndX;
@@ -201,9 +201,12 @@ export declare class Viewport {
      * only viewMain would call scrollTo, other views did not call scroll, see scroll.render-controller
      * @param pos
      *
-     * when scrolling:
-     *
+     * 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);
+     *
      *
      * when change skelenton:
      * _currentSkeletonBefore$ ---> scroll.render-controller@_updateSceneSize --> setSearchParam --> scene@_setTransForm ---> viewport.resetCanvasSizeAndUpdateScrollBar ---> scrollTo ---> _scroll
@@ -213,8 +216,13 @@ export declare class Viewport {
      * _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)
      */
@@ -224,6 +232,7 @@ export declare class Viewport {
     } | undefined;
     /**
      * current position plus offset, relative
+     * normally triggered by scroll-timer(in sheet)
      * @param pos
      * @returns isLimited
      */
@@ -231,7 +240,16 @@ export declare class Viewport {
         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
@@ -276,8 +294,19 @@ export declare class Viewport {
     private _makeDefaultViewport;
     private _calcViewportInfo;
     getBounding(): IViewportInfo;
-    getRelativeVector(coord: Vector2): Vector2;
+    /**
+     * convert vector to scene coordinate, include row & col
+     * @param vec
+     * @returns Vector2
+     */
+    transformVector2SceneCoord(vec: Vector2): Vector2;
     getAbsoluteVector(coord: Vector2): Vector2;
+    /**
+     * At f7140a7c11, only doc need this method.
+     * In sheet, wheel event is handled by scroll-manager.service@setScrollInfo
+     * @param evt
+     * @param state
+     */
     onMouseWheel(evt: IWheelEvent, state: EventState): void;
     isHit(coord: Vector2): boolean | undefined;
     pickScrollBar(coord: Vector2): import('./shape').Rect<import('./shape').IRectProps> | null | undefined;
@@ -310,7 +339,7 @@ export declare class Viewport {
     private _triggerScrollStop;
     /**
      * Scroll Viewport
-     * Only the 'viewMain' will enter this function, other viewports will not.
+     * This function called by viewMain only, other viewports will not.
      *
      * caller: scroll.render-controller viewportMain.scrollTo({x, y}))
      * this._scrollManagerService.scrollInfo$.subscribe --> scrollTo --> _scroll
@@ -318,7 +347,7 @@ export declare class Viewport {
      * @param scrollBarPos viewMain 滚动条的位置
      * @param isTrigger
      */
-    private _scrollToScrollbarPos;
+    private _scrollCore;
     expandBounds(value: {
         top: number;
         left: number;
@@ -334,7 +363,7 @@ export declare class Viewport {
     private _getBoundScale;
     /**
      * main canvas element resize
-     * called by this.scene.getEngine()?.onTransformChangeObservable.add
+     * called by this.scene.getEngine()?.onTransformChange$.add
      */
     private _mainCanvasResizeHandler;
 }