@univerjs/engine-render 0.1.0-beta.4 → 0.1.0-beta.5

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

@@ -59,7 +59,7 @@ export interface IDocumentSkeletonPage {
     marginBottom: number;
     pageNumber: number;
     pageNumberStart: number;
-    verticalAlign: Boolean;
+    verticalAlign: boolean;
     angle: number;
     width: number;
     height: number;

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

@@ -28,3 +28,4 @@ export * from './scroll-xy';
 export * from './tools';
 export * from './transform';
 export * from './vector2';
+export * from './text-rotation';

package/lib/types/basics/text-rotation.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 { type ITextRotation } from '@univerjs/core';
+export declare const VERTICAL_ROTATE_ANGLE = 90;
+export declare function convertTextRotation(textRotation: ITextRotation): {
+    centerAngle: number;
+    vertexAngle: number;
+};

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

@@ -37,16 +37,16 @@ export declare class Transform {
      * Transform point
      * @method
      * @name UniverSheet.Transform#point
-     * @param {Object} point 2D point(x, y)
-     * @returns {Object} 2D point(x, y)
+     * @param {object} point 2D point(x, y)
+     * @returns {object} 2D point(x, y)
      */
     applyPoint(point: Vector2, ignoreOffset?: boolean): Vector2;
     /**
      * Apply translation
      * @method
      * @name universheet.Transform#translate
-     * @param {Number} x
-     * @param {Number} y
+     * @param {number} x
+     * @param {number} y
      * @returns {UniverSheet.Transform}
      */
     translate(x: number, y: number): this;
@@ -54,8 +54,8 @@ export declare class Transform {
      * Apply scale
      * @method
      * @name UniverSheet.Transform#scale
-     * @param {Number} sx
-     * @param {Number} sy
+     * @param {number} sx
+     * @param {number} sy
      * @returns {UniverSheet.Transform}
      */
     scale(sx: number, sy: number): this;
@@ -63,7 +63,7 @@ export declare class Transform {
      * Apply rotation
      * @method
      * @name UniverSheet.Transform#rotate
-     * @param {Number} Degree  Angle in Degree
+     * @param {number} Degree  Angle in Degree
      * @returns {UniverSheet.Transform}
      */
     rotate(deg: number): this;
@@ -71,7 +71,7 @@ export declare class Transform {
      * Returns the translation
      * @method
      * @name UniverSheet.Transform#getTranslation
-     * @returns {Object} 2D point(x, y)
+     * @returns {object} 2D point(x, y)
      */
     getTranslation(): {
         x: number;
@@ -81,8 +81,8 @@ export declare class Transform {
      * Apply skew
      * @method
      * @name UniverSheet.Transform#skew
-     * @param {Number} sx
-     * @param {Number} sy
+     * @param {number} sx
+     * @param {number} sy
      * @returns {UniverSheet.Transform}
      */
     skew(sx: number, sy: number): this;
@@ -144,14 +144,14 @@ export declare class Transform {
      * transformations from an object that is not enLived yet.
      * is called DimensionsTransformMatrix because those properties are the one that influence
      * the size of the resulting box of the object.
-     * @param  {Object} options
-     * @param  {Number} [options.scaleX]
-     * @param  {Number} [options.scaleY]
-     * @param  {Boolean} [options.flipX]
-     * @param  {Boolean} [options.flipY]
-     * @param  {Number} [options.skewX]
-     * @param  {Number} [options.skewX]
-     * @return {Number[]} transform matrix
+     * @param  {object} options
+     * @param  {number} [options.scaleX]
+     * @param  {number} [options.scaleY]
+     * @param  {boolean} [options.flipX]
+     * @param  {boolean} [options.flipY]
+     * @param  {number} [options.skewX]
+     * @param  {number} [options.skewX]
+     * @return {number[]} transform matrix
      */
     private _calcDimensionsMatrix;
 }

package/lib/types/canvas.d.ts

@@ -14,20 +14,36 @@
  * limitations under the License.
  */
 import { UniverRenderingContext } from './context';
+/**
+ * canvas render mode
+ */
+export declare enum CanvasRenderMode {
+    /**
+     * Normal canvas render mode
+     */
+    Rendering = 0,
+    /**
+     * Printing render mode,
+     * in case of to generate high dpi pdf,
+     * some canvas api was disabled by some unknown reason.
+     */
+    Printing = 1
+}
 interface ICanvasProps {
     width?: number;
     height?: number;
     pixelRatio?: number;
+    mode?: CanvasRenderMode;
 }
 /**
  * View Renderer constructor. It is a wrapper around native canvas element.
  * Usually you don't need to use it manually.
  * @constructor
  * @abstract
- * @param {Object} props
- * @param {Number} props.width
- * @param {Number} props.height
- * @param {Number} props.pixelRatio
+ * @param {object} props
+ * @param {number} props.width
+ * @param {number} props.height
+ * @param {number} props.pixelRatio
  */
 export declare class Canvas {
     isCache: boolean;
@@ -54,9 +70,9 @@ export declare class Canvas {
     /**
      * to data url
      * @method
-     * @param {String} mimeType
-     * @param {Number} quality between 0 and 1 for jpg mime types
-     * @returns {String} data url string
+     * @param {string} mimeType
+     * @param {number} quality between 0 and 1 for jpg mime types
+     * @returns {string} data url string
      */
     toDataURL(mimeType: string, quality: number): string;
 }

package/lib/types/components/docs/extensions/background.d.ts

@@ -19,7 +19,7 @@ import type { UniverRenderingContext } from '../../../context';
 import { docExtension } from '../doc-extension';
 export declare class Background extends docExtension {
     uKey: string;
-    zIndex: number;
+    Z_INDEX: number;
     private _preBackgroundColor;
     draw(ctx: UniverRenderingContext, parentScale: IScale, span: IDocumentSkeletonSpan): void;
     clearCache(): void;

package/lib/types/components/docs/extensions/border.d.ts

@@ -19,7 +19,7 @@ import type { UniverRenderingContext } from '../../../context';
 import { docExtension } from '../doc-extension';
 export declare class Border extends docExtension {
     uKey: string;
-    zIndex: number;
+    Z_INDEX: number;
     private _preBorderStyle;
     private _preBorderColor;
     draw(ctx: UniverRenderingContext, parentScale: IScale, span: IDocumentSkeletonSpan): void;

package/lib/types/components/docs/extensions/font-and-base-line.d.ts

@@ -19,7 +19,7 @@ import type { UniverRenderingContext } from '../../../context';
 import { docExtension } from '../doc-extension';
 export declare class FontAndBaseLine extends docExtension {
     uKey: string;
-    zIndex: number;
+    Z_INDEX: number;
     private _preFontString;
     private _preFontColor;
     draw(ctx: UniverRenderingContext, parentScale: IScale, span: IDocumentSkeletonSpan): void;

package/lib/types/components/docs/extensions/line.d.ts

@@ -19,7 +19,7 @@ import type { UniverRenderingContext } from '../../../context';
 import { docExtension } from '../doc-extension';
 export declare class Line extends docExtension {
     uKey: string;
-    zIndex: number;
+    Z_INDEX: number;
     private _preBackgroundColor;
     draw(ctx: UniverRenderingContext, parentScale: IScale, span: IDocumentSkeletonSpan): void;
     clearCache(): void;

package/lib/types/components/extension.d.ts

@@ -29,16 +29,17 @@ export interface IExtensionConfig {
 export declare class ComponentExtension<T, U, V> {
     uKey: string;
     type: U;
-    zIndex: number;
+    protected Z_INDEX: number;
     parent: Nullable<BaseObject>;
     translateX: number;
     translateY: number;
     extensionOffset: IExtensionConfig;
+    get zIndex(): number;
     draw(ctx: UniverRenderingContext, parentScale: IScale, skeleton: T, diffBounds?: V): void;
     clearCache(): void;
     protected _getScale(parentScale: IScale): number;
 }
-export declare const SpreadsheetExtensionRegistry: Registry;
-export declare const SheetRowHeaderExtensionRegistry: Registry;
-export declare const SheetColumnHeaderExtensionRegistry: Registry;
-export declare const DocumentsSpanAndLineExtensionRegistry: Registry;
+export declare const SpreadsheetExtensionRegistry: Registry<any>;
+export declare const SheetRowHeaderExtensionRegistry: Registry<any>;
+export declare const SheetColumnHeaderExtensionRegistry: Registry<any>;
+export declare const DocumentsSpanAndLineExtensionRegistry: Registry<any>;

package/lib/types/components/sheets/extensions/background.d.ts

@@ -19,6 +19,8 @@ import type { SpreadsheetSkeleton } from '../sheet-skeleton';
 import { SheetExtension } from './sheet-extension';
 export declare class Background extends SheetExtension {
     uKey: string;
-    zIndex: number;
+    Z_INDEX: number;
+    PRINTING_Z_INDEX: number;
+    get zIndex(): number;
     draw(ctx: UniverRenderingContext, parentScale: IScale, spreadsheetSkeleton: SpreadsheetSkeleton, diffRanges?: IRange[]): void;
 }

package/lib/types/components/sheets/extensions/border.d.ts

@@ -19,7 +19,7 @@ import type { SpreadsheetSkeleton } from '../sheet-skeleton';
 import { SheetExtension } from './sheet-extension';
 export declare class Border extends SheetExtension {
     uKey: string;
-    zIndex: number;
+    Z_INDEX: number;
     draw(ctx: UniverRenderingContext, parentScale: IScale, spreadsheetSkeleton: SpreadsheetSkeleton, diffRanges?: IRange[]): void;
     private _getOverflowExclusion;
 }

package/lib/types/components/sheets/extensions/column-header-layout.d.ts

@@ -19,6 +19,6 @@ import type { SpreadsheetSkeleton } from '../sheet-skeleton';
 import { SheetExtension } from './sheet-extension';
 export declare class ColumnHeaderLayout extends SheetExtension {
     uKey: string;
-    zIndex: number;
+    Z_INDEX: number;
     draw(ctx: UniverRenderingContext, parentScale: IScale, spreadsheetSkeleton: SpreadsheetSkeleton): void;
 }

package/lib/types/components/sheets/extensions/font.d.ts

@@ -17,11 +17,13 @@ import type { IColorStyle, IRange, IScale } from '@univerjs/core';
 import { ObjectMatrix } from '@univerjs/core';
 import type { UniverRenderingContext } from '../../../context';
 import { type SpreadsheetSkeleton } from '../sheet-skeleton';
+import type { Spreadsheet } from '../spreadsheet';
 import { SheetExtension } from './sheet-extension';
 export declare class Font extends SheetExtension {
     uKey: string;
-    zIndex: number;
+    Z_INDEX: number;
     changeFontColor: ObjectMatrix<IColorStyle>;
+    get spreadsheet(): Spreadsheet;
     getDocuments(): any;
     setChangeFontColor(r: number, c: number, color: IColorStyle): void;
     draw(ctx: UniverRenderingContext, parentScale: IScale, spreadsheetSkeleton: SpreadsheetSkeleton, diffRanges?: IRange[]): void;

package/lib/types/components/sheets/extensions/row-header-layout.d.ts

@@ -19,6 +19,6 @@ import type { SpreadsheetSkeleton } from '../sheet-skeleton';
 import { SheetExtension } from './sheet-extension';
 export declare class RowHeaderLayout extends SheetExtension {
     uKey: string;
-    zIndex: number;
+    Z_INDEX: number;
     draw(ctx: UniverRenderingContext, parentScale: IScale, spreadsheetSkeleton: SpreadsheetSkeleton): void;
 }

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

@@ -32,12 +32,16 @@ export declare class Spreadsheet extends SheetComponent {
     private _overflowCacheRuntime;
     private _overflowCacheRuntimeRange;
     private _overflowCacheRuntimeTimeout;
+    private _forceDisableGridlines;
     private _documents;
+    isPrinting: boolean;
     constructor(oKey: string, spreadsheetSkeleton?: SpreadsheetSkeleton, _allowCache?: boolean);
     get backgroundExtension(): Background;
     get borderExtension(): Border;
     get fontExtension(): Font;
     getDocuments(): Documents;
+    get allowCache(): boolean;
+    get forceDisableGridlines(): boolean;
     draw(ctx: UniverRenderingContext, bounds?: IViewportBound): void;
     isHit(coord: Vector2): boolean;
     getNoMergeCellPositionByIndex(rowIndex: number, columnIndex: number): {
@@ -51,6 +55,7 @@ export declare class Spreadsheet extends SheetComponent {
         y: number;
     };
     makeForceDirty(state?: boolean): void;
+    setForceDisableGridlines(disabled: boolean): void;
     getSelectionBounding(startRow: number, startColumn: number, endRow: number, endColumn: number): {
         startRow: number;
         startColumn: number;

package/lib/types/context.d.ts

@@ -39,6 +39,7 @@ export declare class UniverRenderingContext2D implements CanvasRenderingContext2
     set lineJoin(val: CanvasLineJoin);
     get lineWidth(): number;
     set lineWidth(val: number);
+    setLineWidthNative(val: number): void;
     get miterLimit(): number;
     set miterLimit(val: number);
     get shadowBlur(): number;
@@ -269,6 +270,8 @@ export declare class UniverRenderingContext2D implements CanvasRenderingContext2
     translate(x: number, y: number): void;
     translateWithPrecision(x: number, y: number): void;
     translateWithPrecisionRatio(x: number, y: number): void;
+    clearRectForTexture(x: number, y: number, width: number, height: number): void;
+    setGlobalCompositeOperation(val: GlobalCompositeOperation): void;
 }
 /**
  * TODO
@@ -282,3 +285,9 @@ export declare class UniverRenderingContextWebGPU {
 }
 export declare class UniverRenderingContext extends UniverRenderingContext2D {
 }
+export declare class UniverPrintingContext extends UniverRenderingContext2D {
+    private __getScale;
+    clearRect(x: number, y: number, width: number, height: number): void;
+    clearRectForTexture(x: number, y: number, width: number, height: number): void;
+    setGlobalCompositeOperation(val: GlobalCompositeOperation): void;
+}

package/lib/types/engine.d.ts

@@ -15,7 +15,7 @@
  */
 import { Observable } from '@univerjs/core';
 import type { CURSOR_TYPE } from './basics/const';
-import { Canvas } from './canvas';
+import { Canvas, type CanvasRenderMode } from './canvas';
 import type { Scene } from './scene';
 import { ThinEngine } from './thin-engine';
 export declare class Engine extends ThinEngine<Scene> {
@@ -52,7 +52,7 @@ export declare class Engine extends ThinEngine<Scene> {
     private pointer;
     private _mouseId;
     private _isUsingFirefox;
-    constructor(elemWidth?: number, elemHeight?: number);
+    constructor(elemWidth?: number, elemHeight?: number, pixelRatio?: number, mode?: CanvasRenderMode);
     get width(): number;
     get height(): number;
     get requestNewFrameHandler(): number;
@@ -70,7 +70,7 @@ export declare class Engine extends ThinEngine<Scene> {
      */
     setRemainCapture(): void;
     getPixelRatio(): number;
-    setContainer(elem: HTMLElement): void;
+    setContainer(elem: HTMLElement, resize?: boolean): void;
     resize(): void;
     resizeBySize(width: number, height: number): void;
     dispose(): void;

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

@@ -83,7 +83,7 @@ export declare class Path extends Shape<IPathProps> {
     /**
      * Return length of the path.
      * @method
-     * @returns {Number} length
+     * @returns {number} length
      * @example
      * var length = path.getLength();
      */
@@ -91,8 +91,8 @@ export declare class Path extends Shape<IPathProps> {
     /**
      * Get point on path at specific length of the path
      * @method
-     * @param {Number} length length
-     * @returns {Object} point {x,y} point
+     * @param {number} length length
+     * @returns {object} point {x,y} point
      * @example
      * var point = path.getPointAtLength(10);
      */