@univerjs/engine-render 1.1.0 → 1.3.0

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

@@ -13,14 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { ITabStop } from '@univerjs/core';
+import type { ITabStop, ITextStyle } 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[];
+export declare function layoutParagraph(ctx: ILayoutContext, glyphGroup: IDocumentSkeletonGlyph[], pages: IDocumentSkeletonPage[], sectionBreakConfig: ISectionBreakConfig, paragraphConfig: IParagraphConfig, isParagraphFirstShapedText: boolean, breakPointType?: BreakPointType, renderBullet?: boolean, startNewLine?: boolean, markerTextStyle?: Pick<ITextStyle, 'cl' | 'ul'>): IDocumentSkeletonPage[];
 declare function _adjustExplicitTabStop(divide: IDocumentSkeletonDivide, followingGlyphs: IDocumentSkeletonGlyph[], paragraphConfig: IParagraphConfig, tabStops?: ITabStop[] | undefined): void;
 declare function __getWrapTablePosition(table: IDocumentSkeletonTable, column: IDocumentSkeletonColumn, lineTop: number, lineHeight: number, drawingAnchorTop?: number): {
     left: number;

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

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 import type { INumberUnit, ITable, Nullable } from '@univerjs/core';
+import { TableAlignmentType } from '@univerjs/core';
 import type { IDocumentSkeletonPage, IDocumentSkeletonRow, IDocumentSkeletonTable } from '../../../../basics/i-document-skeleton-cached';
 import type { ISectionBreakConfig } from '../../../../basics/interfaces';
 import type { DataStreamTreeNode } from '../../view-model/data-stream-tree-node';
@@ -21,7 +22,6 @@ import type { DocumentViewModel } from '../../view-model/document-view-model';
 import type { DocumentFootnoteLayout } from '../footnote-layout';
 import type { ICellSkeletonBuildState } from '../model/page';
 import type { ILayoutContext } from '../tools';
-import { TableAlignmentType } from '@univerjs/core';
 export interface ITableSkeletonBuildState {
     ctx: ILayoutContext;
     curPage: IDocumentSkeletonPage;
@@ -82,7 +82,7 @@ export declare function stepTableSkeletonsBuild(state: ISlicedTableSkeletonBuild
 export declare function cachePrecomputedSlicedTableSkeletons(ctx: ILayoutContext, tableNode: DataStreamTreeNode, availableHeight: number, result: ISlicedTableSkeletonParams): void;
 export declare function createTableSkeletons(ctx: ILayoutContext, curPage: IDocumentSkeletonPage, viewModel: DocumentViewModel, tableNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, availableHeight: number): ISlicedTableSkeletonParams;
 export declare function resolveTableLayoutColumns(table: ITable, availableWidth: number, traditional?: boolean): ITable;
-export declare function getTableLeft(pageWidth: number, tableWidth: number, align: TableAlignmentType, indent?: INumberUnit): number;
+export declare function getTableLeft(pageWidth: number, tableWidth: number, align: TableAlignmentType, indent?: INumberUnit, allowMarginOverflow?: boolean): number;
 export declare function getNullTableSkeleton(st: number, ed: number, table: ITable): IDocumentSkeletonTable;
 export declare function getTableSliceId(tableId: string, sliceIndex: number): string;
 export declare function getTableIdAndSliceIndex(tableSliceId: string): {

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;
@@ -82,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;
@@ -90,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/tools.d.ts

@@ -184,7 +184,7 @@ export declare function getFontConfigFromLastGlyph(glyph: IDocumentSkeletonGlyph
     snapToGrid: BooleanNumber;
     pageWidth: number;
 };
-export declare function getFontCreateConfig(index: number, viewModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraph: IDocumentLayoutParagraph): IFontCreateConfig;
+export declare function getFontCreateConfig(index: number, viewModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, sectionBreakConfig: ISectionBreakConfig, paragraph: IDocumentLayoutParagraph, includeCustomRangeStyle?: boolean): IFontCreateConfig;
 export declare function getCustomRangeGlyphWidth(index: number, viewModel: DocumentViewModel, paragraphNode: DataStreamTreeNode, config: IFontCreateConfig): number | undefined;
 /**
  * Returns whether a custom range should occupy one measured glyph in the

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