@univerjs/engine-render 0.2.6 → 0.2.7

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[];

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

@@ -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>;

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

@@ -1,5 +1,5 @@
 import { IDocumentData, IStyleBase, ITransformState, LocaleService } from '@univerjs/core';
-import { BaseObject, ObjectType } from '../base-object';
+import { BASE_OBJECT_ARRAY, BaseObject, ObjectType } from '../base-object';
 import { IViewportInfo } from '../basics/vector2';
 import { UniverRenderingContext } from '../context';
 
@@ -9,35 +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;
 }