@univerjs/engine-render 0.1.0-alpha.1

package/lib/types/viewport.d.ts

@@ -0,0 +1,193 @@
+import type { EventState, IPosition, Nullable } from '@univerjs/core';
+import { Observable } from '@univerjs/core';
+import type { IWheelEvent } from './basics/i-events';
+import { Transform } from './basics/transform';
+import type { IBoundRect } from './basics/vector2';
+import { Vector2 } from './basics/vector2';
+import type { BaseScrollBar } from './shape/base-scroll-bar';
+import type { ThinScene } from './thin-scene';
+interface IViewPosition {
+    top?: number;
+    left?: number;
+    bottom?: number;
+    right?: number;
+    width?: number;
+    height?: number;
+}
+interface IViewProps extends IViewPosition {
+    attachX?: boolean;
+    attachY?: boolean;
+    isWheelPreventDefaultX?: boolean;
+    isWheelPreventDefaultY?: boolean;
+    active?: boolean;
+}
+export interface IScrollObserverParam {
+    viewport?: Viewport;
+    scrollX?: number;
+    scrollY?: number;
+    x?: number;
+    y?: number;
+    actualScrollX?: number;
+    actualScrollY?: number;
+    limitX?: number;
+    limitY?: number;
+    isTrigger?: boolean;
+}
+interface IScrollBarPosition {
+    x?: number;
+    y?: number;
+}
+export declare class Viewport {
+    /**
+     * The offset of the scrollbar equals the distance from the top to the scrollbar
+     * use getActualScroll, convert to actualScrollX, actualScrollY
+     *
+     */
+    scrollX: number;
+    scrollY: number;
+    /**
+     * 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 getBarScroll, convert to scrollX, scrollY
+     */
+    actualScrollX: number;
+    actualScrollY: number;
+    onMouseWheelObserver: Observable<IWheelEvent>;
+    onScrollAfterObserver: Observable<IScrollObserverParam>;
+    onScrollBeforeObserver: Observable<IScrollObserverParam>;
+    onScrollStopObserver: Observable<IScrollObserverParam>;
+    private _viewPortKey;
+    private _dirty;
+    private _topOrigin;
+    private _leftOrigin;
+    private _bottomOrigin;
+    private _rightOrigin;
+    private _widthOrigin;
+    private _heightOrigin;
+    private _top;
+    private _left;
+    private _bottom;
+    private _right;
+    private _width;
+    private _height;
+    private _scene;
+    private _cacheCanvas;
+    private _scrollBar?;
+    private _isWheelPreventDefaultX;
+    private _isWheelPreventDefaultY;
+    private _allowCache;
+    private _scrollStopNum;
+    private _preScrollX;
+    private _preScrollY;
+    private _renderClipState;
+    private _active;
+    private _paddingStartX;
+    private _paddingEndX;
+    private _paddingStartY;
+    private _paddingEndY;
+    private _isRelativeX;
+    private _isRelativeY;
+    constructor(viewPortKey: string, scene: ThinScene, props?: IViewProps);
+    get scene(): ThinScene;
+    get width(): Nullable<number>;
+    get height(): Nullable<number>;
+    get viewPortKey(): string;
+    get topOrigin(): number;
+    get leftOrigin(): number;
+    get bottomOrigin(): number;
+    get rightOrigin(): number;
+    get top(): number;
+    get left(): number;
+    get bottom(): number;
+    get right(): number;
+    get isWheelPreventDefaultX(): boolean;
+    get isWheelPreventDefaultY(): boolean;
+    set width(w: Nullable<number>);
+    set height(h: Nullable<number>);
+    get isActive(): boolean;
+    private set top(value);
+    private set left(value);
+    private set bottom(value);
+    private set right(value);
+    enable(): void;
+    disable(): void;
+    resetSizeAndScrollBar(): void;
+    setScrollBar(instance: BaseScrollBar): void;
+    removeScrollBar(): void;
+    resize(position: IViewPosition): void;
+    setPadding(param: IPosition): void;
+    resetPadding(): void;
+    makeDirty(state?: boolean, refreshParent?: boolean): void;
+    isDirty(): boolean;
+    /**
+     * scroll to position, absolute
+     * @param pos
+     * @returns
+     */
+    scrollTo(pos: IScrollBarPosition, isTrigger?: boolean): {
+        isLimitedX: boolean;
+        isLimitedY: boolean;
+    } | undefined;
+    /**
+     * current position plus offset, relative
+     * @param pos
+     * @returns
+     */
+    scrollBy(pos: IScrollBarPosition, isTrigger?: boolean): {
+        isLimitedX: boolean;
+        isLimitedY: boolean;
+    } | undefined;
+    /**
+     * 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): {
+        isLimitedX: boolean;
+        isLimitedY: boolean;
+    } | undefined;
+    getBarScroll(actualX: number, actualY: number): {
+        x: number;
+        y: number;
+    };
+    getActualScroll(scrollX: number, scrollY: number): {
+        x: number;
+        y: number;
+    };
+    getTransformedScroll(): {
+        x: number;
+        y: number;
+    };
+    getScrollBar(): Nullable<BaseScrollBar>;
+    updateScroll(param: IScrollObserverParam): this;
+    getScrollBarTransForm(isMouseFix?: boolean): Transform;
+    render(parentCtx?: CanvasRenderingContext2D): void;
+    getBounding(): IBoundRect;
+    getRelativeVector(coord: Vector2): Vector2;
+    getAbsoluteVector(coord: Vector2): Vector2;
+    onMouseWheel(evt: IWheelEvent, state: EventState): void;
+    isHit(coord: Vector2): boolean | undefined;
+    pickScrollBar(coord: Vector2): import("@univerjs/engine-render").Rect<import("@univerjs/engine-render").IRectProps> | null | undefined;
+    openClip(): void;
+    closeClip(): void;
+    dispose(): void;
+    limitedScroll(): {
+        isLimitedX: boolean;
+        isLimitedY: boolean;
+    } | undefined;
+    private _resizeCacheCanvasAndScrollBar;
+    private _getViewPortSize;
+    private _getApplyCanvasState;
+    private _scrollRendered;
+    private _triggerScrollStop;
+    private _scroll;
+    private _calViewportRelativeBounding;
+    private drawScrollbar;
+    private _applyCache;
+    private _setWithAndHeight;
+    private _getBoundScale;
+}
+export {};
+//# sourceMappingURL=viewport.d.ts.map

package/lib/types/viewport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"viewport.d.ts","sourceRoot":"","sources":["../../src/viewport.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AACtE,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAG5C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAGrD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAE9C,UAAU,aAAa;IACnB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,UAAU,UAAW,SAAQ,aAAa;IACtC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,MAAM,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACjC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,UAAU,kBAAkB;IACxB,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,CAAC,CAAC,EAAE,MAAM,CAAC;CACd;AAOD,qBAAa,QAAQ;IACjB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAK;IAEpB,OAAO,EAAE,MAAM,CAAK;IAEpB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAK;IAE1B,aAAa,EAAE,MAAM,CAAK;IAE1B,oBAAoB,0BAAiC;IAErD,qBAAqB,mCAA0C;IAE/D,sBAAsB,mCAA0C;IAEhE,oBAAoB,mCAA0C;IAE9D,OAAO,CAAC,YAAY,CAAc;IAElC,OAAO,CAAC,MAAM,CAAiB;IAE/B,OAAO,CAAC,UAAU,CAAa;IAE/B,OAAO,CAAC,WAAW,CAAa;IAEhC,OAAO,CAAC,aAAa,CAAa;IAElC,OAAO,CAAC,YAAY,CAAa;IAEjC,OAAO,CAAC,YAAY,CAAmB;IAEvC,OAAO,CAAC,aAAa,CAAmB;IAExC,OAAO,CAAC,IAAI,CAAa;IAEzB,OAAO,CAAC,KAAK,CAAa;IAE1B,OAAO,CAAC,OAAO,CAAa;IAE5B,OAAO,CAAC,MAAM,CAAa;IAE3B,OAAO,CAAC,MAAM,CAAmB;IAEjC,OAAO,CAAC,OAAO,CAAmB;IAElC,OAAO,CAAC,MAAM,CAAa;IAE3B,OAAO,CAAC,YAAY,CAAmB;IAEvC,OAAO,CAAC,UAAU,CAAC,CAA0B;IAE7C,OAAO,CAAC,uBAAuB,CAAkB;IAEjD,OAAO,CAAC,uBAAuB,CAAkB;IAEjD,OAAO,CAAC,WAAW,CAAkB;IAErC,OAAO,CAAC,cAAc,CAAa;IAEnC,OAAO,CAAC,WAAW,CAAuB;IAE1C,OAAO,CAAC,WAAW,CAAuB;IAE1C,OAAO,CAAC,gBAAgB,CAAQ;IAEhC,OAAO,CAAC,OAAO,CAAQ;IAEvB,OAAO,CAAC,cAAc,CAAa;IAEnC,OAAO,CAAC,YAAY,CAAa;IAEjC,OAAO,CAAC,cAAc,CAAa;IAEnC,OAAO,CAAC,YAAY,CAAa;IAEjC,OAAO,CAAC,YAAY,CAAkB;IAEtC,OAAO,CAAC,YAAY,CAAkB;gBAE1B,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,CAAC,EAAE,UAAU;IAmCrE,IAAI,KAAK,cAER;IAED,IAAI,KAAK,IAoDI,QAAQ,CAAC,MAAM,CAAC,CAlD5B;IAED,IAAI,MAAM,IAoDI,QAAQ,CAAC,MAAM,CAAC,CAlD7B;IAED,IAAI,WAAW,WAEd;IAED,IAAI,SAAS,WAEZ;IAED,IAAI,UAAU,WAEb;IAED,IAAI,YAAY,WAEf;IAED,IAAI,WAAW,WAEd;IAED,IAAI,GAAG,IAAI,MAAM,CAEhB;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,KAAK,IAAI,MAAM,CAElB;IAED,IAAI,sBAAsB,YAEzB;IAED,IAAI,sBAAsB,YAEzB;IAED,IAAI,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,EAE5B;IAED,IAAI,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,EAE7B;IAED,IAAI,QAAQ,YASX;IAED,OAAO,KAAK,GAAG,QAGd;IAED,OAAO,KAAK,IAAI,QAGf;IAED,OAAO,KAAK,MAAM,QAGjB;IAED,OAAO,KAAK,KAAK,QAGhB;IAED,MAAM;IAIN,OAAO;IAIP,qBAAqB;IAIrB,YAAY,CAAC,QAAQ,EAAE,aAAa;IAQpC,eAAe;IAIf,MAAM,CAAC,QAAQ,EAAE,aAAa;IAkB9B,UAAU,CAAC,KAAK,EAAE,SAAS;IAU3B,YAAY;IASZ,SAAS,CAAC,KAAK,GAAE,OAAc,EAAE,aAAa,UAAQ;IAWtD,OAAO,IAAI,OAAO;IAIlB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,kBAAkB,EAAE,SAAS,UAAO;;;;IAIlD;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,kBAAkB,EAAE,SAAS,UAAO;;;;IAIlD;;;;;;;OAOG;IACH,cAAc,CAAC,OAAO,SAAI,EAAE,OAAO,SAAI,EAAE,SAAS,UAAO;;;;IAUzD,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;;;;IA0B7C,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;;;;IA4BhD,oBAAoB;;;;IAOpB,YAAY;IAIZ,YAAY,CAAC,KAAK,EAAE,oBAAoB;IAsBxC,qBAAqB,CAAC,UAAU,GAAE,OAAe;IASjD,MAAM,CAAC,SAAS,CAAC,EAAE,wBAAwB;IAkE3C,WAAW;IAIX,iBAAiB,CAAC,KAAK,EAAE,OAAO;IAQhC,iBAAiB,CAAC,KAAK,EAAE,OAAO;IAShC,YAAY,CAAC,GAAG,EAAE,WAAW,EAAE,KAAK,EAAE,UAAU;IA2FhD,KAAK,CAAC,KAAK,EAAE,OAAO;IAoBpB,aAAa,CAAC,KAAK,EAAE,OAAO;IAU5B,QAAQ;IAIR,SAAS;IAIT,OAAO;IAWP,aAAa;;;;IAiCb,OAAO,CAAC,8BAA8B;IAYtC,OAAO,CAAC,gBAAgB;IAgExB,OAAO,CAAC,oBAAoB;IAI5B,OAAO,CAAC,eAAe;IAKvB,OAAO,CAAC,kBAAkB;IA0B1B,OAAO,CAAC,OAAO;IAwEf,OAAO,CAAC,4BAA4B;IAiDpC,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,WAAW;IAqBnB,OAAO,CAAC,iBAAiB;IA2BzB,OAAO,CAAC,cAAc;CAMzB"}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@univerjs/engine-render",
+  "version": "0.1.0-alpha.1",
+  "description": "UniverSheet normal base-render",
+  "keywords": [],
+  "author": "DreamNum <developer@univer.ai>",
+  "license": "MIT",
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "types": "./lib/types/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "import": "./lib/esm/index.js",
+      "require": "./lib/cjs/index.js",
+      "types": "./lib/types/index.d.ts"
+    },
+    "./*": {
+      "import": "./lib/esm/*",
+      "require": "./lib/cjs/*",
+      "types": "./lib/types/index.d.ts"
+    }
+  },
+  "directories": {
+    "lib": "lib"
+  },
+  "files": [
+    "lib"
+  ],
+  "private": false,
+  "dependencies": {
+    "@wendellhu/redi": "^0.12.11",
+    "rxjs": "^7.8.1",
+    "@univerjs/core": "0.1.0-alpha.1"
+  },
+  "devDependencies": {
+    "@vitest/coverage-istanbul": "^0.34.6",
+    "esbuild": "^0.19.8",
+    "less": "^4.2.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.3.2",
+    "vitest": "^0.34.6"
+  },
+  "scripts": {
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "coverage": "vitest run --coverage",
+    "esbuild": "node ./esbuild.config.mjs && tsc -p tsconfig.esbuild.json"
+  }
+}