@univerjs/engine-render - npm Package Compare versions

Comparing version 0.2.9 to 0.2.10

lib/types/components/docs/text-selection/text-selection-render-manager.d.ts

 import { Nullable, ILogService, RxDisposable } from '@univerjs/core';
 import { Observable } from 'rxjs';
 import { IMouseEvent, IPointerEvent } from '../../../basics/i-events';
-import { INodeInfo, INodePosition } from '../../../basics/interfaces';
+import { INodePosition } from '../../../basics/interfaces';
 import { ISuccinctDocRangeParam, ITextRangeWithStyle, ITextSelectionStyle, RANGE_DIRECTION } from '../../../basics/range';
 import { Scene } from '../../../scene';
 import { Viewport } from '../../../viewport';
-import { DocumentSkeleton, IFindNodeRestrictions } from '../layout/doc-skeleton';
+import { DocumentSkeleton } from '../layout/doc-skeleton';
 import { Documents } from '../document';
@@ -190,7 +190,5 @@ import { TextRange } from './text-range';
     private _getTransformCoordForDocumentOffset;
-    findNodeByCoord(evtOffsetX: number, evtOffsetY: number, restrictions: IFindNodeRestrictions): Nullable<INodeInfo>;
-    private _getNodeIndex;
+    private _findNodeByCoord;
     private _detachEvent;
-    private _activeSelectionRefresh;
 }
 export declare const ITextSelectionRenderManager: import('@univerjs/core').IdentifierDecorator<TextSelectionRenderManager>;

lib/types/components/sheets/column-header.d.ts

@@ -27,3 +27,7 @@ import { Nullable } from '@univerjs/core';
     private _initialDefaultExtension;
+    /**
+     * Custimize column header, such as custom header text and background.
+     * @param cfg
+     */
     setCustomHeader(cfg: IColumnsHeaderCfgParam): void;
 }

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

@@ -10,2 +10,5 @@ import { IScale } from '@univerjs/core';
 }
