@sheetxl/io-xlsx 0.8.0-beta.11 → 0.8.0-beta.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/browser/esm/{Bs0EzhdU8WgGfPzf.mjs → 20e8E-6B9lZDdDO3.mjs} +2 -2
- package/browser/esm/{DICL6ecj9BdJv8aX.mjs → B4_m1DDdERBw_oc_.mjs} +4 -4
- package/browser/esm/{CuAXx5i4uqTz-mMY.mjs → B8HGBRlYw3gtV6cS.mjs} +1 -1
- package/browser/esm/{CzFYJPxmLyKgEKF0.mjs → BUnVDknxJ3z7Byym.mjs} +2 -2
- package/browser/esm/{yveeVJ6hKDI5KDEz.mjs → BZULU4MreyJ0WsDY.mjs} +1243 -1083
- package/browser/esm/{Cv3R6fGatARKedSn.mjs → BduVw3dFdh9sSGv_.mjs} +2560 -2120
- package/browser/esm/CM4k1dv3DNPThvDz.mjs +24 -0
- package/browser/esm/{CZ9I80og75SDRjv0.mjs → CkEGcTzeyh7cqVVb.mjs} +2 -2
- package/browser/esm/{BiDqExNXiY7ykk8E.mjs → DmW0VCJFl3eX7pBV.mjs} +199 -198
- package/browser/esm/{DatIA9fZbEPjW4bh.mjs → eFR-PmxEV53J-933.mjs} +1782 -1266
- package/browser/esm/index.mjs +2 -2
- package/browser/esm/{CLWsOc6DO8l1G_LF.mjs → khCH6SyDFBiHzmSl.mjs} +816 -764
- package/node/esm/BqB-dnUZaszNS--K.mjs +6367 -0
- package/node/esm/{Bpqm_PpGLpdjL47-.mjs → ByC9KtkF09muIv1I.mjs} +257 -256
- package/node/esm/{CAJxmJdobUbzpUz5.mjs → CHElwgFJ32Hh_gHU.mjs} +2 -2
- package/node/esm/{fopiRR7OiVoEiF7B.mjs → CIpg0EBGoVM58ajd.mjs} +2 -2
- package/node/esm/{DScqM1V4wPntNP6-.mjs → CJt_Kh2EU8DlMcus.mjs} +2046 -1588
- package/node/esm/{B9Zn6H1RV07Ob377.mjs → COzTSkHGuyKdKaxO.mjs} +512 -460
- package/node/esm/{ipiyzn5Pfohw2afB.mjs → Cc4XXs0Y2lL-2Et9.mjs} +1350 -1184
- package/node/esm/{CxlSbH7mmnEEsqmX.mjs → DmvVllQAwUtHEJbX.mjs} +1 -1
- package/node/esm/index.mjs +4 -4
- package/package.json +3 -3
- package/types/src/AutoFilterRules.d.ts +0 -42
- package/types/src/DataTableFormula.d.ts +26 -0
- package/types/src/DataValidationRules.d.ts +0 -5
- package/types/src/ExcelCalcStamp.d.ts +0 -36
- package/types/src/ExcelCompat.d.ts +0 -140
- package/types/src/ExcelFunctionFacts.d.ts +0 -272
- package/types/src/ExcelReservedNames.d.ts +0 -64
- package/types/src/KnownFonts.d.ts +0 -13
- package/types/src/LegacyFormula.d.ts +0 -58
- package/types/src/Plugin.d.ts +3 -3
- package/types/src/SheetKinds.d.ts +0 -15
- package/types/src/SourcePackage.d.ts +0 -44
- package/types/src/Types.d.ts +2 -3
- package/types/src/chart/ChartSpaceXml.d.ts +2 -1
- package/types/src/chart/_chartCodecs.d.ts +2 -0
- package/types/src/chart/_chartExStyle.d.ts +0 -9
- package/types/src/reader/CellControls.d.ts +18 -0
- package/types/src/reader/DummyFunctionUnwrap.d.ts +43 -23
- package/types/src/reader/LibreOfficeDataTable.d.ts +3 -2
- package/types/src/reader/domVisitors/AutoFilterVisitor.d.ts +0 -8
- package/types/src/reader/domVisitors/ExternalLinkVisitor.d.ts +1 -11
- package/types/src/reader/domVisitors/FeaturePropertyBagVisitor.d.ts +18 -0
- package/types/src/reader/domVisitors/FmtSchemeVisitor.d.ts +0 -11
- package/types/src/reader/domVisitors/SheetStyleVisitor.d.ts +6 -0
- package/types/src/reader/domVisitors/WorkbookVisitor.d.ts +0 -9
- package/types/src/reader/domVisitors/index.d.ts +2 -4
- package/types/src/reader/saxVisitors/ContentTypesVisitor.d.ts +1 -0
- package/types/src/reader/saxVisitors/SharedStringsVisitor.d.ts +0 -15
- package/types/src/reader/saxVisitors/WorksheetVisitor.d.ts +16 -3
- package/types/src/richValue/ErrorRichValueHandler.d.ts +22 -0
- package/types/src/richValue/IRichValueHandler.d.ts +109 -0
- package/types/src/richValue/LocalImageRichValueHandler.d.ts +18 -0
- package/types/src/richValue/RichDataParts.d.ts +69 -0
- package/types/src/richValue/RichRecordWriter.d.ts +61 -0
- package/types/src/richValue/RichValueHandlers.d.ts +25 -0
- package/types/src/richValue/RichValueResolver.d.ts +54 -0
- package/types/src/richValue/WebImageRichValueHandler.d.ts +37 -0
- package/types/src/richValue/index.d.ts +7 -0
- package/types/src/utils/VmlNoteStyle.d.ts +0 -19
- package/types/src/vba/VBAProject.d.ts +0 -19
- package/types/src/writer/builder/OpcXmlUtils.d.ts +0 -8
- package/types/src/writer/builder/PackageBuilder.d.ts +0 -41
- package/types/src/writer/builder/Types.d.ts +0 -30
- package/types/src/writer/emitters/ExternalLinkEmitter.d.ts +0 -11
- package/types/src/writer/emitters/FeaturePropertyBagEmitter.d.ts +8 -0
- package/types/src/writer/emitters/RichValuePartsEmitters.d.ts +36 -0
- package/types/src/writer/emitters/RichValueRelEmitter.d.ts +12 -0
- package/types/src/writer/emitters/RichValueStructureEmitter.d.ts +4 -3
- package/types/src/writer/emitters/RichValueTypesEmitter.d.ts +3 -2
- package/types/src/writer/emitters/RichValueWebImageEmitter.d.ts +24 -0
- package/types/src/writer/emitters/SlicerEmitter.d.ts +5 -2
- package/types/src/writer/emitters/StylesEmitter.d.ts +2 -0
- package/types/src/writer/utils/CellControlComplements.d.ts +29 -0
- package/types/src/writer/utils/DefaultRows.d.ts +0 -16
- package/types/src/writer/utils/DummyFunction.d.ts +0 -23
- package/types/src/writer/utils/RichValueCollector.d.ts +81 -129
- package/types/src/writer/utils/SheetStyleLayout.d.ts +18 -5
- package/node/esm/DD-yXSBzvDYy0TX5.mjs +0 -5842
- package/types/src/reader/domVisitors/RichValueDataVisitor.d.ts +0 -7
- package/types/src/reader/domVisitors/RichValueStructureVisitor.d.ts +0 -6
|
@@ -1,41 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Every per-function Excel fact this package holds, in ONE map keyed by the upper-cased function
|
|
3
|
-
* name — the single place to see everything measured about a function. The spelling dialect
|
|
4
|
-
* (`LegacyFormula.ts`) and the implicit-intersection semantics (`ExcelCompat.ts`) both read it
|
|
5
|
-
* through the narrow accessors at the bottom; call sites keep asking concern-specific questions
|
|
6
|
-
* and never reach into rows.
|
|
7
|
-
*
|
|
8
|
-
* ### Everything measured; rows OVERRIDE declarations
|
|
9
|
-
*
|
|
10
|
-
* Every fact below is a MEASURED Excel fact, probe-regenerable from
|
|
11
|
-
* `spreadsheetbench/formula-tests/` (`probe-param-intersect{,2,3}.ps1` — 1,212 parameter slots
|
|
12
|
-
* over 497 functions through COM `.Formula`/`.Formula2`; `probe-return-arrayness{,2,3}.ps1` — 508
|
|
13
|
-
* returns; `probe-intersect-oracle.ps1` — the 89-row site battery; `probe-slot-class-intersect*.ps1`
|
|
14
|
-
* — the array scope; `probe-xlfn-prefixes.ps1` / `probe-excel-knows-name.ps1` — the spellings;
|
|
15
|
-
* `probe-volatile-ca.ps1` — `ca="1"`). The registry's declarations state what a BODY needs and
|
|
16
|
-
* serve as the DEFAULT; wherever Excel measurably disagrees, the row here wins (CALC-ISSUES item
|
|
17
|
-
* 44: "use the measured list, not a derived predicate"). Re-run the probes when adding a function
|
|
18
|
-
* — no test can detect a new function Excel happens to disagree with.
|
|
19
|
-
* `scripts/excel-function-facts-lint.mjs` joins the committed probe json against this map and
|
|
20
|
-
* fails on disagreement, which is what lets the rows stay hand-authored.
|
|
21
|
-
*
|
|
22
|
-
* ### Absence keeps its meaning, per FIELD
|
|
23
|
-
*
|
|
24
|
-
* Each field carries its own default for a row that does not declare it (spelled out on the
|
|
25
|
-
* field), and those defaults are NOT the same: absent `prefix` means "written bare", absent
|
|
26
|
-
* `arrayScope` means "INHERITS the enclosing scope". Getting a default wrong here is silent and
|
|
27
|
-
* produces wrong numbers, not errors. The one fact a row's EXISTENCE itself carries: every name
|
|
28
|
-
* here is an Excel-side name, and — unless flagged {@link ExcelFunctionFact.unimplemented} — an
|
|
29
|
-
* Excel built-in our registry implements, i.e. `_xleta.`-eligible.
|
|
30
|
-
*
|
|
31
|
-
* ### Slot addressing
|
|
32
|
-
*
|
|
33
|
-
* Slot fields key parameter positions by the FLATTENED declaration-slot index: the fixed (prefix)
|
|
34
|
-
* parameters in order, then the slots of the repeating cycle. `SUMIFS(sumRange, [criteriaRange,
|
|
35
|
-
* criteria]…)` is slots 0/1/2 and argument `i ≥ 1` binds to slot `1 + (i − 1) % 2` — every
|
|
36
|
-
* criteria pair answers like the first, and insertion stays per-ARGUMENT (two ranges on one slot
|
|
37
|
-
* get two `@`, measured F1/F3 of `probe-collecting-slot.ps1`).
|
|
38
|
-
*/
|
|
39
1
|
/** Future-function prefix. */
|
|
40
2
|
export declare const XLFN = "_xlfn.";
|
|
41
3
|
/**
|
|
@@ -49,101 +11,8 @@ export declare const XLWS = "_xlfn._xlws.";
|
|
|
49
11
|
* see each field for what its absence means.
|
|
50
12
|
*/
|
|
51
13
|
export interface ExcelFunctionFact {
|
|
52
|
-
/**
|
|
53
|
-
* The row exists only for its on-disk SPELLING — our registry implements no function of this
|
|
54
|
-
* name, so a bare token can only be a defined-name reference and never takes `_xleta.`. Three
|
|
55
|
-
* kinds of member, and only the first is a backlog:
|
|
56
|
-
*
|
|
57
|
-
* 1. Excel-side functions we do not YET implement — each a candidate, as `ECMA.CEILING` was
|
|
58
|
-
* until it graduated (2026-08-15) and the flag came off.
|
|
59
|
-
* 2. Documented spellings for surfaces that are not worksheet functions we would ever
|
|
60
|
-
* implement: `COPILOT`, `PY` and the `PYTHON_*` trio, `PQSOURCE`, `QUERYSTRING`, `LONGTEXT`.
|
|
61
|
-
* These are in the map because MS-XLSX documents the marker (see {@link prefix}) and a file
|
|
62
|
-
* carrying one must round-trip; the flag is what stops the ROW — which has to exist for the
|
|
63
|
-
* spelling — from also claiming we implement it. Nothing here will ever graduate.
|
|
64
|
-
* 3. The operator wrapper spellings only this package writes.
|
|
65
|
-
*
|
|
66
|
-
* ABSENT (on a row): the name is an Excel built-in our registry implements, and a bare
|
|
67
|
-
* (parenthesis-less) use of it writes `_xleta.` — the eta-reduction bit. MEASURED, not derived
|
|
68
|
-
* (DESIGN-FORMULA-DIALECT.md: "Excel prefixes what EXCEL considers built-in", not what our
|
|
69
|
-
* registry does — a SheetXL-only built-in stays bare, which round-trips more honestly than
|
|
70
|
-
* `_xleta.OURFN`; those names have NO row at all). Membership was seeded from the audit-1
|
|
71
|
-
* registry dump (`spreadsheetbench/formula-tests/sheetxl-function-names.json`) filtered by the
|
|
72
|
-
* measured Excel-knows oracle (`probe-excel-knows-name{,2,3}.ps1/.json`, Excel 16.0: enter
|
|
73
|
-
* `=NAME()`; an arity refusal or any non-`#NAME?` value proves Excel has it). Slot behavioral
|
|
74
|
-
* verified by `probe-xleta.ps1` / `probe-xleta-lambda-slots.ps1`. Round 3 of the oracle
|
|
75
|
-
* (2026-08-15, build 20228) covered this flag's own members: `ECMA.CEILING`/`PQSOURCE`/
|
|
76
|
-
* `SINGLE`/`ANCHORARRAY` are known; `LONGTEXT`/`PYTHON_*`/`QUERYSTRING` answer a plain
|
|
77
|
-
* `#NAME?` (feature-gated — a negative is build-relative). `COPILOT`/`PY` hang COM entry on
|
|
78
|
-
* their connected-experience init and can never go in an automated sweep, but typing them by
|
|
79
|
-
* hand answers both: `COPILOT` is `#NAME?` like the rest, while `PY` resolves and refuses on
|
|
80
|
-
* ENTITLEMENT (a subscription-tier prompt, not name resolution) — so `PY` is a name this build
|
|
81
|
-
* HAS, and only its license is missing.
|
|
82
|
-
*
|
|
83
|
-
* The one distinction the bit cannot carry — a user-defined name that SHADOWS a built-in
|
|
84
|
-
* spelling stays bare — is derived from the workbook's defined-names collection by the caller
|
|
85
|
-
* (see `createLegacyWriteTransform`).
|
|
86
|
-
*/
|
|
87
14
|
unimplemented?: true;
|
|
88
|
-
/**
|
|
89
|
-
* The on-disk prefix ({@link XLFN} or {@link XLWS}) — functions added in Excel 2010+ that need
|
|
90
|
-
* the marker for backward compatibility, plus the operator spellings only this package writes.
|
|
91
|
-
*
|
|
92
|
-
* ABSENT: the name is written bare. Excel then reads a bare FUTURE name as a call to a defined
|
|
93
|
-
* name that does not exist — `#NAME?`, for a function Excel actually has.
|
|
94
|
-
*
|
|
95
|
-
* ### Two authorities, and which one wins
|
|
96
|
-
*
|
|
97
|
-
* A prefixed row is here because a probe MEASURED the spelling, or because MS-XLSX §2.2.2
|
|
98
|
-
* DOCUMENTS it — `future-function-list` / `worksheet-only-function-list`, at
|
|
99
|
-
* {@link https://learn.microsoft.com/en-us/openspecs/office_standards/ms-xlsx/3d025add-118d-4413-9856-ab65712ec1b0}.
|
|
100
|
-
*
|
|
101
|
-
* The documented list is taken WHOLE, all of it or none of it: all 155 names it spells have a
|
|
102
|
-
* row (joined 2026-08-15), and the 143 inside its `_xlfn.` group plus the 3 `_xlws.` names all
|
|
103
|
-
* carry the marker — the 9 outside the group are the split measured below. A documented
|
|
104
|
-
* spelling we omit is not a missing feature, it is a formula we silently rewrite into `#NAME?`
|
|
105
|
-
* on save, so the bar for a ROW is "Excel writes this name", never "we implement it" — the
|
|
106
|
-
* ones we do not implement are marked {@link unimplemented} and carry the spelling alone.
|
|
107
|
-
*
|
|
108
|
-
* What the list cannot reach is why measurement exists beside it. It omits `TEXTJOIN`,
|
|
109
|
-
* `CONCAT`, `IFS`, `SWITCH`, `MAXIFS`, `MINIFS`, `XMATCH` and `ENCODEURL` — 2016/2019-era
|
|
110
|
-
* functions Excel really does prefix, and precisely the roster `probe-xlfn-prefixes.ps1` was
|
|
111
|
-
* pointed at — plus everything shipped since (`GROUPBY`, `PIVOTBY`, `REGEX*`, `TRIMRANGE`,
|
|
112
|
-
* `PERCENTOF`, and the connected text pair `TRANSLATE`/`DETECTLANGUAGE`, measured in round 3
|
|
113
|
-
* after both sat here BARE — the spelling nothing in the five joins had ever covered).
|
|
114
|
-
* Measurement OVERRIDES the document: the probe enters the formula via
|
|
115
|
-
* `Formula2`, saves, and reads the raw `<f>` back, separating "Excel has it and prefixes it"
|
|
116
|
-
* from "this build never heard of it" by also recording the VALUE — an unknown name is `#NAME?`
|
|
117
|
-
* and nothing else is, and a build that lacks a name still writes `_xlfn.` on it.
|
|
118
|
-
*
|
|
119
|
-
* ### The nine outside the group — measured, and it SPLITS
|
|
120
|
-
*
|
|
121
|
-
* The grammar closes its `("_xlfn." (…))` group before `ECMA.CEILING` / `ISO.CEILING` /
|
|
122
|
-
* `NETWORKDAYS.INTL` / `WORKDAY.INTL` / `FORECAST.LINEAR` / the `FORECAST.ETS*` trio /
|
|
123
|
-
* `FORECAST.ETS.STAT`, and `future-function-call` on the same page is spelled the same way —
|
|
124
|
-
* read literally, all nine are written BARE. Round 2 (`probe-xlfn-prefixes2.ps1/.json`,
|
|
125
|
-
* 2026-08-15, build 20228) measured them and Excel does BOTH: the four ceiling/workday names
|
|
126
|
-
* really are bare, and all five `FORECAST.*` really do take `_xlfn.`. So no reading of the
|
|
127
|
-
* grouping was ever going to be right, and the four bare rows were wrong here from the 2026-02
|
|
128
|
-
* transcription until this measurement — we had been writing `_xlfn.NETWORKDAYS.INTL` for a
|
|
129
|
-
* name Excel writes plain. (Only the WRITE direction moved: the reader strips every leading
|
|
130
|
-
* marker unconditionally, so files carrying the old spelling still load.)
|
|
131
|
-
*/
|
|
132
15
|
prefix?: string;
|
|
133
|
-
/**
|
|
134
|
-
* `'never'`: Excel NEVER intersects into this function, at any argument — the item-44 origin
|
|
135
|
-
* term.
|
|
136
|
-
*
|
|
137
|
-
* Measured 2026-08-12 (`probe-param-intersect.ps1`, verdicts re-joined against the CURRENT
|
|
138
|
-
* declarations 2026-08-12 — the join is what keeps the rows honest when a declaration changes
|
|
139
|
-
* shape). Every marked function has at least one single-value slot the declaration rule would
|
|
140
|
-
* insert into, and Excel inserts into none of them: `=EDATE(D1:D5,1)` stays plain and answers
|
|
141
|
-
* `#VALUE!`, so inserting would turn Excel's error into a date — over-insertion is corruption,
|
|
142
|
-
* not cosmetics.
|
|
143
|
-
*
|
|
144
|
-
* ABSENT: the declaration decides slot by slot (with {@link slotNever}/{@link slotAlways}
|
|
145
|
-
* overrides).
|
|
146
|
-
*/
|
|
147
16
|
intersect?: 'never';
|
|
148
17
|
/**
|
|
149
18
|
* Per-SLOT suppressions — the function intersects normally at other slots and never at these
|
|
@@ -163,132 +32,10 @@ export interface ExcelFunctionFact {
|
|
|
163
32
|
* answers `1`. See {@link valueReturn} for the half of that story Excel does not share with us.
|
|
164
33
|
*/
|
|
165
34
|
slotNever?: readonly number[];
|
|
166
|
-
/**
|
|
167
|
-
* Per-SLOT forces — range-ACCEPTING slots Excel nonetheless intersects into ("consumed whole"),
|
|
168
|
-
* keyed by flattened slot index.
|
|
169
|
-
*
|
|
170
|
-
* `TRANSPOSE.array` is the one permanent member: a site the body consumes entire
|
|
171
|
-
* (`=SUM(TRANSPOSE(A1:A5))` stores as `=SUM(TRANSPOSE(@A1:A5))`, battery A109/A103), and it can
|
|
172
|
-
* never lift — the place `site` and `lift` provably come apart. The other members are item 45's
|
|
173
|
-
* residue — see the section prose at their rows.
|
|
174
|
-
*
|
|
175
|
-
* The `*IFS` criteria entries are GONE (2026-08-13), which is the "data, not API" lifecycle
|
|
176
|
-
* completing: those five slots now declare `AcceptError<Scalar>` and the ENGINE lifts them, so
|
|
177
|
-
* the plain declaration rule answers "site" on its own and the overrides became deletions. The
|
|
178
|
-
* retype was not cosmetic — the hand-rolled broadcast in `aggregateIFS` CLAMPED a short criteria
|
|
179
|
-
* vector where Excel pads `#N/A`, so `=SUMIFS(D1:D5,D1:D5,H1:H3,D1:D5,I1:I2)` answered
|
|
180
|
-
* `140|50|50` against Excel's `140|50|0` (`probe-ifs-broadcast{,2}.ps1`).
|
|
181
|
-
*/
|
|
182
35
|
slotAlways?: readonly number[];
|
|
183
|
-
/**
|
|
184
|
-
* Excel treats the return as ARRAY where the declaration honestly says otherwise — audit 1's
|
|
185
|
-
* residue (`probe-return-arrayness{,2}.ps1`).
|
|
186
|
-
*
|
|
187
|
-
* The selectors are the finding: `IFS`/`SWITCH`/`REDUCE` forward a branch and are marked while
|
|
188
|
-
* `IF`/`CHOOSE`/`LET` forward a branch identically and stay plain — so "polymorphic returns are
|
|
189
|
-
* arrays" is FALSE; it is a per-function fact in Excel's own signature table, and a table is the
|
|
190
|
-
* only honest place for it.
|
|
191
|
-
*/
|
|
192
36
|
arrayReturn?: true;
|
|
193
|
-
/**
|
|
194
|
-
* PROMISES a single value and can hand back a range anyway — rule 3's inner half
|
|
195
|
-
* (`probe-call-wrap.ps1` F-block). The declared scalar return must not be believed by
|
|
196
|
-
* `_isRangeValued`; the arguments decide instead.
|
|
197
|
-
*
|
|
198
|
-
* A call is wrapped only when it promises one value and its arguments break the promise. With
|
|
199
|
-
* one consumer (`SUM`) and eight inner calls, exactly two wrap:
|
|
200
|
-
*
|
|
201
|
-
* ```text
|
|
202
|
-
* wrapped IFERROR, IFNA declared return: a VALUE, forwarded fallback
|
|
203
|
-
* not wrapped IF, CHOOSE, SWITCH, IFS `any` -> not a promise, so it passes through
|
|
204
|
-
* not wrapped TRANSPOSE, SEQUENCE an ARRAY return
|
|
205
|
-
* not wrapped OFFSET a REFERENCE return
|
|
206
|
-
* ```
|
|
207
|
-
*
|
|
208
|
-
* Why a fact and not the declaration: the two error handlers declare `Scalar` (they promise a
|
|
209
|
-
* value, and that promise is load-bearing — it is what refuses `=COLUMN(IFERROR(1,2))` at entry
|
|
210
|
-
* as Excel does, INFORMATION.json item 39) while their `valueIfError` BRANCH forwards whatever
|
|
211
|
-
* it was given. Nothing in a declaration says "promises a value it cannot always deliver", and
|
|
212
|
-
* the one place that needs to know is here. Complementary to {@link arrayReturn}, never
|
|
213
|
-
* overlapping: that bit says "really an array", this one says "a value on paper only".
|
|
214
|
-
*/
|
|
215
37
|
valueReturn?: true;
|
|
216
|
-
/**
|
|
217
|
-
* Reads a reference PER CELL — the result is ranged exactly when the argument at this slot is,
|
|
218
|
-
* even though the declared return is a single value (CALC-ISSUES item 46). The value is the
|
|
219
|
-
* slot the result's extent follows.
|
|
220
|
-
*
|
|
221
|
-
* These never intersect their reference (nothing collapses the argument) and then hand back one
|
|
222
|
-
* value per cell of it, so the mark lands at the ROOT and nowhere else — Excel stores
|
|
223
|
-
* `=@COLUMN(D1:D5)`, `=@ROW(D1:D5)`, `=@ISFORMULA(D1:D5)`, `=@FORMULATEXT(D1:D5)`. Neither the
|
|
224
|
-
* declaration nor the other facts here can reach this: it is a property of the RESULT that only
|
|
225
|
-
* the argument decides.
|
|
226
|
-
*
|
|
227
|
-
* Measured as the four surviving root-bit rows of `probe-param-intersect.ps1` (of its eight, the
|
|
228
|
-
* `IFERROR`/`IFNA` pair closed with rule 3 and both `XLOOKUP` rows with its `IReferenceRange`
|
|
229
|
-
* declaration). **Membership is not derivable** — that sweep holds 23 reference-typed (`r:"p"`,
|
|
230
|
-
* depth 0) slots and Excel marks the root on 10 of them at identical declared shapes: the
|
|
231
|
-
* readers here plus `CELL` (already an {@link arrayReturn} row) and the array/reference returns
|
|
232
|
-
* `OFFSET`/`DROP`/`GROUPBY`/`PIVOTBY` (already answered by their return type), while the
|
|
233
|
-
* aggregators over the very same shape stay plain (`SUBTOTAL`, `SUMIF`/`COUNTIF`/`AVERAGEIF`
|
|
234
|
-
* ranges, `AREAS`, `PHONETIC`). Readers mark, aggregators do not, and no declaration says which.
|
|
235
|
-
*
|
|
236
|
-
* **The rule is the ARGUMENT's rangedness, not the result's realized extent** — measured on both
|
|
237
|
-
* sides, not chosen (`probe-item46-readers2.ps1`). `COLUMN` is the case that separates them,
|
|
238
|
-
* since `COLUMN(D1:D5)` over one column evaluates to the single number 4:
|
|
239
|
-
*
|
|
240
|
-
* ```text
|
|
241
|
-
* C1 =SUM(COLUMN(D1:D5)) -> =SUM(@COLUMN(D1:D5)) wrapped, though the result is 1x1
|
|
242
|
-
* D1 =COLUMN(D1:D5) modern saves as <c cm="1"><f t="array" ref="A10"> marked, though 1x1
|
|
243
|
-
* C5 =SUM(ISFORMULA(F1)) -> unchanged a 1x1 ARGUMENT ranges nothing
|
|
244
|
-
* ```
|
|
245
|
-
*
|
|
246
|
-
* So capability, on the read side AND the write side — in-family with `=SEQUENCE(1)`, which
|
|
247
|
-
* Excel also marks at 1×1 (battery A32). That keeps the read insertion and the `cm` writer on
|
|
248
|
-
* the ONE rule they are meant to share, and makes our marking canonical rather than merely
|
|
249
|
-
* value-identical.
|
|
250
|
-
*
|
|
251
|
-
* A reader also participates in RULE 3: `=SUM(ROW(D1:D5))` stores as `=SUM(@ROW(D1:D5))` even
|
|
252
|
-
* though `SUM` accepts ranges — the collector's tolerance for a reference does not extend to a
|
|
253
|
-
* computed array. See `_isValueReturnCall`.
|
|
254
|
-
*
|
|
255
|
-
* SHAPE, separately (`probe-item46-readers.ps1` block A): `ISFORMULA` and `FORMULATEXT` really
|
|
256
|
-
* do hand back one value per cell (both spill 5×1 over a 5-row reference), `ROW` follows the row
|
|
257
|
-
* axis and `COLUMN` the column axis, and `CELL` — an {@link arrayReturn} row — does NOT lift at
|
|
258
|
-
* all. The `@` alone never proved any of that, which is why it was measured separately.
|
|
259
|
-
*/
|
|
260
38
|
readsPerCell?: number;
|
|
261
|
-
/**
|
|
262
|
-
* The ARRAY SCOPE — the one fact here that is not a property of a single node, THREE-VALUED:
|
|
263
|
-
*
|
|
264
|
-
* - `'opens'` — the function's range-accepting slots array-evaluate their subtree; the scope
|
|
265
|
-
* turns ON beneath them.
|
|
266
|
-
* - `'consumer'` | `'lazy'` — the function turns an inherited scope OFF, for itself and
|
|
267
|
-
* everything below. The two spellings clear identically; they are kept apart because their
|
|
268
|
-
* REASONS are unrelated (a reference collector vs a lazy forwarder — see the section prose at
|
|
269
|
-
* their rows), and the reason is what makes the rows readable.
|
|
270
|
-
* - ABSENT — the function INHERITS the enclosing scope unchanged. The common case and the
|
|
271
|
-
* load-bearing one: a nested `ABS` must leave the scope exactly as it found it.
|
|
272
|
-
*
|
|
273
|
-
* Everything else in this file is a depth-1 fact about one slot. This is a flag pushed DOWN the
|
|
274
|
-
* walk: inside an array-evaluated slot Excel inserts no interior `@`, however scalar the slots
|
|
275
|
-
* beneath it are. `=SUMPRODUCT(ABS(B2:B22))` is what needs it — Excel array-evaluates that
|
|
276
|
-
* argument and answers `945252`, while the depth-1 rules see `ABS`'s scalar `number` slot
|
|
277
|
-
* holding a range, call it a site, and produce `=SUMPRODUCT(ABS(@B2:B22))` — one row, `45003`.
|
|
278
|
-
* A wrong NUMBER from a formula that reads as if nothing happened to it.
|
|
279
|
-
*
|
|
280
|
-
* Measured `probe-slot-class-intersect{,2,3}.ps1` (+ `.json`; 165 cases 2026-08-14, 122 more
|
|
281
|
-
* 2026-08-15), then the FULL-ROSTER sweep `probe-slot-class-intersect4.ps1` (1,031 cases over
|
|
282
|
-
* 509 functions, 2026-08-15 — every built-in probed in BOTH positions, `=F(…)` at the root and
|
|
283
|
-
* `=SUMPRODUCT(F(…))` inside a measured opener, which is what separates opens / clears /
|
|
284
|
-
* inherits; `gen-scope-audit.node.test.ts` derives the case list from the live registry).
|
|
285
|
-
* Method throughout: a type-matched site candidate (`ABS(B2:B22)` / `UPPER(E2:E22)` /
|
|
286
|
-
* `NOT(C2:C22)` — each a one-scalar-slot call over a range, which the `bare` control confirms
|
|
287
|
-
* by taking an `@`) entered through legacy `.Formula` and read back through `.Formula2`, with a
|
|
288
|
-
* root `@` stripped first so only INTERIOR insertion counts. REFUSED at entry (the `D*`
|
|
289
|
-
* database family, `RANK`/`*IFS`/`COUNTBLANK` — Excel rejects a computed array there) is a
|
|
290
|
-
* third outcome, not a verdict: those functions keep no row and stay on the default.
|
|
291
|
-
*/
|
|
292
39
|
arrayScope?: 'opens' | 'consumer' | 'lazy';
|
|
293
40
|
/**
|
|
294
41
|
* Per-SLOT subtree clears — the scope survives the function itself but turns OFF inside these
|
|
@@ -312,25 +59,6 @@ export interface ExcelFunctionFact {
|
|
|
312
59
|
* array slots and clear at these).
|
|
313
60
|
*/
|
|
314
61
|
scopeClears?: readonly number[];
|
|
315
|
-
/**
|
|
316
|
-
* On Excel's volatile-function list — the WRITE-side source of `ca="1"`.
|
|
317
|
-
*
|
|
318
|
-
* Deliberately a COMPAT fact and not an engine property. Excel needs OFFSET/INDIRECT volatile
|
|
319
|
-
* because it cannot statically track where they read; our engine registers the actual target as
|
|
320
|
-
* a dynamic precedent at evaluation (`FormulaContext.getReference`), so it recalculates exactly
|
|
321
|
-
* when the target changes and gains nothing from every-cycle recalc. But the FILE must still say
|
|
322
|
-
* what Excel would say — Excel derives `ca` statically from the formula text, so a cell whose
|
|
323
|
-
* formula calls any of these carries `ca="1"` however our engine schedules it. Functions that
|
|
324
|
-
* really are runtime-volatile for us too (NOW/RAND/CELL/…) also reach `ca` through the live
|
|
325
|
-
* volatile set; this fact is what keeps the flag on the ones that are not.
|
|
326
|
-
*
|
|
327
|
-
* Membership MEASURED over every `FormulaContext.getReference` consumer
|
|
328
|
-
* (`probe-volatile-ca.ps1` + json, 2026-08-14). The measured NOs matter as much:
|
|
329
|
-
* INDEX (value AND reference form — `=SUM(INDEX(..):B10)` stays plain), LOOKUP, XLOOKUP, and
|
|
330
|
-
* the trim-ref OPERATORS `.:.`/`:.` — not volatile even though TRIMRANGE the function is.
|
|
331
|
-
* Also measured there: current Excel adds `aca="1"` beside `ca` on volatile `t="array"` cells
|
|
332
|
-
* (INDIRECT/CELL/TRIMRANGE/RANDARRAY), though corpus files from older producers omit it.
|
|
333
|
-
*/
|
|
334
62
|
volatile?: true;
|
|
335
63
|
}
|
|
336
64
|
/**
|
|
@@ -1,66 +1,2 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Names Excel REFUSES in a worksheet formula, at every arity — the XLM macro-sheet heritage.
|
|
3
|
-
*
|
|
4
|
-
* Emitting one of these bare is not a `#NAME?`, it is an xlsx Excel will not open: the normal
|
|
5
|
-
* load is refused outright, and a user who clicks through the repair prompt gets the workbook
|
|
6
|
-
* back with the offending cell EMPTIED — formula and cached value both gone, and nothing marking
|
|
7
|
-
* that anything was ever there. Measured with its repair outcome in
|
|
8
|
-
* `spreadsheetbench/formula-tests/probe-reserved-name-load.ps1/.json`. The `_xlfn.` marker does
|
|
9
|
-
* NOT rescue them.
|
|
10
|
-
*
|
|
11
|
-
* This is the third of the export hazards and the only one that is file-fatal. The other two:
|
|
12
|
-
*
|
|
13
|
-
* - `ExcelFunctionFact.unimplemented` — Excel has the name, we do not. Record its spelling so
|
|
14
|
-
* the `_xlfn.` prefix survives the round trip.
|
|
15
|
-
* - the deny-set (descriptor category `Sheets`/`SheetXL`, pinned by
|
|
16
|
-
* `sdk/src/__tests__/calculation/excelSupported.parity.test.ts`) — we have the name, Excel does
|
|
17
|
-
* not. Wrap it so the VALUE survives; bare would cost the user their answer.
|
|
18
|
-
* - here — neither has it as a worksheet function AND Excel reserves the name. Wrap it so the
|
|
19
|
-
* FILE survives.
|
|
20
|
-
*
|
|
21
|
-
* ### Provenance
|
|
22
|
-
*
|
|
23
|
-
* Candidates come from two sources: MS-XLSX §2.2.2 `command-list` + `ref-macro-function-call` +
|
|
24
|
-
* `macro-function-call` (505 names), and the function names Excel itself recognizes (708
|
|
25
|
-
* entries), which is the better authority — it is what Excel RECOGNIZES rather than what
|
|
26
|
-
* Microsoft documented, and it carries names the productions never list. `SERIES` is the one that matters here: the chart-series function, absent from every
|
|
27
|
-
* MS-XLSX production and fatal in a worksheet cell.
|
|
28
|
-
*
|
|
29
|
-
* Membership in either source is NOT the verdict — `FILTER`, `IF` and `SORT` appear in them and
|
|
30
|
-
* are ordinary worksheet functions — so every name was MEASURED by entry
|
|
31
|
-
* (`probe-reserved-name-sweep.ps1/.json`, 2026-08-15, Excel 16.0 build 20228): 504 of the 1,238
|
|
32
|
-
* candidates are refused at every arity from 0 to 12.
|
|
33
|
-
*
|
|
34
|
-
* Trying EVERY arity is what makes the reading clean. Excel arity-checks only a name it
|
|
35
|
-
* recognizes, so an unknown name enters at arity 0 (it is read as a call to a defined name that
|
|
36
|
-
* does not exist) while a real function enters at its own minimum — `XLOOKUP` at 3, `ACCRINT`
|
|
37
|
-
* at 6, `ODDFPRICE` at 8. Refused at all of them means the NAME was rejected, not the argument
|
|
38
|
-
* count. The range has to reach the largest mandatory arity in Excel or real functions look
|
|
39
|
-
* reserved: a 0..4 range condemned `ACCRINT`, `PRICE`, `YIELD`, `DURATION`, `VDB` and the
|
|
40
|
-
* `ODD*` family, which is why the probe now carries high-arity controls and fails outright if a
|
|
41
|
-
* name our own registry implements measures reserved.
|
|
42
|
-
*
|
|
43
|
-
* ### What is deliberately NOT here
|
|
44
|
-
*
|
|
45
|
-
* A name we never emit BARE cannot be reached by this hazard, and listing it would do harm.
|
|
46
|
-
* `ANCHORARRAY` and `PQSOURCE` are both refused bare, but `ExcelFunctionFacts` gives them an
|
|
47
|
-
* `_xlfn.` prefix, so we write `_xlfn.PQSOURCE(…)` — the spelling Excel itself writes. Wrapping
|
|
48
|
-
* them would replace a correct round trip with a dead `DUMMYFUNCTION` value, defeating the
|
|
49
|
-
* `unimplemented` rows that exist to preserve exactly that. The rule: a measured refusal earns
|
|
50
|
-
* a place here only if the facts map gives the name no prefix. Lint join 6 enforces it.
|
|
51
|
-
*
|
|
52
|
-
* Only `SPLIT` and `WAIT` are also in our own registry, and the deny-set already wraps both. The
|
|
53
|
-
* rest matter because they reach `resolveUnsupported` as names we do not know, where the default
|
|
54
|
-
* is to pass them through untouched.
|
|
55
|
-
*
|
|
56
|
-
* ### The one name here that measured WRITABLE
|
|
57
|
-
*
|
|
58
|
-
* `MSOCHECKS` enters at every arity on build 20228 — this Excel has forgotten it, so it behaves
|
|
59
|
-
* like any other unknown name. It is listed anyway, against the measurement, because the two
|
|
60
|
-
* errors are not symmetric: a build that still remembers the name makes it file-fatal, while a
|
|
61
|
-
* false positive costs one dead formula in a name nobody types. `FILTER`, `IF` and `SORT` also
|
|
62
|
-
* measured writable and are NOT listed — those are live worksheet functions, where wrapping
|
|
63
|
-
* would break working formulas.
|
|
64
|
-
*/
|
|
65
1
|
export declare const ExcelReservedNames: ReadonlySet<string>;
|
|
66
2
|
//# sourceMappingURL=ExcelReservedNames.d.ts.map
|
|
@@ -1,17 +1,4 @@
|
|
|
1
1
|
import { IFontCollection } from '@sheetxl/sdk';
|
|
2
|
-
/**
|
|
3
|
-
* `x14ac:knownFonts` on `<fonts>` in `styles.xml`: whether a workbook's stored row heights were
|
|
4
|
-
* measured with the real fonts.
|
|
5
|
-
*
|
|
6
|
-
* Excel's rule, from `private-assets/design/rust/tools/oracle-excel-knownfonts.ps1` (2026-10-16):
|
|
7
|
-
* it writes the flag only when it knows every font in the file, and on open it keeps the stored
|
|
8
|
-
* heights of rows that are not custom only when the file has the flag, the Normal style's font is
|
|
9
|
-
* a theme font (`<scheme>`, as in every new workbook; one named outright is re-fitted whatever the
|
|
10
|
-
* flag says), and it knows every font itself; otherwise it re-fits those rows. Which font it is
|
|
11
|
-
* does not matter (Calibri, Arial and Aptos alike). Knowing a font, here, is measuring it with a
|
|
12
|
-
* table of its own: a shipped or added table, or an installed face, never a related family or a
|
|
13
|
-
* stand-in.
|
|
14
|
-
*/
|
|
15
2
|
/** The `paramMap` key under which the styles part leaves what it read about its fonts. */
|
|
16
3
|
export declare const KNOWN_FONTS_PARAM = "knownFonts";
|
|
17
4
|
/** One face a workbook's fonts name. */
|
|
@@ -1,49 +1,8 @@
|
|
|
1
1
|
import { ICalculation } from '@sheetxl/sdk';
|
|
2
2
|
export { XLFN, XLWS } from './ExcelFunctionFacts';
|
|
3
|
-
/**
|
|
4
|
-
* The xlsx legacy-formula dialect — every version-compatibility SPELLING between the modern
|
|
5
|
-
* (dynamic) formula language and what Excel stores on disk. Shared by the writer and the reader;
|
|
6
|
-
* the round-trip tests in this package are the contract that the two halves stay in step.
|
|
7
|
-
*
|
|
8
|
-
* All of it is measured tables + structural rewrites (DESIGN-FORMULA-DIALECT.md):
|
|
9
|
-
*
|
|
10
|
-
* | construct | modern (tree) | on disk (xlsx) |
|
|
11
|
-
* | --- | --- | --- |
|
|
12
|
-
* | future functions | `XLOOKUP(...)` | `_xlfn.XLOOKUP(...)` |
|
|
13
|
-
* | worksheet-only | `FILTER(...)` | `_xlfn._xlws.FILTER(...)` |
|
|
14
|
-
* | spill anchor | postfix `#` | `_xlfn.ANCHORARRAY(ref)` |
|
|
15
|
-
* | implicit intersection | prefix `@` | `_xlfn.SINGLE(ref)` (unless in a table reference) |
|
|
16
|
-
* | structured this-row | `@col` in a table ref | `[#This Row],[col]` |
|
|
17
|
-
* | trim-range | infix `.:.` / `.:` / `:.` | `_xlfn._TRO_ALL/_TRO_LEADING/_TRO_TRAILING(a:b)` |
|
|
18
|
-
* | bare built-in | named `SUM` (unresolved) | `_xleta.SUM` — from the MEASURED `ExcelFunctionFacts` map |
|
|
19
|
-
* | LET/LAMBDA parameter | named `x` | `_xlpm.x` — at the declaration AND at every use |
|
|
20
|
-
* | long string literal | `"…"` over 255 characters | `_xlfn._LONGTEXT("…255…","…255…",…)` |
|
|
21
|
-
*
|
|
22
|
-
* MS-XLSX Extensions to Office Open XML section 2.2.2 Formula:
|
|
23
|
-
* https://learn.microsoft.com/en-us/openspecs/office_standards/ms-xlsx/3d025add-118d-4413-9856-ab65712ec1b0
|
|
24
|
-
*/
|
|
25
|
-
/**
|
|
26
|
-
* The wrapper Excel spells a string literal longer than {@link LONGTEXT_CHUNK} characters with:
|
|
27
|
-
* the literal cut into chunks of at most that many characters, each a string argument, in order.
|
|
28
|
-
* Excel's formula grammar caps a literal at 255 characters; the model has no such cap and holds
|
|
29
|
-
* the literal whole, so the wrapper exists only on disk.
|
|
30
|
-
*
|
|
31
|
-
* Measured (Excel 16.0, 2026-09-23, `probe-dv-launder.ps1`): a 996-character data-validation list
|
|
32
|
-
* literal saved as `_xlfn._LONGTEXT("…","…","…","…")` with chunks of 255, 255, 255 and 231
|
|
33
|
-
* characters (`__tests__/data/conditions/dv-limits.xlsx`). The chunk is counted on the literal's
|
|
34
|
-
* characters, not its imaged form — how a doubled quote (`""`) counts toward the 255 is not yet
|
|
35
|
-
* measured. Excel opens a bare over-long literal in a DV formula (same probe); whether it opens
|
|
36
|
-
* one in a cell `<f>` is unmeasured, so the wrapper is written wherever Excel would write it.
|
|
37
|
-
*/
|
|
38
3
|
export declare const LONGTEXT = "_LONGTEXT";
|
|
39
4
|
/** The longest string literal Excel spells bare — see {@link LONGTEXT}. */
|
|
40
5
|
export declare const LONGTEXT_CHUNK = 255;
|
|
41
|
-
/**
|
|
42
|
-
* Eta-reduced-lambda prefix — a BUILT-IN function referenced WITHOUT parentheses
|
|
43
|
-
* (`=BYROW(A1:B3,SUM)`, and equally `=SUM(ABS)` or `=1+ABS`: Excel prefixes it wherever it
|
|
44
|
-
* appears, not only in lambda-taking slots). A user-defined name (bound to LAMBDA) stays bare.
|
|
45
|
-
* Measured: `spreadsheetbench/formula-tests/probe-xleta*.ps1`, `probe-bare-name.ps1`.
|
|
46
|
-
*/
|
|
47
6
|
export declare const XLETA = "_xleta.";
|
|
48
7
|
/**
|
|
49
8
|
* Lambda-parameter prefix (`_xlpm.name`), stripped on read.
|
|
@@ -53,24 +12,7 @@ export declare const XLETA = "_xleta.";
|
|
|
53
12
|
* cell holds a literal `#NAME?`. See {@link _prefixScopeParameters}.
|
|
54
13
|
*/
|
|
55
14
|
export declare const XLPM = "_xlpm.";
|
|
56
|
-
/**
|
|
57
|
-
* Optional-parameter prefix (`_xlop.name`) — the DECLARATION spelling of `[b]`; every use of the
|
|
58
|
-
* parameter stays `_xlpm.` (measured, application §2.6). Read restores the flag, not the brackets:
|
|
59
|
-
* the display form re-images from `NamedRef.optional`.
|
|
60
|
-
*/
|
|
61
15
|
export declare const XLOP = "_xlop.";
|
|
62
|
-
/**
|
|
63
|
-
* User-defined-function prefix (`_xludf.name`): a call to a function Excel does not resolve.
|
|
64
|
-
*
|
|
65
|
-
* Excel writes it on a name that would otherwise read as one of its own functions. Measured
|
|
66
|
-
* (`spreadsheetbench/formula-tests/probe-bare-future-function.ps1`, Excel 16.0, 2026-10-19): a
|
|
67
|
-
* function Excel stores with a prefix (`_xlfn.RRI`), stored BARE (`<f>RRI(A1,B1,C1)</f>`, as
|
|
68
|
-
* openpyxl and other non-Excel writers leave it), is read as a call to an unknown function -
|
|
69
|
-
* `=@RRI(A1,B1,C1)`, `#NAME?` - and saved untouched as `_xludf.RRI(A1,B1,C1)`; only re-entering
|
|
70
|
-
* the formula makes it the real `RRI`. The bare and the `_xludf.` spellings are the same formula to
|
|
71
|
-
* Excel, so the model holds both as `_xludf.RRI` and writes it bare: LibreOffice keeps whichever
|
|
72
|
-
* spelling it is given, and the bare one is what every other producer wrote.
|
|
73
|
-
*/
|
|
74
16
|
export declare const XLUDF = "_xludf.";
|
|
75
17
|
/**
|
|
76
18
|
* The write direction: modern (dynamic) tree → on-disk xlsx spellings, as an
|
package/types/src/Plugin.d.ts
CHANGED
|
@@ -7,9 +7,9 @@ export declare const XLSX_FORMAT_KEY = "Excel";
|
|
|
7
7
|
* The registry key for macro-enabled Excel (`.xlsm`).
|
|
8
8
|
*
|
|
9
9
|
* @remarks
|
|
10
|
-
* A separate registered format, not a second extension on {@link XLSX_FORMAT_KEY}:
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* A separate registered format, not a second extension on {@link XLSX_FORMAT_KEY}: a format's
|
|
11
|
+
* handler is never told which of its extensions is being written, and macro-enabledness is exactly
|
|
12
|
+
* such a per-extension decision. Both keys
|
|
13
13
|
* share one reader and one writer; only the *write* side is opinionated (the same shape `.sxl` and
|
|
14
14
|
* `.json` use).
|
|
15
15
|
*
|
|
@@ -27,22 +27,7 @@ export declare const readTabColorAttributes: (xml: string) => Map<string, string
|
|
|
27
27
|
* the root, so that is where each goes when absent.
|
|
28
28
|
*/
|
|
29
29
|
export declare const patchTabColor: (xml: string, tabColorXml: string | null) => string;
|
|
30
|
-
/**
|
|
31
|
-
* The part with its first `sheetView@tabSelected` saying whether the tab is selected.
|
|
32
|
-
*
|
|
33
|
-
* @remarks
|
|
34
|
-
* A carried part keeps the source's flag, and Excel group-selects every sheet that has it on open
|
|
35
|
-
* (`probe-sheet-kinds-open.ps1`), so a stale one has to go.
|
|
36
|
-
*/
|
|
37
30
|
export declare const patchTabSelected: (xml: string, selected: boolean) => string;
|
|
38
|
-
/**
|
|
39
|
-
* A macro sheet's part as a worksheet's: the root renamed, the body unchanged.
|
|
40
|
-
*
|
|
41
|
-
* @remarks
|
|
42
|
-
* What Excel does saving a macro sheet into a workbook that cannot hold one (`.xlsx`): the tab comes
|
|
43
|
-
* back as a worksheet holding the same cells (`probe-sheet-kinds-open.ps1`). The macro sheet's body
|
|
44
|
-
* is a worksheet's, element for element in the same order, so only the root changes.
|
|
45
|
-
*/
|
|
46
31
|
export declare const macroSheetAsWorksheet: (xml: string) => string;
|
|
47
32
|
/**
|
|
48
33
|
* A macro sheet's part made independent of the workbook parts it cites by position: each shared
|
|
@@ -1,13 +1,4 @@
|
|
|
1
1
|
import { IWorkbook } from '@sheetxl/sdk';
|
|
2
|
-
/**
|
|
3
|
-
* The default upper bound, in decompressed bytes, on what a {@link SourcePackage} will retain.
|
|
4
|
-
*
|
|
5
|
-
* @remarks
|
|
6
|
-
* Applies to the retained parts only — worksheet/chartsheet bodies and shared strings are never
|
|
7
|
-
* retained (they are always model-owned and rewritten on every save), so this is not the file's
|
|
8
|
-
* uncompressed size, just the "side parts" (styles, drawings, media, printer settings, …) that
|
|
9
|
-
* would otherwise be copied through untouched. See `DESIGN-PACKAGE-PASSTHROUGH.md`.
|
|
10
|
-
*/
|
|
11
2
|
export declare const SOURCE_PACKAGE_MAX_BYTES: number;
|
|
12
3
|
/**
|
|
13
4
|
* A part's still-compressed bytes, sliced directly out of the source zip's local file header —
|
|
@@ -27,17 +18,6 @@ export interface SourcePackagePart {
|
|
|
27
18
|
/** Present when the source's compressed bytes could be sliced out directly; see {@link SourcePackageRawPart}. */
|
|
28
19
|
readonly raw?: SourcePackageRawPart;
|
|
29
20
|
}
|
|
30
|
-
/**
|
|
31
|
-
* The parts of a source OOXML package that SheetXL read but does not model — retained verbatim so
|
|
32
|
-
* a save can pass them through instead of silently dropping them. See
|
|
33
|
-
* `DESIGN-PACKAGE-PASSTHROUGH.md`.
|
|
34
|
-
*
|
|
35
|
-
* @remarks
|
|
36
|
-
* Not a residue map: this holds every non-streamed part from the source zip, decompressed. Which
|
|
37
|
-
* of those a save actually copies through (vs. an emitter claiming the path, vs. a drop-bucket
|
|
38
|
-
* rule) is decided at write time, not here. The one thing it is told rather than holding is
|
|
39
|
-
* {@link isAbsorbed} — which parts the read put on the model, so the writer need not guess.
|
|
40
|
-
*/
|
|
41
21
|
export declare class SourcePackage {
|
|
42
22
|
private readonly _parts;
|
|
43
23
|
private readonly _absorbed;
|
|
@@ -47,33 +27,9 @@ export declare class SourcePackage {
|
|
|
47
27
|
getNames(): string[];
|
|
48
28
|
has(name: string): boolean;
|
|
49
29
|
getPart(name: string): SourcePackagePart | null;
|
|
50
|
-
/**
|
|
51
|
-
* Whether the reader took this part onto the model, so a save writes it from there rather than
|
|
52
|
-
* copying it through — see `DESIGN-PACKAGE-PASSTHROUGH.md` §4.
|
|
53
|
-
*
|
|
54
|
-
* @remarks
|
|
55
|
-
* Identity only: a name, never content. What each absorbed part *says* lives on the model that
|
|
56
|
-
* absorbed it (a chart's part on its movable, a sheet's VML on the sheet, a cache's definition on
|
|
57
|
-
* the workbook), which is the whole point of `PLAN-MODEL-HOMES.md` — this set exists so the
|
|
58
|
-
* passthrough can tell "the model owns this one" from "nothing modeled it" without a list of path
|
|
59
|
-
* patterns standing in for the answer.
|
|
60
|
-
*
|
|
61
|
-
* Independent of whether the element that cited the part still exists: deleting the chart deletes
|
|
62
|
-
* its part with it, and the source's copy should go too.
|
|
63
|
-
*/
|
|
64
30
|
isAbsorbed(name: string): boolean;
|
|
65
31
|
/** Sum of {@link SourcePackagePart.data}'s byte lengths across every retained part. */
|
|
66
32
|
getTotalBytes(): number;
|
|
67
|
-
/**
|
|
68
|
-
* A one-way latch: once true, stays true for this package's lifetime (i.e. until the origin is
|
|
69
|
-
* closed and a fresh read replaces it). Set by the reader when it detects a structural edit —
|
|
70
|
-
* sheet add/delete/reorder, row/column insert/delete — since the read that produced this package.
|
|
71
|
-
*
|
|
72
|
-
* @remarks
|
|
73
|
-
* Deliberately never resets on an undo: an undo doesn't guarantee the exact original XML-level
|
|
74
|
-
* geometry a preserved part assumed, and the parts this gates (`DESIGN-PACKAGE-PASSTHROUGH.md`
|
|
75
|
-
* §4's drop-if-structure-changed bucket) are exactly the ones a wrong guess here would corrupt.
|
|
76
|
-
*/
|
|
77
33
|
hasStructuralChange(): boolean;
|
|
78
34
|
markStructuralChange(): void;
|
|
79
35
|
}
|
package/types/src/Types.d.ts
CHANGED
|
@@ -12,9 +12,8 @@ export interface WriteXLSXOptions extends IWorkbookIO.WriteOptions {
|
|
|
12
12
|
*
|
|
13
13
|
* @remarks
|
|
14
14
|
* Set by the format registration, not by callers: `.xlsx` and `.xlsm` are two registered write
|
|
15
|
-
* formats sharing this one handler
|
|
16
|
-
*
|
|
17
|
-
* handler is never told which of its extensions is being written.
|
|
15
|
+
* formats sharing this one handler. A single format listing both extensions could not express
|
|
16
|
+
* this, because the handler is never told which of its extensions is being written.
|
|
18
17
|
*
|
|
19
18
|
* It decides **both halves together**, so the declaration can never disagree with the payload:
|
|
20
19
|
* the `xl/workbook.xml` content type, and whether a source package's `xl/vbaProject.bin` is
|
|
@@ -28,7 +28,8 @@ export declare const DECLARATION = "<?xml version=\"1.0\" encoding=\"UTF-8\" sta
|
|
|
28
28
|
export declare const writeChartSpace: (chartSpace: ChartModel.ChartSpace) => string;
|
|
29
29
|
/**
|
|
30
30
|
* The markup a chart part is saved as: `xml` as it is while it states what `model` does, so a
|
|
31
|
-
* chart nothing has changed is written byte for byte; otherwise the part written from `model`.
|
|
31
|
+
* chart nothing has changed is written byte for byte; otherwise the part written from `model`. A
|
|
32
|
+
* part stating a label position Excel refuses is always written from `model`, which leaves it out.
|
|
32
33
|
*
|
|
33
34
|
* @param xml The markup the chart was read from, when the part still carries it.
|
|
34
35
|
*/
|
|
@@ -4,6 +4,8 @@ import { XmlWriter } from './_xml';
|
|
|
4
4
|
export declare const NUMBER_FORMAT: Codec;
|
|
5
5
|
/** The DrawingML element name of a group. */
|
|
6
6
|
export declare const groupElementName: (group: Pick<ChartModel.Group, "type" | "is3D">) => string;
|
|
7
|
+
/** Whether a group, a series or a point of the chart states a `dLblPos` its type does not offer. */
|
|
8
|
+
export declare const statesRefusedLabelPosition: (chartSpace: ChartModel.ChartSpace) => boolean;
|
|
7
9
|
/** `c:chartSpace`. */
|
|
8
10
|
export declare const CHART_SPACE: Codec;
|
|
9
11
|
export declare const writeChartSpaceElement: (writer: XmlWriter, chartSpace: ChartModel.ChartSpace) => void;
|
|
@@ -1,12 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* The style and colors parts a 2016 chart is written with when it has none of its own: Excel 16
|
|
3
|
-
* refuses to open a workbook whose `cx:chartSpace` part lacks either, or has an empty one, and opens
|
|
4
|
-
* one that has any complete pair (measured 2026-10-17, `probe-chart-write.ps1`: every 2016 type with
|
|
5
|
-
* the waterfall's style opens clean). These are the parts Excel 16 wrote for a new waterfall
|
|
6
|
-
* (`probe-chart-chartex.ps1`, `chart-chartex.xlsx`); its colors part is the same for every type.
|
|
7
|
-
* Which style each type gets in Excel is in that file too; writing each type its own is Phase 4's
|
|
8
|
-
* style tables.
|
|
9
|
-
*/
|
|
10
1
|
export declare const CHART_STYLE_PART: {
|
|
11
2
|
type: string;
|
|
12
3
|
contentType: string;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { IWorkbook } from '@sheetxl/sdk';
|
|
2
|
+
import { FeaturePropertyBags } from './domVisitors/FeaturePropertyBagVisitor';
|
|
3
|
+
/** The `paramMap` key under which the styles part leaves its cell xfs' complement indices. */
|
|
4
|
+
export declare const XF_COMPLEMENTS_PARAM = "xfComplements";
|
|
5
|
+
/**
|
|
6
|
+
* Splits the cell-control layer back out of the xfs: Excel's per-format checkboxes become the
|
|
7
|
+
* model's anchored `cellControls`, and the styles stay styles.
|
|
8
|
+
*
|
|
9
|
+
* Excel stores a checkbox on the cell's xf (`xfComplement` → the feature property bags), the model
|
|
10
|
+
* keeps it apart. Runs after `applyHeaderStyles`, so `directStyles` already holds every cell's
|
|
11
|
+
* resolved xf as runs (a cell's own over its row's over its column's); each run whose xf carries a
|
|
12
|
+
* control becomes a range of that control, one entry per control per sheet, never a per-cell walk.
|
|
13
|
+
*
|
|
14
|
+
* xf 0 is skipped: it is the format of every unstyled cell, and a control there would cover the
|
|
15
|
+
* whole sheet.
|
|
16
|
+
*/
|
|
17
|
+
export declare const applyCellControls: (jsonWB: IWorkbook.JSON, xfComplements: ReadonlyMap<number, number> | undefined, bags: FeaturePropertyBags | undefined) => void;
|
|
18
|
+
//# sourceMappingURL=CellControls.d.ts.map
|