@univerjs/engine-render 1.0.3 → 1.0.4

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