+/**
+ * Column Header Bar, include a lot of columns header
+ */
 export declare class ColumnHeaderLayout extends SheetExtension {
@@ -12,0 +15,0 @@ uKey: string;

lib/types/components/sheets/extensions/sheet-extension.d.ts

@@ -9,2 +9,12 @@ import { IRange } from '@univerjs/core';
     type: SHEET_EXTENSION_TYPE;
+    /**
+     * Get ISelectionCellWithMergeInfo by cell rowIndex and cell columnIndex.
+     * The startXY in return value does not include rowHeader and columnHeader.
+     * @param rowIndex
+     * @param columnIndex
+     * @param rowHeightAccumulation
+     * @param columnWidthAccumulation
+     * @param dataMergeCache
+     * @returns ISelectionCellWithMergeInfo
+     */
     getCellIndex(rowIndex: number, columnIndex: number, rowHeightAccumulation: number[], columnWidthAccumulation: number[], dataMergeCache: IRange[]): import('@univerjs/core').ISelectionCellWithMergeInfo;
@@ -11,0 +21,0 @@ isRenderDiffRangesByCell(rangeP: IRange, diffRanges?: IRange[]): boolean;

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

@@ -1,2 +0,2 @@
-import { BooleanNumber, DocumentDataModel, HorizontalAlign, IContextService, LocaleService, ObjectMatrix, VerticalAlign, WrapStrategy, ICellData, IPaddingData, IRange, IRowAutoHeightInfo, ISelectionCellWithMergeInfo, ITextRotation, IWorksheetData, Nullable, Styles, Worksheet } from '@univerjs/core';
+import { BooleanNumber, DocumentDataModel, HorizontalAlign, IContextService, LocaleService, ObjectMatrix, VerticalAlign, WrapStrategy, ICellData, IColumnRange, IPaddingData, IPosition, IRange, IRowAutoHeightInfo, ISelectionCellWithMergeInfo, ISize, ITextRotation, IWorksheetData, Nullable, Styles, Worksheet } from '@univerjs/core';
 import { IBoundRectNoAngle, IViewportInfo } from '../../basics/vector2';
@@ -11,6 +11,3 @@ import { DocumentSkeleton } from '../docs/layout/doc-skeleton';
  */
-export declare function getDocsSkeletonPageSize(documentSkeleton: DocumentSkeleton, angleInDegree?: number): {
-    width: number;
-    height: number;
-} | undefined;
+export declare function getDocsSkeletonPageSize(documentSkeleton: DocumentSkeleton, angleInDegree?: number): Nullable<Required<ISize>>;
 interface IRowColumnSegment {
@@ -109,5 +106,5 @@ startRow: number;
     setMarginTop(top: number): void;
-    calculateSegment(bounds?: IViewportInfo): true | undefined;
-    calculateWithoutClearingCache(bounds?: IViewportInfo): this | undefined;
-    calculate(bounds?: IViewportInfo): this;
+    calculateSegment(bounds?: IViewportInfo): boolean;
+    calculateWithoutClearingCache(bounds?: IViewportInfo): Nullable<SpreadsheetSkeleton>;
+    calculate(bounds?: IViewportInfo): Nullable<SpreadsheetSkeleton>;
     calculateAutoHeightInRange(ranges: Nullable<IRange[]>): IRowAutoHeightInfo[];
@@ -117,3 +114,2 @@ private _calculateRowAutoHeight;
      * Calculate data for row col & cell position, then update position value to this._rowHeaderWidth & this._rowHeightAccumulation & this._columnHeaderHeight & this._columnWidthAccumulation.
-     * @returns this
      */
@@ -133,23 +129,7 @@ private _updateLayout;
     getRowCount(): number;
-    getOverflowPosition(contentSize: {
-        width: number;
-        height: number;
-    }, horizontalAlign: HorizontalAlign, row: number, column: number, columnCount: number): {
-        startColumn: number;
-        endColumn: number;
-    };
-    getNoMergeCellPositionByIndex(rowIndex: number, columnIndex: number): {
-        startY: number;
-        endY: number;
-        startX: number;
-        endX: number;
-    };
-    getNoMergeCellPositionByIndexWithNoHeader(rowIndex: number, columnIndex: number): {
-        startY: number;
-        endY: number;
-        startX: number;
-        endX: number;
-    };
+    getOverflowPosition(contentSize: Required<ISize>, horizontalAlign: HorizontalAlign, row: number, column: number, columnCount: number): IColumnRange;
+    getNoMergeCellPositionByIndex(rowIndex: number, columnIndex: number): IPosition;
+    getNoMergeCellPositionByIndexWithNoHeader(rowIndex: number, columnIndex: number): IPosition;
     /**
-     *
+     * Get cell by pos(offsetX, offsetY).
      * @param offsetX HTML coordinate system, mouse position x.
@@ -225,27 +205,3 @@ * @param offsetY HTML coordinate system, mouse position y.
     getCellByIndex(row: number, column: number): ISelectionCellWithMergeInfo;
-    getCellByIndexWithNoHeader(row: number, column: number): {
-        actualRow: number;
-        actualColumn: number;
-        startY: number;
-        endY: number;
-        startX: number;
-        endX: number;
-        isMerged: boolean;
-        isMergedMainCell: boolean;
-        mergeInfo: {
-            startX: number;
-            startY: number;
-            endX: number;
-            endY: number;
-            rangeType?: import('@univerjs/core').RANGE_TYPE;
-            startAbsoluteRefType?: import('@univerjs/core').AbsoluteRefType;
-            endAbsoluteRefType?: import('@univerjs/core').AbsoluteRefType;
-            startRow: number;
-            endRow: number;
-            unitId?: string;
-            sheetId?: string;
-            startColumn: number;
-            endColumn: number;
-        };
-    };
+    getCellByIndexWithNoHeader(row: number, column: number): ISelectionCellWithMergeInfo;
     convertTransformToOffsetX(offsetX: number, scaleX: number, scrollXY: {
@@ -252,0 +208,0 @@ x: number;

lib/types/engine.d.ts

@@ -41,3 +41,3 @@ import { Observable } from 'rxjs';
     /** previous pointer position */
-    private pointer;
+    private _pointer;
     private _mouseId;
@@ -44,0 +44,0 @@ private _isUsingFirefox;

lib/types/layer.d.ts

@@ -20,17 +20,25 @@ import { Disposable } from '@univerjs/core';
     /**
-     * get objects which is visible and not in a group.
-     * @returns BaseObject[]
+     * Get direct visible children in order. (direct means object is not in group), default order is ascending by z-index.
+     * @returns {BaseObject[]} objects
      */
     getObjectsByOrder(): BaseObject[];
+    /**
+     * Get visible and evented objects.
+     * @returns {BaseObject[]} objects
+     */
     getObjectsByOrderForPick(): BaseObject[];
     getObjects(): BaseObject[];
     /**
-     * insert o to _objects[]
-     * if o is a group, insert all its children and group itself to _objects[]
+     * Insert object to this._objects, if object is a group, insert all its children and group itself to _objects[]
      * @param o
-     * @returns this
+     * @returns {Layer} this
      */
-    addObject(o: BaseObject): this;
+    addObject(o: BaseObject): Layer;
     removeObject(object: BaseObject | string): void;
-    addObjects(objects: BaseObject[]): this;
+    /**
+     * Insert objects to this._objects, if object is a group, insert all its children and group itself to _objects[]
+     * @param objects
+     * @returns {Layer} this
+     */
+    addObjects(objects: BaseObject[]): Layer;
     removeObjects(objects: BaseObject[] | string[]): void;
@@ -37,0 +45,0 @@ makeDirty(state?: boolean): this;

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

@@ -46,3 +46,3 @@ import { Dependency, DependencyIdentifier, IDisposable, Nullable, UnitModel, UnitType, Disposable, Injector, IUniverInstanceService, UniverInstanceType } from '@univerjs/core';
      * @param type
-     * @param depCtor
+     * @param dep
      */
@@ -107,3 +107,3 @@ registerRenderModule<T extends UnitModel>(type: UnitType, dep: Dependency<T>): IDisposable;
     private _createRender;
-    addRender(unitId: string, item: IRender): void;
+    addRender(unitId: string, renderUnit: IRender): void;
     private _addRenderUnit;
@@ -113,4 +113,4 @@ removeRender(unitId: string): void;
     setCurrent(unitId: string): void;
-    getCurrent(): IRender | undefined;
-    getFirst(): IRender;
+    getCurrent(): Nullable<IRender>;
+    getFirst(): Nullable<IRender>;
     /**
@@ -117,0 +117,0 @@ * get RenderUnit from this._renderMap

lib/types/scene.d.ts

@@ -73,24 +73,38 @@ import { Nullable } from '@univerjs/core';
     addLayer(...argument: Layer[]): void;
-    addObjects(objects: BaseObject[], zIndex?: number): this;
     /**
+     * Add objects to Layer( Layer is specfied by zIndex)
+     * If object is a group, insert all its children and group itself to _objects[].
+     * @param objects
+     * @param zIndex
+     * @returns {Scene} this
+     */
+    addObjects(objects: BaseObject[], zIndex?: number): Scene;
+    /**
      * Add object to Layer (Layer is specified by zIndex).
+     * If object is a group, insert all its children and group itself to _objects[].
      * @param o
      * @param zIndex layer index
-     * @returns scene
+     * @returns {Scene} scene
      */
-    addObject(o: BaseObject, zIndex?: number): this;
+    addObject(o: BaseObject, zIndex?: number): Scene;
     /**
-     * make object parent to scene
+     * Set Scene as object parent, if object has no parent.
      * @param o
+     * @returns {void}
      */
     setObjectBehavior(o: BaseObject): void;
-    removeObject(object?: BaseObject | string): this | undefined;
-    removeObjects(objects?: BaseObject[] | string[]): this | undefined;
+    removeObject(object?: BaseObject | string): Nullable<Scene>;
+    removeObjects(objects?: BaseObject[] | string[]): Nullable<Scene>;
     getObjectsByLayer(zIndex: number): BaseObject[];
     /**
-     * get objects which is visible and not in a group in each layer.
-     * @returns BaseObject[]
+     * Get all objects of each Layer.
+     * @returns {BaseObject[]} objects
      */
     getAllObjects(): BaseObject[];
     /**
+     * Get objects which is visible and not in a group in each layer.
+     * @returns BaseObject[]
+     */
+    getAllObjectsByOrder(): BaseObject[];
+    /**
      * get objects which is visible and not in a group.
@@ -100,6 +114,11 @@ * @param isDesc
      */
-    getAllObjectsByOrder(isDesc?: boolean): BaseObject[];
+    getAllObjectsByDescOrder(isDesc?: boolean): BaseObject[];
+    /**
+     * Get visible and evented objects.
+     * @param isDesc
+     * @returns {BaseObject[]} objects
+     */
     getAllObjectsByOrderForPick(isDesc?: boolean): BaseObject[];
-    getObject(oKey: string): BaseObject | undefined;
-    getObjectIncludeInGroup(oKey: string): BaseObject | undefined;
+    getObject(oKey: string): Nullable<BaseObject>;
+    getObjectIncludeInGroup(oKey: string): Nullable<BaseObject>;
     fuzzyMathObjects(oKey: string, matchStart?: boolean): BaseObject[];
@@ -106,0 +125,0 @@ addViewport(...viewport: Viewport[]): this;

lib/types/shape/shape.d.ts

@@ -105,3 +105,7 @@ import { IOffset, IScale, ISize, Nullable } from '@univerjs/core';
     render(mainCtx: UniverRenderingContext, bounds?: IViewportInfo): this;
-    setProps(props?: T): this | undefined;
+    /**
+     * this[_key] = props[key]
+     * @param props
+     */
+    setProps(props?: T): Shape<T>;
     toJson(): {
@@ -108,0 +112,0 @@ [x: string]: any;

package.json

 {
   "name": "@univerjs/engine-render",
-  "version": "0.2.9",
+  "version": "0.2.10",
   "private": false,
@@ -50,3 +50,3 @@ "description": "UniverSheet normal base-render",
     "rxjs": ">=7.0.0",
-    "@univerjs/core": "0.2.9"
+    "@univerjs/core": "0.2.10"
   },
@@ -64,6 +64,6 @@ "dependencies": {
     "typescript": "^5.5.4",
-    "vite": "^5.4.0",
+    "vite": "^5.4.2",
     "vitest": "^2.0.5",
-    "@univerjs/core": "0.2.9",
-    "@univerjs/shared": "0.2.9"
+    "@univerjs/core": "0.2.10",
+    "@univerjs/shared": "0.2.10"
   },
@@ -70,0 +70,0 @@ "browser": {

No alert changes

Improved metrics

Total package byte prevSize

18796937

increased by0.02%

Lines of code

89871

increased by0.07%

No dependency changes