@sheetxl/sdk 0.8.0-beta.10 → 0.8.0-beta.12

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.
Files changed (522) hide show
  1. package/README.md +1 -1
  2. package/browser/esm/{CYyv6uGjo10ig5FP.mjs → -Jx-jNHmtIQQfLvK.mjs} +1 -1
  3. package/browser/esm/{CdLZWVcH8cncBUPJ.mjs → 2WuhYrIpYmOR5H73.mjs} +110 -261
  4. package/browser/esm/{Cqr3knDsBvoVZ6MN.mjs → 2mIwPy2D2JUX-9wx.mjs} +2 -2
  5. package/browser/esm/B3wf5vZCsWfWsDbj.mjs +12 -0
  6. package/browser/esm/{BzLfNyc6OOShIErH.mjs → BIHrHjRGWVlJglcp.mjs} +2 -2
  7. package/browser/esm/{C9B0djuUarfNdoj0.mjs → BTFBedJMRWGvZyCE.mjs} +1 -1
  8. package/browser/esm/{Btg43M1Bf-ENDreu.mjs → BdCJNawfifyPupCP.mjs} +1 -1
  9. package/browser/esm/{ClB5ix51roQOpZEr.mjs → Bg5Di9GLNAkbqQ1P.mjs} +2877 -2067
  10. package/browser/esm/BnC4-27Igwb8oDf2.mjs +1552 -0
  11. package/browser/esm/{DhKkrCVASZ6Isvz6.mjs → Bt8_m94tBdks209L.mjs} +1 -1
  12. package/browser/esm/{zqJOaweiXE9D8RY1.mjs → BudSIfXBAsTxvu-K.mjs} +31835 -40812
  13. package/browser/esm/C9u8FUewte5ugUjH.mjs +5132 -0
  14. package/browser/esm/{Di58Ji1n--3Mgc_2.mjs → CBYMTDzMf1Vh7pkw.mjs} +1 -1
  15. package/browser/esm/CNdjyofiRu6CYOrr.mjs +12835 -0
  16. package/browser/esm/{Dtoyt8q5RyGAlxCp.mjs → CRkYR-siY2C994KV.mjs} +1 -1
  17. package/browser/esm/CTe2qfmIUEad6FJv.mjs +199 -0
  18. package/browser/esm/CUzYuYTTGsChC_kZ.mjs +8422 -0
  19. package/browser/esm/CdEO8CEee6lEhabA.mjs +117 -0
  20. package/browser/esm/CfRqiPDg6RBTg1EN.mjs +367 -0
  21. package/browser/esm/CndRBvVfQUJIYRRj.mjs +193 -0
  22. package/browser/esm/{Y79I7Sm8kjaYexhf.mjs → CwOPLXU3-9ZHGyOT.mjs} +1 -1
  23. package/browser/esm/{CjsUGJEQSbGjnH6R.mjs → Cxjxk0ncRKx80I-w.mjs} +1 -1
  24. package/browser/esm/D2RZh0O9neOsyLAE.mjs +281 -0
  25. package/browser/esm/{De175LygU7ot4nQm.mjs → D64dM68B1pKYFzdP.mjs} +2 -2
  26. package/browser/esm/{o8MFgcVXns987D6_.mjs → D9xNz46kAfXMZzp4.mjs} +6 -6
  27. package/browser/esm/{BcHmrKHwMMOlzc9_.mjs → DK899HhWX1HINMC1.mjs} +55 -55
  28. package/browser/esm/DPhGQLNGmDZwODwJ.mjs +395 -0
  29. package/browser/esm/DVroRnhi-5IDXNgM.mjs +210 -0
  30. package/browser/esm/{Bk7xxbdDpa7-sIwd.mjs → DZiivy0NmO1Vnyzk.mjs} +2 -2
  31. package/browser/esm/{CZ5oa92wZEAXebgk.mjs → DgrAuRD2qr2DvFeJ.mjs} +78 -68
  32. package/browser/esm/{D4uVlrG0xEFctsSM.mjs → DobHLF6VjHr7Xi40.mjs} +285 -67
  33. package/browser/esm/{CSx9ed1JOs7K5BXO.mjs → DwZCT7DZiiXoTweg.mjs} +2 -2
  34. package/browser/esm/DwwR3O2sEZApPSTF.mjs +86 -0
  35. package/browser/esm/Tah7cnFb_HNZdLtj.mjs +128 -0
  36. package/browser/esm/{BEAY9XgKNx-bakXW.mjs → fXWUMDhZ5yMSO629.mjs} +1 -1
  37. package/browser/esm/{BqskM7wA8oPfFQue.mjs → hCQJcmIzPDxDEv2q.mjs} +2 -2
  38. package/browser/esm/index.mjs +1294 -1008
  39. package/browser/esm/{Cgd5BnM3hg9RyUel.mjs → qO-ujUrgq6H3TQix.mjs} +1 -1
  40. package/browser/esm/w6Jea0TiclPrYZ2M.mjs +1703 -0
  41. package/browser/esm/yuhcOYw6SHQ-RCm3.mjs +114 -0
  42. package/licenses/dependencies.txt +75 -75
  43. package/node/esm/-TA0MneBDKdGhsib.mjs +8668 -0
  44. package/node/esm/B-HUPAcqvK0eeeCz.mjs +134 -0
  45. package/node/esm/BL2iiEoqxDEV2Xrg.mjs +8320 -0
  46. package/node/esm/{C6ZXsNyLXI6zA63X.mjs → BNXLOEddJ6O9gYws.mjs} +9 -9
  47. package/node/esm/{BH1v-E4Ro3bR7Znw.mjs → BSvOluusoDM4z_dx.mjs} +151 -302
  48. package/node/esm/{CD9wbvufChVYYkrI.mjs → BskP3b8vUoIOGLY6.mjs} +2 -2
  49. package/node/esm/{CnSQ7MTXAUAyBOoS.mjs → Btw4148Ot8ifhNc1.mjs} +285 -64
  50. package/node/esm/{B6D7sSetrcOWLsKj.mjs → C14-R6tifRh7pc0p.mjs} +1 -1
  51. package/node/esm/C99zzq8DImQXi4BQ.mjs +133 -0
  52. package/node/esm/{BtuY37FumvLE7EBo.mjs → CBuEu5Jk-LfaDy-H.mjs} +176 -166
  53. package/node/esm/{DdFgXl-Ux2cMBTs_.mjs → CG-qBU5BAaVz7e-P.mjs} +1 -1
  54. package/node/esm/CPI58duc0j0a-HpJ.mjs +115 -0
  55. package/node/esm/CRt3vXe6YmXzqk3H.mjs +406 -0
  56. package/node/esm/{CUUoseJmFsCf82bb.mjs → C_aL7CGS1lrNn1Ng.mjs} +1 -1
  57. package/node/esm/{D7MfcID2Wf6l6VpC.mjs → C_xf5Bz30VqiJjXn.mjs} +1 -1
  58. package/node/esm/CiIymQN6aJCul62g.mjs +610 -0
  59. package/node/esm/{B9ljpEIZg6wOTzRE.mjs → Ci_zLYmCD7e-C79O.mjs} +1 -1
  60. package/node/esm/{Bqd62L8KFgdS0Vou.mjs → CkRYLed8Mmn3giNg.mjs} +2 -2
  61. package/node/esm/D3ptRKzASqBut1DE.mjs +117 -0
  62. package/node/esm/{DefYISWfdZJFx57m.mjs → D4ROK9UwDpS6jO3Z.mjs} +1 -1
  63. package/node/esm/D8hO07ToAibIuniw.mjs +13014 -0
  64. package/node/esm/{Bh4dv6tMjXX3X4nI.mjs → DUTmDHbFbhLDT4F3.mjs} +1 -1
  65. package/node/esm/{DCplLG93GfTs1vNw.mjs → DV5CU37aEbFbWFL0.mjs} +1 -1
  66. package/node/esm/{CUQi5ZtMO02nhG0W.mjs → DdoiuKg9BKubtF1V.mjs} +1 -1
  67. package/node/esm/DggQ23jKMpwhENfa.mjs +372 -0
  68. package/node/esm/DhS6yWjrrSNIJMsn.mjs +1033 -0
  69. package/node/esm/{DMD12JUh7HJw2-jl.mjs → DhTya_mhmN53vskv.mjs} +1 -1
  70. package/node/esm/Dn1M7YWi25DeeYUb.mjs +210 -0
  71. package/node/esm/DrCf6ITcBhVOFpRj.mjs +86 -0
  72. package/node/esm/{BN9j8V9gCExMjVtJ.mjs → DxazKtROyaI51dWl.mjs} +1 -1
  73. package/node/esm/{MiU4rDOiocmJ-9Ry.mjs → Q_S1g46ZOTrdhTae.mjs} +1 -1
  74. package/node/esm/Vocy-I9dKzZMr0Ct.mjs +59323 -0
  75. package/node/esm/ZXPFcsT2zrALCZux.mjs +289 -0
  76. package/node/esm/eimUGjiIP-b8HiM6.mjs +199 -0
  77. package/node/esm/icn2nX5Z8e_3mNAv.mjs +12 -0
  78. package/node/esm/index.mjs +2808 -65678
  79. package/node/esm/lGJ42sHqg5if2bba.mjs +1770 -0
  80. package/node/esm/{Bsx9uijd4X_SKV3L.mjs → pYtP7wPyS96NQyXS.mjs} +51 -51
  81. package/package.json +6 -7
  82. package/resources/contents.json +120 -0
  83. package/resources/fonts/arial-bold-italic.hinted.json +125 -0
  84. package/resources/fonts/arial-bold-italic.metrics.json +13 -13
  85. package/resources/fonts/arial-bold-italic.rows.json +9 -0
  86. package/resources/fonts/arial-bold.hinted.json +125 -0
  87. package/resources/fonts/arial-bold.metrics.json +12 -12
  88. package/resources/fonts/arial-bold.rows.json +9 -0
  89. package/resources/fonts/arial-italic.hinted.json +125 -0
  90. package/resources/fonts/arial-italic.metrics.json +13 -13
  91. package/resources/fonts/arial-italic.rows.json +9 -0
  92. package/resources/fonts/arial-regular.hinted.json +125 -0
  93. package/resources/fonts/arial-regular.metrics.json +12 -12
  94. package/resources/fonts/arial-regular.rows.json +9 -0
  95. package/resources/fonts/calibri-bold-italic.hinted.json +122 -0
  96. package/resources/fonts/calibri-bold-italic.metrics.json +2 -2
  97. package/resources/fonts/calibri-bold-italic.rows.json +9 -0
  98. package/resources/fonts/calibri-bold.hinted.json +122 -0
  99. package/resources/fonts/calibri-bold.metrics.json +1 -1
  100. package/resources/fonts/calibri-bold.rows.json +9 -0
  101. package/resources/fonts/calibri-italic.hinted.json +121 -0
  102. package/resources/fonts/calibri-italic.metrics.json +2 -2
  103. package/resources/fonts/calibri-italic.rows.json +9 -0
  104. package/resources/fonts/calibri-regular.hinted.json +121 -0
  105. package/resources/fonts/calibri-regular.metrics.json +1 -1
  106. package/resources/fonts/calibri-regular.rows.json +9 -0
  107. package/resources/fonts/cambria-bold-italic.hinted.json +105 -0
  108. package/resources/fonts/cambria-bold-italic.metrics.json +26 -26
  109. package/resources/fonts/cambria-bold-italic.rows.json +9 -0
  110. package/resources/fonts/cambria-bold.hinted.json +108 -0
  111. package/resources/fonts/cambria-bold.metrics.json +19 -19
  112. package/resources/fonts/cambria-bold.rows.json +9 -0
  113. package/resources/fonts/cambria-italic.hinted.json +102 -0
  114. package/resources/fonts/cambria-italic.metrics.json +23 -23
  115. package/resources/fonts/cambria-italic.rows.json +9 -0
  116. package/resources/fonts/cambria-regular.hinted.json +110 -0
  117. package/resources/fonts/cambria-regular.metrics.json +18 -18
  118. package/resources/fonts/cambria-regular.rows.json +9 -0
  119. package/resources/fonts/contents.json +280 -0
  120. package/resources/fonts/courier-new-bold-italic.hinted.json +11 -0
  121. package/resources/fonts/courier-new-bold-italic.metrics.json +12 -12
  122. package/resources/fonts/courier-new-bold-italic.rows.json +9 -0
  123. package/resources/fonts/courier-new-bold.hinted.json +11 -0
  124. package/resources/fonts/courier-new-bold.metrics.json +12 -12
  125. package/resources/fonts/courier-new-bold.rows.json +9 -0
  126. package/resources/fonts/courier-new-italic.hinted.json +11 -0
  127. package/resources/fonts/courier-new-italic.metrics.json +12 -12
  128. package/resources/fonts/courier-new-italic.rows.json +9 -0
  129. package/resources/fonts/courier-new-regular.hinted.json +11 -0
  130. package/resources/fonts/courier-new-regular.metrics.json +12 -12
  131. package/resources/fonts/courier-new-regular.rows.json +9 -0
  132. package/resources/fonts/times-new-roman-bold-italic.hinted.json +125 -0
  133. package/resources/fonts/times-new-roman-bold-italic.metrics.json +15 -15
  134. package/resources/fonts/times-new-roman-bold-italic.rows.json +9 -0
  135. package/resources/fonts/times-new-roman-bold.hinted.json +125 -0
  136. package/resources/fonts/times-new-roman-bold.metrics.json +12 -12
  137. package/resources/fonts/times-new-roman-bold.rows.json +9 -0
  138. package/resources/fonts/times-new-roman-italic.hinted.json +125 -0
  139. package/resources/fonts/times-new-roman-italic.metrics.json +16 -16
  140. package/resources/fonts/times-new-roman-italic.rows.json +9 -0
  141. package/resources/fonts/times-new-roman-regular.hinted.json +125 -0
  142. package/resources/fonts/times-new-roman-regular.metrics.json +16 -16
  143. package/resources/fonts/times-new-roman-regular.rows.json +9 -0
  144. package/resources/locales/de/model.msg.json +93 -9
  145. package/resources/locales/en/model.msg.json +95 -10
  146. package/types/scripting-api.json +10809 -8021
  147. package/types/scripting-enums.json +201 -44
  148. package/types/scripting.d.ts +17030 -8666
  149. package/types/src/.generated/wasm/fonts.d.ts +161 -0
  150. package/types/src/.generated/wasm/fonts_bg.inline.d.ts +3 -0
  151. package/types/src/.generated/wasm/sdk.d.ts +122 -0
  152. package/types/src/.generated/wasm/sdk_bg.inline.d.ts +3 -0
  153. package/types/src/address/AddressUtils.d.ts +10 -1
  154. package/types/src/address/_StructuredAddress.d.ts +58 -0
  155. package/types/src/anomalies/_Anomalies.d.ts +109 -0
  156. package/types/src/anomalies/_FocusTable.d.ts +11 -0
  157. package/types/src/anomalies/_FormulaChecks.d.ts +133 -0
  158. package/types/src/anomalies/_LabelChecks.d.ts +21 -0
  159. package/types/src/anomalies/_LiteralChecks.d.ts +35 -0
  160. package/types/src/anomalies/_SeriesChecks.d.ts +13 -0
  161. package/types/src/border/IBorders.d.ts +16 -0
  162. package/types/src/calculation/Calculation.d.ts +139 -371
  163. package/types/src/calculation/ExternalBookBindings.d.ts +2 -3
  164. package/types/src/calculation/FormulaLiterals.d.ts +2 -1
  165. package/types/src/calculation/FormulaText.d.ts +18 -2
  166. package/types/src/calculation/ICalculation.d.ts +133 -18
  167. package/types/src/calculation/INamedFormulasCollection.d.ts +4 -0
  168. package/types/src/calculation/NamedFormulaCollection.d.ts +293 -22
  169. package/types/src/calculation/_CloneBoundary.d.ts +1 -1
  170. package/types/src/calculation/_FormulaToolkit.d.ts +9 -0
  171. package/types/src/calculation/_TableExtent.d.ts +60 -0
  172. package/types/src/calculation/compiler/ASTTypes.d.ts +6 -2
  173. package/types/src/calculation/compiler/CompilerUtils.d.ts +17 -0
  174. package/types/src/calculation/compiler/ParserUtils.d.ts +16 -0
  175. package/types/src/calculation/compiler/Types.d.ts +9 -1
  176. package/types/src/calculation/engine/CalcBackend.d.ts +953 -0
  177. package/types/src/calculation/engine/index.d.ts +10 -0
  178. package/types/src/calculation/executor/CalcExecutor.d.ts +94 -24
  179. package/types/src/calculation/executor/CalcExecutorUtils.d.ts +23 -1
  180. package/types/src/calculation/executor/_WhatIf.d.ts +50 -0
  181. package/types/src/calculation/formula/Formula.d.ts +9 -0
  182. package/types/src/calculation/formula/FormulaBlock.d.ts +10 -3
  183. package/types/src/calculation/formula/IFormulaBlock.d.ts +21 -0
  184. package/types/src/calculation/formula/LambdaValue.d.ts +5 -3
  185. package/types/src/calculation/functions/FunctionDeclarations.d.ts +5 -1
  186. package/types/src/calculation/functions/_DataTableFunction.d.ts +14 -0
  187. package/types/src/calculation/functions/expandDeclaration.d.ts +15 -0
  188. package/types/src/calculation/functions/initializeFunctions.d.ts +0 -12
  189. package/types/src/calculation/grid/CalcGrid.d.ts +44 -10
  190. package/types/src/calculation/grid/CalcGridBackend.d.ts +35 -27
  191. package/types/src/calculation/grid/CalcGridProxy.d.ts +2 -2
  192. package/types/src/calculation/grid/CalcGridUtils.d.ts +12 -3
  193. package/types/src/calculation/grid/FormulaHost.d.ts +51 -6
  194. package/types/src/calculation/grid/ICalcGrid.d.ts +48 -15
  195. package/types/src/calculation/grid/_CalcRequest.d.ts +28 -6
  196. package/types/src/calculation/grid/_CellValueRun.d.ts +21 -0
  197. package/types/src/calculation/spatial/FormulaSpatialValue.d.ts +29 -2
  198. package/types/src/calculation/spatial/SpillEntry.d.ts +16 -2
  199. package/types/src/calculation/state/CalcNode.d.ts +0 -1
  200. package/types/src/calculation/state/CalcScope.d.ts +44 -6
  201. package/types/src/calculation/state/CalcState.d.ts +36 -4
  202. package/types/src/calculation/state/CalculationContext.d.ts +30 -3
  203. package/types/src/calculation/state/DeferredCalls.d.ts +260 -0
  204. package/types/src/calculation/state/IContextContainer.d.ts +32 -0
  205. package/types/src/calculation/state/_PendingOverlayGrid.d.ts +6 -0
  206. package/types/src/calculation/state/_WhatIfLayer.d.ts +91 -0
  207. package/types/src/calculation/toolkit/FormulaLiteralReader.d.ts +4 -0
  208. package/types/src/calculation/toolkit/FormulaTextParser.d.ts +10 -0
  209. package/types/src/calculation/toolkit/FunctionDeclarationTable.d.ts +4 -0
  210. package/types/src/calculation/toolkit/index.d.ts +12 -0
  211. package/types/src/cell/ICell.d.ts +302 -34
  212. package/types/src/cell/ICellHeader.d.ts +7 -6
  213. package/types/src/cell/ICellProtection.d.ts +1 -1
  214. package/types/src/cellControl/CellControl.d.ts +67 -0
  215. package/types/src/cellControl/CellControlCollection.d.ts +29 -0
  216. package/types/src/cellControl/CellControlRegistry.d.ts +47 -0
  217. package/types/src/cellControl/ICellControl.d.ts +99 -0
  218. package/types/src/cellControl/ICellControlCollection.d.ts +67 -0
  219. package/types/src/cellControl/index.d.ts +4 -0
  220. package/types/src/cellRange/ICellHeaderRange.d.ts +6 -9
  221. package/types/src/cellRange/ICellHeaderRanges.d.ts +5 -0
  222. package/types/src/cellRange/ICellRange.d.ts +525 -110
  223. package/types/src/cellRange/ICellRanges.d.ts +12 -6
  224. package/types/src/chart/Chart.d.ts +217 -15
  225. package/types/src/chart/ChartCollection.d.ts +7 -2
  226. package/types/src/chart/IChart.d.ts +1921 -35
  227. package/types/src/chart/IChartCollection.d.ts +27 -2
  228. package/types/src/chart/_ChartParts.d.ts +1066 -0
  229. package/types/src/chart/_ChartSource.d.ts +47 -0
  230. package/types/src/chart/createChart.d.ts +26 -0
  231. package/types/src/chart/index.d.ts +4 -0
  232. package/types/src/chart/kinds/ChartKind.d.ts +252 -0
  233. package/types/src/chart/kinds/_Area.d.ts +3 -0
  234. package/types/src/chart/kinds/_Bar.d.ts +4 -0
  235. package/types/src/chart/kinds/_BoxWhisker.d.ts +4 -0
  236. package/types/src/chart/kinds/_Bubble.d.ts +3 -0
  237. package/types/src/chart/kinds/_Funnel.d.ts +4 -0
  238. package/types/src/chart/kinds/_Hierarchy.d.ts +31 -0
  239. package/types/src/chart/kinds/_Histogram.d.ts +4 -0
  240. package/types/src/chart/kinds/_HitKinds.d.ts +23 -0
  241. package/types/src/chart/kinds/_Line.d.ts +4 -0
  242. package/types/src/chart/kinds/_OfPie.d.ts +4 -0
  243. package/types/src/chart/kinds/_Pie.d.ts +4 -0
  244. package/types/src/chart/kinds/_Placeholder.d.ts +6 -0
  245. package/types/src/chart/kinds/_Radar.d.ts +4 -0
  246. package/types/src/chart/kinds/_Scatter.d.ts +8 -0
  247. package/types/src/chart/kinds/_Sunburst.d.ts +4 -0
  248. package/types/src/chart/kinds/_Surface.d.ts +4 -0
  249. package/types/src/chart/kinds/_Treemap.d.ts +4 -0
  250. package/types/src/chart/kinds/_Waterfall.d.ts +18 -0
  251. package/types/src/chart/kinds/_builtIns.d.ts +11 -0
  252. package/types/src/chart/layout/ChartLayout.d.ts +829 -0
  253. package/types/src/chart/layout/TextMeasurer.d.ts +38 -0
  254. package/types/src/chart/layout/_HitGeometry.d.ts +50 -0
  255. package/types/src/chart/layout/_HitTest.d.ts +36 -0
  256. package/types/src/chart/layout/_Layout.d.ts +25 -0
  257. package/types/src/chart/layout/_LayoutUtils.d.ts +97 -0
  258. package/types/src/chart/math/BoxStats.d.ts +35 -0
  259. package/types/src/chart/math/DateUnitCalcs.d.ts +80 -0
  260. package/types/src/chart/math/DisplayUnits.d.ts +53 -0
  261. package/types/src/chart/math/Histogram.d.ts +48 -0
  262. package/types/src/chart/math/OrdUnitCalcs.d.ts +166 -0
  263. package/types/src/chart/math/Treemap.d.ts +28 -0
  264. package/types/src/chart/math/Trendlines.d.ts +71 -0
  265. package/types/src/chart/math/UnitCalcs.d.ts +98 -0
  266. package/types/src/chart/model/ChartModel.d.ts +681 -0
  267. package/types/src/chart/model/_ChartType.d.ts +14 -0
  268. package/types/src/chart/model/_Edits.d.ts +489 -0
  269. package/types/src/chart/model/_Grouping.d.ts +83 -0
  270. package/types/src/chart/model/_Inference.d.ts +52 -0
  271. package/types/src/chart/model/_ModelFacts.d.ts +112 -0
  272. package/types/src/chart/model/_NewChart.d.ts +208 -0
  273. package/types/src/chart/model/_OfPie.d.ts +18 -0
  274. package/types/src/chart/resolve/_LegacyStyles.d.ts +48 -0
  275. package/types/src/chart/resolve/_Resolve.d.ts +61 -0
  276. package/types/src/chart/resolve/_ResolvedChart.d.ts +447 -0
  277. package/types/src/collections/ISparseGrid.d.ts +11 -2
  278. package/types/src/collections/MixedTypedArrayList.d.ts +8 -2
  279. package/types/src/collections/RTree.d.ts +116 -36
  280. package/types/src/collections/SparseGrid.d.ts +9 -11
  281. package/types/src/collections/SpatialMap.d.ts +2 -8
  282. package/types/src/collections/SpatialMap3D.d.ts +2 -0
  283. package/types/src/collections/index.d.ts +1 -1
  284. package/types/src/comment/Comment.d.ts +32 -9
  285. package/types/src/comment/IComment.d.ts +41 -4
  286. package/types/src/comment/_NoteBox.d.ts +19 -2
  287. package/types/src/condition/AnchoredConditional.d.ts +30 -4
  288. package/types/src/condition/ICondition.d.ts +3 -2
  289. package/types/src/conditionalFormat/ConditionalFormat.d.ts +9 -3
  290. package/types/src/conditionalFormat/IConditionalFormat.d.ts +4 -3
  291. package/types/src/dataValidation/DataValidation.d.ts +1 -1
  292. package/types/src/dataValidation/DataValidationCollection.d.ts +4 -1
  293. package/types/src/dataValidation/IDataValidation.d.ts +1 -1
  294. package/types/src/dataValidation/IDataValidationCollection.d.ts +24 -0
  295. package/types/src/documentProperties/DocumentProperties.d.ts +66 -0
  296. package/types/src/documentProperties/ICustomProperty.d.ts +69 -0
  297. package/types/src/documentProperties/IDocumentProperties.d.ts +110 -0
  298. package/types/src/documentProperties/index.d.ts +3 -0
  299. package/types/src/externalBook/IExternalBook.d.ts +3 -4
  300. package/types/src/fetch/Fetcher.d.ts +15 -0
  301. package/types/src/fetch/IFetcher.d.ts +47 -0
  302. package/types/src/fetch/_WorkbookFetch.d.ts +43 -0
  303. package/types/src/fetch/index.d.ts +3 -0
  304. package/types/src/fill/IFill.d.ts +7 -0
  305. package/types/src/fill/IFillable.d.ts +47 -0
  306. package/types/src/fill/IStroke.d.ts +15 -1
  307. package/types/src/fill/PaintUtils.d.ts +24 -0
  308. package/types/src/fill/index.d.ts +2 -0
  309. package/types/src/font/AdvanceBuilder.d.ts +34 -0
  310. package/types/src/font/AdvanceTable.d.ts +128 -14
  311. package/types/src/font/CanvasAdvanceBuilder.d.ts +54 -0
  312. package/types/src/font/FontCapture.d.ts +4 -0
  313. package/types/src/font/FontCollection.d.ts +53 -2
  314. package/types/src/font/FontPlatform.d.ts +20 -0
  315. package/types/src/font/FontUtils.d.ts +5 -0
  316. package/types/src/font/IFont.d.ts +191 -61
  317. package/types/src/font/IFontCollection.d.ts +20 -14
  318. package/types/src/font/IFontStyle.d.ts +207 -0
  319. package/types/src/font/TableFileAdvanceBuilder.d.ts +9 -0
  320. package/types/src/font/_FontUtils.d.ts +11 -4
  321. package/types/src/font/_FontsVersion.d.ts +7 -0
  322. package/types/src/font/index.d.ts +1 -3
  323. package/types/src/font/platform.browser.d.ts +15 -0
  324. package/types/src/font/platform.node.d.ts +5 -0
  325. package/types/src/group/Group.d.ts +5 -0
  326. package/types/src/group/GroupMovableCollection.d.ts +4 -0
  327. package/types/src/history/IHistory.d.ts +19 -2
  328. package/types/src/hyperlink/IHyperlink.d.ts +17 -1
  329. package/types/src/hyperlink/_Hyperlink.d.ts +4 -1
  330. package/types/src/index.d.ts +4 -0
  331. package/types/src/license/LicenseManager.d.ts +21 -0
  332. package/types/src/license/_Utils.d.ts +18 -1
  333. package/types/src/license/runtime.browser.d.ts +5 -0
  334. package/types/src/license/runtime.node.d.ts +10 -0
  335. package/types/src/listener/IListener.d.ts +14 -2
  336. package/types/src/listener/ListenerEmitter.d.ts +11 -3
  337. package/types/src/movable/IMovable.d.ts +28 -15
  338. package/types/src/movable/IMovableCollection.d.ts +1 -1
  339. package/types/src/movable/Movable.d.ts +12 -1
  340. package/types/src/movable/MovableCollection.d.ts +7 -3
  341. package/types/src/movable/_InsertableCollection.d.ts +16 -5
  342. package/types/src/named/INamed.d.ts +30 -0
  343. package/types/src/named/INamedCollection.d.ts +38 -2
  344. package/types/src/named/NamedCollection.d.ts +34 -4
  345. package/types/src/numFmt/NumberFormatParser.d.ts +5 -0
  346. package/types/src/outline/IOutline.d.ts +1 -1
  347. package/types/src/outline/Outline.d.ts +2 -2
  348. package/types/src/picture/IPicture.d.ts +98 -1
  349. package/types/src/picture/Picture.d.ts +15 -7
  350. package/types/src/pivot/IPivotTable.d.ts +2 -2
  351. package/types/src/pivot/PivotTable.d.ts +5 -5
  352. package/types/src/primitives/AsyncValue.d.ts +58 -0
  353. package/types/src/primitives/ReferenceRange.d.ts +2 -2
  354. package/types/src/print/IPageLayout.d.ts +635 -0
  355. package/types/src/print/PageLayout.d.ts +258 -0
  356. package/types/src/print/index.d.ts +1 -1
  357. package/types/src/protectedRange/IProtectedRange.d.ts +2 -2
  358. package/types/src/protection/IProtection.d.ts +6 -0
  359. package/types/src/protection/PasswordHasher.d.ts +13 -0
  360. package/types/src/resource/IResource.d.ts +9 -0
  361. package/types/src/resource/IResourceCollection.d.ts +4 -0
  362. package/types/src/resource/Resource.d.ts +2 -0
  363. package/types/src/resource/_AddResource.d.ts +13 -0
  364. package/types/src/richData/CellImage.d.ts +95 -0
  365. package/types/src/richData/Hyperlink.d.ts +49 -0
  366. package/types/src/richData/IRichDataCollection.d.ts +76 -0
  367. package/types/src/richData/IRichDataKind.d.ts +66 -0
  368. package/types/src/richData/RichArray.d.ts +42 -0
  369. package/types/src/richData/RichDataCollection.d.ts +23 -0
  370. package/types/src/richData/RichDataRegistry.d.ts +89 -0
  371. package/types/src/richData/RichDataValues.d.ts +20 -0
  372. package/types/src/richData/RichRecord.d.ts +68 -0
  373. package/types/src/richData/RichText.d.ts +59 -0
  374. package/types/src/richData/index.d.ts +9 -0
  375. package/types/src/scripting/FunctionArguments.d.ts +17 -1
  376. package/types/src/scripting/FunctionCollection.d.ts +8 -0
  377. package/types/src/scripting/IModule.d.ts +3 -3
  378. package/types/src/scripting/IScript.d.ts +2 -2
  379. package/types/src/scripting/ITypedFunction.d.ts +1 -1
  380. package/types/src/scripting/Scripts.d.ts +10 -0
  381. package/types/src/scripting/TypedFunction.d.ts +2 -0
  382. package/types/src/scripting/declarations.d.ts +3 -0
  383. package/types/src/selection/ChartElementSelection.d.ts +39 -0
  384. package/types/src/selection/IChartElementSelection.d.ts +103 -0
  385. package/types/src/selection/IItemSelection.d.ts +131 -0
  386. package/types/src/selection/IMovableSelection.d.ts +6 -34
  387. package/types/src/selection/IRangeSelection.d.ts +4 -4
  388. package/types/src/selection/ItemSelection.d.ts +49 -0
  389. package/types/src/selection/MovableSelection.d.ts +11 -30
  390. package/types/src/selection/RangeSelection.d.ts +4 -4
  391. package/types/src/selection/index.d.ts +3 -0
  392. package/types/src/shape/IShape.d.ts +2 -1
  393. package/types/src/shape/IShapeStyle.d.ts +5 -31
  394. package/types/src/shape/ITextBoxStyle.d.ts +85 -0
  395. package/types/src/shape/ShapeStyleUtils.d.ts +13 -1
  396. package/types/src/shape/_Connectors.d.ts +9 -9
  397. package/types/src/shape/_ShapeStyle.d.ts +9 -0
  398. package/types/src/shape/index.d.ts +1 -0
  399. package/types/src/sheet/CellRegion.d.ts +37 -3
  400. package/types/src/sheet/ICellContainerOptions.d.ts +6 -0
  401. package/types/src/sheet/IOpaqueSheet.d.ts +46 -0
  402. package/types/src/sheet/ISheet.d.ts +81 -1078
  403. package/types/src/sheet/IWorksheet.d.ts +1521 -0
  404. package/types/src/sheet/{ISheetCollection.d.ts → IWorksheetCollection.d.ts} +37 -12
  405. package/types/src/sheet/NamedCellRange.d.ts +2 -2
  406. package/types/src/sheet/NamedRange.d.ts +2 -2
  407. package/types/src/sheet/OpaqueSheet.d.ts +114 -0
  408. package/types/src/sheet/SheetCell.d.ts +40 -27
  409. package/types/src/sheet/SheetRange.d.ts +50 -13
  410. package/types/src/sheet/SheetRanges.d.ts +14 -12
  411. package/types/src/sheet/{Sheet.d.ts → Worksheet.d.ts} +591 -171
  412. package/types/src/sheet/WorksheetCollection.d.ts +39 -0
  413. package/types/src/sheet/_CellBuffer.d.ts +11 -1
  414. package/types/src/sheet/_CopyUtils.d.ts +13 -6
  415. package/types/src/sheet/_IgnoredErrors.d.ts +46 -0
  416. package/types/src/sheet/_InvalidSheetRange.d.ts +3 -2
  417. package/types/src/sheet/_Kinds.d.ts +34 -0
  418. package/types/src/sheet/_Labels.d.ts +38 -0
  419. package/types/src/sheet/_ListenerAnchor.d.ts +7 -1
  420. package/types/src/sheet/_RangeStateSweep.d.ts +2 -3
  421. package/types/src/sheet/_ScalarListFactory.d.ts +55 -7
  422. package/types/src/sheet/_SheetAutoFillUtils.d.ts +3 -3
  423. package/types/src/sheet/_SheetAutoFitUtils.d.ts +3 -3
  424. package/types/src/sheet/_SheetChangeEvent.d.ts +72 -0
  425. package/types/src/sheet/_SheetCoords.d.ts +3 -3
  426. package/types/src/sheet/_SheetEvents.d.ts +1 -1
  427. package/types/src/sheet/_SheetFilterUtils.d.ts +6 -6
  428. package/types/src/sheet/_SheetIntents.d.ts +32 -14
  429. package/types/src/sheet/_SheetMessages.d.ts +1 -1
  430. package/types/src/sheet/_SheetMutations.d.ts +11 -9
  431. package/types/src/sheet/_SheetSortUtils.d.ts +2 -2
  432. package/types/src/sheet/_SheetStateReader.d.ts +18 -0
  433. package/types/src/sheet/_SheetStateTypes.d.ts +80 -9
  434. package/types/src/sheet/_SheetUtils.d.ts +20 -19
  435. package/types/src/sheet/_WatchAnchor.d.ts +15 -2
  436. package/types/src/sheet/clipboard/RangeClipboardItems.d.ts +4 -4
  437. package/types/src/sheet/clipboard/SheetHTMLTableParser.d.ts +3 -3
  438. package/types/src/sheet/clipboard/SheetHTMLTableWriter.d.ts +3 -3
  439. package/types/src/sheet/index.d.ts +5 -2
  440. package/types/src/sheet/style/SheetCellStyle.d.ts +67 -86
  441. package/types/src/sheet/style/SheetDirectStyle.d.ts +3 -3
  442. package/types/src/sheet/style/SheetNamedStyle.d.ts +2 -0
  443. package/types/src/sheet/style/_DigitWidth.d.ts +7 -0
  444. package/types/src/sheet/style/_Resolvers.d.ts +3 -2
  445. package/types/src/sheet/style/_StyleUtils.d.ts +7 -43
  446. package/types/src/sheetHeader/ISheetHeader.d.ts +2 -2
  447. package/types/src/sheetHeader/SheetCellHeader.d.ts +2 -0
  448. package/types/src/sheetHeader/SheetCellHeaderRange.d.ts +2 -0
  449. package/types/src/sheetHeader/SheetCellHeaderRanges.d.ts +2 -0
  450. package/types/src/sheetHeader/SheetHeader.d.ts +7 -6
  451. package/types/src/sheetHeader/_HeaderUtils.d.ts +2 -3
  452. package/types/src/sheetProtection/{ISheetProtection.d.ts → IWorksheetProtection.d.ts} +28 -28
  453. package/types/src/sheetProtection/WorksheetProtection.d.ts +51 -0
  454. package/types/src/sheetProtection/index.d.ts +1 -1
  455. package/types/src/sheetView/{ISheetView.d.ts → IWorksheetView.d.ts} +168 -61
  456. package/types/src/sheetView/WorksheetView.d.ts +139 -0
  457. package/types/src/sheetView/_SheetViewUtils.d.ts +5 -3
  458. package/types/src/sheetView/index.d.ts +1 -1
  459. package/types/src/slicer/ISlicer.d.ts +2 -2
  460. package/types/src/sort/ISort.d.ts +35 -5
  461. package/types/src/style/ICellStyle.d.ts +56 -44
  462. package/types/src/style/_BuiltInStyleDefs.d.ts +4 -3
  463. package/types/src/table/AnchoredTable.d.ts +23 -7
  464. package/types/src/table/AutoTable.d.ts +1 -1
  465. package/types/src/table/ITable.d.ts +32 -19
  466. package/types/src/table/_NamedTable.d.ts +3 -3
  467. package/types/src/table/_NamedTableSource.d.ts +2 -2
  468. package/types/src/text/IText.d.ts +4 -51
  469. package/types/src/text/TextEngine.d.ts +34 -0
  470. package/types/src/text/TextFrame.d.ts +4 -2
  471. package/types/src/text/TextRun.d.ts +3 -2
  472. package/types/src/text/TextWrapper.d.ts +32 -26
  473. package/types/src/text/_TextUtils.d.ts +5 -5
  474. package/types/src/text/_TextWrapperFallback.d.ts +49 -0
  475. package/types/src/text/impl/TabStrategy.d.ts +3 -1
  476. package/types/src/text/richtext/IRichText.d.ts +16 -2
  477. package/types/src/text/richtext/index.d.ts +0 -1
  478. package/types/src/theme/ITheme.d.ts +108 -7
  479. package/types/src/theme/ThemeCollection.d.ts +5 -0
  480. package/types/src/theme/_OfficeFontScheme.d.ts +8 -0
  481. package/types/src/transaction/ITransaction.d.ts +20 -1
  482. package/types/src/transaction/Transaction.d.ts +8 -1
  483. package/types/src/transaction/_BatchHandle.d.ts +118 -0
  484. package/types/src/type/AbstractCollection.d.ts +4 -13
  485. package/types/src/type/ICollection.d.ts +17 -4
  486. package/types/src/type/IProperties.d.ts +1 -1
  487. package/types/src/utils/_CSSUtils.d.ts +1 -1
  488. package/types/src/wasm/_fontsWasm.d.ts +7 -0
  489. package/types/src/wasm/_sdkWasm.d.ts +1 -1
  490. package/types/src/wasm/fontsWasm.d.ts +32 -0
  491. package/types/src/wasm/index.d.ts +1 -0
  492. package/types/src/wasm/loader.browser.d.ts +9 -0
  493. package/types/src/wasm/loader.node.d.ts +9 -0
  494. package/types/src/wasm/sdkWasm.d.ts +6 -3
  495. package/types/src/workbook/IWorkbook.d.ts +269 -39
  496. package/types/src/workbook/Workbook.d.ts +102 -25
  497. package/types/src/workbook/WorkbookRange.d.ts +2 -2
  498. package/types/src/workbook/WorkbookRanges.d.ts +3 -3
  499. package/types/src/workbook/_WorkbookIntents.d.ts +2 -2
  500. package/types/src/workbook/_WorkbookMessages.d.ts +5 -0
  501. package/types/src/workbookView/IWorkbookView.d.ts +82 -0
  502. package/types/src/workbookView/WorkbookView.d.ts +21 -0
  503. package/browser/esm/BbSmt62FpFIpoVzu.mjs +0 -392
  504. package/browser/esm/BgcZ-CoTbMfmyDJL.mjs +0 -412
  505. package/browser/esm/DOMHmhYzPcLVcpAW.mjs +0 -7
  506. package/browser/esm/DUvUK61b2_4pf4tG.mjs +0 -484
  507. package/node/esm/CCouEwT37f08qO3V.mjs +0 -7
  508. package/node/esm/CImNvdz1iP-lUlro.mjs +0 -610
  509. package/node/esm/CT0CN82y0_Qgoryk.mjs +0 -7568
  510. package/node/esm/DHUADiCmxNQS1ARz.mjs +0 -417
  511. package/node/esm/Ds0d8zXzmgOu3MGx.mjs +0 -403
  512. package/types/src/chart/_ChartXml.d.ts +0 -70
  513. package/types/src/collections/OverlappingRangeIterator.d.ts +0 -87
  514. package/types/src/collections/_RangeSweep.d.ts +0 -97
  515. package/types/src/font/CanvasFontMeasurer.d.ts +0 -25
  516. package/types/src/font/FontKitFontMeasurer.d.ts +0 -11
  517. package/types/src/font/SimpleFontMeasurer.d.ts +0 -4
  518. package/types/src/print/IPrint.d.ts +0 -212
  519. package/types/src/sheet/SheetCollection.d.ts +0 -29
  520. package/types/src/sheetProtection/SheetProtection.d.ts +0 -51
  521. package/types/src/sheetView/SheetView.d.ts +0 -122
  522. package/types/src/text/richtext/IStyledFont.d.ts +0 -330
