reamkit 1.31.0 → 1.32.0

package/dist/esm/excel/formula/parser.js

@@ -148,6 +148,10 @@ var Parser = class {
 			case "sheetq":
 				this.expect("!");
 				return this.parseSheetCell(t.text);
+			case "sref": return {
+				k: "sref",
+				ref: parseStructuredRef(t.text)
+			};
 			case "op":
 				if (t.text === "(") {
 					const e = this.parseExpr(0);
@@ -323,5 +327,96 @@ function columnToIndex(letters) {
 	for (let i = 0; i < up.length; i++) idx = idx * 26 + (up.charCodeAt(i) - 64);
 	return idx - 1;
 }
+var AREAS = new Map([
+	["#all", "#All"],
+	["#data", "#Data"],
+	["#headers", "#Headers"],
+	["#totals", "#Totals"],
+	["#this row", "#This Row"]
+]);
+/**
+* §18.17.6.4 — read a structured reference's text: `Table[Col]`, `Table[]`,
+* `Table[#Totals]`, `Table[[#Headers],[A]:[C]]`, `[@Col]`, `[@[Col 2]]`.
+*
+* @param text The token: the table's name, if any, and its brackets.
+* @returns The reference.
+* @throws ParseError when the brackets name nothing a table has.
+*/
+function parseStructuredRef(text) {
+	const open = text.indexOf("[");
+	const table = text.slice(0, open);
+	let inner = text.slice(open + 1, -1).trim();
+	const areas = [];
+	let columns;
+	if (inner.startsWith("@")) {
+		areas.push("#This Row");
+		inner = inner.slice(1).trim();
+		if (inner.length > 0 && !inner.startsWith("[")) inner = `[${inner}]`;
+	} else if (inner.length > 0 && !inner.startsWith("[")) inner = `[${inner}]`;
+	for (const item of splitTopLevel(inner)) {
+		const range = splitRange(item);
+		if (range) {
+			columns = [unescapeName(range[0]), unescapeName(range[1])];
+			continue;
+		}
+		const body = item.slice(1, -1);
+		const area = AREAS.get(body.trim().toLowerCase());
+		if (area) areas.push(area);
+		else {
+			const name = unescapeName(body);
+			columns = [name, name];
+		}
+	}
+	return {
+		table,
+		areas,
+		...columns ? { columns } : {}
+	};
+}
+/** The bracket groups of a list `[a],[b]:[c]`, each with its `:` partner. */
+function splitTopLevel(inner) {
+	const out = [];
+	let depth = 0;
+	let start = 0;
+	for (let i = 0; i < inner.length; i++) {
+		const c = inner[i];
+		if (c === "'") {
+			i++;
+			continue;
+		}
+		if (c === "[") depth++;
+		else if (c === "]") depth--;
+		else if (c === "," && depth === 0) {
+			out.push(inner.slice(start, i).trim());
+			start = i + 1;
+		}
+	}
+	const last = inner.slice(start).trim();
+	if (last.length > 0) out.push(last);
+	for (const item of out) if (!item.startsWith("[") || !item.endsWith("]")) throw new ParseError(`bad structured reference part ${item}`);
+	return out;
+}
+/** `[A]:[C]` → the two columns' bracketed bodies, or undefined for one group. */
+function splitRange(item) {
+	let depth = 0;
+	for (let i = 0; i < item.length; i++) {
+		const c = item[i];
+		if (c === "'") {
+			i++;
+			continue;
+		}
+		if (c === "[") depth++;
+		else if (c === "]") depth--;
+		else if (c === ":" && depth === 0) {
+			const a = item.slice(0, i).trim();
+			const b = item.slice(i + 1).trim();
+			return [a.slice(1, -1), b.slice(1, -1)];
+		}
+	}
+}
+/** A column name as written in a reference, its `'` escapes undone. */
+function unescapeName(name) {
+	return name.trim().replace(/'(.)/g, "$1");
+}
 //#endregion
 export { parse };

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.
  *