@univerjs/engine-render 0.16.1 → 0.17.0

package/lib/types/base-object.d.ts

@@ -1,4 +1,4 @@
-import { IKeyValue, ITransformState, Nullable, Disposable, EventSubject } from '@univerjs/core';
+import { IGroupBaseBound, IKeyValue, ITransformState, Nullable, Disposable, EventSubject } from '@univerjs/core';
 import { IDragEvent, IMouseEvent, IPointerEvent, IWheelEvent } from './basics/i-events';
 import { IObjectFullState, ITransformChangeState } from './basics/interfaces';
 import { ITransformerConfig } from './basics/transformer-config';
@@ -22,6 +22,7 @@ export declare enum ObjectType {
 export declare abstract class BaseObject extends Disposable {
     groupKey?: string;
     isInGroup: boolean;
+    isDrawingObject: boolean;
     objectType: ObjectType;
     onTransformChange$: EventSubject<ITransformChangeState>;
     onPointerDown$: EventSubject<IMouseEvent | IPointerEvent>;
@@ -146,6 +147,7 @@ export declare abstract class BaseObject extends Disposable {
     isRender(bounds?: IViewportInfo): boolean | undefined;
     getParent(): any;
     getState(): ITransformState;
+    getRealBound(): IGroupBaseBound;
     hide(): void;
     show(): void;
     render(ctx: UniverRenderingContext, bounds: IViewportInfo): void;

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

@@ -1,4 +1,4 @@
-import { ITransformState } from '@univerjs/core';
+import { IGroupBaseBound, ITransformState, Nullable } from '@univerjs/core';
 export declare function getGroupState(parentLeft: number, parentTop: number, objectStates: ITransformState[]): {
     left: number;
     top: number;
@@ -8,8 +8,67 @@ export declare function getGroupState(parentLeft: number, parentTop: number, obj
     scaleX: number;
     scaleY: number;
 };
-export declare function transformObjectOutOfGroup(child: ITransformState, parent: ITransformState, groupOriginWidth: number, groupOriginHeight: number): {
+export declare function getDrawingGroupState(parentLeft: number, parentTop: number, objectStates: ITransformState[]): {
     left: number;
     top: number;
+    width: number;
+    height: number;
+    angle: number;
+    scaleX: number;
+    scaleY: number;
+};
+/**
+ * Transform a child object out of a group, computing its absolute position, angle, and flip state.
+ *
+ * When a DrawingGroup has a baseBound (chOff/chExt in OOXML), children store their positions
+ * in the baseBound coordinate space. This method first maps the child's position from baseBound
+ * space to the actual parent bound space, then applies group flip mirroring and rotation.
+ *
+ * @param child - The child's transform state (position in baseBound space if baseBound is provided)
+ * @param parent - The parent group's transform state (absolute position, angle, flip)
+ * @param groupOriginWidth - The original width of the group (used to compute group center)
+ * @param groupOriginHeight - The original height of the group (used to compute group center)
+ * @param baseBound - Optional. The group's baseBound (chOff/chExt). If provided, child coordinates
+ *                    are mapped from this space to the parent's actual bound space before transforming.
+ *
+ * @example
+ * // in excel, the group off & ext is the real position and size of the group, and the child position is relative to the group chOff/chExt. For example:
+ * ```xml
+ *   <a:xfrm>
+ *        <a:off x="1212850" y="889000"/>
+ *        <a:ext cx="6813550" cy="4883150"/>
+ *        <a:chOff x="1212850" y="889000"/>
+ *        <a:chExt cx="6813550" cy="4883150"/>
+ *    </a:xfrm>
+ * ```
+ */
+export declare function transformObjectOutOfGroup(child: ITransformState, parent: ITransformState, groupOriginWidth: number, groupOriginHeight: number, baseBound: Nullable<IGroupBaseBound>): {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
     angle: number;
+    flipX: boolean;
+    flipY: boolean;
 };
+/**
+ * Get the rendered position and size of an object based on the group's baseBound and the parent's bound.
+ * @param baseBound The group's baseBound defining the coordinate space for its children,In Excel, this corresponds to chOff (child offset) and chExt (child extent) in OOXML.
+ * @param parentBound The bounding box of the parent context (e.g., the group or canvas) within which the object is rendered.
+ * @param objectBound The original bounding box of the object in the group's coordinate space.
+ * @returns {IGroupBaseBound} The transformed bound for rendering the object within the group context
+ */
+export declare function getRenderTransformBaseOnParentBound(baseBound: IGroupBaseBound, parentBound: IGroupBaseBound, objectBound: IGroupBaseBound): IGroupBaseBound;
+/**
+ * In Excel, a rotated shape's bounding box for group calculations uses major axis switching.
+ * The axis-aligned bound depends on which 90° increment the rotation angle is closest to:
+ *
+ * [-45°, 45°)   → 0°   horizontal (original width/height)
+ * [45°, 135°)   → 90°  vertical   (width/height swapped)
+ * [135°, 225°)  → 180° horizontal (original width/height)
+ * [225°, 315°)  → 270° vertical   (width/height swapped)
+ *
+ * @param bound - The original axis-aligned bound { left, top, width, height }
+ * @param angle - The rotation angle in degrees
+ */
+export declare function getRotatedBoundInGroup(bound: IGroupBaseBound, angle: number): IGroupBaseBound;

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

@@ -1,6 +1,6 @@
 import { ITransformState } from '@univerjs/core';
-import { Vector2 } from './vector2';
 import { IRect } from './interfaces';
+import { Vector2 } from './vector2';
 export declare const INITIAL_MATRIX: number[];
 export declare class Transform {
     dirty: boolean;

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

@@ -1,8 +1,8 @@
 import { Nullable } from '@univerjs/core';
-import { Break } from '../break';
-import { IBreakPoints, LineBreaker } from '../line-breaker';
 import { Hyphen } from '../../hyphenation/hyphen';
 import { Lang } from '../../hyphenation/lang';
+import { IBreakPoints, LineBreaker } from '../line-breaker';
+import { Break } from '../break';
 export declare class LineBreakerHyphenEnhancer implements IBreakPoints {
     private _lineBreaker;
     private _hyphen;

package/lib/types/drawing-group.d.ts

@@ -0,0 +1,37 @@
+import { IGroupBaseBound } from '@univerjs/core';
+import { BaseObject } from './base-object';
+import { IViewportInfo, Vector2, Transform } from './basics';
+import { UniverRenderingContext } from './context';
+import { Group } from './group';
+export declare class DrawingGroupObject extends Group {
+    protected _selfSizeMode: boolean;
+    /**
+     * Corresponds to chOff (child offset) and chExt (child extent) in OOXML.
+     * Describes the coordinate space of children within this group.
+     * Children store their absolute positions in this coordinate space.
+     * When rendering, positions are mapped from baseBound space to the group's current transform.
+     */
+    private _baseBound;
+    /**
+     * Set the baseBound (chOff/chExt in OOXML) for this group.
+     * This defines the coordinate space of children within the group.
+     * When set, the group automatically enters selfSizeMode so its dimensions
+     * are tracked independently of children.
+     */
+    setBaseBound(bound: IGroupBaseBound): void;
+    /**
+     * Get the baseBound (chOff/chExt in OOXML) for this group.
+     */
+    getBaseBound(): IGroupBaseBound;
+    /**
+     * Override ancestorTransform to use the same render transform as render(),
+     * which uses [m[0], m[1], m[2], m[3], centerX, centerY] from realBound
+     * instead of the standard transform translation.
+     * This ensures children (e.g., Image.isHit) that compose with
+     * parent.ancestorTransform get the correct coordinate space.
+     */
+    get ancestorTransform(): Transform;
+    render(ctx: UniverRenderingContext, bounds: IViewportInfo): void;
+    addObjects(...objects: BaseObject[]): void;
+    isHit(coord: Vector2): boolean;
+}

package/lib/types/group.d.ts

@@ -3,8 +3,8 @@ import { IViewportInfo } from './basics/vector2';
 import { UniverRenderingContext } from './context';
 import { BaseObject } from './base-object';
 export declare class Group extends BaseObject {
-    private _objects;
-    private _selfSizeMode;
+    protected _objects: BaseObject[];
+    protected _selfSizeMode: boolean;
     constructor(key?: string, ...objects: BaseObject[]);
     get classType(): RENDER_CLASS_TYPE;
     set cursor(val: CURSOR_TYPE);

package/lib/types/index.d.ts

@@ -34,9 +34,10 @@ export { DocumentViewModel } from './components/docs/view-model/document-view-mo
 export { DocumentEditArea } from './components/docs/view-model/document-view-model';
 export { parseDataStreamToTree } from './components/docs/view-model/document-view-model';
 export { DEFAULT_PADDING_DATA } from './components/sheets/sheet.render-skeleton';
+export type { IUniverEngineRenderConfig } from './config/config';
 export * from './context';
-export type { IUniverEngineRenderConfig } from './controllers/config.schema';
 export * from './custom';
+export { DrawingGroupObject } from './drawing-group';
 export * from './engine';
 export * from './group';
 export * from './layer';

package/lib/types/plugin.d.ts

@@ -1,4 +1,4 @@
-import { IUniverEngineRenderConfig } from './controllers/config.schema';
+import { IUniverEngineRenderConfig } from './config/config';
 import { IConfigService, Injector, Plugin } from '@univerjs/core';
 import { Engine } from './engine';
 /**
@@ -12,6 +12,8 @@ export declare class UniverRenderEnginePlugin extends Plugin {
     readonly _injector: Injector;
     private readonly _configService;
     static pluginName: string;
+    static packageName: string;
+    static version: string;
     constructor(_config: Partial<IUniverEngineRenderConfig> | undefined, _injector: Injector, _configService: IConfigService);
     onStarting(): void;
 }

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

@@ -24,6 +24,7 @@ export declare class Image extends Shape<IImageProps> {
     private _renderByCropper;
     private _transformCalculateSrcRect;
     objectType: ObjectType;
+    isDrawingObject: boolean;
     constructor(id: string, config: IImageProps);
     get srcRect(): Nullable<ISrcRect>;
     get prstGeom(): Nullable<PresetGeometryType>;
@@ -52,7 +53,7 @@ export declare class Image extends Shape<IImageProps> {
     };
     private _transformBySrcRect;
     render(mainCtx: UniverRenderingContext, bounds?: IViewportInfo): this;
-    protected _draw(ctx: UniverRenderingContext): void;
+    protected _draw(ctx: UniverRenderingContext, _bounds?: IViewportInfo, renderWidth?: number, renderHeight?: number): void;
     private _init;
     private _updateSrcRectByTransform;
     isHit(coord: Vector2): boolean;

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

@@ -97,12 +97,23 @@ export declare class ScrollBar extends Disposable {
     get miniThumbRatioY(): number;
     hasHorizonThumb(): boolean;
     hasVerticalThumb(): boolean;
+    /**
+     * The horizontal scroll thumb thickness.
+     */
     get scrollHorizonThumbThickness(): number;
+    /**
+     * The vertical scroll thumb thickness.
+     */
     get scrollVerticalThumbThickness(): number;
+    /**
+     * The scroll track thickness.
+     * trackThickness = scrollTrackSize(horizonScrollTrack.height/verticalScrollTrack.width) + trackBorderThickness
+     */
     set barSize(v: number);
     get barSize(): number;
     set trackThickness(v: number);
     get trackThickness(): number;
+    get totalSize(): number;
     static attachTo(view: Viewport, props?: IScrollBarProps): ScrollBar;
     dispose(): void;
     render(ctx: UniverRenderingContext, left?: number, top?: number): void;

package/lib/types/viewport.d.ts

@@ -147,6 +147,13 @@ export declare class Viewport {
     private _paddingEndX;
     private _paddingStartY;
     private _paddingEndY;
+    /**
+     * The viewMain viewport's marginLeft and marginTop is used to calculate the scrollBar position.
+     * marginLeft = rowHeaderWidthAndMarginLeft;
+     * marginTop = columnHeaderHeightAndMarginTop;
+     */
+    private _marginLeft;
+    private _marginTop;
     /**
      * viewbound of cache area, cache area is slightly bigger than viewbound.
      */
@@ -243,6 +250,7 @@ export declare class Viewport {
     resizeWhenFreezeChange(position: IViewPosition): void;
     setPadding(param: IPosition): void;
     resetPadding(): void;
+    setMargin(marginLeft: number, marginTop: number): void;
     /**
      * ScrollBar scroll to certain position.
      * @param pos position of scrollBar