@univerjs/engine-render 0.2.6 → 0.2.8

package/lib/types/custom/custom-object.d.ts

@@ -1,7 +1,6 @@
 import { BaseObject } from '../base-object';
 import { IViewportInfo, Vector2 } from '../basics/vector2';
 import { UniverRenderingContext } from '../context';
-
 export declare class CustomObject extends BaseObject {
     private _render;
     private _isHitCustom?;

package/lib/types/engine.d.ts

@@ -3,7 +3,6 @@ import { CURSOR_TYPE } from './basics/const';
 import { Canvas, CanvasRenderMode } from './canvas';
 import { Scene } from './scene';
 import { ThinEngine } from './thin-engine';
-
 export declare class Engine extends ThinEngine<Scene> {
     renderEvenInBackground: boolean;
     private readonly _beginFrame$;
@@ -64,6 +63,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/floating/util.d.ts

@@ -1,3 +1,2 @@
 import { Observable } from 'rxjs';
-
 export declare function observeClientRect(containerElement: HTMLElement): Observable<void>;

package/lib/types/group.d.ts

@@ -2,7 +2,6 @@ import { BaseObject } from './base-object';
 import { CURSOR_TYPE, RENDER_CLASS_TYPE } from './basics/const';
 import { IViewportInfo, Vector2 } from './basics/vector2';
 import { UniverRenderingContext } from './context';
-
 export declare class Group extends BaseObject {
     private _objects;
     private _selfSizeMode;

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

@@ -2,7 +2,6 @@ import { Disposable } from '@univerjs/core';
 import { BaseObject } from './base-object';
 import { UniverRenderingContext } from './context';
 import { Scene } from './scene';
-
 export declare class Layer extends Disposable {
     private _scene;
     private _zIndex;
@@ -17,6 +16,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[];

package/lib/types/render-engine.d.ts

@@ -1,6 +1,5 @@
 import { Injector, Plugin } from '@univerjs/core';
 import { Engine } from './engine';
-
 /**
  * The global rendering engine.
  */

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

@@ -6,15 +6,23 @@ import { SheetComponent } from '../components/sheets/sheet-component';
 import { Slide } from '../components/slides/slide';
 import { Engine } from '../engine';
 import { IRender, RenderUnit } from './render-unit';
-
 export type RenderComponentType = SheetComponent | DocComponent | Slide | BaseObject;
 export interface IRenderManagerService extends IDisposable {
     /** @deprecated */
     currentRender$: Observable<Nullable<string>>;
     addRender(unitId: string, renderer: IRender): void;
+    /**
+     * create renderUnit & init deps from renderDependencies by renderUnit's type.
+     * @param unitId
+     * @returns renderUnit:IRender
+     */
     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>;
@@ -32,6 +40,11 @@ export interface IRenderManagerService extends IDisposable {
     getFirst(): Nullable<IRender>;
     has(unitId: string): boolean;
     withCurrentTypeOfUnit<T>(type: UniverInstanceType, id: DependencyIdentifier<T>): Nullable<T>;
+    /**
+     * add dep to _renderDependencies(type, dep)
+     * @param type
+     * @param depCtor
+     */
     registerRenderModule<T extends UnitModel>(type: UnitType, dep: Dependency<T>): IDisposable;
 }
 export declare class RenderManagerService extends Disposable implements IRenderManagerService {
@@ -54,13 +67,41 @@ export declare class RenderManagerService extends Disposable implements IRenderM
     constructor(_injector: Injector, _univerInstanceService: IUniverInstanceService);
     dispose(): void;
     registerRenderModules(type: UnitType, deps: Dependency[]): IDisposable;
-    registerRenderModule(type: UnitType, ctor: Dependency): IDisposable;
-    private _getRenderControllersForType;
+    /**
+     * add dep to _renderDependencies(type, dep)
+     * @param type
+     * @param depCtor
+     */
+    registerRenderModule(type: UnitType, depCtor: Dependency): IDisposable;
+    /**
+     * get render dependencies from _renderDependencies
+     * @param type
+     * @returns Dependency[]
+     */
+    private _getRenderDepsByType;
     create(unitId: string): void;
+    /**
+     * create renderUnit & init deps from renderDependencies
+     * @param unitId
+     * @returns renderUnit:IRender
+     */
     createRender(unitId: string): IRender;
     getAllRenderersOfType(type: UniverInstanceType): RenderUnit[];
     getCurrentTypeOfRenderer(type: UniverInstanceType): Nullable<RenderUnit>;
     withCurrentTypeOfUnit<T>(type: UniverInstanceType, id: DependencyIdentifier<T>): Nullable<T>;
+    /**
+     * init deps by injector.get(dep), and injector derives from renderer.
+     * @param renderer
+     * @param deps
+     */
+    private _tryAddRenderDependencies;
+    /**
+     * create renderUnit & init deps from renderDependencies by renderUnit's type
+     * @param unitId
+     * @param engine
+     * @param isMainScene
+     * @returns renderUnit:IRender
+     */
     private _createRender;
     addRender(unitId: string, item: IRender): void;
     private _addRenderUnit;
@@ -69,6 +110,11 @@ export declare class RenderManagerService extends Disposable implements IRenderM
     setCurrent(unitId: string): void;
     getCurrent(): IRender | undefined;
     getFirst(): IRender;
+    /**
+     * get RenderUnit from this._renderMap
+     * @param unitId
+     * @returns RenderUnit, aka IRender
+     */
     getRenderById(unitId: string): Nullable<IRender>;
     getRenderAll(): Map<string, IRender>;
     private _disposeItem;

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

@@ -1,15 +1,16 @@
-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 {
@@ -22,7 +23,7 @@ export interface IRenderContext<T extends UnitModel = UnitModel> extends Omit<IR
     type: UnitType;
 }
 /**
- * This class is responsible
+ * RenderUnit impl IRender
  */
 export declare class RenderUnit extends Disposable implements IRender {
     readonly isRenderUnit: boolean;

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

@@ -5,7 +5,6 @@ import { IObjectFullState } from './basics/interfaces';
 import { IViewportInfo, Vector2 } from './basics/vector2';
 import { UniverRenderingContext } from './context';
 import { ThinScene } from './thin-scene';
-
 export declare class SceneViewer extends BaseObject {
     private _subScenes;
     private _activeSubScene;

package/lib/types/scene.d.ts

@@ -12,7 +12,6 @@ import { ThinEngine } from './thin-engine';
 import { ThinScene } from './thin-scene';
 import { Viewport } from './viewport';
 import { ITransformerConfig } from './basics/transformer-config';
-
 export declare class Scene extends ThinScene {
     private _parent;
     private _layers;
@@ -80,7 +79,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;
@@ -92,6 +100,10 @@ export declare class Scene extends ThinScene {
     getViewport(key: string): Viewport | undefined;
     render(parentCtx?: UniverRenderingContext): void;
     requestRender(parentCtx?: UniverRenderingContext): Promise<unknown>;
+    /**
+     * create transformer if not exist, and then transformer attach to object that passed in by parameter.
+     * @param o
+     */
     attachTransformerTo(o: BaseObject): void;
     detachTransformerFrom(o: BaseObject): void;
     initTransformer(config?: ITransformerConfig): void;

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

@@ -1,7 +1,6 @@
 import { Disposable } from '@univerjs/core';
 import { IMouseEvent } from './basics/i-events';
 import { ThinScene } from './thin-scene';
-
 export declare class InputManager extends Disposable {
     /** The distance in pixel that you have to move to prevent some events */
     static DragMovementThreshold: number;

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

@@ -4,13 +4,13 @@ import { IMouseEvent, IPointerEvent } from './basics/i-events';
 import { Group } from './group';
 import { Scene } from './scene';
 import { ITransformerConfig } from './basics/transformer-config';
-
 declare enum MoveObserverType {
     MOVE_START = 0,
     MOVING = 1,
     MOVE_END = 2
 }
 export interface IChangeObserverConfig {
+    target?: BaseObject;
     objects: Map<string, BaseObject>;
     type: MoveObserverType;
     moveX?: number;
@@ -63,6 +63,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>;

package/lib/types/scroll-timer.d.ts

@@ -1,7 +1,6 @@
 import { IPaddingData } from '@univerjs/core';
 import { Scene } from './scene';
 import { Viewport } from './viewport';
-
 export declare enum ScrollTimerType {
     NONE = 0,
     X = 1,

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

@@ -3,7 +3,6 @@ import { Vector2 } from '../basics/vector2';
 import { UniverRenderingContext } from '../context';
 import { ThinScene } from '../thin-scene';
 import { Rect } from './rect';
-
 export interface IScrollBarProps {
     thumbMargin?: number;
     thumbLengthRatio?: number;

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

@@ -1,6 +1,5 @@
 import { UniverRenderingContext } from '../context';
 import { IShapeProps, Shape } from './shape';
-
 export interface ICheckboxProps extends IShapeProps {
     checked?: boolean;
 }

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

@@ -1,7 +1,6 @@
 import { UniverRenderingContext } from '../context';
 import { ObjectType } from '../base-object';
 import { IShapeProps, Shape } from './shape';
-
 export interface ICircleProps extends IShapeProps {
     radius: number;
 }

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

@@ -1,7 +1,6 @@
 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/dropdown-item.d.ts

@@ -1,6 +1,5 @@
 import { UniverRenderingContext } from '../context';
 import { IShapeProps, Shape } from './shape';
-
 export interface IListItemProps extends IShapeProps {
     text: number;
     fontString: string;

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

@@ -3,7 +3,6 @@ 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 {
     image?: HTMLImageElement;
     url?: string;

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

@@ -1,6 +1,5 @@
 import { UniverRenderingContext } from '../context';
 import { IShapeProps, Shape } from './shape';
-
 interface IPathDataArray {
     command: string;
     points: number[];

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

@@ -2,7 +2,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 {
     radius?: number;
 }

package/lib/types/shape/regular-polygon.d.ts

@@ -2,7 +2,6 @@ import { IObjectFullState } from '../basics/interfaces';
 import { IPoint, Vector2 } from '../basics/vector2';
 import { UniverRenderingContext } from '../context';
 import { IShapeProps, Shape } from './shape';
-
 export interface IRegularPolygonProps extends IShapeProps {
     pointsGroup: IPoint[][];
 }

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

@@ -1,43 +1,104 @@
-import { IDocumentData, IStyleBase, ITransformState, LocaleService } from '@univerjs/core';
-import { BaseObject, ObjectType } from '../base-object';
+import { IDocumentData, IStyleBase, ITransformState, LocaleService, DocumentDataModel } from '@univerjs/core';
+import { BASE_OBJECT_ARRAY, BaseObject, ObjectType } from '../base-object';
 import { IViewportInfo } from '../basics/vector2';
 import { UniverRenderingContext } from '../context';
-
 export interface IRichTextProps extends ITransformState, IStyleBase {
     text?: string;
     richText?: IDocumentData;
     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;
+    documentModel: DocumentDataModel;
+    /**
+     * 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/scroll-bar.d.ts

@@ -3,7 +3,6 @@ import { UniverRenderingContext } from '../context';
 import { Viewport } from '../viewport';
 import { IScrollBarProps, BaseScrollBar } from './base-scroll-bar';
 import { Rect } from './rect';
-
 export declare class ScrollBar extends BaseScrollBar {
     protected _view: Viewport;
     private _mainScene;

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

@@ -3,7 +3,6 @@ import { BaseObject, ObjectType } from '../base-object';
 import { IObjectFullState } from '../basics/interfaces';
 import { IViewportInfo, Vector2 } from '../basics/vector2';
 import { UniverRenderingContext } from '../context';
-
 export type LineJoin = 'round' | 'bevel' | 'miter';
 export type LineCap = 'butt' | 'round' | 'square';
 export type PaintFirst = 'fill' | 'stroke';

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

@@ -1,5 +1,4 @@
 import { IShapeProps, Shape } from './shape';
-
 export interface ITextProps extends IShapeProps {
     width: number;
 }

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

@@ -3,7 +3,6 @@ import { CURSOR_TYPE, RENDER_CLASS_TYPE } from './basics/const';
 import { IEvent } from './basics/i-events';
 import { ITransformChangeState } from './basics/interfaces';
 import { Canvas } from './canvas';
-
 export declare abstract class ThinEngine<T extends IDisposable> extends Disposable {
     onInputChanged$: EventSubject<IEvent>;
     onTransformChange$: EventSubject<ITransformChangeState>;

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

@@ -8,7 +8,6 @@ import { Vector2 } from './basics/vector2';
 import { UniverRenderingContext } from './context';
 import { ThinEngine } from './thin-engine';
 import { Scene } from './scene';
-
 export declare abstract class ThinScene extends Disposable {
     onTransformChange$: EventSubject<ITransformChangeState>;
     onFileLoaded$: EventSubject<string>;

package/lib/types/viewport.d.ts

@@ -6,7 +6,6 @@ import { IBoundRectNoAngle, IViewportInfo, Vector2 } from './basics/vector2';
 import { UniverRenderingContext } from './context';
 import { BaseScrollBar } from './shape/base-scroll-bar';
 import { ThinScene } from './thin-scene';
-
 interface IViewPosition {
     top?: number;
     left?: number;