@univerjs/engine-render 0.2.9 → 0.2.11

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

@@ -1,11 +1,11 @@
 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';
 import { TextRange } from './text-range';
 import { RectRange } from './rect-range';
@@ -187,9 +187,7 @@ export declare class TextSelectionRenderManager extends RxDisposable implements
     private _initInputEvents;
     private _eventHandle;
     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>;

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

@@ -24,5 +24,9 @@ export declare class SpreadsheetColumnHeader extends SpreadsheetHeader {
     draw(ctx: UniverRenderingContext, bounds?: IViewportInfo): void;
     isHit(coord: Vector2): boolean;
     private _initialDefaultExtension;
+    /**
+     * Custimize column header, such as custom header text and background.
+     * @param cfg
+     */
     setCustomHeader(cfg: IColumnsHeaderCfgParam): void;
 }

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

@@ -7,6 +7,9 @@ export interface IColumnsHeaderCfgParam {
     headerStyle?: Partial<IColumnStyleCfg>;
     columnsCfg?: IAColumnCfg[];
 }
+/**
+ * Column Header Bar, include a lot of columns header
+ */
 export declare class ColumnHeaderLayout extends SheetExtension {
     uKey: string;
     Z_INDEX: number;

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

@@ -6,6 +6,16 @@ export declare enum SHEET_EXTENSION_TYPE {
 }
 export declare class SheetExtension extends ComponentExtension<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]> {
     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;
     isRenderDiffRangesByCell(rangeP: IRange, diffRanges?: IRange[]): boolean;
     isRenderDiffRangesByColumn(curStartColumn: number, curEndColumn: number, diffRanges?: IRange[]): boolean;

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

@@ -1,4 +1,4 @@
-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';
 import { DocumentSkeleton } from '../docs/layout/doc-skeleton';
 import { Skeleton } from '../skeleton';
@@ -8,10 +8,7 @@ import { IStylesCache } from './interfaces';
  * @param documentSkeleton Data of the document's ViewModel
  * @param angleInDegree The rotation angle of an Excel cell, it's **degree**
  */
-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 {
     startRow: number;
     endRow: number;
@@ -105,14 +102,13 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     setOverflowCache(value: ObjectMatrix<IRange>): void;
     setMarginLeft(left: number): void;
     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[];
     private _calculateRowAutoHeight;
     /**
      * Calculate data for row col & cell position, then update position value to this._rowHeaderWidth & this._rowHeightAccumulation & this._columnHeaderHeight & this._columnWidthAccumulation.
-     * @returns this
      */
     private _updateLayout;
     private _dynamicallyUpdateRowHeaderWidth;
@@ -127,27 +123,11 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     appendToOverflowCache(row: number, column: number, startColumn: number, endColumn: number): void;
     getColumnCount(): number;
     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.
      * @param offsetY HTML coordinate system, mouse position y.
      * @param scaleX render scene scale x-axis, scene.getAncestorScale
@@ -218,31 +198,7 @@ export declare class SpreadsheetSkeleton extends Skeleton {
      * @param column Specified Column Coordinate
      */
     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: {
         x: number;
         y: number;

package/lib/types/engine.d.ts

@@ -38,7 +38,7 @@ export declare class Engine extends ThinEngine<Scene> {
     private _dropEvent;
     private _remainCapture;
     /** previous pointer position */
-    private pointer;
+    private _pointer;
     private _mouseId;
     private _isUsingFirefox;
     private _previousWidth;

package/lib/types/layer.d.ts

@@ -17,21 +17,29 @@ export declare class Layer extends Disposable {
     disableCache(): void;
     isAllowCache(): boolean;
     /**
-     * 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;
     makeDirty(state?: boolean): this;
     makeDirtyWithDebounce(state?: boolean): void;

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

@@ -43,7 +43,7 @@ export interface IRenderManagerService extends IDisposable {
     /**
      * add dep to _renderDependencies(type, dep)
      * @param type
-     * @param depCtor
+     * @param dep
      */
     registerRenderModule<T extends UnitModel>(type: UnitType, dep: Dependency<T>): IDisposable;
 }
@@ -103,13 +103,13 @@ export declare class RenderManagerService extends Disposable implements IRenderM
      * @returns renderUnit:IRender
      */
     private _createRender;
-    addRender(unitId: string, item: IRender): void;
+    addRender(unitId: string, renderUnit: IRender): void;
     private _addRenderUnit;
     removeRender(unitId: string): void;
     has(unitId: string): boolean;
     setCurrent(unitId: string): void;
-    getCurrent(): IRender | undefined;
-    getFirst(): IRender;
+    getCurrent(): Nullable<IRender>;
+    getFirst(): Nullable<IRender>;
     /**
      * get RenderUnit from this._renderMap
      * @param unitId

package/lib/types/scene.d.ts

@@ -70,36 +70,55 @@ export declare class Scene extends ThinScene {
     getLayer(zIndex?: number): Layer;
     getLayerMaxZIndex(): number;
     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.
      * @param isDesc
      * @returns BaseObject[]
      */
-    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[];
     addViewport(...viewport: Viewport[]): this;
     removeViewport(key: string): Viewport | undefined;

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

@@ -102,7 +102,11 @@ export declare abstract class Shape<T extends IShapeProps> extends BaseObject {
     private static _setFillStyles;
     private static _setStrokeStyles;
     render(mainCtx: UniverRenderingContext, bounds?: IViewportInfo): this;
-    setProps(props?: T): this | undefined;
+    /**
+     * this[_key] = props[key]
+     * @param props
+     */
+    setProps(props?: T): Shape<T>;
     toJson(): {
         [x: string]: any;
     };