@univerjs/engine-render 0.1.14 → 0.1.15

package/lib/types/basics/scroll-xy.d.ts

@@ -14,6 +14,6 @@
  * limitations under the License.
  */
 export declare function getCurrentScrollXY(scrollTimer: any): {
-    scrollX: any;
-    scrollY: any;
+    scrollX: number;
+    scrollY: number;
 };

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

@@ -1,4 +1,4 @@
-import { IRange, IRangeWithCoord, IScale, ISelectionCell, ISelectionCellWithCoord, IStyleBase, LocaleService, Nullable } from '@univerjs/core';
+import { IRange, IRangeWithCoord, IScale, ISelectionCellWithCoord, IStyleBase, LocaleService, Nullable } from '@univerjs/core';
 import { IBoundRectNoAngle } from './vector2';
 import { IDocumentSkeletonFontStyle } from './i-document-skeleton-cached';
 
@@ -73,10 +73,6 @@ export declare function getCellPositionByIndex(row: number, column: number, rowH
     endX: number;
 };
 export declare function getCellByIndex(row: number, column: number, rowHeightAccumulation: number[], columnWidthAccumulation: number[], mergeData: IRange[]): ISelectionCellWithCoord;
-/**
- * Determines whether the cell(row, column) is within the range of the merged cells.
- */
-export declare function getCellInfoInMergeData(row: number, column: number, mergeData?: IRange[]): ISelectionCell;
 /**
  * Determine whether there are any cells in a row that are not in the merged cells, mainly used for the calculation of auto height
  */

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, ISelectionCellWithCoord, ITextRotation, IWorksheetData, Nullable, Styles, Worksheet } from '@univerjs/core';
+import { BooleanNumber, DocumentDataModel, HorizontalAlign, IContextService, LocaleService, ObjectMatrix, VerticalAlign, WrapStrategy, ICellData, IPaddingData, IRange, IRowAutoHeightInfo, ISelectionCellWithCoord, 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';
@@ -13,10 +13,6 @@ export declare function getDocsSkeletonPageSize(documentSkeleton: DocumentSkelet
     width: number;
     height: number;
 } | undefined;
-export interface IRowAutoHeightInfo {
-    row: number;
-    autoHeight?: number;
-}
 interface IRowColumnSegment {
     startRow: number;
     endRow: number;

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

@@ -63,7 +63,9 @@ export declare class Spreadsheet extends SheetComponent {
         endColumn: number;
     } | undefined;
     /**
+     * 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/scene-viewer.d.ts

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

package/lib/types/scene.d.ts

@@ -47,14 +47,23 @@ export declare class Scene extends ThinScene {
     setCursor(val: CURSOR_TYPE): void;
     setDefaultCursor(val: CURSOR_TYPE): void;
     resize(width?: number, height?: number): this;
+    setScaleValue(scaleX: number, scaleY: number): void;
     /**
      * scale to value, absolute
+     * setTransform ---> viewport._updateScrollBarPosByViewportScroll --->  scrollTo
      */
     scale(scaleX?: number, scaleY?: number): this;
     /**
      * current scale plus offset, relative
      */
     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
+     * @param state
+     * @returns
+     */
     transformByState(state: ISceneTransformState): void;
     getParent(): ThinEngine<Scene> | SceneViewer;
     getEngine(): Nullable<ThinEngine<Scene>>;

package/lib/types/viewport.d.ts

@@ -39,8 +39,8 @@ export interface IScrollObserverParam {
     /**
      * scrollX for viewport
      */
-    actualScrollX?: number;
-    actualScrollY?: number;
+    viewportScrollX?: number;
+    viewportScrollY?: number;
     limitX?: number;
     limitY?: number;
     isTrigger?: boolean;
@@ -56,18 +56,23 @@ export declare class Viewport {
      */
     scrollX: number;
     scrollY: number;
-    _preScrollX: number;
-    _preScrollY: number;
+    private _preScrollX;
+    private _preScrollY;
     /**
-     * The actual scroll offset equals the distance from the content area position to the top, and there is a conversion relationship with scrollX and scrollY
-     * use getActualScroll to get scrolling value for spreadsheet.
+     * The viewport scroll offset equals the distance from the content area position to the top, and there is a conversion relationship with scrollX and scrollY
+     * use transScroll2ViewportScrollValue to get scrolling value for spreadsheet.
      */
-    viewportScrollX: number;
-    viewportScrollY: number;
-    preViewportScrollX: number;
-    preViewportScrollY: number;
-    _deltaViewportScrollX: number;
-    _deltaViewportScrollY: number;
+    private _viewportScrollX;
+    private _viewportScrollY;
+    private _preViewportScrollX;
+    private _preViewportScrollY;
+    private _deltaViewportScrollX;
+    private _deltaViewportScrollY;
+    /**
+     * physcal scene size (scene width * scale)
+     */
+    private _physicalSceneWidth;
+    private _physicalSceneHeight;
     onMouseWheelObserver: Observable<IWheelEvent>;
     onScrollAfterObserver: Observable<IScrollObserverParam>;
     onScrollBeforeObserver: Observable<IScrollObserverParam>;
@@ -155,6 +160,10 @@ export declare class Viewport {
     set width(w: Nullable<number>);
     set height(h: Nullable<number>);
     get isActive(): boolean;
+    set viewportScrollX(val: number);
+    get viewportScrollX(): number;
+    set viewportScrollY(val: number);
+    get viewportScrollY(): number;
     private set top(value);
     private set left(value);
     private set bottom(value);
@@ -167,43 +176,56 @@ export declare class Viewport {
     enable(): void;
     disable(): void;
     /**
-     * 物理 canvas 大小改变时调用(调整 window 大小时触发)
+     * invoked when canvas element size change
+     * engineResizeObserver --> engine.resizeBySize --> scene._setTransForm
      */
-    resetSizeAndScrollBar(): void;
+    resetCanvasSizeAndUpdateScrollBar(): void;
     setScrollBar(instance: BaseScrollBar): void;
     removeScrollBar(): void;
     /**
-     * 和 resetSizeAndScrollBar 不同
-     * 此方法是调整冻结行列设置时 & 初始化时触发, resize window 时并不会触发
+     * NOT same as resetCanvasSizeAndScrollbar
+     * This method is triggered when adjusting the frozen row & col settings, and during initialization,
+     * it is not triggered when resizing the window.
      *
-     * 注意参数 position 不一定有 height & width  对于 viewMain 只有 left top bottom right
-     * this.width this.height 也有可能是 undefined
-     * 因此应通过 _getViewPortSize 获取宽高
+     * Note that the 'position' parameter may not always have 'height' and 'width' properties. For the 'viewMain' element, it only has 'left', 'top', 'bottom', and 'right' properties.
+     * Additionally, 'this.width' and 'this.height' may also be 'undefined'.
+     * Therefore, you should use the '_getViewPortSize' method to retrieve the width and height.
      * @param position
      */
-    resize(position: IViewPosition): void;
+    resizeWhenFreezeChange(position: IViewPosition): void;
     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
+     *
+     * when scrolling:
      *
-     * 改动 scrollbar 的位置，不是 viewport content 滚动
-     * scroll to position, absolute
-     * 只有 viewMain 才会被调用 scrollTo 其他 viewport 都不会调用此方法
-     * 具体在 scroll.controller 中
+     * scroll.render-controller@_scrollManagerService.scrollInfo$.subscribe --> scrollTo
+     *
+     * when change skelenton:
+     * _currentSkeletonBefore$ ---> scroll.render-controller@_updateSceneSize --> setSearchParam --> scene@_setTransForm ---> viewport.resetCanvasSizeAndUpdateScrollBar ---> scrollTo ---> _scroll
+     * --> 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$
      *
      * Debug
      * window.scene.getViewports()[0].scrollTo({x: 14.2, y: 1.8}, true)
-     * @param pos
-     * @returns
      */
-    scrollTo(pos: IScrollBarPosition, isTrigger?: boolean): {
+    scrollTo(pos: IScrollBarPosition): {
         isLimitedX: boolean;
         isLimitedY: boolean;
     } | undefined;
     /**
      * current position plus offset, relative
      * @param pos
-     * @returns
+     * @returns isLimited
      */
     scrollBy(pos: IScrollBarPosition, isTrigger?: boolean): {
         isLimitedX: boolean;
@@ -222,11 +244,11 @@ export declare class Viewport {
         isLimitedX: boolean;
         isLimitedY: boolean;
     } | undefined;
-    getBarScroll(actualX: number, actualY: number): {
+    transViewportScroll2ScrollValue(viewportScrollX: number, viewportScrollY: number): {
         x: number;
         y: number;
     };
-    getActualScroll(scrollX: number, scrollY: number): {
+    transScroll2ViewportScrollValue(scrollX: number, scrollY: number): {
         x: number;
         y: number;
     };
@@ -234,12 +256,12 @@ export declare class Viewport {
      * get actual scroll value by scrollXY
      * @returns
      */
-    getTransformedScroll(): {
+    getViewportScrollByScroll(): {
         x: number;
         y: number;
     };
     getScrollBar(): Nullable<BaseScrollBar>;
-    updateScroll(param: IScrollObserverParam): this;
+    updateScroll(current: IScrollObserverParam): this;
     getScrollBarTransForm(): Transform;
     shouldIntoRender(): boolean;
     /**
@@ -272,20 +294,31 @@ export declare class Viewport {
     markForceDirty(state?: boolean): void;
     resetPrevCacheBounds(): void;
     get isForceDirty(): boolean;
+    /**
+     * resize canvas & use viewportScrollXY to scrollTo
+     */
     private _resizeCacheCanvas;
+    /**
+     * This method will be invoked whenever the viewport is resized.
+     */
+    private _updateScrollBarPosByViewportScroll;
     private _getViewPortSize;
-    private _scrollRendered;
+    /**
+     * update pre scroll value has handled in updateScroll()
+     */
+    private _afterRender;
     private _triggerScrollStop;
     /**
      * Scroll Viewport
      * Only the 'viewMain' will enter this function, other viewports will not.
      *
-     * caller: scroll.controller viewportMain.proscrollTo(config)
+     * caller: scroll.render-controller viewportMain.scrollTo({x, y}))
+     * this._scrollManagerService.scrollInfo$.subscribe --> scrollTo --> _scroll
      * @param scrollType
-     * @param pos viewMain 滚动条的位置
+     * @param scrollBarPos viewMain 滚动条的位置
      * @param isTrigger
      */
-    private _scroll;
+    private _scrollToScrollbarPos;
     expandBounds(value: {
         top: number;
         left: number;
@@ -297,7 +330,7 @@ export declare class Viewport {
     private _diffViewBound;
     private _calcDiffCacheBound;
     private _drawScrollbar;
-    private _setWithAndHeight;
+    private _setViewportWidthAndHeight;
     private _getBoundScale;
     /**
      * main canvas element resize