@univerjs/engine-render 0.1.17 → 0.2.0

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

@@ -9,8 +9,8 @@ export interface IDocumentSkeletonCached extends ISkeletonResourceReference {
     ed?: number;
 }
 export interface ISkeletonResourceReference {
-    skeHeaders: Map<string, Map<number, IDocumentSkeletonHeader>>;
-    skeFooters: Map<string, Map<number, IDocumentSkeletonFooter>>;
+    skeHeaders: Map<string, Map<number, IDocumentSkeletonHeaderFooter>>;
+    skeFooters: Map<string, Map<number, IDocumentSkeletonHeaderFooter>>;
     skeListLevel?: Map<string, IDocumentSkeletonBullet[]>;
     drawingAnchor?: Map<number, IDocumentSkeletonDrawingAnchor>;
 }
@@ -19,20 +19,6 @@ export interface IDocumentSkeletonDrawingAnchor {
     paragraphIndex: number;
     top: number;
 }
-export interface IDocumentSkeletonHeaderFooterBase {
-    lines: IDocumentSkeletonLine[];
-    skeDrawings: Map<string, IDocumentSkeletonDrawing>;
-    height: number;
-    st: number;
-    ed: number;
-    marginLeft: number;
-}
-export interface IDocumentSkeletonHeader extends IDocumentSkeletonHeaderFooterBase {
-    marginTop: number;
-}
-export interface IDocumentSkeletonFooter extends IDocumentSkeletonHeaderFooterBase {
-    marginBottom: number;
-}
 export interface IDocumentSkeletonPage {
     sections: IDocumentSkeletonSection[];
     headerId: string;
@@ -42,7 +28,9 @@ export interface IDocumentSkeletonPage {
     pageOrient: PageOrientType;
     marginLeft: number;
     marginRight: number;
+    originMarginTop: number;
     marginTop: number;
+    originMarginBottom: number;
     marginBottom: number;
     pageNumber: number;
     pageNumberStart: number;
@@ -57,6 +45,8 @@ export interface IDocumentSkeletonPage {
     renderConfig?: IDocumentRenderConfig;
     parent?: IDocumentSkeletonCached;
 }
+export interface IDocumentSkeletonHeaderFooter extends IDocumentSkeletonPage {
+}
 export interface IDocumentSkeletonSection {
     columns: IDocumentSkeletonColumn[];
     colCount: number;
@@ -127,6 +117,7 @@ export interface IDocumentSkeletonGlyph {
     left: number;
     count: number;
     content: string;
+    raw: string;
     adjustability: IAdjustability;
     isJustifiable: boolean;
     ts?: ITextStyle;

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

@@ -1,6 +1,6 @@
 import { BooleanNumber, GridType, IDocStyleBase, IDocumentLayout, IOffset, IParagraphStyle, IReferenceSource, IScale, ISectionBreakBase, ISize, ITextStyle, ITransformState, LocaleService } from '@univerjs/core';
 import { DocumentViewModel } from '../components/docs/view-model/document-view-model';
-import { IDocumentSkeletonBullet, IDocumentSkeletonDrawing, IDocumentSkeletonDrawingAnchor, IDocumentSkeletonFontStyle, IDocumentSkeletonFooter, IDocumentSkeletonGlyph, IDocumentSkeletonHeader } from './i-document-skeleton-cached';
+import { IDocumentSkeletonBullet, IDocumentSkeletonDrawing, IDocumentSkeletonDrawingAnchor, IDocumentSkeletonFontStyle, IDocumentSkeletonGlyph, IDocumentSkeletonHeaderFooter } from './i-document-skeleton-cached';
 import { Vector2 } from './vector2';
 import { ITransformerConfig } from './transformer-config';
 
@@ -54,7 +54,7 @@ export interface ISectionBreakConfig extends IDocStyleBase, ISectionBreakBase, I
     headerIds?: IHeaderIds;
     footerIds?: IFooterIds;
     useFirstPageHeaderFooter?: BooleanNumber;
-    useEvenPageHeaderFooter?: BooleanNumber;
+    evenAndOddHeaders?: BooleanNumber;
 }
 export interface IParagraphConfig {
     paragraphIndex: number;
@@ -62,8 +62,8 @@ export interface IParagraphConfig {
     paragraphInlineSkeDrawings?: Map<string, IDocumentSkeletonDrawing>;
     bulletSkeleton?: IDocumentSkeletonBullet;
     paragraphStyle?: IParagraphStyle;
-    skeHeaders: Map<string, Map<number, IDocumentSkeletonHeader>>;
-    skeFooters: Map<string, Map<number, IDocumentSkeletonFooter>>;
+    skeHeaders: Map<string, Map<number, IDocumentSkeletonHeaderFooter>>;
+    skeFooters: Map<string, Map<number, IDocumentSkeletonHeaderFooter>>;
     drawingAnchor?: Map<number, IDocumentSkeletonDrawingAnchor>;
 }
 export interface IFontCreateConfig {
@@ -78,6 +78,8 @@ export interface INodeInfo {
     node: IDocumentSkeletonGlyph;
     ratioX: number;
     ratioY: number;
+    segmentId: string;
+    segmentPage: number;
 }
 export interface INodeSearch {
     glyph: number;
@@ -86,6 +88,8 @@ export interface INodeSearch {
     column: number;
     section: number;
     page: number;
+    segmentPage: number;
+    isInBody: boolean;
 }
 export interface INodePosition extends INodeSearch {
     isBack: boolean;

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

@@ -13,6 +13,8 @@ export interface ITextRangeWithStyle extends ITextRangeParam {
 export interface ISuccinctTextRangeParam {
     startOffset: number;
     endOffset: number;
+    segmentId?: string;
+    segmentPage?: number;
     style?: ITextSelectionStyle;
 }
 export declare enum RANGE_DIRECTION {

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

@@ -1,4 +1,4 @@
-import { IRange, IRangeWithCoord, IScale, ISelectionCellWithCoord, IStyleBase, LocaleService, Nullable } from '@univerjs/core';
+import { IRange, IRangeWithCoord, IScale, ISelectionCellWithMergeInfo, IStyleBase, LocaleService, Nullable } from '@univerjs/core';
 import { IBoundRectNoAngle } from './vector2';
 import { IDocumentSkeletonFontStyle } from './i-document-skeleton-cached';
 
@@ -72,7 +72,7 @@ export declare function getCellPositionByIndex(row: number, column: number, rowH
     startX: number;
     endX: number;
 };
-export declare function getCellByIndex(row: number, column: number, rowHeightAccumulation: number[], columnWidthAccumulation: number[], mergeData: IRange[]): ISelectionCellWithCoord;
+export declare function getCellByIndex(row: number, column: number, rowHeightAccumulation: number[], columnWidthAccumulation: number[], mergeData: IRange[]): ISelectionCellWithMergeInfo;
 /**
  * Determine whether there are any cells in a row that are not in the merged cells, mainly used for the calculation of auto height
  */
@@ -84,9 +84,9 @@ export declare function mergeInfoOffset(mergeInfo: IRangeWithCoord, offsetX: num
     endY: number;
     startColumn: number;
     endColumn: number;
-    rangeType?: import('@univerjs/core').RANGE_TYPE | undefined;
-    startAbsoluteRefType?: import('@univerjs/core').AbsoluteRefType | undefined;
-    endAbsoluteRefType?: import('@univerjs/core').AbsoluteRefType | undefined;
+    rangeType?: import('@univerjs/core').RANGE_TYPE;
+    startAbsoluteRefType?: import('@univerjs/core').AbsoluteRefType;
+    endAbsoluteRefType?: import('@univerjs/core').AbsoluteRefType;
     startRow: number;
     endRow: number;
 };

package/lib/types/components/docs/document.d.ts

@@ -29,9 +29,10 @@ export declare class Documents extends DocComponent {
     dispose(): void;
     getOffsetConfig(): IDocumentOffsetConfig;
     getEngine(): Nullable<import('../..').ThinEngine<Scene>>;
-    draw(ctx: UniverRenderingContext, bounds?: IViewportInfo): void;
     changeSkeleton(newSkeleton: DocumentSkeleton): this;
     protected _draw(ctx: UniverRenderingContext, bounds?: IViewportInfo): void;
+    draw(ctx: UniverRenderingContext, bounds?: IViewportInfo): void;
+    private _drawHeaderFooter;
     private _horizontalHandler;
     private _verticalHandler;
     private _startRotation;

package/lib/types/components/docs/layout/block/paragraph/language-ruler.d.ts

@@ -3,19 +3,19 @@ import { ISectionBreakConfig } from '../../../../../basics/interfaces';
 import { DataStreamTreeNode } from '../../../view-model/data-stream-tree-node';
 import { DocumentViewModel } from '../../../view-model/document-view-model';
 
-export declare function otherHandler(index: number, charArray: string, bodyModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraphStyle: IParagraphStyle): {
+export declare function otherHandler(index: number, charArray: string, viewModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraphStyle: IParagraphStyle): {
     step: number;
     glyphGroup: import('../../../../..').IDocumentSkeletonGlyph[];
 };
-export declare function ArabicHandler(index: number, charArray: string, bodyModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraphStyle: IParagraphStyle): {
+export declare function ArabicHandler(index: number, charArray: string, viewModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraphStyle: IParagraphStyle): {
     step: number;
     glyphGroup: import('../../../../..').IDocumentSkeletonGlyph[];
 };
-export declare function emojiHandler(index: number, charArray: string, bodyModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraphStyle: IParagraphStyle): {
+export declare function emojiHandler(index: number, charArray: string, viewModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraphStyle: IParagraphStyle): {
     step: number;
     glyphGroup: import('../../../../..').IDocumentSkeletonGlyph[];
 };
-export declare function TibetanHandler(index: number, charArray: string, bodyModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraphStyle: IParagraphStyle): {
+export declare function TibetanHandler(index: number, charArray: string, viewModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraphStyle: IParagraphStyle): {
     step: number;
     glyphGroup: import('../../../../..').IDocumentSkeletonGlyph[];
 };

package/lib/types/components/docs/layout/block/paragraph/linebreaking.d.ts

@@ -2,6 +2,7 @@ import { IDocumentSkeletonPage } from '../../../../../basics/i-document-skeleton
 import { ILayoutContext } from '../../tools';
 import { DataStreamTreeNode } from '../../../view-model/data-stream-tree-node';
 import { ISectionBreakConfig } from '../../../../../basics/interfaces';
+import { DocumentViewModel } from '../../../view-model/document-view-model';
 import { IShapedText } from './shaping';
 
-export declare function lineBreaking(ctx: ILayoutContext, shapedTextList: IShapedText[], curPage: IDocumentSkeletonPage, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig): IDocumentSkeletonPage[];
+export declare function lineBreaking(ctx: ILayoutContext, viewModel: DocumentViewModel, shapedTextList: IShapedText[], curPage: IDocumentSkeletonPage, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig): IDocumentSkeletonPage[];

package/lib/types/components/docs/layout/doc-skeleton.d.ts

@@ -1,9 +1,9 @@
 import { LocaleService, Nullable } from '@univerjs/core';
-import { IDocumentSkeletonCached, IDocumentSkeletonGlyph, PageLayoutType } from '../../../basics/i-document-skeleton-cached';
+import { IDocumentSkeletonCached, IDocumentSkeletonGlyph, IDocumentSkeletonPage, PageLayoutType } from '../../../basics/i-document-skeleton-cached';
 import { INodeInfo, INodePosition, INodeSearch } from '../../../basics/interfaces';
 import { IViewportInfo, Vector2 } from '../../../basics/vector2';
 import { Skeleton } from '../../skeleton';
-import { DocumentViewModel } from '../view-model/document-view-model';
+import { DocumentViewModel, DocumentEditArea } from '../view-model/document-view-model';
 
 export declare enum DocumentSkeletonState {
     PENDING = "pending",
@@ -30,10 +30,15 @@ export declare class DocumentSkeleton extends Skeleton {
     };
     private _getPageActualWidth;
     getPageSize(): import('@univerjs/core').ISize | undefined;
-    findPositionByGlyph(glyph: IDocumentSkeletonGlyph): Nullable<INodeSearch>;
-    findNodePositionByCharIndex(charIndex: number, isBack?: boolean): Nullable<INodePosition>;
-    findNodeByCharIndex(charIndex: number): Nullable<IDocumentSkeletonGlyph>;
+    findPositionByGlyph(glyph: IDocumentSkeletonGlyph, segmentPage: number): Nullable<INodeSearch>;
+    findNodePositionByCharIndex(charIndex: number, isBack?: boolean, segmentId?: string, segmentPIndex?: number): Nullable<INodePosition>;
+    findNodeByCharIndex(charIndex: number, segmentId?: string, segmentPageIndex?: number): Nullable<IDocumentSkeletonGlyph>;
     findGlyphByPosition(position: Nullable<INodePosition>): IDocumentSkeletonGlyph | undefined;
+    findEditAreaByCoord(coord: Vector2, pageLayoutType: PageLayoutType, pageMarginLeft: number, pageMarginTop: number): {
+        editArea: DocumentEditArea;
+        pageNumber: number;
+        page: Nullable<IDocumentSkeletonPage>;
+    };
     findNodeByCoord(coord: Vector2, pageLayoutType: PageLayoutType, pageMarginLeft: number, pageMarginTop: number): Nullable<INodeInfo>;
     private _getNearestNode;
     private _getPageBoundingBox;
@@ -68,5 +73,5 @@ export declare class DocumentSkeleton extends Skeleton {
      */
     private _createSkeleton;
     private _addNewSectionByContinuous;
-    private _findNodeIterator;
+    private _findNodeByIndex;
 }

package/lib/types/components/docs/layout/shaping-engine/text-shaping.d.ts

@@ -1,6 +1,5 @@
-import { IDocumentBody } from '@univerjs/core';
+import { IDocumentBody, Nullable } from '@univerjs/core';
 import { default as Opentype } from 'opentype.js';
-import { Nullable } from 'vitest';
 
 interface IBoundingBox {
     x1: number;

package/lib/types/components/docs/layout/style/custom-decoration.d.ts

@@ -0,0 +1,3 @@
+import { ICustomDecorationForInterceptor, ITextStyle, Nullable } from '@univerjs/core';
+
+export declare function getCustomDecorationStyle(customDecoration: ICustomDecorationForInterceptor): Nullable<ITextStyle>;

package/lib/types/components/docs/layout/style/custom-range.d.ts

@@ -0,0 +1,3 @@
+import { ICustomRangeForInterceptor, ITextStyle, Nullable } from '@univerjs/core';
+
+export declare function getCustomRangeStyle(customRange: ICustomRangeForInterceptor): Nullable<ITextStyle>;

package/lib/types/components/docs/layout/tools.d.ts

@@ -72,7 +72,7 @@ export declare function getFontConfigFromLastGlyph(glyph: IDocumentSkeletonGlyph
     snapToGrid: BooleanNumber;
     pageWidth: number;
 };
-export declare function getFontCreateConfig(index: number, bodyModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraphStyle: IParagraphStyle): IFontCreateConfig;
+export declare function getFontCreateConfig(index: number, viewModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraphStyle: IParagraphStyle): IFontCreateConfig;
 export declare function getNullSkeleton(): IDocumentSkeletonCached;
 export declare function setPageParent(pages: IDocumentSkeletonPage[], parent: IDocumentSkeletonCached): void;
 export interface ILayoutContext {

package/lib/types/components/docs/liquid.d.ts

@@ -33,7 +33,7 @@ export declare class Liquid {
         x: number;
         y: number;
     };
-    translateSpan(glyph: IDocumentSkeletonGlyph): {
+    translateGlyph(glyph: IDocumentSkeletonGlyph): {
         x: number;
         y: number;
     };

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

@@ -16,6 +16,12 @@ export declare function getAnchorBounding(pointsGroup: IPoint[][]): {
     width: number;
     height: number;
 };
+export declare function getLineBounding(pointsGroup: IPoint[][]): {
+    left: number;
+    right: number;
+    top: number;
+    bottom: number;
+}[];
 export declare class TextRange {
     private _scene;
     private _document;

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

@@ -19,6 +19,7 @@ export interface ITextSelectionInnerParam {
     segmentId: string;
     isEditing: boolean;
     style: ITextSelectionStyle;
+    segmentPage: number;
 }
 export interface IActiveTextRange {
     startOffset: number;
@@ -28,6 +29,7 @@ export interface IActiveTextRange {
     endNodePosition: Nullable<INodePosition>;
     direction: RANGE_DIRECTION;
     segmentId: string;
+    segmentPage: number;
     style: ITextSelectionStyle;
 }
 export interface ITextSelectionRenderManager {
@@ -47,6 +49,8 @@ export interface ITextSelectionRenderManager {
     enableSelection(): void;
     disableSelection(): void;
     setSegment(id: string): void;
+    setSegmentPage(pageIndex: number): void;
+    getSegmentPage(): number;
     setStyle(style: ITextSelectionStyle): void;
     resetStyle(): void;
     removeAllTextRanges(): void;
@@ -98,8 +102,11 @@ export declare class TextSelectionRenderManager extends RxDisposable implements
     private _inputParent;
     private _input;
     private _scrollTimers;
+    private _viewportScrollX;
+    private _viewportScrollY;
     private _rangeList;
     private _currentSegmentId;
+    private _currentSegmentPage;
     private _selectionStyle;
     private _isSelectionEnabled;
     private _viewPortObserverMap;
@@ -114,11 +121,14 @@ export declare class TextSelectionRenderManager extends RxDisposable implements
     __getEditorContainer(): HTMLElement;
     getViewPort(): Viewport;
     setSegment(id: string): void;
+    setSegmentPage(pageIndex: number): void;
+    getSegmentPage(): number;
     setStyle(style?: ITextSelectionStyle): void;
     resetStyle(): void;
     enableSelection(): void;
     disableSelection(): void;
     addTextRanges(ranges: ISuccinctTextRangeParam[], isEditing?: boolean): void;
+    setCursorManually(evtOffsetX: number, evtOffsetY: number): void;
     sync(): void;
     activate(x: number, y: number): void;
     hasFocus(): boolean;
@@ -128,7 +138,6 @@ export declare class TextSelectionRenderManager extends RxDisposable implements
     changeRuntime(docSkeleton: DocumentSkeleton, scene: Scene, document: Documents): void;
     handleDblClick(evt: IPointerEvent | IMouseEvent): void;
     handleTripleClick(evt: IPointerEvent | IMouseEvent): void;
-    setCursorManually(evtOffsetX: number, evtOffsetY: number): void;
     eventTrigger(evt: IPointerEvent | IMouseEvent): void;
     removeAllTextRanges(): void;
     private _setSystemHighlightColorToStyle;

package/lib/types/components/docs/view-model/document-view-model.d.ts

@@ -1,9 +1,19 @@
-import { IDocumentBody, ITextRun, DocumentDataModel } from '@univerjs/core';
+import { ICustomDecorationForInterceptor, ICustomRangeForInterceptor, IDocumentBody, ITextRun, Nullable, DocumentDataModel } from '@univerjs/core';
 import { IDisposable } from '@wendellhu/redi';
 import { DataStreamTreeNode } from './data-stream-tree-node';
 
+export interface ICustomRangeInterceptor {
+    getCustomRange: (index: number) => Nullable<ICustomRangeForInterceptor>;
+    getCustomDecoration: (index: number) => Nullable<ICustomDecorationForInterceptor>;
+}
+export declare enum DocumentEditArea {
+    BODY = "BODY",
+    HEADER = "HEADER",
+    FOOTER = "FOOTER"
+}
 export declare class DocumentViewModel implements IDisposable {
     private _documentDataModel;
+    private _interceptor;
     children: DataStreamTreeNode[];
     private _sectionBreakCurrentIndex;
     private _paragraphCurrentIndex;
@@ -11,11 +21,17 @@ export declare class DocumentViewModel implements IDisposable {
     private _customBlockCurrentIndex;
     private _tableBlockCurrentIndex;
     private _customRangeCurrentIndex;
+    private _editArea;
+    private readonly _editAreaChange$;
+    readonly editAreaChange$: import('rxjs').Observable<Nullable<DocumentEditArea>>;
     headerTreeMap: Map<string, DocumentViewModel>;
     footerTreeMap: Map<string, DocumentViewModel>;
     constructor(_documentDataModel: DocumentDataModel);
+    registerCustomRangeInterceptor(interceptor: ICustomRangeInterceptor): IDisposable;
     dispose(): void;
     selfPlus(len: number, index: number): void;
+    getEditArea(): DocumentEditArea;
+    setEditArea(editArea: DocumentEditArea): void;
     getPositionInParent(): number;
     getLastIndex(): number;
     getBody(): IDocumentBody | undefined;
@@ -36,7 +52,10 @@ export declare class DocumentViewModel implements IDisposable {
     getTextRun(index: number): ITextRun | undefined;
     getCustomBlock(index: number): import('@univerjs/core').ICustomBlock | undefined;
     getTable(index: number): import('@univerjs/core').ITable | undefined;
-    getCustomRange(index: number): import('@univerjs/core').ICustomRange | undefined;
+    getCustomRangeRaw(index: number): import('@univerjs/core').ICustomRange | undefined;
+    getCustomRange(index: number): Nullable<ICustomRangeForInterceptor>;
+    getCustomDecorationRaw(index: number): import('@univerjs/core').ICustomDecoration | undefined;
+    getCustomDecoration(index: number): Nullable<ICustomDecorationForInterceptor>;
     protected _transformToTree(dataStream: string): DataStreamTreeNode[];
     private _processPreviousNodesUntil;
     private _batchParent;

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

@@ -7,7 +7,7 @@ export declare enum SHEET_EXTENSION_TYPE {
 }
 export declare class SheetExtension extends ComponentExtension<SpreadsheetSkeleton, SHEET_EXTENSION_TYPE, IRange[]> {
     type: SHEET_EXTENSION_TYPE;
-    getCellIndex(rowIndex: number, columnIndex: number, rowHeightAccumulation: number[], columnWidthAccumulation: number[], dataMergeCache: IRange[]): import('@univerjs/core').ISelectionCellWithCoord;
+    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;
     isRenderDiffRangesByRow(curStartRow: number, curEndRow: number, diffRanges?: IRange[]): boolean;

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

@@ -1,4 +1,4 @@
-import { BorderStyleTypes, HorizontalAlign, ISelectionCellWithCoord, ObjectMatrix, VerticalAlign, WrapStrategy } from '@univerjs/core';
+import { BorderStyleTypes, HorizontalAlign, ISelectionCellWithMergeInfo, ObjectMatrix, VerticalAlign, WrapStrategy } from '@univerjs/core';
 import { BORDER_TYPE } from '../../basics/const';
 import { DocumentSkeleton } from '../docs/layout/doc-skeleton';
 import { Canvas } from '../../canvas';
@@ -28,7 +28,7 @@ interface fontCache {
 }
 export interface IStylesCache {
     background?: backgroundCache;
-    backgroundPositions?: ObjectMatrix<ISelectionCellWithCoord>;
+    backgroundPositions?: ObjectMatrix<ISelectionCellWithMergeInfo>;
     font?: fontCache;
     border?: ObjectMatrix<BorderCache>;
 }

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, ISelectionCellWithCoord, ITextRotation, IWorksheetData, Nullable, Styles, Worksheet } from '@univerjs/core';
+import { BooleanNumber, DocumentDataModel, HorizontalAlign, IContextService, LocaleService, ObjectMatrix, VerticalAlign, WrapStrategy, ICellData, IPaddingData, IRange, IRowAutoHeightInfo, ISelectionCellWithMergeInfo, 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';
@@ -165,7 +165,7 @@ export declare class SpreadsheetSkeleton extends Skeleton {
     calculateCellIndexByPosition(offsetX: number, offsetY: number, scaleX: number, scaleY: number, scrollXY: {
         x: number;
         y: number;
-    }): Nullable<ISelectionCellWithCoord>;
+    }): Nullable<ISelectionCellWithMergeInfo>;
     /**
      *
      * @param offsetX HTML coordinate system, mouse position x.
@@ -222,7 +222,7 @@ export declare class SpreadsheetSkeleton extends Skeleton {
      * @param row Specified Row Coordinate
      * @param column Specified Column Coordinate
      */
-    getCellByIndex(row: number, column: number): ISelectionCellWithCoord;
+    getCellByIndex(row: number, column: number): ISelectionCellWithMergeInfo;
     getCellByIndexWithNoHeader(row: number, column: number): {
         actualRow: number;
         actualColumn: number;
@@ -239,9 +239,9 @@ export declare class SpreadsheetSkeleton extends Skeleton {
             endY: number;
             startColumn: number;
             endColumn: number;
-            rangeType?: import('@univerjs/core').RANGE_TYPE | undefined;
-            startAbsoluteRefType?: import('@univerjs/core').AbsoluteRefType | undefined;
-            endAbsoluteRefType?: import('@univerjs/core').AbsoluteRefType | undefined;
+            rangeType?: import('@univerjs/core').RANGE_TYPE;
+            startAbsoluteRefType?: import('@univerjs/core').AbsoluteRefType;
+            endAbsoluteRefType?: import('@univerjs/core').AbsoluteRefType;
             startRow: number;
             endRow: number;
         };
@@ -254,12 +254,7 @@ export declare class SpreadsheetSkeleton extends Skeleton {
         x: number;
         y: number;
     }): number;
-    getSelectionBounding(startRow: number, startColumn: number, endRow: number, endColumn: number): {
-        startRow: number;
-        startColumn: number;
-        endRow: number;
-        endColumn: number;
-    };
+    getSelectionBounding(startRow: number, startColumn: number, endRow: number, endColumn: number): IRange;
     getBlankCellDocumentModel(cell: Nullable<ICellData>): IDocumentLayoutObject;
     getCellDocumentModelWithFormula(cell: ICellData): Nullable<IDocumentLayoutObject>;
     private _getCellDocumentModel;

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

@@ -65,7 +65,6 @@ export declare class Spreadsheet extends SheetComponent {
     /**
      * Since multiple controllers, not just the sheet-render.controller, invoke spreadsheet.makeDirty() — for instance, the cf.render-controller — it's essential to also call viewport.markDirty() whenever spreadsheet.makeDirty() is triggered.
      * @param state
-     * @returns
      */
     makeDirty(state?: boolean): this;
     setDirtyArea(dirtyBounds: IBoundRectNoAngle[]): void;

package/lib/types/engine.d.ts

@@ -24,6 +24,8 @@ export declare class Engine extends ThinEngine<Scene> {
     private _pointerMoveEvent;
     private _pointerDownEvent;
     private _pointerUpEvent;
+    private _pointerOutEvent;
+    private _pointerCancelEvent;
     private _pointerBlurEvent;
     private _pointerWheelEvent;
     private _pointerEnterEvent;

package/lib/types/index.d.ts

@@ -31,7 +31,7 @@ export * from './scroll-timer';
 export * from './shape';
 export * from './viewport';
 export { DocumentViewModel } from './components/docs/view-model/document-view-model';
-export { getAnchorBounding, TEXT_RANGE_LAYER_INDEX, TextRange } from './components/docs/text-selection/text-range';
+export { getAnchorBounding, TEXT_RANGE_LAYER_INDEX, TextRange, getLineBounding } from './components/docs/text-selection/text-range';
 export { NodePositionConvertToCursor } from './components/docs/text-selection/convert-cursor';
 export { Liquid } from './components/docs/liquid';
 export { ITextSelectionRenderManager, TextSelectionRenderManager, getCanvasOffsetByEngine, } from './components/docs/text-selection/text-selection-render-manager';
@@ -44,3 +44,4 @@ export { ThinEngine } from './thin-engine';
 export { getCharSpaceApply, getNumberUnitValue } from './components/docs/layout/tools';
 export { type IChangeObserverConfig } from './scene.transformer';
 export { DEFAULT_PADDING_DATA } from './components/sheets/sheet-skeleton';
+export { DocumentEditArea } from './components/docs/view-model/document-view-model';

package/lib/types/layer.d.ts

@@ -20,6 +20,12 @@ export declare class Layer extends Disposable {
     getObjectsByOrder(): BaseObject[];
     getObjectsByOrderForPick(): BaseObject[];
     getObjects(): BaseObject[];
+    /**
+     * insert o to _objects[]
+     * if o is a group, insert all its children and group itself to _objects[]
+     * @param o
+     * @returns
+     */
     addObject(o: BaseObject): this;
     removeObject(object: BaseObject | string): void;
     addObjects(objects: BaseObject[]): this;

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

@@ -29,7 +29,7 @@ export interface IRenderContext<T extends UnitModel = UnitModel> extends Omit<IR
  * This class is responsible
  */
 export declare class RenderUnit extends Disposable implements IRender {
-    readonly isRenderUnit: true;
+    readonly isRenderUnit: boolean;
     get unitId(): string;
     get type(): UnitType;
     private readonly _injector;

package/lib/types/scene.d.ts

@@ -70,11 +70,16 @@ export declare class Scene extends ThinScene {
     getLayer(zIndex?: number): Layer;
     getLayerMaxZIndex(): number;
     addLayer(...argument: Layer[]): void;
+    addObjects(objects: BaseObject[], zIndex?: number): this;
     addObject(o: BaseObject, zIndex?: number): this;
+    /**
+     * make object parent to scene
+     * @param o
+     */
     setObjectBehavior(o: BaseObject): void;
-    addObjects(objects: BaseObject[], zIndex?: number): this;
     removeObject(object?: BaseObject | string): this | undefined;
     removeObjects(objects?: BaseObject[] | string[]): this | undefined;
+    getObjectsByLayer(zIndex: number): BaseObject[];
     getAllObjects(): BaseObject[];
     getAllObjectsByOrder(isDesc?: boolean): BaseObject[];
     getAllObjectsByOrderForPick(isDesc?: boolean): BaseObject[];
@@ -119,7 +124,7 @@ export declare class Scene extends ThinScene {
         scaleY: number;
     };
     dispose(): void;
-    pick(coord: Vector2): Nullable<BaseObject | Scene | ThinScene>;
+    pick(vec: Vector2): Nullable<BaseObject | Scene | ThinScene>;
     triggerKeyDown(evt: IKeyboardEvent): void;
     triggerKeyUp(evt: IKeyboardEvent): void;
     triggerPointerUp(evt: IPointerEvent | IMouseEvent): boolean;

package/lib/types/scene.input-manager.d.ts

@@ -18,6 +18,8 @@ export declare class InputManager extends Disposable {
     private _onPointerMove;
     private _onPointerDown;
     private _onPointerUp;
+    private _onPointerOut;
+    private _onPointerCancel;
     private _onPointerEnter;
     private _onPointerLeave;
     private _onMouseWheel;
@@ -42,7 +44,7 @@ export declare class InputManager extends Disposable {
     dispose(): void;
     mouseLeaveEnterHandler(evt: IMouseEvent): void;
     dragLeaveEnterHandler(evt: IMouseEvent): void;
-    attachControl(hasDown?: boolean, hasUp?: boolean, hasMove?: boolean, hasWheel?: boolean, hasEnter?: boolean, hasLeave?: boolean): void;
+    attachControl(hasDown?: boolean, hasUp?: boolean, enableMove?: boolean, hasWheel?: boolean, hasEnter?: boolean, hasLeave?: boolean): void;
     /**
      * Detaches all event handlers
      */

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

@@ -0,0 +1,8 @@
+import { IViewportInfo } from '../basics/vector2';
+import { UniverRenderingContext } from '../context';
+import { IRectProps, Rect } from './rect';
+
+export declare class DashedRect extends Rect {
+    static drawWith(ctx: UniverRenderingContext, props: IRectProps | Rect): void;
+    protected _draw(ctx: UniverRenderingContext, viewportInfo?: IViewportInfo): void;
+}

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

@@ -24,3 +24,4 @@ export * from './rich-text';
 export * from './scroll-bar';
 export * from './shape';
 export * from './checkbox';
+export * from './dashedrect';

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

@@ -1,4 +1,4 @@
-import { IScale, Nullable } from '@univerjs/core';
+import { IOffset, IScale, ISize, Nullable } from '@univerjs/core';
 import { BaseObject } from '../base-object';
 import { IObjectFullState } from '../basics/interfaces';
 import { IViewportInfo, Vector2 } from '../basics/vector2';
@@ -7,7 +7,7 @@ import { UniverRenderingContext } from '../context';
 export type LineJoin = 'round' | 'bevel' | 'miter';
 export type LineCap = 'butt' | 'round' | 'square';
 export type PaintFirst = 'fill' | 'stroke';
-export interface IShapeProps extends IObjectFullState {
+export interface IShapeProps extends IObjectFullState, ISize, IOffset, IScale {
     hoverCursor?: Nullable<string>;
     moveCursor?: string | null;
     fillRule?: string;

package/lib/types/thin-scene.d.ts

@@ -16,6 +16,8 @@ export declare abstract class ThinScene extends Disposable {
     onPointerMove$: EventSubject<IMouseEvent | IPointerEvent>;
     onPointerUp$: EventSubject<IMouseEvent | IPointerEvent>;
     onPointerEnter$: EventSubject<IMouseEvent | IPointerEvent>;
+    onPointerOut$: EventSubject<IMouseEvent | IPointerEvent>;
+    onPointerCancel$: EventSubject<IMouseEvent | IPointerEvent>;
     onPointerLeave$: EventSubject<IMouseEvent | IPointerEvent>;
     onDragEnter$: EventSubject<IDragEvent>;
     onDragOver$: EventSubject<IDragEvent>;