@univerjs/engine-render 0.5.4 → 0.5.5-nightly.202501201336

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

@@ -1,10 +1,10 @@
 import { IScale } from '@univerjs/core';
 import { UniverRenderingContext } from '../../../context';
-import { IAColumnCfg, IAColumnCfgObj, IColumnStyleCfg } from '../interfaces';
+import { IAColumnCfg, IAColumnCfgObj, IHeaderStyleCfg } from '../interfaces';
 import { SpreadsheetSkeleton } from '../sheet-skeleton';
 import { SheetExtension } from './sheet-extension';
 export interface IColumnsHeaderCfgParam {
-    headerStyle?: Partial<IColumnStyleCfg>;
+    headerStyle?: Partial<IHeaderStyleCfg>;
     columnsCfg?: IAColumnCfg[];
 }
 /**
@@ -14,10 +14,10 @@ export declare class ColumnHeaderLayout extends SheetExtension {
     uKey: string;
     Z_INDEX: number;
     columnsCfg: IAColumnCfg[];
-    headerStyle: IColumnStyleCfg;
+    headerStyle: IHeaderStyleCfg;
     constructor(cfg?: IColumnsHeaderCfgParam);
     configHeaderColumn(cfg: IColumnsHeaderCfgParam): void;
     getCfgOfCurrentColumn(colIndex: number): [IAColumnCfgObj, boolean];
-    setStyleToCtx(ctx: UniverRenderingContext, columnStyle: Partial<IColumnStyleCfg>): void;
+    setStyleToCtx(ctx: UniverRenderingContext, columnStyle: Partial<IHeaderStyleCfg>): void;
     draw(ctx: UniverRenderingContext, parentScale: IScale, spreadsheetSkeleton: SpreadsheetSkeleton): void;
 }

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

@@ -1,6 +1,6 @@
 import { IScale } from '@univerjs/core';
 import { UniverRenderingContext } from '../../../context';
-import { IARowCfg, IARowCfgObj, IColumnStyleCfg, IRowStyleCfg } from '../interfaces';
+import { IARowCfg, IARowCfgObj, IHeaderStyleCfg, IRowStyleCfg } from '../interfaces';
 import { SpreadsheetSkeleton } from '../sheet-skeleton';
 import { SheetExtension } from './sheet-extension';
 export interface IRowsHeaderCfgParam {
@@ -15,6 +15,6 @@ export declare class RowHeaderLayout extends SheetExtension {
     constructor(cfg?: IRowsHeaderCfgParam);
     configHeaderRow(cfg: IRowsHeaderCfgParam): void;
     getCfgOfCurrentRow(rowIndex: number): [IARowCfgObj, boolean];
-    setStyleToCtx(ctx: UniverRenderingContext, rowStyle: Partial<IColumnStyleCfg>): void;
+    setStyleToCtx(ctx: UniverRenderingContext, rowStyle: Partial<IHeaderStyleCfg>): void;
     draw(ctx: UniverRenderingContext, parentScale: IScale, spreadsheetSkeleton: SpreadsheetSkeleton): void;
 }

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

@@ -66,7 +66,7 @@ export interface IPaintForScrolling {
     scaleX: number;
     scaleY: number;
 }
-export interface IColumnStyleCfg {
+export interface IHeaderStyleCfg {
     fontFamily: string;
     fontColor: string;
     fontSize: number;
@@ -74,8 +74,9 @@ export interface IColumnStyleCfg {
     textAlign: CanvasTextAlign;
     textBaseline: CanvasTextBaseline;
     backgroundColor: string;
+    size?: number;
 }
-export type IAColumnCfgObj = IColumnStyleCfg & {
+export type IAColumnCfgObj = IHeaderStyleCfg & {
     text: string;
 };
 export type IAColumnCfg = undefined | null | string | Partial<IAColumnCfgObj>;
@@ -88,7 +89,7 @@ export interface IRowStyleCfg {
     textBaseline: CanvasTextBaseline;
     backgroundColor: string;
 }
-export type IARowCfgObj = IColumnStyleCfg & {
+export type IARowCfgObj = IHeaderStyleCfg & {
     text: string;
 };
 export type IARowCfg = undefined | null | string | Partial<IARowCfgObj>;

package/lib/types/components/sheets/sheet-skeleton.d.ts

@@ -83,6 +83,10 @@ export declare class SpreadsheetSkeleton extends Skeleton {
      * Whether the row style precedes the column style.
      */
     private _isRowStylePrecedeColumnStyle;
+    /**
+     * Whether auto height for merged cells
+     */
+    private _skipAutoHeightForMergedCells;
     private _renderRawFormula;
     /**
      * @deprecated avoid use `IWorksheetData` directly, use API provided by `Worksheet`, otherwise
@@ -91,12 +95,15 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     private _worksheetData;
     private _cellData;
     constructor(worksheet: Worksheet, _styles: Styles, _localeService: LocaleService, _contextService: IContextService, _configService: IConfigService, _injector: Injector);
+    initConfig(): void;
     get rowHeightAccumulation(): number[];
     get rowTotalHeight(): number;
     get columnWidthAccumulation(): number[];
     get columnTotalWidth(): number;
     get rowHeaderWidth(): number;
     get columnHeaderHeight(): number;
+    set columnHeaderHeight(value: number);
+    set rowHeaderWidth(value: number);
     get imageCacheMap(): ImageCacheMap;
     /**
      * Range of visible area(range in viewBounds)
@@ -164,6 +171,8 @@ export declare class SpreadsheetSkeleton extends Skeleton {
      * @returns {number} width
      */
     private _calculateColWidth;
