@univerjs/engine-render 0.2.2 → 0.2.3

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

@@ -147,6 +147,11 @@ export interface IDocumentSkeletonDrawing {
     angle: number;
     initialState: boolean;
     drawingOrigin: IDocDrawingBase;
+    columnLeft: number;
+    isPageBreak: boolean;
+    lineTop: number;
+    lineHeight: number;
+    blockAnchorTop: number;
 }
 export interface IDocumentSkeletonFontStyle {
     fontString: string;

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

@@ -82,13 +82,13 @@ export declare function mergeInfoOffset(mergeInfo: IRangeWithCoord, offsetX: num
     startY: number;
     endX: number;
     endY: number;
-    startColumn: number;
-    endColumn: number;
     rangeType?: import('@univerjs/core').RANGE_TYPE;
     startAbsoluteRefType?: import('@univerjs/core').AbsoluteRefType;
     endAbsoluteRefType?: import('@univerjs/core').AbsoluteRefType;
     startRow: number;
     endRow: number;
+    startColumn: number;
+    endColumn: number;
 };
 export declare function isRectIntersect(rect1: IBoundRectNoAngle, rect2: IBoundRectNoAngle): boolean;
 export declare function injectStyle(styles: string[]): void;

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

@@ -1,6 +1,7 @@
-import { IDocumentSkeletonGlyph, IDocumentSkeletonPage } from '../../../../../basics/i-document-skeleton-cached';
+import { IDocumentSkeletonDrawing, IDocumentSkeletonGlyph, IDocumentSkeletonLine, IDocumentSkeletonPage } from '../../../../../basics/i-document-skeleton-cached';
 import { IParagraphConfig, ISectionBreakConfig } from '../../../../../basics/interfaces';
 import { ILayoutContext } from '../../tools';
 import { BreakPointType } from '../../line-breaker/break';
 
 export declare function layoutParagraph(ctx: ILayoutContext, glyphGroup: IDocumentSkeletonGlyph[], pages: IDocumentSkeletonPage[], sectionBreakConfig: ISectionBreakConfig, paragraphConfig: IParagraphConfig, paragraphStart?: boolean, breakPointType?: BreakPointType): IDocumentSkeletonPage[];
+export declare function updateInlineDrawingPosition(line: IDocumentSkeletonLine, paragraphInlineSkeDrawings?: Map<string, IDocumentSkeletonDrawing>, blockAnchorTop?: number): void;

package/lib/types/components/docs/layout/line-breaker/extensions/custom-block-linebreak-extension.d.ts

@@ -0,0 +1,3 @@
+import { LineBreaker } from '../line-breaker';
+
+export declare function customBlockLineBreakExtension(breaker: LineBreaker): void;

package/lib/types/components/docs/layout/model/line.d.ts

@@ -15,6 +15,7 @@ export declare function createSkeletonLine(paragraphIndex: number, lineType: Lin
 export declare function calculateLineTopByDrawings(lineHeight?: number, lineTop?: number, pageSkeDrawings?: Map<string, IDocumentSkeletonDrawing>, headersDrawings?: Map<string, IDocumentSkeletonDrawing>, footersDrawings?: Map<string, IDocumentSkeletonDrawing>): number;
 export declare function updateDivideInfo(divide: IDocumentSkeletonDivide, states: Partial<IDocumentSkeletonDivide>): void;
 export declare function setLineMarginBottom(line: IDocumentSkeletonLine, marginBottom: number): void;
-export declare function collisionDetection(drawing: IDocumentSkeletonDrawing, lineHeight: number, lineTop: number, columnWidth: number): boolean;
+export declare function collisionDetection(drawing: IDocumentSkeletonDrawing, lineHeight: number, lineTop: number, columnLeft: number, columnWidth: number): boolean;
+export declare function getBoundingBox(angle: number, left: number, width: number, top: number, height: number): import('../../../..').IRect;
 export declare function createAndUpdateBlockAnchor(paragraphIndex: number, line: IDocumentSkeletonLine, top: number, drawingAnchor?: Map<number, IDocumentSkeletonDrawingAnchor>): void;
 export {};

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

@@ -1,5 +1,5 @@
 import { DocumentDataModel, INumberUnit, IObjectPositionH, IObjectPositionV, IParagraphStyle, ITextStyle, Nullable, BooleanNumber, GridType, SpacingRule } from '@univerjs/core';
-import { IDocumentSkeletonCached, IDocumentSkeletonColumn, IDocumentSkeletonDivide, IDocumentSkeletonDrawing, IDocumentSkeletonFontStyle, IDocumentSkeletonGlyph, IDocumentSkeletonLine, IDocumentSkeletonPage, ISkeletonResourceReference } from '../../../basics/i-document-skeleton-cached';
+import { IDocumentSkeletonCached, IDocumentSkeletonColumn, IDocumentSkeletonDivide, IDocumentSkeletonDrawing, IDocumentSkeletonFontStyle, IDocumentSkeletonGlyph, IDocumentSkeletonLine, IDocumentSkeletonPage, IDocumentSkeletonSection, ISkeletonResourceReference } from '../../../basics/i-document-skeleton-cached';
 import { IDocsConfig, IParagraphConfig, ISectionBreakConfig } from '../../../basics/interfaces';
 import { DataStreamTreeNode } from '../view-model/data-stream-tree-node';
 import { DocumentViewModel } from '../view-model/document-view-model';
@@ -7,7 +7,7 @@ import { Hyphen } from './hyphenation/hyphen';
 import { LanguageDetector } from './hyphenation/language-detector';
 
 export declare function getLastPage(pages: IDocumentSkeletonPage[]): IDocumentSkeletonPage;
-export declare function getLastSection(page: IDocumentSkeletonPage): import('../../../basics/i-document-skeleton-cached').IDocumentSkeletonSection;
+export declare function getLastSection(page: IDocumentSkeletonPage): IDocumentSkeletonSection;
 export declare function getLastColumn(page: IDocumentSkeletonPage): IDocumentSkeletonColumn;
 export declare function getLastLine(page: IDocumentSkeletonPage): IDocumentSkeletonLine | undefined;
 export declare function getLastLineByColumn(column: IDocumentSkeletonColumn): IDocumentSkeletonLine;
@@ -49,8 +49,9 @@ export declare function getCharSpaceConfig(sectionBreakConfig: ISectionBreakConf
     snapToGrid: BooleanNumber;
 };
 export declare function updateBlockIndex(pages: IDocumentSkeletonPage[], start?: number): void;
-export declare function spanIterator(pages: IDocumentSkeletonPage[], iteratorFunction: (glyph: IDocumentSkeletonGlyph) => void): void;
-export declare function lineIterator(pages: IDocumentSkeletonPage[], iteratorFunction: (line: IDocumentSkeletonLine) => void): void;
+export declare function updateInlineDrawingCoords(ctx: ILayoutContext, pages: IDocumentSkeletonPage[]): void;
+export declare function glyphIterator(pages: IDocumentSkeletonPage[], cb: (glyph: IDocumentSkeletonGlyph, divide: IDocumentSkeletonDivide, line: IDocumentSkeletonLine, column: IDocumentSkeletonColumn, section: IDocumentSkeletonSection, page: IDocumentSkeletonPage) => void): void;
+export declare function lineIterator(pages: IDocumentSkeletonPage[], cb: (line: IDocumentSkeletonLine, column: IDocumentSkeletonColumn, section: IDocumentSkeletonSection, page: IDocumentSkeletonPage) => void): void;
 export declare function columnIterator(pages: IDocumentSkeletonPage[], iteratorFunction: (column: IDocumentSkeletonColumn) => void): void;
 export declare function getPositionHorizon(positionH: IObjectPositionH, column: IDocumentSkeletonColumn, page: IDocumentSkeletonPage, objectWidth: number, isPageBreak?: boolean): number | undefined;
 export declare function getPositionVertical(positionV: IObjectPositionV, page: IDocumentSkeletonPage, lineTop: number, lineHeight: number, objectHeight: number, blockAnchorTop?: number, isPageBreak?: boolean): number | undefined;

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

@@ -20,6 +20,9 @@ export interface ITextSelectionInnerParam {
     isEditing: boolean;
     style: ITextSelectionStyle;
     segmentPage: number;
+    options?: {
+        [key: string]: boolean;
+    };
 }
 export interface IActiveTextRange {
     startOffset: number;
@@ -36,6 +39,7 @@ export interface ITextSelectionRenderManager {
     readonly onInputBefore$: Observable<Nullable<IEditorInputConfig>>;
     readonly onKeydown$: Observable<Nullable<IEditorInputConfig>>;
     readonly onInput$: Observable<Nullable<IEditorInputConfig>>;
+    readonly onPointerDown$: Observable<void>;
     readonly onCompositionstart$: Observable<Nullable<IEditorInputConfig>>;
     readonly onCompositionupdate$: Observable<Nullable<IEditorInputConfig>>;
     readonly onCompositionend$: Observable<Nullable<IEditorInputConfig>>;
@@ -54,7 +58,9 @@ export interface ITextSelectionRenderManager {
     setStyle(style: ITextSelectionStyle): void;
     resetStyle(): void;
     removeAllTextRanges(): void;
-    addTextRanges(ranges: ISuccinctTextRangeParam[], isEditing?: boolean): void;
+    addTextRanges(ranges: ISuccinctTextRangeParam[], isEditing?: boolean, options?: {
+        [key: string]: boolean;
+    }): void;
     sync(): void;
     activate(x: number, y: number): void;
     deactivate(): void;
@@ -98,6 +104,8 @@ export declare class TextSelectionRenderManager extends RxDisposable implements
     readonly onFocus$: Observable<Nullable<IEditorInputConfig>>;
     private readonly _onBlur$;
     readonly onBlur$: Observable<Nullable<IEditorInputConfig>>;
+    private readonly _onPointerDown$;
+    readonly onPointerDown$: Observable<void>;
     private _container;
     private _inputParent;
     private _input;
@@ -121,13 +129,16 @@ export declare class TextSelectionRenderManager extends RxDisposable implements
     __getEditorContainer(): HTMLElement;
     getViewPort(): Viewport;
     setSegment(id: string): void;
+    getSegment(): string;
     setSegmentPage(pageIndex: number): void;
     getSegmentPage(): number;
     setStyle(style?: ITextSelectionStyle): void;
     resetStyle(): void;
     enableSelection(): void;
     disableSelection(): void;
-    addTextRanges(ranges: ISuccinctTextRangeParam[], isEditing?: boolean): void;
+    addTextRanges(ranges: ISuccinctTextRangeParam[], isEditing?: boolean, options?: {
+        [key: string]: boolean;
+    }): void;
     setCursorManually(evtOffsetX: number, evtOffsetY: number): void;
     sync(): void;
     activate(x: number, y: number): void;

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

@@ -51,6 +51,7 @@ export declare class DocumentViewModel implements IDisposable {
      */
     getTextRun(index: number): ITextRun | undefined;
     getCustomBlock(index: number): import('@univerjs/core').ICustomBlock | undefined;
+    getCustomBlockWithoutSetCurrentIndex(index: number): import('@univerjs/core').ICustomBlock | undefined;
     getTable(index: number): import('@univerjs/core').ITable | undefined;
     getCustomRangeRaw(index: number): import('@univerjs/core').ICustomRange | undefined;
     getCustomRange(index: number): Nullable<ICustomRangeForInterceptor>;

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

@@ -123,12 +123,7 @@ export declare class SpreadsheetSkeleton extends Skeleton {
      */
     getWorksheetConfig(): IWorksheetData;
     getRowColumnSegmentByViewBound(bound?: IBoundRectNoAngle): IRange;
-    getMergeBounding(startRow: number, startColumn: number, endRow: number, endColumn: number): {
-        startRow: number;
-        startColumn: number;
-        endRow: number;
-        endColumn: number;
-    };
+    getMergeBounding(startRow: number, startColumn: number, endRow: number, endColumn: number): IRange;
     appendToOverflowCache(row: number, column: number, startColumn: number, endColumn: number): void;
     getColumnCount(): number;
     getRowCount(): number;
@@ -237,13 +232,13 @@ export declare class SpreadsheetSkeleton extends Skeleton {
             startY: number;
             endX: number;
             endY: number;
-            startColumn: number;
-            endColumn: number;
             rangeType?: import('@univerjs/core').RANGE_TYPE;
             startAbsoluteRefType?: import('@univerjs/core').AbsoluteRefType;
             endAbsoluteRefType?: import('@univerjs/core').AbsoluteRefType;
             startRow: number;
             endRow: number;
+            startColumn: number;
+            endColumn: number;
         };
     };
     convertTransformToOffsetX(offsetX: number, scaleX: number, scrollXY: {
@@ -254,7 +249,7 @@ export declare class SpreadsheetSkeleton extends Skeleton {
         x: number;
         y: number;
     }): number;
-    getSelectionBounding(startRow: number, startColumn: number, endRow: number, endColumn: number): IRange;
+    getSelectionMergeBounding(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

@@ -1,3 +1,4 @@
+import { IRange } from '@univerjs/core';
 import { IBoundRectNoAngle, IViewportInfo, Vector2 } from '../../basics/vector2';
 import { Canvas } from '../../canvas';
 import { UniverRenderingContext } from '../../context';
@@ -56,12 +57,7 @@ export declare class Spreadsheet extends SheetComponent {
      */
     makeForceDirty(state?: boolean): void;
     setForceDisableGridlines(disabled: boolean): void;
-    getSelectionBounding(startRow: number, startColumn: number, endRow: number, endColumn: number): {
-        startRow: number;
-        startColumn: number;
-        endRow: number;
-        endColumn: number;
-    } | undefined;
+    getSelectionBounding(startRow: number, startColumn: number, endRow: number, endColumn: number): IRange | undefined;
     /**
      * 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

package/lib/types/engine.d.ts

@@ -1,3 +1,4 @@
+import { Observable } from 'rxjs';
 import { CURSOR_TYPE } from './basics/const';
 import { Canvas, CanvasRenderMode } from './canvas';
 import { Scene } from './scene';
@@ -6,9 +7,11 @@ import { ThinEngine } from './thin-engine';
 export declare class Engine extends ThinEngine<Scene> {
     renderEvenInBackground: boolean;
     private readonly _beginFrame$;
-    readonly beginFrame$: import('rxjs').Observable<void>;
+    readonly beginFrame$: Observable<void>;
     private readonly _endFrame$;
-    readonly endFrame$: import('rxjs').Observable<void>;
+    readonly endFrame$: Observable<void>;
+    private _rect$;
+    get clientRect$(): Observable<void>;
     private _container;
     private _canvas;
     private _renderingQueueLaunched;

package/lib/types/floating/util.d.ts

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

package/lib/types/index.d.ts

@@ -24,7 +24,7 @@ export * from './group';
 export * from './layer';
 export { IRenderingEngine, UniverRenderEnginePlugin } from './render-engine';
 export { type RenderComponentType, IRenderManagerService, RenderManagerService } from './render-manager/render-manager.service';
-export { RenderUnit, type IRender, type IRenderModuleCtor, type IRenderModule, type IRenderContext } from './render-manager/render-unit';
+export { RenderUnit, type IRender, type IRenderModule, type IRenderContext } from './render-manager/render-unit';
 export * from './scene';
 export * from './scene-viewer';
 export * from './scroll-timer';
@@ -45,3 +45,5 @@ export { getCharSpaceApply, getNumberUnitValue } from './components/docs/layout/
 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';

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

@@ -1,12 +1,12 @@
 import { Nullable, UnitModel, UnitType, UniverInstanceType, Disposable, IUniverInstanceService } from '@univerjs/core';
-import { DependencyIdentifier, IDisposable, Injector } from '@wendellhu/redi';
+import { Dependency, DependencyIdentifier, IDisposable, Injector } from '@wendellhu/redi';
 import { Observable } from 'rxjs';
 import { BaseObject } from '../base-object';
 import { DocComponent } from '../components/docs/doc-component';
 import { SheetComponent } from '../components/sheets/sheet-component';
 import { Slide } from '../components/slides/slide';
 import { Engine } from '../engine';
-import { IRender, IRenderModuleCtor } from './render-unit';
+import { IRender, RenderUnit } from './render-unit';
 
 export type RenderComponentType = SheetComponent | DocComponent | Slide | BaseObject;
 export interface IRenderManagerService extends IDisposable {
@@ -17,6 +17,7 @@ export interface IRenderManagerService extends IDisposable {
     removeRender(unitId: string): void;
     setCurrent(unitId: string): void;
     getRenderById(unitId: string): Nullable<IRender>;
+    getCurrentTypeOfRenderer(type: UniverInstanceType): Nullable<RenderUnit>;
     getRenderAll(): Map<string, IRender>;
     defaultEngine: Engine;
     /** @deprecated */
@@ -29,7 +30,7 @@ export interface IRenderManagerService extends IDisposable {
     getFirst(): Nullable<IRender>;
     has(unitId: string): boolean;
     withCurrentTypeOfUnit<T>(type: UniverInstanceType, id: DependencyIdentifier<T>): Nullable<T>;
-    registerRenderModule<T extends UnitModel>(type: UnitType, ctor: IRenderModuleCtor<T>): IDisposable;
+    registerRenderModule<T extends UnitModel>(type: UnitType, dep: Dependency<T>): IDisposable;
 }
 export declare class RenderManagerService extends Disposable implements IRenderManagerService {
     private readonly _injector;
@@ -43,13 +44,15 @@ export declare class RenderManagerService extends Disposable implements IRenderM
     /** @deprecated */
     readonly createRender$: Observable<string>;
     get defaultEngine(): Engine;
-    private readonly _renderControllers;
+    private readonly _renderDependencies;
     constructor(_injector: Injector, _univerInstanceService: IUniverInstanceService);
     dispose(): void;
-    registerRenderModule(type: UnitType, ctor: IRenderModuleCtor): IDisposable;
+    registerRenderModules(type: UnitType, deps: Dependency[]): IDisposable;
+    registerRenderModule(type: UnitType, ctor: Dependency): IDisposable;
     private _getRenderControllersForType;
     create(unitId: string): void;
     createRender(unitId: string): IRender;
+    getCurrentTypeOfRenderer(type: UniverInstanceType): Nullable<RenderUnit>;
     withCurrentTypeOfUnit<T>(type: UniverInstanceType, id: DependencyIdentifier<T>): Nullable<T>;
     private _createRender;
     addRender(unitId: string, item: IRender): void;

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

@@ -1,5 +1,5 @@
 import { Nullable, UnitModel, UnitType, Disposable } from '@univerjs/core';
-import { DependencyIdentifier, IDisposable, Injector } from '@wendellhu/redi';
+import { Dependency, DependencyIdentifier, IDisposable, Injector } from '@wendellhu/redi';
 import { Engine } from '../engine';
 import { Scene } from '../scene';
 import { RenderComponentType } from './render-manager.service';
@@ -13,9 +13,6 @@ export interface IRender {
     isMainScene: boolean;
     with<T>(dependency: DependencyIdentifier<T>): T;
 }
-export interface IRenderModuleCtor<T extends UnitModel = UnitModel> {
-    new (unit: IRenderContext<T>, ...args: any[]): IRenderModule;
-}
 export interface IRenderModule extends IDisposable {
 }
 /**
@@ -49,6 +46,6 @@ export declare class RenderUnit extends Disposable implements IRender {
      * Get render controller hold by this render unit.
      */
     with<T>(dependency: DependencyIdentifier<T>): T;
-    addRenderControllers(ctors: IRenderModuleCtor[]): void;
-    private _initControllers;
+    addRenderDependencies(dependencies: Dependency[]): void;
+    private _initDependencies;
 }

package/lib/types/scene.d.ts

@@ -97,13 +97,24 @@ export declare class Scene extends ThinScene {
     initTransformer(config?: ITransformerConfig): void;
     getTransformerByCreate(): Transformer;
     getTransformer(): Nullable<Transformer>;
-    getActiveViewportByRelativeCoord(coord: Vector2): Viewport | undefined;
+    /**
+     * prev getActiveViewportByRelativeCoord
+     * @param coord
+     * @returns
+     */
+    findViewportByPosToViewport(coord: Vector2): Viewport | undefined;
     getActiveViewportByCoord(coord: Vector2): Viewport | undefined;
-    getScrollXYByRelativeCoords(coord: Vector2, viewPort?: Viewport): {
+    /**
+     * getViewportScrollXYInfo by viewport under cursor position
+     * prev getScrollXYByRelativeCoords
+     * @param pos
+     * @param viewPort
+     */
+    getVpScrollXYInfoByPosToVp(pos: Vector2, viewPort?: Viewport): {
         x: number;
         y: number;
     };
-    getScrollXY(viewPort: Viewport): {
+    getViewportScrollXY(viewPort: Viewport): {
         x: number;
         y: number;
     };
@@ -112,7 +123,7 @@ export declare class Scene extends ThinScene {
      * @param coord Coordinates to be converted.
      * @returns
      */
-    getRelativeCoord(coord: Vector2): Vector2;
+    getRelativeToViewportCoord(coord: Vector2): Vector2;
     clearLayer(): void;
     clearViewports(): void;
     getAncestorScale(): {

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

@@ -12,10 +12,12 @@ declare enum MoveObserverType {
 }
 export interface IChangeObserverConfig {
     objects: Map<string, BaseObject>;
+    type: MoveObserverType;
     moveX?: number;
     moveY?: number;
     angle?: number;
-    type: MoveObserverType;
+    offsetX?: number;
+    offsetY?: number;
 }
 /**
  * Transformer constructor.  Transformer is a special type of group that allow you transform

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

@@ -16,6 +16,7 @@ export interface IImageProps extends IShapeProps {
      * 20.1.9.18 prstGeom (Preset geometry)
      */
     prstGeom?: Nullable<PresetGeometryType>;
+    opacity?: number;
 }
 export declare class Image extends Shape<IImageProps> {
     protected _props: IImageProps;
@@ -25,6 +26,8 @@ export declare class Image extends Shape<IImageProps> {
     constructor(id: string, config: IImageProps);
     get srcRect(): Nullable<ISrcRect>;
     get prstGeom(): Nullable<PresetGeometryType>;
+    get opacity(): number;
+    setOpacity(opacity: number): void;
     get classType(): RENDER_CLASS_TYPE;
     transformByStateCloseCropper(option: IObjectFullState): void;
     changeSource(url: string): void;