@@ -2,10 +2,10 @@ import { IRange } from '@sheetxl/primitives';
2
2
  import { TopLeft } from '@sheetxl/utils';
3
3
  import { IListener } from '../listener';
4
4
  import { IColor } from '../color';
5
- import { IMovableSelection, IRangeSelection } from '../selection';
6
- import { ISheet } from '../sheet';
5
+ import { IChartElementSelection, IMovableSelection, IRangeSelection } from '../selection';
6
+ import { IWorksheet } from '../sheet';
7
7
  /**
8
- * The `ISheetView` provides properties and methods for controlling how a sheet is displayed and interacted with,
8
+ * The `IWorksheetView` provides properties and methods for controlling how a sheet is displayed and interacted with,
9
9
  * without affecting the underlying data itself.
10
10
  *
11
11
  * View settings include aspects like frozen panes, zoom level, selection, gridlines visibility, and whether formulas are displayed.
@@ -15,7 +15,7 @@ import { ISheet } from '../sheet';
15
15
  * * Since views only affect the presentation of the data, changes to view settings are typically not included in the undo/redo stack.
16
16
  * * Multiple views can be associated to the same collection of data, each providing a different way of viewing and interacting.
17
17
  */
18
- export interface ISheetView {
18
+ export interface IWorksheetView {
19
19
  /**
20
20
  * Identifies this view.
21
21
  *
@@ -44,7 +44,7 @@ export interface ISheetView {
44
44
  * @remarks
45
45
  * The cell-coordinate reading of {@link getTopLeft} (which is base px), resolved against the row /
46
46
  * column headers. Freeze-aware per axis: a frozen band is what actually occupies the corner, so on a
47
- * frozen axis the FROZEN pane's own scroll ({@link ISheetView.FreezePanes.topLeft}) answers — normally
47
+ * frozen axis the FROZEN pane's own scroll ({@link IWorksheetView.FreezePanes.topLeft}) answers — normally
48
48
  * leaving that axis at the sheet's start — while an unfrozen axis reads the main scroll. This is the
49
49
  * same split the xlsx writer emits as `sheetView@topLeftCell` / `pane@topLeftCell`.
50
50
  *
@@ -55,11 +55,11 @@ export interface ISheetView {
55
55
  /**
56
56
  * The freeze panes.
57
57
  */
58
- setFreezePanes(freezePanes: ISheetView.FreezePanes): this;
58
+ setFreezePanes(freezePanes: IWorksheetView.FreezePanes): this;
59
59
  /**
60
60
  * @see {@link setFreezePanes}
61
61
  */
62
- getFreezePanes(): ISheetView.FreezePanes;
62
+ getFreezePanes(): IWorksheetView.FreezePanes;
63
63
  /**
64
64
  * Show/Hide row headers.
65
65
  *
@@ -105,35 +105,38 @@ export interface ISheetView {
105
105
  *
106
106
  * @defaultValue {@link HeaderTextStyle.A1}
107
107
  */
108
- setRowHeaderStyle(rowHeaderStyle: ISheetView.HeaderTextStyle): this;
108
+ setRowHeaderStyle(rowHeaderStyle: IWorksheetView.HeaderTextStyle): this;
109
109
  /**
110
110
  * @see {@link setRowHeaderStyle}
111
111
  */
112
- getRowHeaderStyle(): ISheetView.HeaderTextStyle;
112
+ getRowHeaderStyle(): IWorksheetView.HeaderTextStyle;
113
113
  /**
114
114
  * Style of displaying default column header text.
115
115
  *
116
116
  * @defaultValue {@link HeaderTextStyle.A1}
117
117
  */
118
- setColumnHeaderStyle(columnHeaderStyle: ISheetView.HeaderTextStyle): this;
118
+ setColumnHeaderStyle(columnHeaderStyle: IWorksheetView.HeaderTextStyle): this;
119
119
  /**
120
120
  * @see {@link setColumnHeaderStyle}
121
121
  */
122
- getColumnHeaderStyle(): ISheetView.HeaderTextStyle;
122
+ getColumnHeaderStyle(): IWorksheetView.HeaderTextStyle;
123
123
  /**
124
124
  * Controls when the sheet's column headers display table column names.
125
125
  *
126
126
  * @defaultValue {@link ColumnHeaderTableNames.Sticky}
127
127
  */
128
- setColumnHeaderTableNames(tableNames: ISheetView.ColumnHeaderTableNames): this;
128
+ setColumnHeaderTableNames(tableNames: IWorksheetView.ColumnHeaderTableNames): this;
129
129
  /**
130
130
  * @see {@link setColumnHeaderTableNames}
131
131
  */
132
- getColumnHeaderTableNames(): ISheetView.ColumnHeaderTableNames;
132
+ getColumnHeaderTableNames(): IWorksheetView.ColumnHeaderTableNames;
133
133
  /**
134
134
  * Zoom. This is expressed as a percentage. Values can be between 10 (10%) or 400 (400%).
135
135
  *
136
136
  * @defaultValue `100`
137
+ *
138
+ * @remarks
139
+ * The zoom of the current {@link getViewMode | view mode}. Each mode keeps its own, as in Excel.
137
140
  */
138
141
  setZoomScale(zoomScale: number): this;
139
142
  /**
@@ -155,6 +158,41 @@ export interface ISheetView {
155
158
  * Zoom out the view.
156
159
  */
157
160
  zoomOut(): this;
161
+ /**
162
+ * How the sheet is shown: as the grid, with its page breaks over it, or as printed pages.
163
+ *
164
+ * @defaultValue {@link IWorksheetView.ViewMode.Normal}
165
+ *
166
+ * @remarks
167
+ * Switching modes restores the zoom last set in that mode; page break preview starts at 60%.
168
+ * Only the normal mode is rendered; the others are kept for the file.
169
+ */
170
+ setViewMode(viewMode: IWorksheetView.ViewMode): this;
171
+ /**
172
+ * @see {@link setViewMode}
173
+ */
174
+ getViewMode(): IWorksheetView.ViewMode;
175
+ /**
176
+ * Indicate whether the ruler is shown in {@link IWorksheetView.ViewMode.PageLayout | page layout}.
177
+ *
178
+ * @defaultValue `true`
179
+ */
180
+ setShowRuler(showRuler: boolean): this;
181
+ /**
182
+ * @see {@link setShowRuler}
183
+ */
184
+ isShowRuler(): boolean;
185
+ /**
186
+ * Indicate whether the margins between pages are shown in
187
+ * {@link IWorksheetView.ViewMode.PageLayout | page layout}.
188
+ *
189
+ * @defaultValue `true`
190
+ */
191
+ setShowWhitespace(showWhitespace: boolean): this;
192
+ /**
193
+ * @see {@link setShowWhitespace}
194
+ */
195
+ isShowWhitespace(): boolean;
158
196
  /**
159
197
  * Indicate if view is showing formulas or values
160
198
  *
@@ -260,37 +298,48 @@ export interface ISheetView {
260
298
  * Held beside the {@link getRangeSelection | range selection}, independently of it.
261
299
  */
262
300
  getMovableSelection(): IMovableSelection;
301
+ /**
302
+ * Returns the chart element selection: the elements selected inside the chart whose movable is
303
+ * the active selected one.
304
+ *
305
+ * @remarks
306
+ * Held beside the {@link getMovableSelection | movable selection} and following it: selecting
307
+ * an element selects its chart's movable, and the selection empties when the movable selection
308
+ * moves on. Empty while no chart element is selected: a selected chart with no element selected
309
+ * is the chart itself.
310
+ */
311
+ getChartElementSelection(): IChartElementSelection;
263
312
  /**
264
313
  * Allow for a bulk update of the view properties.
265
314
  */
266
- update(properties: Partial<ISheetView.Properties>): this;
315
+ update(properties: Partial<IWorksheetView.Properties>): this;
267
316
  /**
268
317
  * Add Listeners.
269
318
  *
270
319
  * @see
271
320
  * {@link IListener.ISource.addListeners}
272
321
  */
273
- addListeners(listeners: ISheetView.IListeners, options?: IListener.Options): IListener.Remove;
322
+ addListeners(listeners: IWorksheetView.IListeners, options?: IListener.Options): IListener.Remove;
274
323
  /**
275
324
  * Persist to JSON.
276
325
  *
277
326
  * @remarks
278
327
  * Returns null if it has no customized values.
279
328
  */
280
- toJSON(): ISheetView.JSON | null;
329
+ toJSON(): IWorksheetView.JSON | null;
281
330
  /**
282
331
  * For runtime type checking.
283
332
  */
284
- readonly isISheetView: true;
333
+ readonly isIWorksheetView: true;
285
334
  }
286
335
  /**
287
- * {@inheritDoc ISheetView}
336
+ * {@inheritDoc IWorksheetView}
288
337
  * @see
289
338
  * ### **Interface**
290
339
  *
291
- * {@link ISheetView}
340
+ * {@link IWorksheetView}
292
341
  */
293
- export declare namespace ISheetView {
342
+ export declare namespace IWorksheetView {
294
343
  /**
295
344
  * The coordinates for a FreezePane.
296
345
  *
@@ -306,99 +355,143 @@ export declare namespace ISheetView {
306
355
  *
307
356
  * @remarks
308
357
  * If the current view has a scroll offset and freeze is called it will 'transfer' the scroll
309
- * coordinates. Like {@link ISheetView.setTopLeft | topLeft}, this is expressed in zoom-independent
358
+ * coordinates. Like {@link IWorksheetView.setTopLeft | topLeft}, this is expressed in zoom-independent
310
359
  * (base, unzoomed) px and is therefore stable across zoom changes.
311
360
  */
312
361
  topLeft?: Partial<TopLeft>;
362
+ /**
363
+ * The selections Excel remembers in the panes other than the one holding the selection, as the
364
+ * file wrote them.
365
+ *
366
+ * @remarks
367
+ * SheetXL has one selection, shown across every pane ({@link IWorksheetView.getSelection}); these
368
+ * are carried for the file only. They are dropped when the freeze moves, and do not follow
369
+ * inserts or deletes.
370
+ */
371
+ paneSelections?: PaneSelections;
313
372
  }
314
373
  /**
315
- * A listener for changes to the ISheetView object.
374
+ * A frozen pane other than the main one: the frozen corner, the frozen rows (`topRight` when
375
+ * columns are frozen too), or the frozen columns (`bottomLeft`).
376
+ */
377
+ type Pane = 'topLeft' | 'topRight' | 'bottomLeft';
378
+ /**
379
+ * See {@link IWorksheetView.FreezePanes.paneSelections}.
380
+ */
381
+ type PaneSelections = Partial<Record<Pane, PaneSelection>>;
382
+ /**
383
+ * One pane's selection, in A1 form.
384
+ */
385
+ interface PaneSelection {
386
+ /** The active cell. */
387
+ activeCell: string;
388
+ /** The selected ranges, space separated; absent when only the active cell is selected. */
389
+ sqref?: string;
390
+ }
391
+ /**
392
+ * A listener for changes to the IWorksheetView object.
316
393
  */
317
394
  interface Events {
318
395
  /**
319
396
  * Called when the sheetView changes.
320
397
  */
321
- onTopLeftChange?(source: ISheetView, change: Readonly<Partial<TopLeft>>): void;
398
+ onTopLeftChange?(source: IWorksheetView, change: Readonly<Partial<TopLeft>>): void;
322
399
  /**
323
400
  * Called when the freeze pane settings have changed
324
401
  */
325
- onFreezePaneChange?(source: ISheetView): void;
402
+ onFreezePaneChange?(source: IWorksheetView): void;
326
403
  /**
327
404
  * Called when the selection changes.
328
405
  */
329
- onSelectionChange?(source: ISheetView): void;
406
+ onSelectionChange?(source: IWorksheetView): void;
330
407
  /**
331
408
  * Called when the zoom scale changes.
332
409
  */
333
- onZoomScaleChange?(source: ISheetView): void;
410
+ onZoomScaleChange?(source: IWorksheetView): void;
334
411
  /**
335
412
  * Called when the movable selection changes.
336
413
  */
337
- onMovableSelectionChange?(source: ISheetView): void;
414
+ onMovableSelectionChange?(source: IWorksheetView): void;
415
+ /**
416
+ * Called when the chart element selection changes.
417
+ */
418
+ onChartElementSelectionChange?(source: IWorksheetView): void;
338
419
  /**
339
420
  * Fired when header settings change.
340
421
  */
341
- onHeaderChange?(source: ISheetView): void;
422
+ onHeaderChange?(source: IWorksheetView): void;
342
423
  /**
343
424
  * Called when the movable selection changes.
344
425
  */
345
- onAnyChange?(source: ISheetView): void;
426
+ onAnyChange?(source: IWorksheetView): void;
346
427
  }
347
- interface IListeners extends IListener.Callbacks<ISheetView, ISheetView.Events> {
428
+ interface IListeners extends IListener.Callbacks<IWorksheetView, IWorksheetView.Events> {
348
429
  }
349
430
  /**
350
- * A set of values that can be set on a ISheetView.
431
+ * A set of values that can be set on a IWorksheetView.
351
432
  *
352
433
  * @see
353
- * {@link ISheetView}
434
+ * {@link IWorksheetView}
354
435
  */
355
436
  interface Properties {
356
437
  /** The selection coords. `null` when there is no stored selection (it lives on the RangeSelection). */
357
438
  selection?: IRangeSelection.Coords | null;
358
- /** {@inheritDoc ISheetView.setTopLeft} */
439
+ /** {@inheritDoc IWorksheetView.setTopLeft} */
359
440
  topLeft: TopLeft;
360
- /** {@inheritDoc ISheetView.setFreezePanes} */
361
- freezePanes: ISheetView.FreezePanes;
362
- /** {@inheritDoc ISheetView.setShowRowHeaders} */
441
+ /** {@inheritDoc IWorksheetView.setFreezePanes} */
442
+ freezePanes: IWorksheetView.FreezePanes;
443
+ /** {@inheritDoc IWorksheetView.setShowRowHeaders} */
363
444
  showRowHeaders: boolean;
364
- /** {@inheritDoc ISheetView.setShowColumnHeaders} */
445
+ /** {@inheritDoc IWorksheetView.setShowColumnHeaders} */
365
446
  showColumnHeaders: boolean;
366
- /** {@inheritDoc ISheetView.setShowRowGridlines} */
447
+ /** {@inheritDoc IWorksheetView.setShowRowGridlines} */
367
448
  showRowGridlines: boolean;
368
- /** {@inheritDoc ISheetView.setShowColumnGridlines} */
449
+ /** {@inheritDoc IWorksheetView.setShowColumnGridlines} */
369
450
  showColumnGridlines: boolean;
370
- /** {@inheritDoc ISheetView.setRowHeaderStyle} */
371
- rowHeaderStyle: ISheetView.HeaderTextStyle;
372
- /** {@inheritDoc ISheetView.setColumnHeaderStyle} */
373
- columnHeaderStyle: ISheetView.HeaderTextStyle;
374
- /** {@inheritDoc ISheetView.setColumnHeaderTableNames} */
375
- tableNames: ISheetView.ColumnHeaderTableNames;
376
- /** {@inheritDoc ISheetView.setZoomScale} */
451
+ /** {@inheritDoc IWorksheetView.setRowHeaderStyle} */
452
+ rowHeaderStyle: IWorksheetView.HeaderTextStyle;
453
+ /** {@inheritDoc IWorksheetView.setColumnHeaderStyle} */
454
+ columnHeaderStyle: IWorksheetView.HeaderTextStyle;
455
+ /** {@inheritDoc IWorksheetView.setColumnHeaderTableNames} */
456
+ tableNames: IWorksheetView.ColumnHeaderTableNames;
457
+ /** {@inheritDoc IWorksheetView.setZoomScale} */
377
458
  zoomScale: number;
378
- /** {@inheritDoc ISheetView.setShowFormulas} */
459
+ /** {@inheritDoc IWorksheetView.setViewMode} */
460
+ viewMode: IWorksheetView.ViewMode;
461
+ /** The zoom last set in each view mode, for the modes that have one. */
462
+ zoomScales: IWorksheetView.ZoomScales | null;
463
+ /** {@inheritDoc IWorksheetView.setShowRuler} */
464
+ showRuler: boolean;
465
+ /** {@inheritDoc IWorksheetView.setShowWhitespace} */
466
+ showWhitespace: boolean;
467
+ /**
468
+ * Whether the window's panes are locked by the workbook's protection. Kept from the file.
469
+ */
470
+ windowProtection: boolean;
471
+ /** {@inheritDoc IWorksheetView.setShowFormulas} */
379
472
  showFormulas: boolean;
380
- /** {@inheritDoc ISheetView.setShowLockedShading} */
473
+ /** {@inheritDoc IWorksheetView.setShowLockedShading} */
381
474
  showLockedShading: boolean;
382
- /** {@inheritDoc ISheetView.setShowInvalid} */
475
+ /** {@inheritDoc IWorksheetView.setShowInvalid} */
383
476
  showInvalid: boolean;
384
- /** {@inheritDoc ISheetView.setShowZeros} */
477
+ /** {@inheritDoc IWorksheetView.setShowZeros} */
385
478
  showZeros: boolean;
386
- /** {@inheritDoc ISheetView.setShowOutlineSymbols} */
479
+ /** {@inheritDoc IWorksheetView.setShowOutlineSymbols} */
387
480
  showOutlineSymbols: boolean;
388
- /** {@inheritDoc ISheetView.setRightToLeft} */
481
+ /** {@inheritDoc IWorksheetView.setRightToLeft} */
389
482
  rightToLeft: boolean;
390
- /** {@inheritDoc ISheetView.setGridLineColor} */
483
+ /** {@inheritDoc IWorksheetView.setGridLineColor} */
391
484
  gridLineColor: string | IColor | null;
392
485
  }
393
486
  interface ConstructorOptions {
394
487
  /**
395
488
  * Sheets need to be associated with a sheet.
396
489
  */
397
- sheet: ISheet;
490
+ sheet: IWorksheet;
398
491
  /**
399
492
  * The state to load.
400
493
  */
401
- json?: ISheetView.JSON;
494
+ json?: IWorksheetView.JSON;
402
495
  }
403
496
  /**
404
497
  * A JSON representation useful for persistence.
@@ -409,6 +502,20 @@ export declare namespace ISheetView {
409
502
  freezePanes?: string | FreezePanes;
410
503
  zoomScale?: string | number;
411
504
  }
505
+ /**
506
+ * How a sheet is shown. Shaped after Excel's `Window.View`.
507
+ */
508
+ const ViewMode: {
509
+ /** The grid. */
510
+ readonly Normal: "normal";
511
+ /** The grid, with the pages it prints on drawn over it. */
512
+ readonly PageBreakPreview: "pageBreakPreview";
513
+ /** The sheet as printed pages, with headers, footers and margins. */
514
+ readonly PageLayout: "pageLayout";
515
+ };
516
+ type ViewMode = typeof ViewMode[keyof typeof ViewMode];
517
+ /** A zoom percentage for each view mode that has one. */
518
+ type ZoomScales = Partial<Record<ViewMode, number>>;
412
519
  /**
413
520
  * Suggested style for rendering **header text** on either axis.
414
521
  *
@@ -425,8 +532,8 @@ export declare namespace ISheetView {
425
532
  * @remarks
426
533
  * - This is a **hint** for the header renderer and may be ignored
427
534
  * (e.g., by a custom `HeaderRenderer`).
428
- * - Use {@link ISheetView.setRowHeaderStyle} and
429
- * {@link ISheetView.setColumnHeaderStyle} to apply per-axis preferences.
535
+ * - Use {@link IWorksheetView.setRowHeaderStyle} and
536
+ * {@link IWorksheetView.setColumnHeaderStyle} to apply per-axis preferences.
430
537
  *
431
538
  * @example
432
539
  * // Excel-like: columns as A/B/C…, rows as 1/2/3…
@@ -460,15 +567,15 @@ export declare namespace ISheetView {
460
567
  * - View-only: does not affect formulas or underlying data.
461
568
  * - Applies when a table intersects the viewport; exact resolution when multiple
462
569
  * tables qualify is implementation-defined.
463
- * - Complements {@link ISheetView.setFreezePanes | freeze panes} and does not
570
+ * - Complements {@link IWorksheetView.setFreezePanes | freeze panes} and does not
464
571
  * “freeze” content—this is a label-substitution rule for the column header UI.
465
572
  *
466
573
  * @example
467
574
  * // Show table column names when the table header row scrolls off-screen
468
575
  * sheetView.setColumnHeaderTableNames(ColumnHeaderTableNames.Sticky);
469
576
  *
470
- * @see {@link ISheetView.setColumnHeaderTableNames}
471
- * @see {@link ISheetView.getColumnHeaderTableNames}
577
+ * @see {@link IWorksheetView.setColumnHeaderTableNames}
578
+ * @see {@link IWorksheetView.getColumnHeaderTableNames}
472
579
  */
473
580
  const ColumnHeaderTableNames: {
474
581
  /**
@@ -490,4 +597,4 @@ export declare namespace ISheetView {
490
597
  /** Type union for {@link ColumnHeaderTableNames}. */
491
598
  type ColumnHeaderTableNames = typeof ColumnHeaderTableNames[keyof typeof ColumnHeaderTableNames];
492
599
  }
493
- //# sourceMappingURL=ISheetView.d.ts.map
600
+ //# sourceMappingURL=IWorksheetView.d.ts.map
@@ -0,0 +1,139 @@
1
+ import { IRange } from '@sheetxl/primitives';
2
+ import { TopLeft } from '@sheetxl/utils';
3
+ import { IListener } from '../listener';
4
+ import { IColor } from '../color';
5
+ import { IChartElementSelection, IMovableSelection, IRangeSelection } from '../selection';
6
+ import { ChartElementSelection } from '../selection/ChartElementSelection';
7
+ import { IWorksheet } from '../sheet';
8
+ import { ListenerEmitter } from '../listener/ListenerEmitter';
9
+ import { IWorksheetView } from './IWorksheetView';
10
+ /**
11
+ * Default Sheet View
12
+ */
13
+ export declare class WorksheetView implements IWorksheetView {
14
+ protected _state: IWorksheetView.Properties;
15
+ protected _sheet: IWorksheet;
16
+ protected _rangeSelection: IRangeSelection;
17
+ protected _rangeSelectionRemoveListener: IListener.Remove;
18
+ protected _emitter: ListenerEmitter<IWorksheetView, IWorksheetView.IListeners>;
19
+ protected _movableSelection: IMovableSelection;
20
+ protected _movableSelectionRemoveListener: IListener.Remove;
21
+ protected _chartElementSelection: ChartElementSelection;
22
+ protected _chartElementSelectionRemoveListener: IListener.Remove;
23
+ protected _id: string;
24
+ constructor(options: IWorksheetView.ConstructorOptions);
25
+ /** {@inheritDoc IWorksheetView.getId} */
26
+ getId(): string;
27
+ /** {@inheritDoc IWorksheetView.addListeners} */
28
+ addListeners(listeners: IWorksheetView.IListeners, options?: IListener.Options): IListener.Remove;
29
+ /** {@inheritDoc IWorksheetView.setTopLeft} */
30
+ setTopLeft(topLeft: Partial<TopLeft>): this;
31
+ /** {@inheritDoc IWorksheetView.getTopLeft} */
32
+ getTopLeft(): TopLeft;
33
+ /** {@inheritDoc IWorksheetView.getTopLeftCell} */
34
+ getTopLeftCell(): IRange.CellCoords;
35
+ /** {@inheritDoc IWorksheetView.getFreezePanes} */
36
+ getFreezePanes(): IWorksheetView.FreezePanes;
37
+ /** {@inheritDoc IWorksheetView.setFreezePanes} */
38
+ setFreezePanes(freezePanes: Partial<IWorksheetView.FreezePanes> | null): this;
39
+ protected _mergeFreezePanes(freezePanes: Partial<IWorksheetView.FreezePanes> | null): Partial<IWorksheetView.FreezePanes>;
40
+ /** {@inheritDoc IWorksheetView.isShowRowHeaders} */
41
+ isShowRowHeaders(): boolean;
42
+ /** {@inheritDoc IWorksheetView.setShowRowHeaders} */
43
+ setShowRowHeaders(newValue: boolean): this;
44
+ /** {@inheritDoc IWorksheetView.isShowColumnHeaders} */
45
+ isShowColumnHeaders(): boolean;
46
+ /** {@inheritDoc IWorksheetView.setShowColumnHeaders} */
47
+ setShowColumnHeaders(newValue: boolean): this;
48
+ /** {@inheritDoc IWorksheetView.isShowRowGridlines} */
49
+ isShowRowGridlines(): boolean;
50
+ /** {@inheritDoc IWorksheetView.setShowRowGridlines} */
51
+ setShowRowGridlines(newValue: boolean): this;
52
+ /** {@inheritDoc IWorksheetView.isShowColumnGridlines} */
53
+ isShowColumnGridlines(): boolean;
54
+ /** {@inheritDoc IWorksheetView.setShowColumnGridlines} */
55
+ setShowColumnGridlines(newValue: boolean): this;
56
+ /** {@inheritDoc IWorksheetView.getRowHeaderStyle} */
57
+ getRowHeaderStyle(): IWorksheetView.HeaderTextStyle;
58
+ /** {@inheritDoc IWorksheetView.setRowHeaderStyle} */
59
+ setRowHeaderStyle(newValue: IWorksheetView.HeaderTextStyle): this;
60
+ /** {@inheritDoc IWorksheetView.setColumnHeaderStyle} */
61
+ setColumnHeaderStyle(newValue: IWorksheetView.HeaderTextStyle): this;
62
+ /** {@inheritDoc IWorksheetView.getColumnHeaderStyle} */
63
+ getColumnHeaderStyle(): IWorksheetView.HeaderTextStyle;
64
+ /** {@inheritDoc IWorksheetView.setColumnHeaderTableNames} */
65
+ setColumnHeaderTableNames(tableNames: IWorksheetView.ColumnHeaderTableNames): this;
66
+ /** {@inheritDoc IWorksheetView.getColumnHeaderTableNames} */
67
+ getColumnHeaderTableNames(): IWorksheetView.ColumnHeaderTableNames;
68
+ /** {@inheritDoc IWorksheetView.getZoomScale} */
69
+ getZoomScale(): number;
70
+ /** {@inheritDoc IWorksheetView.setZoomScale} */
71
+ setZoomScale(zoomScale: number): this;
72
+ /** {@inheritDoc IWorksheetView.zoomIn} */
73
+ zoomIn(): this;
74
+ /** {@inheritDoc IWorksheetView.zoomOut} */
75
+ zoomOut(): this;
76
+ protected _updateZoom(nextZoom: number): this;
77
+ /** {@inheritDoc IWorksheetView.getNextZoomScale} */
78
+ getNextZoomScale(zoomIn: boolean, amount?: number): number;
79
+ /** {@inheritDoc IWorksheetView.getViewMode} */
80
+ getViewMode(): IWorksheetView.ViewMode;
81
+ /** {@inheritDoc IWorksheetView.setViewMode} */
82
+ setViewMode(viewMode: IWorksheetView.ViewMode): this;
83
+ /** {@inheritDoc IWorksheetView.isShowRuler} */
84
+ isShowRuler(): boolean;
85
+ /** {@inheritDoc IWorksheetView.setShowRuler} */
86
+ setShowRuler(newValue: boolean): this;
87
+ /** {@inheritDoc IWorksheetView.isShowWhitespace} */
88
+ isShowWhitespace(): boolean;
89
+ /** {@inheritDoc IWorksheetView.setShowWhitespace} */
90
+ setShowWhitespace(newValue: boolean): this;
91
+ /** {@inheritDoc IWorksheetView.isShowFormulas} */
92
+ isShowFormulas(): boolean;
93
+ /** {@inheritDoc IWorksheetView.setShowFormulas} */
94
+ setShowFormulas(newValue: boolean): this;
95
+ /** {@inheritDoc IWorksheetView.isShowLockedShading} */
96
+ isShowLockedShading(): boolean;
97
+ /** {@inheritDoc IWorksheetView.setShowLockedShading} */
98
+ setShowLockedShading(newValue: boolean): this;
99
+ /** {@inheritDoc IWorksheetView.isShowInvalid} */
100
+ isShowInvalid(): boolean;
101
+ /** {@inheritDoc IWorksheetView.setShowInvalid} */
102
+ setShowInvalid(newValue: boolean): this;
103
+ /** {@inheritDoc IWorksheetView.isRightToLeft} */
104
+ isRightToLeft(): boolean;
105
+ /** {@inheritDoc IWorksheetView.setRightToLeft} */
106
+ setRightToLeft(newValue: boolean): this;
107
+ /** {@inheritDoc IWorksheetView.isShowZeros} */
108
+ isShowZeros(): boolean;
109
+ /** {@inheritDoc IWorksheetView.setShowZeros} */
110
+ setShowZeros(newValue: boolean): this;
111
+ /** {@inheritDoc IWorksheetView.isShowOutlineSymbols} */
112
+ isShowOutlineSymbols(): boolean;
113
+ /** {@inheritDoc IWorksheetView.setShowOutlineSymbols} */
114
+ setShowOutlineSymbols(newValue: boolean): this;
115
+ /** {@inheritDoc IWorksheetView.getGridLineColor} */
116
+ getGridLineColor(): any;
117
+ /** {@inheritDoc IWorksheetView.setGridLineColor} */
118
+ setGridLineColor(newValue: IColor | null): this;
119
+ /** {@inheritDoc IWorksheetView.getRangeSelection} */
120
+ getRangeSelection(): IRangeSelection;
121
+ /** {@inheritDoc IWorksheetView.getMovableSelection} */
122
+ getMovableSelection(): IMovableSelection;
123
+ /** {@inheritDoc IWorksheetView.getChartElementSelection} */
124
+ getChartElementSelection(): IChartElementSelection;
125
+ protected _update<T extends IWorksheetView.Properties[K], K extends keyof IWorksheetView.Properties>(newValue: T, property: K, event: keyof IWorksheetView.IListeners): T;
126
+ protected _notifyAll(): void;
127
+ /** {@inheritDoc IWorksheetView.toJSON} */
128
+ toJSON(): IWorksheetView.JSON | null;
129
+ protected _fromJSON(json: IWorksheetView.JSON): void;
130
+ /** {@inheritDoc IWorksheetView.clear} */
131
+ clear(notify?: boolean): this;
132
+ /** {@inheritDoc IWorksheetView.update} */
133
+ update(properties: Partial<IWorksheetView.Properties>): this;
134
+ get [Symbol.toStringTag](): string;
135
+ toString(): string;
136
+ /** {@inheritDoc IWorksheetView.isIWorksheetView} */
137
+ get isIWorksheetView(): true;
138
+ }
139
+ //# sourceMappingURL=WorksheetView.d.ts.map
@@ -1,14 +1,16 @@
1
1
  import { IRangeSelection } from '../selection';
2
- import { ISheetView } from './ISheetView';
2
+ import { IWorksheetView } from './IWorksheetView';
3
3
  /**
4
4
  * Frozen FreezePanes for easy comparisons.
5
5
  */
6
- export declare const EmptyFreezePanes: ISheetView.FreezePanes;
6
+ export declare const EmptyFreezePanes: IWorksheetView.FreezePanes;
7
7
  /**
8
8
  * Frozen IRangeSelection.Coords for easy comparisons.
9
9
  */
10
10
  export declare const EmptySelection: IRangeSelection.Coords;
11
- export declare const DefaultSheetProperties: ISheetView.Properties;
11
+ export declare const DefaultSheetProperties: IWorksheetView.Properties;
12
+ /** The zoom a view mode opens at before one is set in it. Measured against Excel. */
13
+ export declare const DefaultViewModeZoom: Readonly<Record<IWorksheetView.ViewMode, number>>;
12
14
  /**
13
15
  * A simple stepper.
14
16
  *
@@ -1,2 +1,2 @@
1
- export * from './ISheetView';
1
+ export * from './IWorksheetView';
2
2
  //# sourceMappingURL=index.d.ts.map
@@ -5,7 +5,7 @@ import { IListener } from '../listener';
5
5
  import { IModel } from '../model';
6
6
  import { IMovable, IMovableCollection } from '../movable';
7
7
  import { ITable } from '../table';
8
- import { ISheet } from '../sheet';
8
+ import { IWorksheet } from '../sheet';
9
9
  /**
10
10
  * A slicer: buttons that filter one column of a table.
11
11
  *
@@ -223,7 +223,7 @@ export declare namespace ISlicer {
223
223
  *
224
224
  * @defaultValue The table's sheet.
225
225
  */
226
- sheet?: ISheet;
226
+ sheet?: IWorksheet;
227
227
  /** {@inheritDoc ISlicer.JSON.caption} */
228
228
  caption?: string;
229
229
  /**
@@ -173,12 +173,10 @@ export declare namespace ISort {
173
173
  */
174
174
  iconId?: number;
175
175
  /**
176
- * Used with sortOn === cellColor or fontColor
177
- *
178
- * @remarks
179
- * **PLACEHOLDER** - This is a placeholder for future use.
176
+ * The format whose color sorts first, with `sortOn` {@link ISort.SortOn.FillColor} (its fill)
177
+ * or {@link ISort.SortOn.FontColor} (its font color).
180
178
  */
181
- dxfId?: any;
179
+ style?: ICellStyle.Properties;
182
180
  /**
183
181
  * Sort by a custom list.
184
182
  * @remarks
@@ -315,6 +313,38 @@ export declare namespace ISort {
315
313
  * @defaultValue false
316
314
  */
317
315
  includeHidden?: boolean;
316
+ /**
317
+ * The ranges the last sort in the file covered, kept so a saved workbook says what it was
318
+ * read with.
319
+ *
320
+ * @remarks
321
+ * Excel records the range it last sorted, which need not be the table's or filter's range: it
322
+ * may leave out the header or run past the last row. A sort made through the model sorts the
323
+ * table body and clears this.
324
+ */
325
+ extent?: ISort.SortExtent;
318
326
  };
327
+ /**
328
+ * A range given by how far each of its edges sits from the edges of the table or filter range,
329
+ * so it moves with that range. Positive is down or right.
330
+ */
331
+ interface Extent {
332
+ top: number;
333
+ bottom: number;
334
+ left: number;
335
+ right: number;
336
+ }
337
+ /**
338
+ * The ranges of a sort as a file records them.
339
+ */
340
+ interface SortExtent {
341
+ /** The range the sort covered. */
342
+ range: ISort.Extent;
343
+ /**
344
+ * Each level's range, in the order of {@link JSON.sorts}. `null` for a level that uses its
345
+ * column of {@link range}.
346
+ */
347
+ sorts?: (ISort.Extent | null)[];
348
+ }
319
349
  }
320
350
  //# sourceMappingURL=ISort.d.ts.map