@aiquants/spreadsheet 0.16.0 → 0.17.0

package/dist/index.d.cts

@@ -670,6 +670,22 @@ export declare type HtmlTableResult = {
     readonly outcome: "none";
 };
 
+/**
+ * Yields the rows of a text that may be only the beginning of a TSV (a file read partway, a stream not yet ended), in
+ * exactly iterateTsvRows's grammar, but only those the rest of the text cannot change: every row the text ends with a
+ * line terminator, up to the first field that opens a quote the text does not close (whether it is one quoted field or a
+ * literal one split at its line breaks is the rest's to decide). So the rows of any beginning of a TSV are the first
+ * rows of the whole: a reader of a stream can show them as final. Empty text yields no row. Unpadded.
+ * TSV の先頭だけかもしれない文字 (途中まで読んだファイル、まだ終わらないストリーム) の行を、iterateTsvRows とちょうど同じ文法で、
+ * ただし文字の続きが変えられない行だけ出す処理。文字が改行で終える行すべてを、文字が閉じない引用を開く最初の値まで出す (それが 1 つの
+ * 引用の値か、改行で割れる文字どおりの値かは続きが決める)。そのため TSV のどの先頭の行も全体の最初の行で、ストリームの読み手は
+ * それを確定したものとして見せられる。空の文字は行を出さない。埋めない。
+ *
+ * @param text - The beginning of a TSV text, as read. 読んだままの TSV の文字の先頭。
+ * @returns The rows the rest of the text cannot change, unpadded. 文字の続きが変えられない行 (埋めない)。
+ */
+export declare function iterateTsvPrefixRows(text: string): Generator<string[]>;
+
 /**
  * Yields the rows of a TSV text one at a time, in exactly parseTsv's grammar (the same quoting rule, line terminators
  * and final-terminator handling; empty text is one row with one empty cell), WITHOUT padding them to a common width. A
@@ -1308,6 +1324,20 @@ export declare const SPREADSHEET_RESERVED_SHORTCUTS: readonly string[];
  */
 export declare type SpreadsheetCommand = "bold" | "italic" | "underline" | "strikethrough" | "clearFormatting" | "alignLeft" | "alignCenter" | "alignRight" | "formatNumber" | "formatTime" | "formatDate" | "formatCurrency" | "formatPercent" | "formatScientific" | "bordersOuter" | "bordersClear" | "borderTop" | "borderRight" | "borderBottom" | "borderLeft" | "insertLink" | "insertNote" | "insertComment" | "openHyperlink" | "openValidationList" | "pasteSpecial" | "fillDown" | "fillRight" | "fillSelection" | "insertDate" | "insertTime" | "hideRows" | "hideColumns" | "unhideRows" | "unhideColumns" | "increaseColumnWidth" | "decreaseColumnWidth" | "increaseRowHeight" | "decreaseRowHeight" | "autoFitColumnWidth" | "formatGeneral" | "bordersAll" | "pasteFormats" | "pasteFormulas" | "pasteAdd" | "pasteSubtract" | "pasteMultiply" | "pasteDivide" | "multiplyBy100" | "multiplyBy1000" | "divideBy100" | "divideBy1000" | "signReversal" | "fillColorYellow" | "fillColorBlue" | "fillColorGreen" | "fillColorRed" | "fillColorCustom1" | "fillColorCustom2" | "fillColorCustom3" | "fillColorCustom4" | "fillColorCustom5" | "fontColorYellow" | "fontColorBlue" | "fontColorGreen" | "fontColorRed" | "fontColorCustom1" | "fontColorCustom2" | "fontColorCustom3" | "fontColorCustom4" | "fontColorCustom5" | "toggleRowHighlight" | "toggleColumnHighlight" | "toggleBothHighlight" | "toggleIntersectionHighlight";
 
+/**
+ * The size of a grid's content in CSS px of the page (v0.17): the column-letter and row-number bands (0 when `headings`
+ * is false), every column and row at its current size, and the two scroll bars the grid always reserves, all scaled by
+ * the zoom — the box a host gives the grid to show every column and row without scrolling.
+ * グリッドの中身の大きさ (ページの CSS px。v0.17)。列の記号と行の番号の帯 (`headings` が false なら 0)、今の大きさの全部の列と行、
+ * グリッドがいつも取る 2 本のスクロールバーを、どれも倍率で伸び縮みさせたもの。ホストがスクロールなしで全部の列と行を見せる箱の大きさ。
+ */
+export declare type SpreadsheetContentSize = {
+    /** The width in CSS px. 幅 (CSS px)。 */
+    readonly width: number;
+    /** The height in CSS px. 高さ (CSS px)。 */
+    readonly height: number;
+};
+
 /**
  * The single data boundary between the grid and the consumer. Reads via getCellText (renderCell
  * — a SpreadsheetProps prop, not an adapter member — customizes only the presentation of that
@@ -1578,6 +1608,22 @@ export declare type SpreadsheetHandle = {
     resizeRow: (row: number, heightPx: number) => void;
     /** Column-width resize (§6.9-8). / 列幅変更。 */
     resizeColumn: (col: number, widthPx: number) => void;
