@univerjs/engine-render 1.0.0-insiders.20260809-70eefdd → 1.0.0-rc.0

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

@@ -0,0 +1,62 @@
+/**
+ * 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 { DocumentDataModel, LocaleService, Nullable } from '@univerjs/core';
+import type { IDocumentSkeletonPage } from './basics/i-document-skeleton-cached';
+import type { IDocumentLayoutGeometryPublication, IDocumentLayoutPagePublication } from './components/docs/layout/document-layout-publication';
+import type { DocumentLayoutReason, IDocumentLayoutInvalidation, IDocumentLayoutProgress } from './components/docs/layout/document-layout-types';
+import { Disposable } from '@univerjs/core';
+export interface IDocumentLayoutSessionStartOptions {
+    reason?: DocumentLayoutReason;
+    anchor?: number;
+    priorityAnchor?: number;
+    invalidation?: IDocumentLayoutInvalidation;
+    waitForHyphenationPatterns?: boolean;
+}
+export interface IDocumentLayoutStepResult {
+    progress: IDocumentLayoutProgress;
+    publication: IDocumentLayoutGeometryPublication | null;
+}
+/**
+ * Worker-safe owner of the document view model and incremental layout state.
+ * Scheduling, transport, presentation and model revision ordering belong to callers.
+ */
+export declare class DocumentLayoutSession extends Disposable {
+    private readonly _viewModel;
+    private readonly _skeleton;
+    private _lastPublishedPageCount;
+    private _layoutReason;
+    private _didPublishEditAnchor;
+    private _continuousPageSnapshot;
+    private _continuousReplacementOffset;
+    private readonly _publishedHeaderPages;
+    private readonly _publishedFooterPages;
+    private _resetPublishedResources;
+    private _pendingPaginatedCompletion;
+    constructor(dataModel: DocumentDataModel, localeService: LocaleService);
+    start(options?: IDocumentLayoutSessionStartOptions): number;
+    step(generation: number, budgetMs?: number, maxWorkUnits?: number): IDocumentLayoutStepResult;
+    publishBacklog(generation: number): IDocumentLayoutStepResult;
+    getPage(pageIndex: number): IDocumentLayoutPagePublication | null;
+    cancel(generation?: number): void;
+    resetDataModel(dataModel: DocumentDataModel): void;
+    getProgress(): Nullable<IDocumentLayoutProgress>;
+    static hydratePage(publication: IDocumentLayoutPagePublication, snapshot?: ReturnType<DocumentDataModel['getSnapshot']>): IDocumentSkeletonPage;
+    dispose(): void;
+    private _collectPublications;
+    private _publishPaginatedCompletionBacklog;
+    private _collectPublication;
+    private _collectResourcePublication;
+}