gram: docs

> ./docs/api/docx-editor-core/editor.api.md

## API Report File for "@eigenpal/docx-editor-core"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

import { EditorState } from 'prosemirror-state';
import { Node as Node_2 } from 'prosemirror-model';
import { Transaction } from 'prosemirror-state';

// @public
export function computeLayout(inputs: ComputeLayoutInputs): LayoutComputation;

// @public (undocumented)
export interface ComputeLayoutInputs {
    // (undocumented)
    columns: ColumnLayout | undefined;
    // (undocumented)
    contentWidth: number;
    // (undocumented)
    document: Document_2 | null;
    // (undocumented)
    finalColumns: ColumnLayout | undefined;
    // (undocumented)
    finalMargins: PageMargins;
    // (undocumented)
    finalPageSize: PageSizePx;
    // (undocumented)
    finalSectionProperties: SectionProperties | null | undefined;
    // (undocumented)
    firstPageFooterContent: HeaderFooter | null | undefined;
    // (undocumented)
    firstPageHeaderContent: HeaderFooter | null | undefined;
    // (undocumented)
    footerContent: HeaderFooter | null | undefined;
    getHfPmDoc: (hf: HeaderFooter) => Node_2 | null | undefined;
    headerContent: HeaderFooter | null | undefined;
    // (undocumented)
    margins: PageMargins;
    // (undocumented)
    measureBlocks: MeasureBlocksFn;
    // (undocumented)
    pageGap: number;
    // (undocumented)
    pageSize: PageSizePx;
    // (undocumented)
    sectionProperties: SectionProperties | null | undefined;
    // (undocumented)
    state: EditorState;
    // (undocumented)
    styles: StyleDefinitions | null | undefined;
    // (undocumented)
    theme: Theme | null | undefined;
}

// @public (undocumented)
export function createLayoutScheduler(run: (state: EditorState) => void, scheduleFrame?: (cb: () => void) => number, cancelFrame?: (handle: number) => void): LayoutScheduler;

// @public (undocumented)
export interface LayoutComputation {
    // (undocumented)
    blocks: FlowBlock[];
    // (undocumented)
    firstPageFooterForRender: HeaderFooterContent | undefined;
    // (undocumented)
    firstPageHeaderForRender: HeaderFooterContent | undefined;
    // (undocumented)
    footerContentForRender: HeaderFooterContent | undefined;
    // (undocumented)
    footerDistancePx: number | undefined;
    // (undocumented)
    footnotesByPage: Map<number, FootnoteRenderItem[]> | undefined;
    // (undocumented)
    hasTitlePg: boolean;
    // (undocumented)
    headerContentForRender: HeaderFooterContent | undefined;
    // (undocumented)
    headerDistancePx: number | undefined;
    // (undocumented)
    layout: Layout;
    // (undocumented)
    measures: Measure[];
    // (undocumented)
    pageBorders: SectionProperties['pageBorders'] | undefined;
    // (undocumented)
    watermark: Watermark | undefined;
}

// @public
export interface LayoutScheduler {
    cancel(): void;
    schedule(state: EditorState): void;
}

// @public
export type MeasureBlocksFn = (blocks: FlowBlock[], contentWidth: number | number[], pageGeometry?: FloatPageGeometry) => Measure[];

// @public
export function stripScrollFlag(transaction: Transaction, probeTr: Transaction): void;

// (No @packageDocumentation comment for this package)