+    /**
+     * Fits each listed column to the widest text of ALL its rows (header rows included; v0.17), as Alt+Shift+= fits the
+     * active column over the rows in view: the same painted fonts, the 9 px padding and the 10,000 px bound, measured with
+     * the cells' base font. A hidden column keeps its width and so does an empty one. Refused through
+     * onOperationRejected("resize", cells, "limit") when the cells to measure exceed `maxOperationCells`. Works whatever
+     * `enableResizeUI` and `headings` say (an imperative path, like resizeColumn).
+     * 名指した列を、その列の**全部の行** (見出しの行も) で最も広い文字に合わせる (v0.17)。Alt+Shift+= が表示中の行で active 列を
+     * 合わせるのと同じ塗りの書体・余白 9 px・上限 10,000 px で、セルの基本の書体で測る。隠した列と空の列は幅を保つ。測るセルが
+     * `maxOperationCells` を超えると onOperationRejected("resize", セル, "limit") で拒む。`enableResizeUI` と `headings` に依らず
+     * 働く (resizeColumn と同じ命令の経路)。
+     *
+     * @param columns - The columns to fit (repeats count once). 合わせる列 (重複は 1 回)。
+     * @returns True when the fit ran (a hidden or empty column changes nothing); false when refused or when the grid cannot measure (`renderCell` is set, or the grid is not mounted). 走ったら true (隠した列・空の列は何も変えない)。拒まれたとき・測れないとき (`renderCell` がある、または未装着) は false。
+     * @throws {RangeError} When a column is not an integer between 0 and the column count − 1. 列が 0〜列数 − 1 の整数でない場合。
+     */
+    autoFitColumns: (columns: readonly number[]) => boolean;
     /**
      * Programmatic viewport jump to a cell (delegates to the engine's scrollToCell — the
      * floor-and-pin jump API). Selection is unchanged; the deep grid stays reachable at any
@@ -2026,6 +2072,29 @@ export declare type SpreadsheetProps = {
      * 復元手段を失う (命令 API のみ)。
      */
     enableResizeUI?: boolean;
