@univerjs/engine-render 1.0.4 → 1.2.0

package/lib/types/basics/document-node-tools.d.ts

@@ -24,6 +24,7 @@ export declare function getParagraphByGlyph(glyph: Nullable<IDocumentSkeletonGly
     paragraphEnd: number;
     startIndex: number;
     paragraphId: string;
+    headingCollapsed?: boolean;
     styleId?: string;
     paragraphStyle?: import("@univerjs/core").IParagraphStyle;
     bullet?: import("@univerjs/core").IBullet;

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

@@ -42,6 +42,7 @@ export interface ISkeletonResourceReference {
     drawingAnchor?: Map<string, Map<number, IDocumentSkeletonDrawingAnchor>>;
 }
 export interface IDocumentSkeletonDrawingAnchor {
+    left?: number;
     elements: IDocumentSkeletonLine[];
     paragraphIndex: number;
     top: number;
@@ -318,6 +319,9 @@ export interface IDocumentSkeletonDrawing {
     initialState: boolean;
     drawingOrigin: IDocDrawingBase;
     columnLeft: number;
+    blockAnchorLeft?: number;
+    normalizeTraditionalColumnAnchor?: boolean;
+    pageAnchorLeft?: number;
     isPageBreak: boolean;
     lineTop: number;
     lineHeight: number;

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

@@ -61,6 +61,7 @@ export interface IFontLocale {
     defaultFontSize: number;
 }
 export interface IDocsConfig extends IReferenceSource, IDocumentLayout {
+    lineGap?: number;
     localeService: LocaleService;
     documentTextStyle?: IDocumentLayoutTextStyle;
     documentCompatibilityPolicy?: IDocumentCompatibilityPolicy;
@@ -138,6 +139,8 @@ export interface IFontCreateConfig {
 }
 export interface INodeInfo {
     node: IDocumentSkeletonGlyph;
+    /** The pointer is inside the glyph's content box, excluding line spacing and paragraph margins. */
+    isInsideGlyph?: boolean;
     ratioX: number;
     ratioY: number;
     segmentId: string;

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

@@ -57,6 +57,7 @@ export declare class Documents extends DocComponent {
     getOffsetConfig(): IDocumentOffsetConfig;
     getEngine(): Nullable<import("../..").Engine>;
     isHit(coord: Vector2): boolean;
+    private _isHitTable;
     changeSkeleton(newSkeleton: DocumentSkeleton): this;
     /** Editor-only emphasis; standalone and export renderers retain full document colors. */
     setInactiveAreaOpacity(opacity: number): void;

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

@@ -14,10 +14,10 @@
  * limitations under the License.
  */
 import type { ITabStop } from '@univerjs/core';
+import { BooleanNumber, GridType, SpacingRule } from '@univerjs/core';
 import type { IDocumentSkeletonColumn, IDocumentSkeletonDivide, IDocumentSkeletonDrawing, IDocumentSkeletonGlyph, IDocumentSkeletonLine, IDocumentSkeletonPage, IDocumentSkeletonSection, IDocumentSkeletonTable } from '../../../../../basics/i-document-skeleton-cached';
 import type { IParagraphConfig, IParagraphTableCache, ISectionBreakConfig } from '../../../../../basics/interfaces';
 import type { IFloatObject, ILayoutContext } from '../../tools';
-import { BooleanNumber, GridType, SpacingRule } from '@univerjs/core';
 import { BreakPointType } from '../../line-breaker/break';
 declare function isGlyphGroupBeyondDivideWidth(glyphGroup: IDocumentSkeletonGlyph[], offsetLeft: number, divideWidth: number, hangingPunctuation?: boolean, precedingGlyphs?: IDocumentSkeletonGlyph[], preserveWordSpacing?: boolean, lineWrapTolerance?: number, includeParagraphMark?: boolean, justifyWordSpacing?: boolean): boolean;
 export declare function layoutParagraph(ctx: ILayoutContext, glyphGroup: IDocumentSkeletonGlyph[], pages: IDocumentSkeletonPage[], sectionBreakConfig: ISectionBreakConfig, paragraphConfig: IParagraphConfig, isParagraphFirstShapedText: boolean, breakPointType?: BreakPointType, renderBullet?: boolean, startNewLine?: boolean): IDocumentSkeletonPage[];
@@ -47,6 +47,6 @@ export declare function getLineHeightMetrics(glyphLineHeight: number, paragraphL
     contentHeight: number;
     lineSpacingApply: number;
 };
-export declare function updateInlineDrawingPosition(line: IDocumentSkeletonLine, paragraphInlineSkeDrawings?: Map<string, IDocumentSkeletonDrawing>, unitId?: string, blockAnchorTop?: number, paragraphNonInlineSkeDrawings?: Map<string, IDocumentSkeletonDrawing>, documentCompatibilityPolicy?: IParagraphConfig['documentCompatibilityPolicy']): void;
+export declare function updateInlineDrawingPosition(line: IDocumentSkeletonLine, paragraphInlineSkeDrawings?: Map<string, IDocumentSkeletonDrawing>, unitId?: string, blockAnchorTop?: number, paragraphNonInlineSkeDrawings?: Map<string, IDocumentSkeletonDrawing>, documentCompatibilityPolicy?: IParagraphConfig['documentCompatibilityPolicy'], blockAnchorLeft?: number, normalizeTraditionalColumnAnchor?: boolean): void;
 declare function __checkPageBreak(column: IDocumentSkeletonColumn): boolean;
 export {};

package/lib/types/components/docs/layout/block/section.d.ts

@@ -29,3 +29,4 @@ export declare function dealWithSection(ctx: ILayoutContext, viewModel: Document
     nextParagraphIndex: number;
     complete: boolean;
 };
+export declare function rollbackSectionPages(paragraphIndex: number, allCurrentSkeletonPages: IDocumentSkeletonPage[]): void;

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

@@ -25,11 +25,12 @@ export declare class DocSimpleSkeleton {
     private _warp;
     private _width;
     private _height;
+    private _lineGap;
     private _lineBreaker;
     private _lines;
     private _dirty;
     private _lastBreakLength;
-    constructor(_text: string, _fontStyle: string, _warp: boolean, _width: number, _height: number);
+    constructor(_text: string, _fontStyle: string, _warp: boolean, _width: number, _height: number, _lineGap?: number);
     calculate(): ILineInfo[];
     getLines(): ILineInfo[];
     getTotalHeight(): number;

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

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 import type { LocaleService, Nullable } from '@univerjs/core';
+import { Skeleton } from '@univerjs/core';
 import type { IDocumentSkeletonCached, IDocumentSkeletonGlyph, IDocumentSkeletonPage } from '../../../basics/i-document-skeleton-cached';
 import type { INodeInfo, INodePosition, INodeSearch } from '../../../basics/interfaces';
 import type { IViewportInfo, Vector2 } from '../../../basics/vector2';
@@ -21,7 +22,6 @@ import type { DocumentViewModel } from '../view-model/document-view-model';
 import type { IDocumentLayoutGeometryPublication, IDocumentLayoutPagePublication } from './document-layout-publication';
 import type { DocumentLayoutReason, IDocumentLayoutApplyResult, IDocumentLayoutInvalidation, IDocumentLayoutPageRange, IDocumentLayoutProgress, IDocumentLayoutProtectedRange } from './document-layout-types';
 import type { IDocumentPaginationMetrics } from './tools';
-import { Skeleton } from '@univerjs/core';
 import { PageLayoutType } from '../../../basics/i-document-skeleton-cached';
 import { DocumentEditArea } from '../view-model/document-view-model';
 export declare enum DocumentSkeletonState {
@@ -55,6 +55,8 @@ export declare class DocumentSkeleton extends Skeleton {
     private _paginationMetrics;
     private _completedPageCount;
     private _lastCompleteSkeletonData;
+    private _completedHeadingCollapseSignature;
+    private _publishedHeadingCollapseSignature;
     private _pendingInvalidationAnchor;
     private _layoutGeneration;
     private _activeLayout;
@@ -66,11 +68,14 @@ export declare class DocumentSkeleton extends Skeleton {
     private readonly _isolateIncrementalPublications;
     private _modernPageWidth;
     private _modernHorizontalMargin;
+    private readonly _lineGap;
     constructor(_docViewModel: DocumentViewModel, localeService: LocaleService, options?: {
         isolateIncrementalPublications?: boolean;
+        lineGap?: number;
     });
     static create(docViewModel: DocumentViewModel, localeService: LocaleService, options?: {
         isolateIncrementalPublications?: boolean;
+        lineGap?: number;
     }): DocumentSkeleton;
     dispose(): void;
     getViewModel(): DocumentViewModel;
@@ -79,6 +84,7 @@ export declare class DocumentSkeleton extends Skeleton {
      * PS: This method has significant impact on performance.
      */
     calculate(bounds?: IViewportInfo): void;
+    private _getHeadingCollapseSignature;
     startIncrementalLayout(options?: {
         reason?: DocumentLayoutReason;
         anchor?: number;
@@ -87,6 +93,8 @@ export declare class DocumentSkeleton extends Skeleton {
         modernPageWidth?: number;
         modernHorizontalMargin?: number;
         bounds?: IViewportInfo;
+        /** Keep the current Modern viewport until a visibility change fills its replacement. */
+        minimumPublicationHeight?: number;
         reuseUnaffectedTail?: boolean;
         /** The caller proved this edit only changes offset-preserving render metadata. */
         allowMetadataOnlyStructuralTailReuse?: boolean;

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

@@ -28,7 +28,7 @@ export declare function createNullCellPage(ctx: ILayoutContext, sectionBreakConf
 };
 export declare function getCellBorderWidth(border: ITableCellBorder | undefined): number;
 export declare function getRowBorderInset(row: ITableRow, edge: 'borderTop' | 'borderBottom', tableBoundary?: boolean): number;
-export declare function createSkeletonCellPages(ctx: ILayoutContext, viewModel: DocumentViewModel, cellNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, tableConfig: ITable, row: number, col: number, availableHeight?: number, maxCellPageHeight?: number, cellPageHeights?: readonly number[]): IDocumentSkeletonPage[];
+export declare function createSkeletonCellPages(parentContext: ILayoutContext, viewModel: DocumentViewModel, cellNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, tableConfig: ITable, row: number, col: number, availableHeight?: number, maxCellPageHeight?: number, cellPageHeights?: readonly number[]): IDocumentSkeletonPage[];
 export interface ICellSkeletonBuildState {
     ctx: ILayoutContext;
     viewModel: DocumentViewModel;
@@ -44,7 +44,7 @@ export interface ICellSkeletonBuildState {
     complete: boolean;
     requiresSyncFallback: boolean;
 }
-export declare function startSkeletonCellPagesBuild(ctx: ILayoutContext, viewModel: DocumentViewModel, cellNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, tableConfig: ITable, row: number, col: number, availableHeight?: number, maxCellPageHeight?: number, cellPageHeights?: readonly number[]): ICellSkeletonBuildState;
+export declare function startSkeletonCellPagesBuild(parentContext: ILayoutContext, viewModel: DocumentViewModel, cellNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, tableConfig: ITable, row: number, col: number, availableHeight?: number, maxCellPageHeight?: number, cellPageHeights?: readonly number[]): ICellSkeletonBuildState;
 export declare function stepSkeletonCellPagesBuild(state: ICellSkeletonBuildState): boolean;
 export declare function expandCellPageHeightForInlineDrawings(pages: IDocumentSkeletonPage[]): void;
 export declare function expandCellPageHeightForFlowTables(pages: IDocumentSkeletonPage[]): void;

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

@@ -15,6 +15,7 @@
  */
 import type { DocumentDataModel, ICustomBlock, ICustomDecorationForInterceptor, ICustomRangeForInterceptor, ICustomTable, IDisposable, ITable, JSONXActions, Nullable } from '@univerjs/core';
 import type { IDocumentLayoutBody, IDocumentLayoutColumnGroup, IDocumentLayoutCustomColumnGroup, IDocumentLayoutParagraph, IDocumentLayoutSectionBreak, IDocumentLayoutSnapshot, IDocumentLayoutTextRun } from '../document-layout-presentation';
+import type { IHeadingSection } from './heading-sections';
 import { DataStreamTreeNode } from './data-stream-tree-node';
 interface ITableNodeCache {
     table: DataStreamTreeNode;
@@ -56,6 +57,8 @@ export declare class DocumentViewModel implements IDisposable {
     private _treeNodes;
     private _treeNodesByStartIndex;
     private _plainTopLevelParagraphNodes;
+    private _headingSections;
+    private _collapsedHeadingSections;
     private _metadataCachesDirty;
     private _textRunsOrderedAndDisjoint;
     private _paragraphsOrdered;
@@ -83,6 +86,8 @@ export declare class DocumentViewModel implements IDisposable {
     getEditArea(): DocumentEditArea;
     setEditArea(editArea: DocumentEditArea): void;
     getChildren(): DataStreamTreeNode[];
+    getHeadingSections(): readonly IHeadingSection[];
+    getCollapsedHeadingAtOffset(offset: number): IHeadingSection | undefined;
     getBody(): IDocumentLayoutBody | undefined;
     getSnapshot(): IDocumentLayoutSnapshot;
     getDataModel(): DocumentDataModel;

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

@@ -0,0 +1,26 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { IParagraph } from '@univerjs/core';
+import type { DataStreamTreeNode } from './data-stream-tree-node';
+export interface IHeadingSection {
+    paragraphId: string;
+    paragraphIndex: number;
+    startOffset: number;
+    endOffset: number;
+    collapsed: boolean;
+}
+/** Each table cell and modern column has its own heading hierarchy. */
+export declare function getHeadingSections(sections: readonly DataStreamTreeNode[], getParagraph: (index: number) => IParagraph | undefined): IHeadingSection[];

package/lib/types/components/sheets/extensions/font.d.ts

@@ -71,7 +71,7 @@ export declare class Font extends SheetExtension {
      * @param renderFontContext
      * @param row
      * @param col
-     * @param fontCache
+     * @param padding
      */
     private _clipByRenderBounds;
     private _renderText;

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

@@ -86,6 +86,7 @@ export declare class SpreadsheetSkeleton extends SheetSkeleton {
     private _gridlinesColor;
     private _defaultGridlinesColor;
     private _scene;
+    readonly textLineGap: number;
     constructor(worksheet: Worksheet, _styles: Styles, _localeService: LocaleService, _contextService: IContextService, _configService: IConfigService, _injector: Injector);
     registerGetCellHeight(): void;
     setScene(scene: Scene): void;

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

@@ -25,6 +25,7 @@ export interface ITextProps extends IShapeProps {
     text: string;
     fontStyle: string;
     warp?: boolean;
+    lineGap?: number;
     hAlign?: HorizontalAlign;
     vAlign?: VerticalAlign;
     color?: Nullable<string>;
@@ -40,6 +41,7 @@ export declare class Text extends Shape<ITextProps> {
     text: string;
     fontStyle: string;
     warp: boolean;
+    lineGap: number;
     hAlign: HorizontalAlign;
     vAlign: VerticalAlign;
     skeleton: DocSimpleSkeleton;