reamkit 1.31.0 → 1.32.1

package/dist/esm/excel/print-model.d.ts

@@ -1,7 +1,8 @@
-import { BodyElement, SectionProperties, Table } from '../core/document-model/index.js';
+import { BodyElement, CellNoteFlag, SectionProperties, Table } from '../core/document-model/index.js';
 import { CellRange, DefinedName, ParsedWorksheet, SheetRichRun, WorksheetCell, XlsxStyles } from './index.js';
 import { SheetHyperlink, SheetSlicer } from '../core/ir/sheet.js';
 import { Loss } from '../core/ir/loss.js';
+import { DrawingBox } from './column-bands.js';
 /**
  * Excel "character width" → twips: the default font's Maximum Digit Width,
  * ~7 px at 96 DPI ≈ 5.25 pt ≈ 105 twips.
@@ -36,11 +37,37 @@ export declare const COL_PADDING_TWIPS = 75;
  * @returns The rendered column width in twips.
  */
 export declare function columnTwips(chars: number, charTwips: number): number;
+/**
+ * §18.3.1.81 — the DEFAULT column, in twips: the sheet's `defaultColWidth`
+ * where it declares one — a stored width, padding included — and otherwise
+ * `baseColWidth` digits and their padding, rounded up to Excel's step of eight
+ * pixels. Padding a `baseColWidth` twice once stood in for that rounding: it
+ * gives 47668.xlsx's 80px as well, and nothing else.
+ *
+ * @param worksheet The sheet.
+ * @param charTwips The Maximum Digit Width, in twips.
+ * @returns The default column width in twips.
+ */
+export declare function defaultColumnTwips(worksheet: ParsedWorksheet, charTwips: number): number;
 /**
  * Excel's default column width is 8.43 "characters" ≈ 64px ≈ 960 twips. Used for
  * columns without an explicit `<col width="..">`.
  */
 export declare const DEFAULT_COL_TWIPS = 960;
+/**
+ * §18.3.1.13 — the unit a sheet's columns are measured in: the Maximum Digit
+ * Width of the workbook's Normal font, in twips — the font's own where the
+ * workbook names it, the face we render with where it names none. A drawing's
+ * anchor counts columns in the same unit, or it lands beside the cells it is
+ * anchored to: 45540_form_Footer.xlsx sets its form in 宋体 12, whose digit
+ * is 8px, and anchored at Excel's 7px its check boxes stood a column off
+ * their labels.
+ *
+ * @param styles       The workbook's styles (its first font is the Normal style's).
+ * @param digitWidthPt The render font's digit width, for a workbook that names no font.
+ * @returns The unit, in twips.
+ */
+export declare function columnUnitTwips(styles: XlsxStyles, digitWidthPt?: number): number;
 /**
  * The row height a sheet that declares none inherits from the workbook's
  * Normal font. Sizes outside Excel's table scale from its 10pt entry and snap
@@ -94,6 +121,8 @@ export declare function printableWidthPt(worksheet: ParsedWorksheet): number;
  */
 export declare function printableHeightPt(worksheet: ParsedWorksheet): number;
 interface PrintModelOptions {
+    readonly screen?: boolean;
+    readonly image?: boolean;
     readonly printArea?: CellRange;
     readonly gridLines: boolean;
     readonly titleRows?: {
@@ -114,10 +143,16 @@ interface PrintModelOptions {
     readonly bandSink?: {
         lefts: Array<number>;
     };
+    readonly headingSink?: {
+        dxPt: number;
+        dyPt: number;
+    };
+    readonly noteFlags?: ReadonlyMap<string, CellNoteFlag>;
     readonly drawingExtentPt?: {
         readonly widthPt: number;
         readonly heightPt: number;
     };
+    readonly drawingBoxesPt?: ReadonlyArray<DrawingBox>;
     readonly losses?: Array<Loss>;
 }
 /**
@@ -149,6 +184,8 @@ export declare function worksheetToBody(worksheet: ParsedWorksheet, sharedString
  * @returns The resolved display string.
  */
 export declare function resolveCellText(cell: WorksheetCell, sharedStrings: ReadonlyArray<string>, styles: XlsxStyles, date1904: boolean): string;
+/** The key {@link PrintModelOptions.noteFlags} is looked up by: absolute row and column. */
+export declare function noteKey(row: number, col: number): string;
 /**
  * Whether an EMPTY cell still draws something of its own — a fill or a border.
  *