@univerjs/engine-render 0.2.5 → 0.2.7

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

@@ -1,21 +1,18 @@
 import { Nullable, ILogService, RxDisposable } from '@univerjs/core';
 import { Observable } from 'rxjs';
 import { IMouseEvent, IPointerEvent } from '../../../basics/i-events';
-import { INodePosition } from '../../../basics/interfaces';
-import { ISuccinctTextRangeParam, ITextRangeWithStyle, ITextSelectionStyle, RANGE_DIRECTION } from '../../../basics/range';
-import { Engine } from '../../../engine';
+import { INodeInfo, INodePosition } from '../../../basics/interfaces';
+import { ISuccinctDocRangeParam, ITextRangeWithStyle, ITextSelectionStyle, RANGE_DIRECTION } from '../../../basics/range';
 import { Scene } from '../../../scene';
 import { Viewport } from '../../../viewport';
-import { DocumentSkeleton } from '../layout/doc-skeleton';
+import { DocumentSkeleton, IFindNodeRestrictions } from '../layout/doc-skeleton';
 import { Documents } from '../document';
 import { TextRange } from './text-range';
+import { RectRange } from './rect-range';
 
-export declare function getCanvasOffsetByEngine(engine: Nullable<Engine>): {
-    left: number;
-    top: number;
-};
 export interface ITextSelectionInnerParam {
     textRanges: TextRange[];
+    rectRanges: RectRange[];
     segmentId: string;
     isEditing: boolean;
     style: ITextSelectionStyle;
@@ -58,8 +55,8 @@ export interface ITextSelectionRenderManager {
     getSegmentPage(): number;
     setStyle(style: ITextSelectionStyle): void;
     resetStyle(): void;
-    removeAllTextRanges(): void;
-    addTextRanges(ranges: ISuccinctTextRangeParam[], isEditing?: boolean, options?: {
+    removeAllRanges(): void;
+    addDocRanges(ranges: ISuccinctDocRangeParam[], isEditing?: boolean, options?: {
         [key: string]: boolean;
     }): void;
     sync(): void;
@@ -74,7 +71,7 @@ export interface ITextSelectionRenderManager {
     dispose(): void;
     handleDblClick(evt: IPointerEvent | IMouseEvent): void;
     handleTripleClick(evt: IPointerEvent | IMouseEvent): void;
-    eventTrigger(evt: IPointerEvent | IMouseEvent): void;
+    onPointDown(evt: IPointerEvent | IMouseEvent): void;
     setCursorManually(evtOffsetX: number, evtOffsetY: number): void;
 }
 export interface IEditorInputConfig {
@@ -113,9 +110,12 @@ export declare class TextSelectionRenderManager extends RxDisposable implements
     private _inputParent;
     private _input;
     private _scrollTimers;
-    private _viewportScrollX;
-    private _viewportScrollY;
     private _rangeList;
+    private _rangeListCache;
+    private _rectRangeList;
+    private _rectRangeListCache;
+    private _anchorNodePosition;
+    private _focusNodePosition;
     private _currentSegmentId;
     private _currentSegmentPage;
     private _selectionStyle;
@@ -140,7 +140,7 @@ export declare class TextSelectionRenderManager extends RxDisposable implements
     resetStyle(): void;
     enableSelection(): void;
     disableSelection(): void;
-    addTextRanges(ranges: ISuccinctTextRangeParam[], isEditing?: boolean, options?: {
+    addDocRanges(ranges: ISuccinctDocRangeParam[], isEditing?: boolean, options?: {
         [key: string]: boolean;
     }): void;
     setCursorManually(evtOffsetX: number, evtOffsetY: number): void;
@@ -155,23 +155,31 @@ 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;
-    eventTrigger(evt: IPointerEvent | IMouseEvent): void;
-    removeAllTextRanges(): void;
+    onPointDown(evt: IPointerEvent | IMouseEvent): void;
+    removeAllRanges(): void;
     private _setSystemHighlightColorToStyle;
     private _getAllTextRanges;
+    private _getAllRectRanges;
     private _getActiveRange;
-    private _add;
     private _getActiveRangeInstance;
     dispose(): void;
     private _initDOM;
     private _initInput;
     private _getNodePosition;
-    private _interactTextRange;
+    private _interactTextRanges;
+    private _interactRectRanges;
+    private _removeAllRanges;
+    private _removeAllCacheRanges;
     private _removeAllTextRanges;
+    private _removeAllRectRanges;
     private _deactivateAllTextRanges;
+    private _deactivateAllRectRanges;
+    private _addTextRangesToCache;
     private _addTextRange;
+    private _addRectRangesToCache;
+    private _addRectRanges;
     private _updateTextRangeAnchorPosition;
-    private _updateActiveRangeFocusPosition;
+    private _updateActiveRangePosition;
     private _isEmpty;
     private _getCanvasOffset;
     private _updateInputPosition;
@@ -180,7 +188,7 @@ export declare class TextSelectionRenderManager extends RxDisposable implements
     private _initInputEvents;
     private _eventHandle;
     private _getTransformCoordForDocumentOffset;
-    private _findNodeByCoord;
+    findNodeByCoord(evtOffsetX: number, evtOffsetY: number, restrictions: IFindNodeRestrictions): Nullable<INodeInfo>;
     private _getNodeIndex;
     private _detachEvent;
     private _activeSelectionRefresh;

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

@@ -10,6 +10,7 @@ export declare enum DocumentEditArea {
     HEADER = "HEADER",
     FOOTER = "FOOTER"
 }
+export declare function parseDataStreamToTree(dataStream: string): DataStreamTreeNode[];
 export declare class DocumentViewModel implements IDisposable {
     private _documentDataModel;
     private _interceptor;
@@ -28,12 +29,13 @@ export declare class DocumentViewModel implements IDisposable {
     constructor(_documentDataModel: DocumentDataModel);
     registerCustomRangeInterceptor(interceptor: ICustomRangeInterceptor): IDisposable;
     dispose(): void;
-    selfPlus(len: number, index: number): void;
+    selfPlus(_len: number, _index: number): void;
     getEditArea(): DocumentEditArea;
     setEditArea(editArea: DocumentEditArea): void;
     getPositionInParent(): number;
     getLastIndex(): number;
     getBody(): IDocumentBody | undefined;
+    getSnapshot(): import('@univerjs/core').IDocumentData;
     getDataModel(): DocumentDataModel;
     getSelfOrHeaderFooterViewModel(segmentId?: string): DocumentViewModel;
     reset(documentDataModel: DocumentDataModel): void;
@@ -43,7 +45,7 @@ export declare class DocumentViewModel implements IDisposable {
     getText(): string;
     resetCache(): void;
     getSectionBreak(index: number): import('@univerjs/core').ISectionBreak | undefined;
-    getParagraph(index: number): import('@univerjs/core').IParagraph | undefined;
+    getParagraph(index: number, fromStart?: boolean): import('@univerjs/core').IParagraph | undefined;
     getTextRunRange(startIndex: number | undefined, endIndex: number): ITextRun[];
     /**
      * textRun matches according to the selection. If the text length is 10, then the range of textRun is from 0 to 11.
@@ -56,9 +58,6 @@ export declare class DocumentViewModel implements IDisposable {
     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;
     private _buildHeaderFooterViewModel;
     private _getParagraphByIndex;
     private _forEachTop;

package/lib/types/engine.d.ts

@@ -64,6 +64,11 @@ export declare class Engine extends ThinEngine<Scene> {
     getPixelRatio(): number;
     setContainer(elem: HTMLElement, resize?: boolean): void;
     resize(): void;
+    /**
+     * set canvas element size
+     * @param width
+     * @param height
+     */
     resizeBySize(width: number, height: number): void;
     dispose(): void;
     /**

package/lib/types/index.d.ts

@@ -32,9 +32,11 @@ export * from './shape';
 export * from './viewport';
 export { DocumentViewModel } from './components/docs/view-model/document-view-model';
 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 { RectRange, convertPositionsToRectRanges } from './components/docs/text-selection/rect-range';
+export { NodePositionConvertToCursor } from './components/docs/text-selection/convert-text-range';
 export { Liquid } from './components/docs/liquid';
-export { ITextSelectionRenderManager, TextSelectionRenderManager, getCanvasOffsetByEngine, } from './components/docs/text-selection/text-selection-render-manager';
+export { getCanvasOffsetByEngine } from './components/docs/text-selection/selection-utils';
+export { ITextSelectionRenderManager, TextSelectionRenderManager, } from './components/docs/text-selection/text-selection-render-manager';
 export type { IActiveTextRange, IEditorInputConfig, ITextSelectionInnerParam } from './components/docs/text-selection/text-selection-render-manager';
 export { Documents } from './components/docs/document';
 export { DocBackground } from './components/docs/doc-background';
@@ -46,4 +48,10 @@ 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';
 export { lineIterator, glyphIterator } from './components/docs/layout/tools';
-export { getOneTextSelectionRange } from './components/docs/text-selection/convert-cursor';
+export { getOneTextSelectionRange } from './components/docs/text-selection/convert-text-range';
+export { getLastLine } from './components/docs/layout/tools';
+export { DataStreamTreeNode } from './components/docs/view-model/data-stream-tree-node';
+export type { IDocRange } from './components/docs/text-selection/range-interface';
+export { isInSameTableCell, isValidRectRange, NodePositionConvertToRectRange } from './components/docs/text-selection/convert-rect-range';
+export { parseDataStreamToTree } from './components/docs/view-model/document-view-model';
+export { DOC_RANGE_TYPE } from './components/docs/text-selection/range-interface';

package/lib/types/layer.d.ts

@@ -17,6 +17,10 @@ export declare class Layer extends Disposable {
     enableCache(): void;
     disableCache(): void;
     isAllowCache(): boolean;
+    /**
+     * get objects which is visible and not in a group.
+     * @returns BaseObject[]
+     */
     getObjectsByOrder(): BaseObject[];
     getObjectsByOrderForPick(): BaseObject[];
     getObjects(): BaseObject[];
@@ -24,7 +28,7 @@ export declare class Layer extends Disposable {
      * insert o to _objects[]
      * if o is a group, insert all its children and group itself to _objects[]
      * @param o
-     * @returns
+     * @returns this
      */
     addObject(o: BaseObject): this;
     removeObject(object: BaseObject | string): void;

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

@@ -1,4 +1,4 @@
-import { Dependency, DependencyIdentifier, IDisposable, Nullable, UnitModel, UnitType, UniverInstanceType, Disposable, Injector, IUniverInstanceService } from '@univerjs/core';
+import { Dependency, DependencyIdentifier, IDisposable, Nullable, UnitModel, UnitType, Disposable, Injector, IUniverInstanceService, UniverInstanceType } from '@univerjs/core';
 import { Observable } from 'rxjs';
 import { BaseObject } from '../base-object';
 import { DocComponent } from '../components/docs/doc-component';
@@ -15,6 +15,10 @@ export interface IRenderManagerService extends IDisposable {
     createRender(unitId: string): IRender;
     removeRender(unitId: string): void;
     setCurrent(unitId: string): void;
+    /**
+     * get RenderUnit By Id, RenderUnit implements IRender
+     * @param unitId
+     */
     getRenderById(unitId: string): Nullable<IRender>;
     getAllRenderersOfType(type: UniverInstanceType): RenderUnit[];
     getCurrentTypeOfRenderer(type: UniverInstanceType): Nullable<RenderUnit>;
@@ -61,6 +65,7 @@ export declare class RenderManagerService extends Disposable implements IRenderM
     getAllRenderersOfType(type: UniverInstanceType): RenderUnit[];
     getCurrentTypeOfRenderer(type: UniverInstanceType): Nullable<RenderUnit>;
     withCurrentTypeOfUnit<T>(type: UniverInstanceType, id: DependencyIdentifier<T>): Nullable<T>;
+    private _tryAddRenderDependencies;
     private _createRender;
     addRender(unitId: string, item: IRender): void;
     private _addRenderUnit;

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

@@ -1,15 +1,17 @@
-import { Dependency, DependencyIdentifier, IDisposable, Nullable, UnitModel, UnitType, Disposable, Injector } from '@univerjs/core';
+import { Dependency, DependencyIdentifier, IDisposable, Nullable, UnitModel, UnitType, UniverInstanceType, Disposable, Injector } from '@univerjs/core';
 import { Engine } from '../engine';
 import { Scene } from '../scene';
 import { RenderComponentType } from './render-manager.service';
 
 export interface IRender {
     unitId: string;
+    type: UniverInstanceType;
     engine: Engine;
     scene: Scene;
     mainComponent: Nullable<RenderComponentType>;
     components: Map<string, RenderComponentType>;
     isMainScene: boolean;
+    isThumbNail?: boolean;
     with<T>(dependency: DependencyIdentifier<T>): T;
 }
 export interface IRenderModule extends IDisposable {

package/lib/types/scene.d.ts

@@ -80,7 +80,16 @@ export declare class Scene extends ThinScene {
     removeObject(object?: BaseObject | string): this | undefined;
     removeObjects(objects?: BaseObject[] | string[]): this | undefined;
     getObjectsByLayer(zIndex: number): BaseObject[];
+    /**
+     * get objects which is visible and not in a group in each layer.
+     * @returns BaseObject[]
+     */
     getAllObjects(): BaseObject[];
+    /**
+     * get objects which is visible and not in a group.
+     * @param isDesc
+     * @returns BaseObject[]
+     */
     getAllObjectsByOrder(isDesc?: boolean): BaseObject[];
     getAllObjectsByOrderForPick(isDesc?: boolean): BaseObject[];
     getObject(oKey: string): BaseObject | undefined;

package/lib/types/scene.transformer.d.ts

@@ -11,6 +11,7 @@ declare enum MoveObserverType {
     MOVE_END = 2
 }
 export interface IChangeObserverConfig {
+    target?: BaseObject;
     objects: Map<string, BaseObject>;
     type: MoveObserverType;
     moveX?: number;
@@ -63,6 +64,10 @@ export declare class Transformer extends Disposable implements ITransformerConfi
     useSingleNodeRotation: boolean;
     shouldOverdrawWholeArea: boolean;
     private readonly _changeStart$;
+    /**
+     * actually pointer down on a object,
+     * trigger when pick an object even object not change.
+     */
     readonly changeStart$: import('rxjs').Observable<IChangeObserverConfig>;
     private readonly _changing$;
     readonly changing$: import('rxjs').Observable<IChangeObserverConfig>;
@@ -146,6 +151,7 @@ export declare class Transformer extends Disposable implements ITransformerConfi
     private _clearControlMap;
     private _createControl;
     private _getTopScene;
+    activeAnObject(applyObject: BaseObject): void;
     private _updateActiveObjectList;
     private _findGroupObject;
     private _addCancelObserver;

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

@@ -1,4 +1,5 @@
 import { UniverRenderingContext } from '../context';
+import { ObjectType } from '../base-object';
 import { IShapeProps, Shape } from './shape';
 
 export interface ICircleProps extends IShapeProps {
@@ -7,6 +8,7 @@ export interface ICircleProps extends IShapeProps {
 export declare const CIRCLE_OBJECT_ARRAY: string[];
 export declare class Circle extends Shape<ICircleProps> {
     private _radius;
+    objectType: ObjectType;
     constructor(key?: string, props?: ICircleProps);
     get radius(): number;
     static drawWith(ctx: UniverRenderingContext, props: ICircleProps | Circle): void;

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

@@ -1,6 +1,7 @@
 import { ISrcRect, Nullable, PresetGeometryType } from '@univerjs/core';
 import { UniverRenderingContext } from '../context';
 import { IObjectFullState, IViewportInfo, RENDER_CLASS_TYPE } from '../basics';
+import { ObjectType } from '../base-object';
 import { IShapeProps, Shape } from './shape';
 
 export interface IImageProps extends IShapeProps {
@@ -23,6 +24,7 @@ export declare class Image extends Shape<IImageProps> {
     protected _native: Nullable<HTMLImageElement>;
     private _renderByCropper;
     private _transformCalculateSrcRect;
+    objectType: ObjectType;
     constructor(id: string, config: IImageProps);
     get srcRect(): Nullable<ISrcRect>;
     get prstGeom(): Nullable<PresetGeometryType>;

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

@@ -1,5 +1,6 @@
 import { UniverRenderingContext } from '../context';
 import { IViewportInfo } from '../basics/vector2';
+import { ObjectType } from '../base-object';
 import { IShapeProps, Shape } from './shape';
 
 export interface IRectProps extends IShapeProps {
@@ -8,6 +9,7 @@ export interface IRectProps extends IShapeProps {
 export declare const RECT_OBJECT_ARRAY: string[];
 export declare class Rect<T extends IRectProps = IRectProps> extends Shape<T> {
     private _radius;
+    objectType: ObjectType;
     constructor(key?: string, props?: T);
     get radius(): number;
     static drawWith(ctx: UniverRenderingContext, props: IRectProps | Rect): void;

package/lib/types/shape/rich-text.d.ts

@@ -1,5 +1,5 @@
 import { IDocumentData, IStyleBase, ITransformState, LocaleService } from '@univerjs/core';
-import { BaseObject } from '../base-object';
+import { BASE_OBJECT_ARRAY, BaseObject, ObjectType } from '../base-object';
 import { IViewportInfo } from '../basics/vector2';
 import { UniverRenderingContext } from '../context';
 
@@ -9,34 +9,96 @@ export interface IRichTextProps extends ITransformState, IStyleBase {
     zIndex: number;
     forceRender?: boolean;
 }
+export type RichtextObjectJSONType = {
+    [key in typeof BASE_OBJECT_ARRAY[number]]: number;
+} & {
+    text: string;
+    fs: number;
+    richText?: unknown;
+};
 export declare const RICHTEXT_OBJECT_ARRAY: string[];
 export declare class RichText extends BaseObject {
     private _localeService;
     private _documentData;
     private _documentSkeleton;
     private _documents;
+    /**
+     * fontFamily
+     */
     private _ff?;
+    /**
+     * fontSize
+     * pt
+     */
     private _fs?;
+    /**
+     * italic
+     * 0: false
+     * 1: true
+     */
     private _it?;
+    /**
+     * bold
+     * 0: false
+     * 1: true
+     */
     private _bl?;
+    /**
+     * underline
+     */
     private _ul?;
+    /**
+     * strikethrough
+     */
     private _st?;
+    /**
+     * overline
+     */
     private _ol?;
+    /**
+     * background
+     */
     private _bg?;
+    /**
+     * border
+     */
     private _bd?;
+    /**
+     * foreground
+     */
     private _cl?;
+    objectType: ObjectType;
     constructor(_localeService: LocaleService, key?: string, props?: IRichTextProps);
+    get fs(): number;
+    get text(): string;
     get documentData(): IDocumentData;
+    /**
+     * get last page size
+     */
     getDocsSkeletonPageSize(): {
         width: number;
         height: number;
     } | undefined;
+    /**
+     * this[`_${key}`] = props[key];
+     * @param props
+     */
     setProps(props?: IRichTextProps): this | undefined;
     render(mainCtx: UniverRenderingContext, bounds?: IViewportInfo): this;
-    toJson(): {
-        [x: string]: any;
-    };
+    toJson(): RichtextObjectJSONType;
     protected _draw(ctx: UniverRenderingContext): void;
     private _convertToDocumentData;
     private _initialProps;
+    /**
+     *
+     * it should be invoked when _documentData changed.
+     * _documentData changed ---> update _documentSkeleton & _documentSkeleton
+     *
+     * now it is invoked when transformByState(change editor size) & end of editing
+     */
+    refreshDocumentByDocData(): void;
+    /**
+     * invoked when end editing.
+     */
+    resizeToContentSize(): void;
 }

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

@@ -1,5 +1,5 @@
 import { IOffset, IScale, ISize, Nullable } from '@univerjs/core';
-import { BaseObject } from '../base-object';
+import { BaseObject, ObjectType } from '../base-object';
 import { IObjectFullState } from '../basics/interfaces';
 import { IViewportInfo, Vector2 } from '../basics/vector2';
 import { UniverRenderingContext } from '../context';
@@ -62,6 +62,7 @@ export declare abstract class Shape<T extends IShapeProps> extends BaseObject {
     private _strokeDashOffset;
     private _strokeMiterLimit;
     private _type;
+    objectType: ObjectType;
     constructor(key?: string, props?: T);
     get hoverCursor(): Nullable<string>;
     get moveCursor(): string | null;