@univerjs/engine-render 1.0.3 → 1.1.0

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

@@ -36,12 +36,13 @@ export interface IDocumentSkeletonParagraphBorders {
     borderBetween?: IParagraphBorder;
 }
 export interface ISkeletonResourceReference {
-    skeHeaders: Map<string, Map<number, IDocumentSkeletonHeaderFooter>>;
-    skeFooters: Map<string, Map<number, IDocumentSkeletonHeaderFooter>>;
+    skeHeaders: Map<string, Map<number | string, IDocumentSkeletonHeaderFooter>>;
+    skeFooters: Map<string, Map<number | string, IDocumentSkeletonHeaderFooter>>;
     skeListLevel?: Map<string, IParagraphList[][]>;
     drawingAnchor?: Map<string, Map<number, IDocumentSkeletonDrawingAnchor>>;
 }
 export interface IDocumentSkeletonDrawingAnchor {
+    left?: number;
     elements: IDocumentSkeletonLine[];
     paragraphIndex: number;
     top: number;
@@ -67,6 +68,10 @@ export interface IDocumentSkeletonPage {
     sections: IDocumentSkeletonSection[];
     headerId: string;
     footerId: string;
+    /** Per-page field geometry; plain stories keep the legacy width cache key. */
+    fieldsResolved?: boolean;
+    headerLayoutKey?: string;
+    footerLayoutKey?: string;
     pageWidth: number;
     pageHeight: number;
     pageOrient: PageOrientType;
@@ -314,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;
@@ -121,8 +122,8 @@ export interface IParagraphConfig {
     paragraphStyle?: IDocumentLayoutParagraphStyle;
     borderTopSpace?: number;
     borderBottomSpace?: number;
-    skeHeaders: Map<string, Map<number, IDocumentSkeletonHeaderFooter>>;
-    skeFooters: Map<string, Map<number, IDocumentSkeletonHeaderFooter>>;
+    skeHeaders: Map<string, Map<number | string, IDocumentSkeletonHeaderFooter>>;
+    skeFooters: Map<string, Map<number | string, IDocumentSkeletonHeaderFooter>>;
     pDrawingAnchor?: Map<number, IDocumentSkeletonDrawingAnchor>;
 }
 export interface IFontCreateConfig {
@@ -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

@@ -13,8 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { ICustomRange, IDisposable, Nullable } from '@univerjs/core';
-import type { IDocumentSkeletonGlyph, IDocumentSkeletonPage, IDocumentSkeletonSection } from '../../basics/i-document-skeleton-cached';
+import type { IDisposable, Nullable } from '@univerjs/core';
+import type { IDocumentSkeletonPage, IDocumentSkeletonSection } from '../../basics/i-document-skeleton-cached';
 import type { Transform } from '../../basics/transform';
 import type { IViewportInfo } from '../../basics/vector2';
 import type { UniverRenderingContext } from '../../context';
@@ -23,7 +23,6 @@ import type { DocumentSkeleton } from './layout/doc-skeleton';
 import { Vector2 } from '../../basics/vector2';
 import { DocComponent } from './doc-component';
 import './extensions';
-export declare function resolveHeaderFooterFieldGlyph(glyph: IDocumentSkeletonGlyph, startIndex: number, endIndex: number, customRanges: ICustomRange[], pageNumber: number, pageCount: number): IDocumentSkeletonGlyph;
 export interface IPageRenderConfig {
     page: IDocumentSkeletonPage;
     pageLeft: number;
@@ -58,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

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

@@ -53,6 +53,7 @@ export declare class DocumentSkeleton extends Skeleton {
     private _languageDetector;
     private _initialWidth;
     private _paginationMetrics;
+    private _completedPageCount;
     private _lastCompleteSkeletonData;
     private _pendingInvalidationAnchor;
     private _layoutGeneration;
@@ -65,11 +66,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;
@@ -188,6 +192,8 @@ export declare class DocumentSkeleton extends Skeleton {
     private _initializeIncrementalSection;
     private _restartDirtyIncrementalLayout;
     private _finishIncrementalLayout;
+    getCompletedPageCount(): number | undefined;
+    private _prepareFieldCountRetry;
     private _prepareLayoutContext;
     /**
      * \v COLUMN_BREAK

package/lib/types/components/docs/layout/document-layout-publication.d.ts

@@ -26,8 +26,8 @@ export interface IDocumentLayoutPagePublication {
 }
 export interface IDocumentLayoutResourcePublication {
     reset: boolean;
-    skeHeaders: Array<[string, Array<[number, IDocumentSkeletonPagePatch]>]>;
-    skeFooters: Array<[string, Array<[number, IDocumentSkeletonPagePatch]>]>;
+    skeHeaders: Array<[string, Array<[number | string, IDocumentSkeletonPagePatch]>]>;
+    skeFooters: Array<[string, Array<[number | string, IDocumentSkeletonPagePatch]>]>;
     skeListLevel: IDocumentLayoutListLevelPublication | null;
     drawingAnchor: IDocumentLayoutDrawingAnchorPublication | null;
 }

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

@@ -41,6 +41,8 @@ export interface IDocumentLayoutApplyResult {
 export interface IDocumentLayoutProgress {
     generation: number;
     publicationRevision: number;
+    /** Pagination may restart when a total-page field changes the available body space. */
+    paginationRevision?: number;
     didPublish: boolean;
     /** The publication atomically replaced the page containing the edit anchor. */
     didPublishAnchor: boolean;

package/lib/types/components/docs/layout/header-footer-field.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 { ICustomRange } from '@univerjs/core';
+import type { IDocumentSkeletonGlyph } from '../../../basics/i-document-skeleton-cached';
+export declare function resolveHeaderFooterFieldGlyph(glyph: IDocumentSkeletonGlyph, startIndex: number, endIndex: number, customRanges: ICustomRange[], pageNumber: number, pageCount: number | undefined): IDocumentSkeletonGlyph;

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/layout/tools.d.ts

@@ -103,7 +103,7 @@ export interface IDocumentSkeletonLineContext {
     visualWidth?: number;
 }
 export type DocumentSkeletonTableSource = 'page' | 'table-cell' | 'column' | 'header' | 'footer';
-type HeaderFooterSkeletonMap = Map<string, Map<number, IDocumentSkeletonPage>>;
+type HeaderFooterSkeletonMap = Map<string, Map<number | string, IDocumentSkeletonPage>>;
 export interface IDocumentSkeletonTableCellGeometry {
     cell: IDocumentSkeletonPage;
     cellRect: IBoundRectNoAngle;
@@ -241,6 +241,15 @@ export interface IDocumentPaginationMetrics {
     peakCheckpointLineCount: number;
 }
 export interface ILayoutContext {
+    headerFooterFieldContext?: {
+        pageNumber: number;
+        pageCount?: number;
+    };
+    fieldPageCount?: number;
+    hasNumPagesFields?: boolean;
+    fieldCountCandidates?: Set<number>;
+    fieldCountCycle?: boolean;
+    headerFooterMinimumMargins?: Map<string, number>;
     noteReferences?: ReadonlyMap<number, INoteReferenceLayout>;
     footnoteLayout?: DocumentFootnoteLayout;
     endnoteLayout?: DocumentEndnoteLayout;

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;

package/lib/types/worker-layout.d.ts

@@ -45,6 +45,7 @@ export declare class DocumentLayoutSession extends Disposable {
     private readonly _viewModel;
     private readonly _skeleton;
     private _lastPublishedPageCount;
+    private _paginationRevision;
     private _layoutReason;
     private _didPublishEditAnchor;
     private _continuousPageSnapshot;