+    getColWidth(colIndex: number): number;
+    getRowHeight(rowIndex: number): number;
     /**
      * For _calculateColMaxWidth
      * @param cell

package/lib/types/floating/util.d.ts

@@ -1,2 +1,11 @@
 import { Observable } from 'rxjs';
+/**
+ * Tracks position and size changes of an element by monitoring:
+ * - Ancestor scrolling and resizing
+ * - Layout shifts
+ * - Element's bounding rectangle changes
+ *
+ * @param containerElement
+ * @returns Observable<void>
+ */
 export declare function observeClientRect(containerElement: HTMLElement): Observable<void>;

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

@@ -20,10 +20,15 @@ export interface IRenderManagerService extends IDisposable {
     removeRender(unitId: string): void;
     setCurrent(unitId: string): void;
     /**
-     * get RenderUnit By Id, RenderUnit implements IRender
+     * Get RenderUnit By Id, RenderUnit implements IRender
      * @param unitId
      */
     getRenderById(unitId: string): Nullable<IRender>;
+    /**
+     * Get RenderUnit By Id, RenderUnit implements IRender
+     * @param unitId
+     */
+    getRenderUnitById(unitId: string): Nullable<IRender>;
     getAllRenderersOfType(type: UniverInstanceType): RenderUnit[];
     getCurrentTypeOfRenderer(type: UniverInstanceType): Nullable<RenderUnit>;
     getRenderAll(): Map<string, IRender>;
@@ -111,11 +116,13 @@ export declare class RenderManagerService extends Disposable implements IRenderM
     getCurrent(): Nullable<IRender>;
     getFirst(): Nullable<IRender>;
     /**
-     * get RenderUnit from this._renderMap
+     * @deprecated use getRenderUnitById instead
+     * Get RenderUnit from this._renderMap.
      * @param unitId
      * @returns RenderUnit, aka IRender
      */
     getRenderById(unitId: string): Nullable<IRender>;
+    getRenderUnitById(unitId: string): Nullable<IRender>;
     getRenderAll(): Map<string, IRender>;
     private _disposeItem;
 }

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

@@ -17,6 +17,7 @@ export interface IRender {
     isMainScene: boolean;
     isThumbNail?: boolean;
     with<T>(dependency: DependencyIdentifier<T>): T;
+    getRenderContext?(): IRenderContext;
 }
 /**
  * Every render module should implement this interface.
@@ -62,4 +63,5 @@ export declare class RenderUnit extends Disposable implements IRender {
      */
     addRenderDependencies(dependencies: Dependency[]): void;
     private _initDependencies;
+    getRenderContext(): IRenderContext;
 }

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

@@ -9,6 +9,9 @@ export interface IScrollBarProps {
     thumbBackgroundColor?: string;
     thumbHoverBackgroundColor?: string;
     thumbActiveBackgroundColor?: string;
+    /**
+     * The thickness of a scrolling bar.
+     */
     barSize?: number;
     barBackgroundColor?: string;
     barBorder?: number;
@@ -16,6 +19,8 @@ export interface IScrollBarProps {
     enableHorizontal?: boolean;
     enableVertical?: boolean;
     mainScene?: Scene;
+    minThumbSizeH?: number;
+    minThumbSizeV?: number;
 }
 export declare abstract class BaseScrollBar extends Disposable {
     enableHorizontal: boolean;

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

@@ -14,6 +14,9 @@ export declare class ScrollBar extends BaseScrollBar {
     private _horizonPointerUpSub;
     private _verticalPointerMoveSub;
     private _verticalPointerUpSub;
+    /**
+     * The thickness of a scrolling bar.
+     */
     barSize: number;
     barBorder: number;
     thumbMargin: number;
@@ -26,6 +29,14 @@ export declare class ScrollBar extends BaseScrollBar {
     thumbActiveBackgroundColor: string;
     barBackgroundColor: string;
     barBorderColor: string;
+    /**
+     * The min width of horizon thumb.
+     */
+    minThumbSizeH: number;
+    /**
+     * The min height of vertical thumb.
+     */
+    minThumbSizeV: number;
     private _eventSub;
     constructor(view: Viewport, props?: IScrollBarProps);
     static attachTo(view: Viewport, props?: IScrollBarProps): ScrollBar;

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

@@ -106,7 +106,7 @@ export declare abstract class Shape<T extends IShapeProps> extends BaseObject {
     private static _setStrokeStyles;
     render(mainCtx: UniverRenderingContext, bounds?: IViewportInfo): this;
     /**
-     * this[_key] = props[key]
+     * if BASE_OBJECT_ARRAY_Set.has(key) not exist, then this[_key] = props[key],
      * @param props
      */
     setProps(props?: T): Shape<T>;

package/lib/types/viewport.d.ts

@@ -121,7 +121,13 @@ export declare class Viewport {
     private _rightOrigin;
     private _widthOrigin;
     private _heightOrigin;
+    /**
+     * this._topOrigin * scaleY;
+     */
     private _top;
+    /**
+     * this._leftOrigin * scaleX;
+     */
     private _left;
     private _bottom;
     private _right;
@@ -194,10 +200,10 @@ export declare class Viewport {
     get viewportScrollX(): number;
     set viewportScrollY(val: number);
     get viewportScrollY(): number;
-    private set top(value);
-    private set left(value);
-    private set bottom(value);
-    private set right(value);
+    set top(num: number);
+    set left(num: number);
+    set bottom(num: number);
+    set right(num: number);
     get viewBound(): IBoundRectNoAngle;
     get cacheBound(): IBoundRectNoAngle | null;
     set cacheBound(val: IBoundRectNoAngle | null);
@@ -387,6 +393,6 @@ export declare class Viewport {
     private _diffViewBound;
     private _calcDiffCacheBound;
     private _drawScrollbar;
-    private _setViewportSize;
+    setViewportSize(props?: IViewProps): void;
 }
 export {};