+    /**
+     * v0.17 — Shows the column letters, the row numbers and the corner (Excel's "headings"; not `headerRows`), true by
+     * default. False draws none of the three and collapses their grid tracks to 0, so the cells start at the grid's
+     * top-left corner; the gestures that live only on them go with them (header presses, the corner's select-all, the
+     * resize strips and unhide markers), and their keyboard twins stay (Ctrl+Space, Shift+Space, Ctrl+A, Alt+Shift+Arrow,
+     * Alt+Shift+=). The bands are `aria-hidden`, so assistive technology meets the same grid. The root carries
+     * `data-aqsp-headings-hidden` while they are hidden. LIVE prop.
+     * v0.17 — 列の記号・行の番号・角 (Excel の「見出し」。`headerRows` とは別) を見せるか (既定 true)。false は 3 つを描かず、
+     * その格子の帯を 0 にしてセルを根の左上から始める。それらの上にだけある操作 (見出しの押下・角の全選択・境の帯と再表示の印) は
+     * 無くなり、キーの双子 (Ctrl+Space・Shift+Space・Ctrl+A・Alt+Shift+矢印・Alt+Shift+=) は残る。帯は `aria-hidden` なので、
+     * 支援技術から見えるグリッドは変わらない。隠している間、根は `data-aqsp-headings-hidden` を持つ。
+     */
+    headings?: boolean;
+    /**
+     * v0.17 — Receives the size of the grid's content (`SpreadsheetContentSize`) after the first layout and again after
+     * every change of it: a track's size (a resize, an autofit, a hide or unhide, the imperative resizeRow / resizeColumn),
+     * the row or column count, the default sizes, the zoom or `headings`. An unchanged size is not repeated. A host uses it
+     * to size the grid's box to its content.
+     * v0.17 — グリッドの中身の大きさ (`SpreadsheetContentSize`) を、最初の配置の後と、それが変わるたびに受け取る (トラックの
+     * 大きさ — 境の操作・autofit・隠す・再表示・命令の resizeRow / resizeColumn —、行や列の数、既定の大きさ、倍率、`headings`)。
+     * 同じ大きさは繰り返さない。ホストはこれでグリッドの箱を中身に合わせる。
+     */
+    onContentSizeChange?: (size: SpreadsheetContentSize) => void;
     /**
      * AT announcement text for the active cell; omit for silence (no built-in strings). `text`
      * is the RAW canonical getCellText; `displayText` is the value-format display string (the

package/dist/index.d.ts

@@ -670,6 +670,22 @@ export declare type HtmlTableResult = {
     readonly outcome: "none";
 };
 
+/**
+ * Yields the rows of a text that may be only the beginning of a TSV (a file read partway, a stream not yet ended), in
+ * exactly iterateTsvRows's grammar, but only those the rest of the text cannot change: every row the text ends with a
+ * line terminator, up to the first field that opens a quote the text does not close (whether it is one quoted field or a
+ * literal one split at its line breaks is the rest's to decide). So the rows of any beginning of a TSV are the first
+ * rows of the whole: a reader of a stream can show them as final. Empty text yields no row. Unpadded.
+ * TSV の先頭だけかもしれない文字 (途中まで読んだファイル、まだ終わらないストリーム) の行を、iterateTsvRows とちょうど同じ文法で、
+ * ただし文字の続きが変えられない行だけ出す処理。文字が改行で終える行すべてを、文字が閉じない引用を開く最初の値まで出す (それが 1 つの
+ * 引用の値か、改行で割れる文字どおりの値かは続きが決める)。そのため TSV のどの先頭の行も全体の最初の行で、ストリームの読み手は
+ * それを確定したものとして見せられる。空の文字は行を出さない。埋めない。
+ *
+ * @param text - The beginning of a TSV text, as read. 読んだままの TSV の文字の先頭。
+ * @returns The rows the rest of the text cannot change, unpadded. 文字の続きが変えられない行 (埋めない)。
+ */
+export declare function iterateTsvPrefixRows(text: string): Generator<string[]>;
+
 /**
  * Yields the rows of a TSV text one at a time, in exactly parseTsv's grammar (the same quoting rule, line terminators
  * and final-terminator handling; empty text is one row with one empty cell), WITHOUT padding them to a common width. A
@@ -1308,6 +1324,20 @@ export declare const SPREADSHEET_RESERVED_SHORTCUTS: readonly string[];
  */
 export declare type SpreadsheetCommand = "bold" | "italic" | "underline" | "strikethrough" | "clearFormatting" | "alignLeft" | "alignCenter" | "alignRight" | "formatNumber" | "formatTime" | "formatDate" | "formatCurrency" | "formatPercent" | "formatScientific" | "bordersOuter" | "bordersClear" | "borderTop" | "borderRight" | "borderBottom" | "borderLeft" | "insertLink" | "insertNote" | "insertComment" | "openHyperlink" | "openValidationList" | "pasteSpecial" | "fillDown" | "fillRight" | "fillSelection" | "insertDate" | "insertTime" | "hideRows" | "hideColumns" | "unhideRows" | "unhideColumns" | "increaseColumnWidth" | "decreaseColumnWidth" | "increaseRowHeight" | "decreaseRowHeight" | "autoFitColumnWidth" | "formatGeneral" | "bordersAll" | "pasteFormats" | "pasteFormulas" | "pasteAdd" | "pasteSubtract" | "pasteMultiply" | "pasteDivide" | "multiplyBy100" | "multiplyBy1000" | "divideBy100" | "divideBy1000" | "signReversal" | "fillColorYellow" | "fillColorBlue" | "fillColorGreen" | "fillColorRed" | "fillColorCustom1" | "fillColorCustom2" | "fillColorCustom3" | "fillColorCustom4" | "fillColorCustom5" | "fontColorYellow" | "fontColorBlue" | "fontColorGreen" | "fontColorRed" | "fontColorCustom1" | "fontColorCustom2" | "fontColorCustom3" | "fontColorCustom4" | "fontColorCustom5" | "toggleRowHighlight" | "toggleColumnHighlight" | "toggleBothHighlight" | "toggleIntersectionHighlight";
 
+/**
+ * The size of a grid's content in CSS px of the page (v0.17): the column-letter and row-number bands (0 when `headings`
+ * is false), every column and row at its current size, and the two scroll bars the grid always reserves, all scaled by
+ * the zoom — the box a host gives the grid to show every column and row without scrolling.
+ * グリッドの中身の大きさ (ページの CSS px。v0.17)。列の記号と行の番号の帯 (`headings` が false なら 0)、今の大きさの全部の列と行、
+ * グリッドがいつも取る 2 本のスクロールバーを、どれも倍率で伸び縮みさせたもの。ホストがスクロールなしで全部の列と行を見せる箱の大きさ。
+ */
+export declare type SpreadsheetContentSize = {
+    /** The width in CSS px. 幅 (CSS px)。 */
+    readonly width: number;
+    /** The height in CSS px. 高さ (CSS px)。 */
+    readonly height: number;
+};
+
 /**
  * The single data boundary between the grid and the consumer. Reads via getCellText (renderCell
  * — a SpreadsheetProps prop, not an adapter member — customizes only the presentation of that
@@ -1578,6 +1608,22 @@ export declare type SpreadsheetHandle = {
     resizeRow: (row: number, heightPx: number) => void;
     /** Column-width resize (§6.9-8). / 列幅変更。 */
     resizeColumn: (col: number, widthPx: number) => void;
+    /**
+     * Fits each listed column to the widest text of ALL its rows (header rows included; v0.17), as Alt+Shift+= fits the
+     * active column over the rows in view: the same painted fonts, the 9 px padding and the 10,000 px bound, measured with
+     * the cells' base font. A hidden column keeps its width and so does an empty one. Refused through
+     * onOperationRejected("resize", cells, "limit") when the cells to measure exceed `maxOperationCells`. Works whatever
+     * `enableResizeUI` and `headings` say (an imperative path, like resizeColumn).
+     * 名指した列を、その列の**全部の行** (見出しの行も) で最も広い文字に合わせる (v0.17)。Alt+Shift+= が表示中の行で active 列を
+     * 合わせるのと同じ塗りの書体・余白 9 px・上限 10,000 px で、セルの基本の書体で測る。隠した列と空の列は幅を保つ。測るセルが
+     * `maxOperationCells` を超えると onOperationRejected("resize", セル, "limit") で拒む。`enableResizeUI` と `headings` に依らず
+     * 働く (resizeColumn と同じ命令の経路)。
+     *
+     * @param columns - The columns to fit (repeats count once). 合わせる列 (重複は 1 回)。
+     * @returns True when the fit ran (a hidden or empty column changes nothing); false when refused or when the grid cannot measure (`renderCell` is set, or the grid is not mounted). 走ったら true (隠した列・空の列は何も変えない)。拒まれたとき・測れないとき (`renderCell` がある、または未装着) は false。
+     * @throws {RangeError} When a column is not an integer between 0 and the column count − 1. 列が 0〜列数 − 1 の整数でない場合。
+     */
+    autoFitColumns: (columns: readonly number[]) => boolean;
     /**
      * Programmatic viewport jump to a cell (delegates to the engine's scrollToCell — the
      * floor-and-pin jump API). Selection is unchanged; the deep grid stays reachable at any
@@ -2026,6 +2072,29 @@ export declare type SpreadsheetProps = {
      * 復元手段を失う (命令 API のみ)。
      */
     enableResizeUI?: boolean;
+    /**
+     * v0.17 — Shows the column letters, the row numbers and the corner (Excel's "headings"; not `headerRows`), true by
+     * default. False draws none of the three and collapses their grid tracks to 0, so the cells start at the grid's
+     * top-left corner; the gestures that live only on them go with them (header presses, the corner's select-all, the
+     * resize strips and unhide markers), and their keyboard twins stay (Ctrl+Space, Shift+Space, Ctrl+A, Alt+Shift+Arrow,
+     * Alt+Shift+=). The bands are `aria-hidden`, so assistive technology meets the same grid. The root carries
+     * `data-aqsp-headings-hidden` while they are hidden. LIVE prop.
+     * v0.17 — 列の記号・行の番号・角 (Excel の「見出し」。`headerRows` とは別) を見せるか (既定 true)。false は 3 つを描かず、
+     * その格子の帯を 0 にしてセルを根の左上から始める。それらの上にだけある操作 (見出しの押下・角の全選択・境の帯と再表示の印) は
+     * 無くなり、キーの双子 (Ctrl+Space・Shift+Space・Ctrl+A・Alt+Shift+矢印・Alt+Shift+=) は残る。帯は `aria-hidden` なので、
+     * 支援技術から見えるグリッドは変わらない。隠している間、根は `data-aqsp-headings-hidden` を持つ。
+     */
+    headings?: boolean;
+    /**
+     * v0.17 — Receives the size of the grid's content (`SpreadsheetContentSize`) after the first layout and again after
+     * every change of it: a track's size (a resize, an autofit, a hide or unhide, the imperative resizeRow / resizeColumn),
+     * the row or column count, the default sizes, the zoom or `headings`. An unchanged size is not repeated. A host uses it
+     * to size the grid's box to its content.
+     * v0.17 — グリッドの中身の大きさ (`SpreadsheetContentSize`) を、最初の配置の後と、それが変わるたびに受け取る (トラックの
+     * 大きさ — 境の操作・autofit・隠す・再表示・命令の resizeRow / resizeColumn —、行や列の数、既定の大きさ、倍率、`headings`)。
+     * 同じ大きさは繰り返さない。ホストはこれでグリッドの箱を中身に合わせる。
+     */
+    onContentSizeChange?: (size: SpreadsheetContentSize) => void;
     /**
      * AT announcement text for the active cell; omit for silence (no built-in strings). `text`
      * is the RAW canonical getCellText; `displayText` is the value-format display string (the