exceljs-lts 0.0.0-stage → 4.5.0

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 (541) hide show
  1. package/CHANGELOG.md +45 -0
  2. package/LICENSE +22 -0
  3. package/README.md +3051 -2
  4. package/README_zh.md +2879 -0
  5. package/dist/LICENSE +22 -0
  6. package/dist/es5/csv/csv.js +182 -0
  7. package/dist/es5/csv/csv.js.map +1 -0
  8. package/dist/es5/csv/line-buffer.js +68 -0
  9. package/dist/es5/csv/line-buffer.js.map +1 -0
  10. package/dist/es5/csv/stream-converter.js +110 -0
  11. package/dist/es5/csv/stream-converter.js.map +1 -0
  12. package/dist/es5/doc/anchor.js +93 -0
  13. package/dist/es5/doc/anchor.js.map +1 -0
  14. package/dist/es5/doc/cell.js +987 -0
  15. package/dist/es5/doc/cell.js.map +1 -0
  16. package/dist/es5/doc/column.js +277 -0
  17. package/dist/es5/doc/column.js.map +1 -0
  18. package/dist/es5/doc/data-validations.js +18 -0
  19. package/dist/es5/doc/data-validations.js.map +1 -0
  20. package/dist/es5/doc/defined-names.js +173 -0
  21. package/dist/es5/doc/defined-names.js.map +1 -0
  22. package/dist/es5/doc/enums.js +49 -0
  23. package/dist/es5/doc/enums.js.map +1 -0
  24. package/dist/es5/doc/image.js +68 -0
  25. package/dist/es5/doc/image.js.map +1 -0
  26. package/dist/es5/doc/modelcontainer.js +16 -0
  27. package/dist/es5/doc/modelcontainer.js.map +1 -0
  28. package/dist/es5/doc/note.js +64 -0
  29. package/dist/es5/doc/note.js.map +1 -0
  30. package/dist/es5/doc/pivot-table.js +137 -0
  31. package/dist/es5/doc/pivot-table.js.map +1 -0
  32. package/dist/es5/doc/range.js +229 -0
  33. package/dist/es5/doc/range.js.map +1 -0
  34. package/dist/es5/doc/row.js +382 -0
  35. package/dist/es5/doc/row.js.map +1 -0
  36. package/dist/es5/doc/table.js +439 -0
  37. package/dist/es5/doc/table.js.map +1 -0
  38. package/dist/es5/doc/workbook.js +205 -0
  39. package/dist/es5/doc/workbook.js.map +1 -0
  40. package/dist/es5/doc/worksheet.js +900 -0
  41. package/dist/es5/doc/worksheet.js.map +1 -0
  42. package/dist/es5/exceljs.bare.js +14 -0
  43. package/dist/es5/exceljs.bare.js.map +1 -0
  44. package/dist/es5/exceljs.browser.js +36 -0
  45. package/dist/es5/exceljs.browser.js.map +1 -0
  46. package/dist/es5/exceljs.nodejs.js +15 -0
  47. package/dist/es5/exceljs.nodejs.js.map +1 -0
  48. package/dist/es5/index.js +15 -0
  49. package/dist/es5/stream/xlsx/hyperlink-reader.js +89 -0
  50. package/dist/es5/stream/xlsx/hyperlink-reader.js.map +1 -0
  51. package/dist/es5/stream/xlsx/sheet-comments-writer.js +94 -0
  52. package/dist/es5/stream/xlsx/sheet-comments-writer.js.map +1 -0
  53. package/dist/es5/stream/xlsx/sheet-rels-writer.js +94 -0
  54. package/dist/es5/stream/xlsx/sheet-rels-writer.js.map +1 -0
  55. package/dist/es5/stream/xlsx/workbook-reader.js +383 -0
  56. package/dist/es5/stream/xlsx/workbook-reader.js.map +1 -0
  57. package/dist/es5/stream/xlsx/workbook-writer.js +347 -0
  58. package/dist/es5/stream/xlsx/workbook-writer.js.map +1 -0
  59. package/dist/es5/stream/xlsx/worksheet-reader.js +391 -0
  60. package/dist/es5/stream/xlsx/worksheet-reader.js.map +1 -0
  61. package/dist/es5/stream/xlsx/worksheet-writer.js +651 -0
  62. package/dist/es5/stream/xlsx/worksheet-writer.js.map +1 -0
  63. package/dist/es5/utils/auto-drain.js +18 -0
  64. package/dist/es5/utils/auto-drain.js.map +1 -0
  65. package/dist/es5/utils/browser-buffer-decode.js +41 -0
  66. package/dist/es5/utils/browser-buffer-decode.js.map +1 -0
  67. package/dist/es5/utils/browser-buffer-encode.js +18 -0
  68. package/dist/es5/utils/browser-buffer-encode.js.map +1 -0
  69. package/dist/es5/utils/cell-matrix.js +149 -0
  70. package/dist/es5/utils/cell-matrix.js.map +1 -0
  71. package/dist/es5/utils/col-cache.js +258 -0
  72. package/dist/es5/utils/col-cache.js.map +1 -0
  73. package/dist/es5/utils/copy-style.js +42 -0
  74. package/dist/es5/utils/copy-style.js.map +1 -0
  75. package/dist/es5/utils/encryptor.js +55 -0
  76. package/dist/es5/utils/encryptor.js.map +1 -0
  77. package/dist/es5/utils/iterate-stream.js +50 -0
  78. package/dist/es5/utils/iterate-stream.js.map +1 -0
  79. package/dist/es5/utils/parse-sax.js +55 -0
  80. package/dist/es5/utils/parse-sax.js.map +1 -0
  81. package/dist/es5/utils/shared-formula.js +42 -0
  82. package/dist/es5/utils/shared-formula.js.map +1 -0
  83. package/dist/es5/utils/shared-strings.js +38 -0
  84. package/dist/es5/utils/shared-strings.js.map +1 -0
  85. package/dist/es5/utils/stream-base64.js +66 -0
  86. package/dist/es5/utils/stream-base64.js.map +1 -0
  87. package/dist/es5/utils/stream-buf.js +344 -0
  88. package/dist/es5/utils/stream-buf.js.map +1 -0
  89. package/dist/es5/utils/string-buf.js +73 -0
  90. package/dist/es5/utils/string-buf.js.map +1 -0
  91. package/dist/es5/utils/string-builder.js +32 -0
  92. package/dist/es5/utils/string-builder.js.map +1 -0
  93. package/dist/es5/utils/stuttered-pipe.js +61 -0
  94. package/dist/es5/utils/stuttered-pipe.js.map +1 -0
  95. package/dist/es5/utils/typed-stack.js +23 -0
  96. package/dist/es5/utils/typed-stack.js.map +1 -0
  97. package/dist/es5/utils/under-dash.js +168 -0
  98. package/dist/es5/utils/under-dash.js.map +1 -0
  99. package/dist/es5/utils/utils.js +200 -0
  100. package/dist/es5/utils/utils.js.map +1 -0
  101. package/dist/es5/utils/uuid.js +24 -0
  102. package/dist/es5/utils/uuid.js.map +1 -0
  103. package/dist/es5/utils/xml-stream.js +151 -0
  104. package/dist/es5/utils/xml-stream.js.map +1 -0
  105. package/dist/es5/utils/zip-stream.js +79 -0
  106. package/dist/es5/utils/zip-stream.js.map +1 -0
  107. package/dist/es5/xlsx/defaultnumformats.js +230 -0
  108. package/dist/es5/xlsx/defaultnumformats.js.map +1 -0
  109. package/dist/es5/xlsx/rel-type.js +21 -0
  110. package/dist/es5/xlsx/rel-type.js.map +1 -0
  111. package/dist/es5/xlsx/xform/base-xform.js +134 -0
  112. package/dist/es5/xlsx/xform/base-xform.js.map +1 -0
  113. package/dist/es5/xlsx/xform/book/defined-name-xform.js +85 -0
  114. package/dist/es5/xlsx/xform/book/defined-name-xform.js.map +1 -0
  115. package/dist/es5/xlsx/xform/book/sheet-xform.js +32 -0
  116. package/dist/es5/xlsx/xform/book/sheet-xform.js.map +1 -0
  117. package/dist/es5/xlsx/xform/book/workbook-calc-properties-xform.js +24 -0
  118. package/dist/es5/xlsx/xform/book/workbook-calc-properties-xform.js.map +1 -0
  119. package/dist/es5/xlsx/xform/book/workbook-pivot-cache-xform.js +27 -0
  120. package/dist/es5/xlsx/xform/book/workbook-pivot-cache-xform.js.map +1 -0
  121. package/dist/es5/xlsx/xform/book/workbook-properties-xform.js +27 -0
  122. package/dist/es5/xlsx/xform/book/workbook-properties-xform.js.map +1 -0
  123. package/dist/es5/xlsx/xform/book/workbook-view-xform.js +51 -0
  124. package/dist/es5/xlsx/xform/book/workbook-view-xform.js.map +1 -0
  125. package/dist/es5/xlsx/xform/book/workbook-xform.js +241 -0
  126. package/dist/es5/xlsx/xform/book/workbook-xform.js.map +1 -0
  127. package/dist/es5/xlsx/xform/comment/comment-xform.js +103 -0
  128. package/dist/es5/xlsx/xform/comment/comment-xform.js.map +1 -0
  129. package/dist/es5/xlsx/xform/comment/comments-xform.js +76 -0
  130. package/dist/es5/xlsx/xform/comment/comments-xform.js.map +1 -0
  131. package/dist/es5/xlsx/xform/comment/style/vml-position-xform.js +35 -0
  132. package/dist/es5/xlsx/xform/comment/style/vml-position-xform.js.map +1 -0
  133. package/dist/es5/xlsx/xform/comment/style/vml-protection-xform.js +32 -0
  134. package/dist/es5/xlsx/xform/comment/style/vml-protection-xform.js.map +1 -0
  135. package/dist/es5/xlsx/xform/comment/vml-anchor-xform.js +53 -0
  136. package/dist/es5/xlsx/xform/comment/vml-anchor-xform.js.map +1 -0
  137. package/dist/es5/xlsx/xform/comment/vml-client-data-xform.js +97 -0
  138. package/dist/es5/xlsx/xform/comment/vml-client-data-xform.js.map +1 -0
  139. package/dist/es5/xlsx/xform/comment/vml-notes-xform.js +107 -0
  140. package/dist/es5/xlsx/xform/comment/vml-notes-xform.js.map +1 -0
  141. package/dist/es5/xlsx/xform/comment/vml-shape-xform.js +95 -0
  142. package/dist/es5/xlsx/xform/comment/vml-shape-xform.js.map +1 -0
  143. package/dist/es5/xlsx/xform/comment/vml-textbox-xform.js +69 -0
  144. package/dist/es5/xlsx/xform/comment/vml-textbox-xform.js.map +1 -0
  145. package/dist/es5/xlsx/xform/composite-xform.js +51 -0
  146. package/dist/es5/xlsx/xform/composite-xform.js.map +1 -0
  147. package/dist/es5/xlsx/xform/core/app-heading-pairs-xform.js +30 -0
  148. package/dist/es5/xlsx/xform/core/app-heading-pairs-xform.js.map +1 -0
  149. package/dist/es5/xlsx/xform/core/app-titles-of-parts-xform.js +27 -0
  150. package/dist/es5/xlsx/xform/core/app-titles-of-parts-xform.js.map +1 -0
  151. package/dist/es5/xlsx/xform/core/app-xform.js +93 -0
  152. package/dist/es5/xlsx/xform/core/app-xform.js.map +1 -0
  153. package/dist/es5/xlsx/xform/core/content-types-xform.js +126 -0
  154. package/dist/es5/xlsx/xform/core/content-types-xform.js.map +1 -0
  155. package/dist/es5/xlsx/xform/core/core-xform.js +158 -0
  156. package/dist/es5/xlsx/xform/core/core-xform.js.map +1 -0
  157. package/dist/es5/xlsx/xform/core/relationship-xform.js +23 -0
  158. package/dist/es5/xlsx/xform/core/relationship-xform.js.map +1 -0
  159. package/dist/es5/xlsx/xform/core/relationships-xform.js +65 -0
  160. package/dist/es5/xlsx/xform/core/relationships-xform.js.map +1 -0
  161. package/dist/es5/xlsx/xform/drawing/base-cell-anchor-xform.js +47 -0
  162. package/dist/es5/xlsx/xform/drawing/base-cell-anchor-xform.js.map +1 -0
  163. package/dist/es5/xlsx/xform/drawing/blip-fill-xform.js +61 -0
  164. package/dist/es5/xlsx/xform/drawing/blip-fill-xform.js.map +1 -0
  165. package/dist/es5/xlsx/xform/drawing/blip-xform.js +39 -0
  166. package/dist/es5/xlsx/xform/drawing/blip-xform.js.map +1 -0
  167. package/dist/es5/xlsx/xform/drawing/c-nv-pic-pr-xform.js +35 -0
  168. package/dist/es5/xlsx/xform/drawing/c-nv-pic-pr-xform.js.map +1 -0
  169. package/dist/es5/xlsx/xform/drawing/c-nv-pr-xform.js +62 -0
  170. package/dist/es5/xlsx/xform/drawing/c-nv-pr-xform.js.map +1 -0
  171. package/dist/es5/xlsx/xform/drawing/cell-position-xform.js +82 -0
  172. package/dist/es5/xlsx/xform/drawing/cell-position-xform.js.map +1 -0
  173. package/dist/es5/xlsx/xform/drawing/drawing-xform.js +98 -0
  174. package/dist/es5/xlsx/xform/drawing/drawing-xform.js.map +1 -0
  175. package/dist/es5/xlsx/xform/drawing/ext-lst-xform.js +40 -0
  176. package/dist/es5/xlsx/xform/drawing/ext-lst-xform.js.map +1 -0
  177. package/dist/es5/xlsx/xform/drawing/ext-xform.js +38 -0
  178. package/dist/es5/xlsx/xform/drawing/ext-xform.js.map +1 -0
  179. package/dist/es5/xlsx/xform/drawing/hlink-click-xform.js +38 -0
  180. package/dist/es5/xlsx/xform/drawing/hlink-click-xform.js.map +1 -0
  181. package/dist/es5/xlsx/xform/drawing/nv-pic-pr-xform.js +59 -0
  182. package/dist/es5/xlsx/xform/drawing/nv-pic-pr-xform.js.map +1 -0
  183. package/dist/es5/xlsx/xform/drawing/one-cell-anchor-xform.js +63 -0
  184. package/dist/es5/xlsx/xform/drawing/one-cell-anchor-xform.js.map +1 -0
  185. package/dist/es5/xlsx/xform/drawing/pic-xform.js +67 -0
  186. package/dist/es5/xlsx/xform/drawing/pic-xform.js.map +1 -0
  187. package/dist/es5/xlsx/xform/drawing/sp-pr.js +30 -0
  188. package/dist/es5/xlsx/xform/drawing/sp-pr.js.map +1 -0
  189. package/dist/es5/xlsx/xform/drawing/two-cell-anchor-xform.js +62 -0
  190. package/dist/es5/xlsx/xform/drawing/two-cell-anchor-xform.js.map +1 -0
  191. package/dist/es5/xlsx/xform/list-xform.js +91 -0
  192. package/dist/es5/xlsx/xform/list-xform.js.map +1 -0
  193. package/dist/es5/xlsx/xform/pivot-table/cache-field.js +47 -0
  194. package/dist/es5/xlsx/xform/pivot-table/cache-field.js.map +1 -0
  195. package/dist/es5/xlsx/xform/pivot-table/pivot-cache-definition-xform.js +73 -0
  196. package/dist/es5/xlsx/xform/pivot-table/pivot-cache-definition-xform.js.map +1 -0
  197. package/dist/es5/xlsx/xform/pivot-table/pivot-cache-records-xform.js +93 -0
  198. package/dist/es5/xlsx/xform/pivot-table/pivot-cache-records-xform.js.map +1 -0
  199. package/dist/es5/xlsx/xform/pivot-table/pivot-table-xform.js +176 -0
  200. package/dist/es5/xlsx/xform/pivot-table/pivot-table-xform.js.map +1 -0
  201. package/dist/es5/xlsx/xform/sheet/auto-filter-xform.js +40 -0
  202. package/dist/es5/xlsx/xform/sheet/auto-filter-xform.js.map +1 -0
  203. package/dist/es5/xlsx/xform/sheet/cell-xform.js +455 -0
  204. package/dist/es5/xlsx/xform/sheet/cell-xform.js.map +1 -0
  205. package/dist/es5/xlsx/xform/sheet/cf/cf-rule-xform.js +281 -0
  206. package/dist/es5/xlsx/xform/sheet/cf/cf-rule-xform.js.map +1 -0
  207. package/dist/es5/xlsx/xform/sheet/cf/cfvo-xform.js +25 -0
  208. package/dist/es5/xlsx/xform/sheet/cf/cfvo-xform.js.map +1 -0
  209. package/dist/es5/xlsx/xform/sheet/cf/color-scale-xform.js +38 -0
  210. package/dist/es5/xlsx/xform/sheet/cf/color-scale-xform.js.map +1 -0
  211. package/dist/es5/xlsx/xform/sheet/cf/conditional-formatting-xform.js +44 -0
  212. package/dist/es5/xlsx/xform/sheet/cf/conditional-formatting-xform.js.map +1 -0
  213. package/dist/es5/xlsx/xform/sheet/cf/conditional-formattings-xform.js +77 -0
  214. package/dist/es5/xlsx/xform/sheet/cf/conditional-formattings-xform.js.map +1 -0
  215. package/dist/es5/xlsx/xform/sheet/cf/databar-xform.js +42 -0
  216. package/dist/es5/xlsx/xform/sheet/cf/databar-xform.js.map +1 -0
  217. package/dist/es5/xlsx/xform/sheet/cf/ext-lst-ref-xform.js +71 -0
  218. package/dist/es5/xlsx/xform/sheet/cf/ext-lst-ref-xform.js.map +1 -0
  219. package/dist/es5/xlsx/xform/sheet/cf/formula-xform.js +22 -0
  220. package/dist/es5/xlsx/xform/sheet/cf/formula-xform.js.map +1 -0
  221. package/dist/es5/xlsx/xform/sheet/cf/icon-set-xform.js +42 -0
  222. package/dist/es5/xlsx/xform/sheet/cf/icon-set-xform.js.map +1 -0
  223. package/dist/es5/xlsx/xform/sheet/cf-ext/cf-icon-ext-xform.js +27 -0
  224. package/dist/es5/xlsx/xform/sheet/cf-ext/cf-icon-ext-xform.js.map +1 -0
  225. package/dist/es5/xlsx/xform/sheet/cf-ext/cf-rule-ext-xform.js +87 -0
  226. package/dist/es5/xlsx/xform/sheet/cf-ext/cf-rule-ext-xform.js.map +1 -0
  227. package/dist/es5/xlsx/xform/sheet/cf-ext/cfvo-ext-xform.js +38 -0
  228. package/dist/es5/xlsx/xform/sheet/cf-ext/cfvo-ext-xform.js.map +1 -0
  229. package/dist/es5/xlsx/xform/sheet/cf-ext/conditional-formatting-ext-xform.js +52 -0
  230. package/dist/es5/xlsx/xform/sheet/cf-ext/conditional-formatting-ext-xform.js.map +1 -0
  231. package/dist/es5/xlsx/xform/sheet/cf-ext/conditional-formattings-ext-xform.js +43 -0
  232. package/dist/es5/xlsx/xform/sheet/cf-ext/conditional-formattings-ext-xform.js.map +1 -0
  233. package/dist/es5/xlsx/xform/sheet/cf-ext/databar-ext-xform.js +74 -0
  234. package/dist/es5/xlsx/xform/sheet/cf-ext/databar-ext-xform.js.map +1 -0
  235. package/dist/es5/xlsx/xform/sheet/cf-ext/f-ext-xform.js +22 -0
  236. package/dist/es5/xlsx/xform/sheet/cf-ext/f-ext-xform.js.map +1 -0
  237. package/dist/es5/xlsx/xform/sheet/cf-ext/icon-set-ext-xform.js +65 -0
  238. package/dist/es5/xlsx/xform/sheet/cf-ext/icon-set-ext-xform.js.map +1 -0
  239. package/dist/es5/xlsx/xform/sheet/cf-ext/sqref-ext-xform.js +22 -0
  240. package/dist/es5/xlsx/xform/sheet/cf-ext/sqref-ext-xform.js.map +1 -0
  241. package/dist/es5/xlsx/xform/sheet/col-xform.js +78 -0
  242. package/dist/es5/xlsx/xform/sheet/col-xform.js.map +1 -0
  243. package/dist/es5/xlsx/xform/sheet/data-validations-xform.js +247 -0
  244. package/dist/es5/xlsx/xform/sheet/data-validations-xform.js.map +1 -0
  245. package/dist/es5/xlsx/xform/sheet/dimension-xform.js +28 -0
  246. package/dist/es5/xlsx/xform/sheet/dimension-xform.js.map +1 -0
  247. package/dist/es5/xlsx/xform/sheet/drawing-xform.js +32 -0
  248. package/dist/es5/xlsx/xform/sheet/drawing-xform.js.map +1 -0
  249. package/dist/es5/xlsx/xform/sheet/ext-lst-xform.js +69 -0
  250. package/dist/es5/xlsx/xform/sheet/ext-lst-xform.js.map +1 -0
  251. package/dist/es5/xlsx/xform/sheet/header-footer-xform.js +126 -0
  252. package/dist/es5/xlsx/xform/sheet/header-footer-xform.js.map +1 -0
  253. package/dist/es5/xlsx/xform/sheet/hyperlink-xform.js +50 -0
  254. package/dist/es5/xlsx/xform/sheet/hyperlink-xform.js.map +1 -0
  255. package/dist/es5/xlsx/xform/sheet/merge-cell-xform.js +26 -0
  256. package/dist/es5/xlsx/xform/sheet/merge-cell-xform.js.map +1 -0
  257. package/dist/es5/xlsx/xform/sheet/merges.js +52 -0
  258. package/dist/es5/xlsx/xform/sheet/merges.js.map +1 -0
  259. package/dist/es5/xlsx/xform/sheet/outline-properties-xform.js +35 -0
  260. package/dist/es5/xlsx/xform/sheet/outline-properties-xform.js.map +1 -0
  261. package/dist/es5/xlsx/xform/sheet/page-breaks-xform.js +24 -0
  262. package/dist/es5/xlsx/xform/sheet/page-breaks-xform.js.map +1 -0
  263. package/dist/es5/xlsx/xform/sheet/page-margins-xform.js +46 -0
  264. package/dist/es5/xlsx/xform/sheet/page-margins-xform.js.map +1 -0
  265. package/dist/es5/xlsx/xform/sheet/page-setup-properties-xform.js +32 -0
  266. package/dist/es5/xlsx/xform/sheet/page-setup-properties-xform.js.map +1 -0
  267. package/dist/es5/xlsx/xform/sheet/page-setup-xform.js +99 -0
  268. package/dist/es5/xlsx/xform/sheet/page-setup-xform.js.map +1 -0
  269. package/dist/es5/xlsx/xform/sheet/picture-xform.js +32 -0
  270. package/dist/es5/xlsx/xform/sheet/picture-xform.js.map +1 -0
  271. package/dist/es5/xlsx/xform/sheet/print-options-xform.js +45 -0
  272. package/dist/es5/xlsx/xform/sheet/print-options-xform.js.map +1 -0
  273. package/dist/es5/xlsx/xform/sheet/row-breaks-xform.js +37 -0
  274. package/dist/es5/xlsx/xform/sheet/row-breaks-xform.js.map +1 -0
  275. package/dist/es5/xlsx/xform/sheet/row-xform.js +128 -0
  276. package/dist/es5/xlsx/xform/sheet/row-xform.js.map +1 -0
  277. package/dist/es5/xlsx/xform/sheet/sheet-format-properties-xform.js +51 -0
  278. package/dist/es5/xlsx/xform/sheet/sheet-format-properties-xform.js.map +1 -0
  279. package/dist/es5/xlsx/xform/sheet/sheet-properties-xform.js +83 -0
  280. package/dist/es5/xlsx/xform/sheet/sheet-properties-xform.js.map +1 -0
  281. package/dist/es5/xlsx/xform/sheet/sheet-protection-xform.js +84 -0
  282. package/dist/es5/xlsx/xform/sheet/sheet-protection-xform.js.map +1 -0
  283. package/dist/es5/xlsx/xform/sheet/sheet-view-xform.js +190 -0
  284. package/dist/es5/xlsx/xform/sheet/sheet-view-xform.js.map +1 -0
  285. package/dist/es5/xlsx/xform/sheet/table-part-xform.js +32 -0
  286. package/dist/es5/xlsx/xform/sheet/table-part-xform.js.map +1 -0
  287. package/dist/es5/xlsx/xform/sheet/worksheet-xform.js +526 -0
  288. package/dist/es5/xlsx/xform/sheet/worksheet-xform.js.map +1 -0
  289. package/dist/es5/xlsx/xform/simple/boolean-xform.js +29 -0
  290. package/dist/es5/xlsx/xform/simple/boolean-xform.js.map +1 -0
  291. package/dist/es5/xlsx/xform/simple/date-xform.js +58 -0
  292. package/dist/es5/xlsx/xform/simple/date-xform.js.map +1 -0
  293. package/dist/es5/xlsx/xform/simple/float-xform.js +47 -0
  294. package/dist/es5/xlsx/xform/simple/float-xform.js.map +1 -0
  295. package/dist/es5/xlsx/xform/simple/integer-xform.js +53 -0
  296. package/dist/es5/xlsx/xform/simple/integer-xform.js.map +1 -0
  297. package/dist/es5/xlsx/xform/simple/string-xform.js +47 -0
  298. package/dist/es5/xlsx/xform/simple/string-xform.js.map +1 -0
  299. package/dist/es5/xlsx/xform/static-xform.js +61 -0
  300. package/dist/es5/xlsx/xform/static-xform.js.map +1 -0
  301. package/dist/es5/xlsx/xform/strings/phonetic-text-xform.js +98 -0
  302. package/dist/es5/xlsx/xform/strings/phonetic-text-xform.js.map +1 -0
  303. package/dist/es5/xlsx/xform/strings/rich-text-xform.js +92 -0
  304. package/dist/es5/xlsx/xform/strings/rich-text-xform.js.map +1 -0
  305. package/dist/es5/xlsx/xform/strings/shared-string-xform.js +107 -0
  306. package/dist/es5/xlsx/xform/strings/shared-string-xform.js.map +1 -0
  307. package/dist/es5/xlsx/xform/strings/shared-strings-xform.js +114 -0
  308. package/dist/es5/xlsx/xform/strings/shared-strings-xform.js.map +1 -0
  309. package/dist/es5/xlsx/xform/strings/text-xform.js +39 -0
  310. package/dist/es5/xlsx/xform/strings/text-xform.js.map +1 -0
  311. package/dist/es5/xlsx/xform/style/alignment-xform.js +139 -0
  312. package/dist/es5/xlsx/xform/style/alignment-xform.js.map +1 -0
  313. package/dist/es5/xlsx/xform/style/border-xform.js +185 -0
  314. package/dist/es5/xlsx/xform/style/border-xform.js.map +1 -0
  315. package/dist/es5/xlsx/xform/style/color-xform.js +66 -0
  316. package/dist/es5/xlsx/xform/style/color-xform.js.map +1 -0
  317. package/dist/es5/xlsx/xform/style/dxf-xform.js +106 -0
  318. package/dist/es5/xlsx/xform/style/dxf-xform.js.map +1 -0
  319. package/dist/es5/xlsx/xform/style/fill-xform.js +307 -0
  320. package/dist/es5/xlsx/xform/style/fill-xform.js.map +1 -0
  321. package/dist/es5/xlsx/xform/style/font-xform.js +175 -0
  322. package/dist/es5/xlsx/xform/style/font-xform.js.map +1 -0
  323. package/dist/es5/xlsx/xform/style/numfmt-xform.js +58 -0
  324. package/dist/es5/xlsx/xform/style/numfmt-xform.js.map +1 -0
  325. package/dist/es5/xlsx/xform/style/protection-xform.js +53 -0
  326. package/dist/es5/xlsx/xform/style/protection-xform.js.map +1 -0
  327. package/dist/es5/xlsx/xform/style/style-xform.js +118 -0
  328. package/dist/es5/xlsx/xform/style/style-xform.js.map +1 -0
  329. package/dist/es5/xlsx/xform/style/styles-xform.js +622 -0
  330. package/dist/es5/xlsx/xform/style/styles-xform.js.map +1 -0
  331. package/dist/es5/xlsx/xform/style/underline-xform.js +46 -0
  332. package/dist/es5/xlsx/xform/style/underline-xform.js.map +1 -0
  333. package/dist/es5/xlsx/xform/table/auto-filter-xform.js +75 -0
  334. package/dist/es5/xlsx/xform/table/auto-filter-xform.js.map +1 -0
  335. package/dist/es5/xlsx/xform/table/custom-filter-xform.js +30 -0
  336. package/dist/es5/xlsx/xform/table/custom-filter-xform.js.map +1 -0
  337. package/dist/es5/xlsx/xform/table/filter-column-xform.js +89 -0
  338. package/dist/es5/xlsx/xform/table/filter-column-xform.js.map +1 -0
  339. package/dist/es5/xlsx/xform/table/filter-xform.js +28 -0
  340. package/dist/es5/xlsx/xform/table/filter-xform.js.map +1 -0
  341. package/dist/es5/xlsx/xform/table/table-column-xform.js +42 -0
  342. package/dist/es5/xlsx/xform/table/table-column-xform.js.map +1 -0
  343. package/dist/es5/xlsx/xform/table/table-style-info-xform.js +40 -0
  344. package/dist/es5/xlsx/xform/table/table-style-info-xform.js.map +1 -0
  345. package/dist/es5/xlsx/xform/table/table-xform.js +122 -0
  346. package/dist/es5/xlsx/xform/table/table-xform.js.map +1 -0
  347. package/dist/es5/xlsx/xlsx.js +775 -0
  348. package/dist/es5/xlsx/xlsx.js.map +1 -0
  349. package/dist/es5/xlsx/xml/theme1.js +5 -0
  350. package/dist/es5/xlsx/xml/theme1.js.map +1 -0
  351. package/dist/exceljs.bare.js +60245 -0
  352. package/dist/exceljs.bare.js.map +855 -0
  353. package/dist/exceljs.bare.min.js +45 -0
  354. package/dist/exceljs.bare.min.js.map +1 -0
  355. package/dist/exceljs.js +65149 -0
  356. package/dist/exceljs.js.map +1183 -0
  357. package/dist/exceljs.min.js +45 -0
  358. package/dist/exceljs.min.js.map +1 -0
  359. package/excel.js +13 -0
  360. package/index.d.ts +2047 -0
  361. package/index.ts +2 -0
  362. package/lib/csv/csv.js +191 -0
  363. package/lib/csv/line-buffer.js +74 -0
  364. package/lib/csv/stream-converter.js +135 -0
  365. package/lib/doc/anchor.js +111 -0
  366. package/lib/doc/cell.js +1153 -0
  367. package/lib/doc/column.js +320 -0
  368. package/lib/doc/data/theme1.json +234 -0
  369. package/lib/doc/data-validations.js +19 -0
  370. package/lib/doc/defined-names.js +196 -0
  371. package/lib/doc/enums.js +48 -0
  372. package/lib/doc/image.js +59 -0
  373. package/lib/doc/modelcontainer.js +18 -0
  374. package/lib/doc/note.js +65 -0
  375. package/lib/doc/pivot-table.js +132 -0
  376. package/lib/doc/range.js +257 -0
  377. package/lib/doc/row.js +415 -0
  378. package/lib/doc/table.js +465 -0
  379. package/lib/doc/workbook.js +224 -0
  380. package/lib/doc/worksheet.js +959 -0
  381. package/lib/exceljs.bare.js +13 -0
  382. package/lib/exceljs.browser.js +36 -0
  383. package/lib/exceljs.nodejs.js +14 -0
  384. package/lib/stream/xlsx/hyperlink-reader.js +83 -0
  385. package/lib/stream/xlsx/sheet-comments-writer.js +121 -0
  386. package/lib/stream/xlsx/sheet-rels-writer.js +119 -0
  387. package/lib/stream/xlsx/workbook-reader.js +356 -0
  388. package/lib/stream/xlsx/workbook-writer.js +347 -0
  389. package/lib/stream/xlsx/worksheet-reader.js +374 -0
  390. package/lib/stream/xlsx/worksheet-writer.js +718 -0
  391. package/lib/utils/auto-drain.js +15 -0
  392. package/lib/utils/browser-buffer-decode.js +36 -0
  393. package/lib/utils/browser-buffer-encode.js +15 -0
  394. package/lib/utils/cell-matrix.js +165 -0
  395. package/lib/utils/col-cache.js +287 -0
  396. package/lib/utils/copy-style.js +43 -0
  397. package/lib/utils/encryptor.js +55 -0
  398. package/lib/utils/iterate-stream.js +52 -0
  399. package/lib/utils/parse-sax.js +38 -0
  400. package/lib/utils/shared-formula.js +44 -0
  401. package/lib/utils/shared-strings.js +41 -0
  402. package/lib/utils/stream-base64.js +72 -0
  403. package/lib/utils/stream-buf.js +365 -0
  404. package/lib/utils/string-buf.js +82 -0
  405. package/lib/utils/string-builder.js +35 -0
  406. package/lib/utils/stuttered-pipe.js +67 -0
  407. package/lib/utils/typed-stack.js +24 -0
  408. package/lib/utils/under-dash.js +184 -0
  409. package/lib/utils/utils.js +205 -0
  410. package/lib/utils/uuid.js +28 -0
  411. package/lib/utils/xml-stream.js +169 -0
  412. package/lib/utils/zip-stream.js +87 -0
  413. package/lib/xlsx/.rels +11 -0
  414. package/lib/xlsx/calcChain.xml +6 -0
  415. package/lib/xlsx/core.xml +7 -0
  416. package/lib/xlsx/defaultnumformats.js +153 -0
  417. package/lib/xlsx/rel-type.js +20 -0
  418. package/lib/xlsx/styles.xml +41 -0
  419. package/lib/xlsx/workbook.xml +16 -0
  420. package/lib/xlsx/xform/base-xform.js +145 -0
  421. package/lib/xlsx/xform/book/defined-name-xform.js +91 -0
  422. package/lib/xlsx/xform/book/sheet-xform.js +34 -0
  423. package/lib/xlsx/xform/book/workbook-calc-properties-xform.js +26 -0
  424. package/lib/xlsx/xform/book/workbook-pivot-cache-xform.js +29 -0
  425. package/lib/xlsx/xform/book/workbook-properties-xform.js +29 -0
  426. package/lib/xlsx/xform/book/workbook-view-xform.js +53 -0
  427. package/lib/xlsx/xform/book/workbook-xform.js +259 -0
  428. package/lib/xlsx/xform/comment/comment-xform.js +105 -0
  429. package/lib/xlsx/xform/comment/comments-xform.js +82 -0
  430. package/lib/xlsx/xform/comment/style/vml-position-xform.js +39 -0
  431. package/lib/xlsx/xform/comment/style/vml-protection-xform.js +36 -0
  432. package/lib/xlsx/xform/comment/vml-anchor-xform.js +60 -0
  433. package/lib/xlsx/xform/comment/vml-client-data-xform.js +95 -0
  434. package/lib/xlsx/xform/comment/vml-notes-xform.js +107 -0
  435. package/lib/xlsx/xform/comment/vml-shape-xform.js +98 -0
  436. package/lib/xlsx/xform/comment/vml-textbox-xform.js +72 -0
  437. package/lib/xlsx/xform/composite-xform.js +56 -0
  438. package/lib/xlsx/xform/core/app-heading-pairs-xform.js +32 -0
  439. package/lib/xlsx/xform/core/app-titles-of-parts-xform.js +28 -0
  440. package/lib/xlsx/xform/core/app-xform.js +100 -0
  441. package/lib/xlsx/xform/core/content-types-xform.js +135 -0
  442. package/lib/xlsx/xform/core/core-xform.js +136 -0
  443. package/lib/xlsx/xform/core/relationship-xform.js +25 -0
  444. package/lib/xlsx/xform/core/relationships-xform.js +73 -0
  445. package/lib/xlsx/xform/drawing/base-cell-anchor-xform.js +48 -0
  446. package/lib/xlsx/xform/drawing/blip-fill-xform.js +71 -0
  447. package/lib/xlsx/xform/drawing/blip-xform.js +42 -0
  448. package/lib/xlsx/xform/drawing/c-nv-pic-pr-xform.js +38 -0
  449. package/lib/xlsx/xform/drawing/c-nv-pr-xform.js +68 -0
  450. package/lib/xlsx/xform/drawing/cell-position-xform.js +77 -0
  451. package/lib/xlsx/xform/drawing/drawing-xform.js +109 -0
  452. package/lib/xlsx/xform/drawing/ext-lst-xform.js +43 -0
  453. package/lib/xlsx/xform/drawing/ext-xform.js +44 -0
  454. package/lib/xlsx/xform/drawing/hlink-click-xform.js +41 -0
  455. package/lib/xlsx/xform/drawing/nv-pic-pr-xform.js +65 -0
  456. package/lib/xlsx/xform/drawing/one-cell-anchor-xform.js +63 -0
  457. package/lib/xlsx/xform/drawing/pic-xform.js +77 -0
  458. package/lib/xlsx/xform/drawing/sp-pr.js +17 -0
  459. package/lib/xlsx/xform/drawing/two-cell-anchor-xform.js +62 -0
  460. package/lib/xlsx/xform/list-xform.js +95 -0
  461. package/lib/xlsx/xform/pivot-table/cache-field.js +43 -0
  462. package/lib/xlsx/xform/pivot-table/pivot-cache-definition-xform.js +77 -0
  463. package/lib/xlsx/xform/pivot-table/pivot-cache-records-xform.js +103 -0
  464. package/lib/xlsx/xform/pivot-table/pivot-table-xform.js +189 -0
  465. package/lib/xlsx/xform/sheet/auto-filter-xform.js +38 -0
  466. package/lib/xlsx/xform/sheet/cell-xform.js +503 -0
  467. package/lib/xlsx/xform/sheet/cf/cf-rule-xform.js +308 -0
  468. package/lib/xlsx/xform/sheet/cf/cfvo-xform.js +27 -0
  469. package/lib/xlsx/xform/sheet/cf/color-scale-xform.js +45 -0
  470. package/lib/xlsx/xform/sheet/cf/conditional-formatting-xform.js +48 -0
  471. package/lib/xlsx/xform/sheet/cf/conditional-formattings-xform.js +92 -0
  472. package/lib/xlsx/xform/sheet/cf/databar-xform.js +49 -0
  473. package/lib/xlsx/xform/sheet/cf/ext-lst-ref-xform.js +87 -0
  474. package/lib/xlsx/xform/sheet/cf/formula-xform.js +25 -0
  475. package/lib/xlsx/xform/sheet/cf/icon-set-xform.js +47 -0
  476. package/lib/xlsx/xform/sheet/cf-ext/cf-icon-ext-xform.js +27 -0
  477. package/lib/xlsx/xform/sheet/cf-ext/cf-rule-ext-xform.js +98 -0
  478. package/lib/xlsx/xform/sheet/cf-ext/cfvo-ext-xform.js +43 -0
  479. package/lib/xlsx/xform/sheet/cf-ext/conditional-formatting-ext-xform.js +62 -0
  480. package/lib/xlsx/xform/sheet/cf-ext/conditional-formattings-ext-xform.js +50 -0
  481. package/lib/xlsx/xform/sheet/cf-ext/databar-ext-xform.js +98 -0
  482. package/lib/xlsx/xform/sheet/cf-ext/f-ext-xform.js +25 -0
  483. package/lib/xlsx/xform/sheet/cf-ext/icon-set-ext-xform.js +73 -0
  484. package/lib/xlsx/xform/sheet/cf-ext/sqref-ext-xform.js +25 -0
  485. package/lib/xlsx/xform/sheet/col-xform.js +86 -0
  486. package/lib/xlsx/xform/sheet/data-validations-xform.js +257 -0
  487. package/lib/xlsx/xform/sheet/dimension-xform.js +29 -0
  488. package/lib/xlsx/xform/sheet/drawing-xform.js +33 -0
  489. package/lib/xlsx/xform/sheet/ext-lst-xform.js +86 -0
  490. package/lib/xlsx/xform/sheet/header-footer-xform.js +146 -0
  491. package/lib/xlsx/xform/sheet/hyperlink-xform.js +54 -0
  492. package/lib/xlsx/xform/sheet/merge-cell-xform.js +27 -0
  493. package/lib/xlsx/xform/sheet/merges.js +56 -0
  494. package/lib/xlsx/xform/sheet/outline-properties-xform.js +43 -0
  495. package/lib/xlsx/xform/sheet/page-breaks-xform.js +27 -0
  496. package/lib/xlsx/xform/sheet/page-margins-xform.js +49 -0
  497. package/lib/xlsx/xform/sheet/page-setup-properties-xform.js +35 -0
  498. package/lib/xlsx/xform/sheet/page-setup-xform.js +103 -0
  499. package/lib/xlsx/xform/sheet/picture-xform.js +33 -0
  500. package/lib/xlsx/xform/sheet/print-options-xform.js +49 -0
  501. package/lib/xlsx/xform/sheet/row-breaks-xform.js +39 -0
  502. package/lib/xlsx/xform/sheet/row-xform.js +142 -0
  503. package/lib/xlsx/xform/sheet/sheet-format-properties-xform.js +55 -0
  504. package/lib/xlsx/xform/sheet/sheet-properties-xform.js +90 -0
  505. package/lib/xlsx/xform/sheet/sheet-protection-xform.js +89 -0
  506. package/lib/xlsx/xform/sheet/sheet-view-xform.js +202 -0
  507. package/lib/xlsx/xform/sheet/table-part-xform.js +33 -0
  508. package/lib/xlsx/xform/sheet/worksheet-xform.js +550 -0
  509. package/lib/xlsx/xform/simple/boolean-xform.js +33 -0
  510. package/lib/xlsx/xform/simple/date-xform.js +66 -0
  511. package/lib/xlsx/xform/simple/float-xform.js +51 -0
  512. package/lib/xlsx/xform/simple/integer-xform.js +57 -0
  513. package/lib/xlsx/xform/simple/string-xform.js +51 -0
  514. package/lib/xlsx/xform/static-xform.js +64 -0
  515. package/lib/xlsx/xform/strings/phonetic-text-xform.js +98 -0
  516. package/lib/xlsx/xform/strings/rich-text-xform.js +101 -0
  517. package/lib/xlsx/xform/strings/shared-string-xform.js +106 -0
  518. package/lib/xlsx/xform/strings/shared-strings-xform.js +127 -0
  519. package/lib/xlsx/xform/strings/text-xform.js +44 -0
  520. package/lib/xlsx/xform/style/alignment-xform.js +172 -0
  521. package/lib/xlsx/xform/style/border-xform.js +207 -0
  522. package/lib/xlsx/xform/style/color-xform.js +63 -0
  523. package/lib/xlsx/xform/style/dxf-xform.js +111 -0
  524. package/lib/xlsx/xform/style/fill-xform.js +364 -0
  525. package/lib/xlsx/xform/style/font-xform.js +102 -0
  526. package/lib/xlsx/xform/style/numfmt-xform.js +63 -0
  527. package/lib/xlsx/xform/style/protection-xform.js +60 -0
  528. package/lib/xlsx/xform/style/style-xform.js +125 -0
  529. package/lib/xlsx/xform/style/styles-xform.js +535 -0
  530. package/lib/xlsx/xform/style/underline-xform.js +47 -0
  531. package/lib/xlsx/xform/table/auto-filter-xform.js +81 -0
  532. package/lib/xlsx/xform/table/custom-filter-xform.js +33 -0
  533. package/lib/xlsx/xform/table/filter-column-xform.js +96 -0
  534. package/lib/xlsx/xform/table/filter-xform.js +31 -0
  535. package/lib/xlsx/xform/table/table-column-xform.js +44 -0
  536. package/lib/xlsx/xform/table/table-style-info-xform.js +41 -0
  537. package/lib/xlsx/xform/table/table-xform.js +131 -0
  538. package/lib/xlsx/xlsx.js +774 -0
  539. package/lib/xlsx/xml/theme1.js +3 -0
  540. package/lib/xlsx/xml/theme1.xml +318 -0
  541. package/package.json +161 -4
package/index.d.ts ADDED
@@ -0,0 +1,2047 @@
1
+ declare interface Buffer extends ArrayBuffer { }
2
+
3
+ export declare enum RelationshipType {
4
+ None = 0,
5
+ OfficeDocument = 1,
6
+ Worksheet = 2,
7
+ CalcChain = 3,
8
+ SharedStrings = 4,
9
+ Styles = 5,
10
+ Theme = 6,
11
+ Hyperlink = 7
12
+ }
13
+
14
+ export declare enum DocumentType {
15
+ Xlsx = 1
16
+ }
17
+
18
+ export const enum PaperSize {
19
+ Legal = 5,
20
+ Executive = 7,
21
+ A4 = 9,
22
+ A5 = 11,
23
+ B5 = 13,
24
+ Envelope_10 = 20,
25
+ Envelope_DL = 27,
26
+ Envelope_C5 = 28,
27
+ Envelope_B5 = 34,
28
+ Envelope_Monarch = 37,
29
+ Double_Japan_Postcard_Rotated = 82,
30
+ K16_197x273_mm = 119,
31
+ }
32
+
33
+ export interface WorksheetViewCommon {
34
+ /**
35
+ * Sets the worksheet view's orientation to right-to-left, `false` by default
36
+ */
37
+ rightToLeft: boolean;
38
+
39
+ /**
40
+ * The currently selected cell
41
+ */
42
+ activeCell: string;
43
+
44
+ /**
45
+ * Shows or hides the ruler in Page Layout, `true` by default
46
+ */
47
+ showRuler: boolean;
48
+
49
+ /**
50
+ * Shows or hides the row and column headers (e.g. A1, B1 at the top and 1,2,3 on the left,
51
+ * `true` by default
52
+ */
53
+ showRowColHeaders: boolean;
54
+
55
+ /**
56
+ * Shows or hides the gridlines (shown for cells where borders have not been defined),
57
+ * `true` by default
58
+ */
59
+ showGridLines: boolean;
60
+
61
+ /**
62
+ * Percentage zoom to use for the view, `100` by default
63
+ */
64
+ zoomScale: number;
65
+
66
+ /**
67
+ * Normal zoom for the view, `100` by default
68
+ */
69
+ zoomScaleNormal: number;
70
+ }
71
+
72
+ export interface WorksheetViewNormal {
73
+ /**
74
+ * Controls the view state
75
+ */
76
+ state: 'normal';
77
+
78
+ /**
79
+ * Presentation style
80
+ */
81
+ style: 'pageBreakPreview' | 'pageLayout';
82
+ }
83
+
84
+ export interface WorksheetViewFrozen {
85
+ /**
86
+ * Where a number of rows and columns to the top and left are frozen in place.
87
+ * Only the bottom left section will scroll
88
+ */
89
+ state: 'frozen';
90
+
91
+ /**
92
+ * Presentation style
93
+ */
94
+ style?: 'pageBreakPreview';
95
+
96
+ /**
97
+ * How many columns to freeze. To freeze rows only, set this to 0 or undefined
98
+ */
99
+ xSplit?: number;
100
+
101
+ /**
102
+ * How many rows to freeze. To freeze columns only, set this to 0 or undefined
103
+ */
104
+ ySplit?: number;
105
+
106
+ /**
107
+ * Which cell will be top-left in the bottom-right pane. Note: cannot be a frozen cell.
108
+ * Defaults to first unfrozen cell
109
+ */
110
+ topLeftCell?: string;
111
+ }
112
+
113
+ export interface WorksheetViewSplit {
114
+ /**
115
+ * Where the view is split into 4 sections, each semi-independently scrollable.
116
+ */
117
+ state: 'split';
118
+
119
+ /**
120
+ * Presentation style
121
+ */
122
+ style?: 'pageBreakPreview' | 'pageLayout';
123
+
124
+ /**
125
+ * How many points from the left to place the splitter.
126
+ * To split vertically, set this to 0 or undefined
127
+ */
128
+ xSplit?: number;
129
+
130
+ /**
131
+ * How many points from the top to place the splitter.
132
+ * To split horizontally, set this to 0 or undefined
133
+ */
134
+ ySplit?: number;
135
+
136
+ /**
137
+ * Which cell will be top-left in the bottom-right pane
138
+ */
139
+ topLeftCell?: string;
140
+
141
+ /**
142
+ * Which pane will be active
143
+ */
144
+ activePane?: 'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight';
145
+ }
146
+
147
+ export type WorksheetView =
148
+ & WorksheetViewCommon
149
+ & (WorksheetViewNormal | WorksheetViewFrozen | WorksheetViewSplit);
150
+
151
+ export interface WorkbookView {
152
+ x: number;
153
+ y: number;
154
+ width: number;
155
+ height: number;
156
+ firstSheet: number;
157
+ activeTab: number;
158
+ visibility: string;
159
+ }
160
+
161
+ export type FillPatterns =
162
+ | 'none' | 'solid'
163
+ | 'darkVertical' | 'darkHorizontal' | 'darkGrid' | 'darkTrellis' | 'darkDown' | 'darkUp'
164
+ | 'lightVertical' | 'lightHorizontal' | 'lightGrid' | 'lightTrellis' | 'lightDown' | 'lightUp'
165
+ | 'darkGray' | 'mediumGray' | 'lightGray' | 'gray125' | 'gray0625';
166
+
167
+ export interface FillPattern {
168
+ type: 'pattern';
169
+ pattern: FillPatterns;
170
+ fgColor?: Partial<Color>;
171
+ bgColor?: Partial<Color>;
172
+ }
173
+
174
+ export interface GradientStop {
175
+ position: number;
176
+ color: Partial<Color>;
177
+ }
178
+
179
+ export interface FillGradientAngle {
180
+ type: 'gradient';
181
+ gradient: 'angle';
182
+
183
+ /**
184
+ * For 'angle' gradient, specifies the direction of the gradient. 0 is from the left to the right.
185
+ * Values from 1 - 359 rotates the direction clockwise
186
+ */
187
+ degree: number;
188
+
189
+ /**
190
+ * Specifies the gradient colour sequence. Is an array of objects containing position and
191
+ * color starting with position 0 and ending with position 1.
192
+ * Intermediary positions may be used to specify other colours on the path.
193
+ */
194
+ stops: GradientStop[];
195
+ }
196
+
197
+ export interface FillGradientPath {
198
+ type: 'gradient';
199
+ gradient: 'path';
200
+
201
+ /**
202
+ * For 'path' gradient. Specifies the relative coordinates for the start of the path.
203
+ * 'left' and 'top' values range from 0 to 1
204
+ */
205
+ center: { left: number; top: number };
206
+
207
+ /**
208
+ * Specifies the gradient colour sequence. Is an array of objects containing position and
209
+ * color starting with position 0 and ending with position 1.
210
+ * Intermediary positions may be used to specify other colours on the path.
211
+ */
212
+ stops: GradientStop[];
213
+ }
214
+
215
+ export type Fill = FillPattern | FillGradientAngle | FillGradientPath;
216
+
217
+ export interface Font {
218
+ name: string;
219
+ size: number;
220
+ family: number;
221
+ scheme: 'minor' | 'major' | 'none';
222
+ charset: number;
223
+ color: Partial<Color>;
224
+ bold: boolean;
225
+ italic: boolean;
226
+ underline: boolean | 'none' | 'single' | 'double' | 'singleAccounting' | 'doubleAccounting';
227
+ vertAlign: 'superscript' | 'subscript';
228
+ strike: boolean;
229
+ outline: boolean;
230
+ }
231
+
232
+ export type BorderStyle =
233
+ | 'thin' | 'dotted' | 'hair' | 'medium' | 'double' | 'thick' | 'dashed' | 'dashDot'
234
+ | 'dashDotDot' | 'slantDashDot' | 'mediumDashed' | 'mediumDashDotDot' | 'mediumDashDot';
235
+
236
+ export interface Color {
237
+ /**
238
+ * Hex string for alpha-red-green-blue e.g. FF00FF00
239
+ */
240
+ argb: string;
241
+
242
+ /**
243
+ * Choose a theme by index
244
+ */
245
+ theme: number;
246
+ }
247
+
248
+ export interface Border {
249
+ style: BorderStyle;
250
+ color: Partial<Color>;
251
+ }
252
+
253
+ export interface BorderDiagonal extends Border {
254
+ up: boolean;
255
+ down: boolean;
256
+ }
257
+
258
+ export interface Borders {
259
+ top: Partial<Border>;
260
+ left: Partial<Border>;
261
+ bottom: Partial<Border>;
262
+ right: Partial<Border>;
263
+ diagonal: Partial<BorderDiagonal>;
264
+ }
265
+
266
+ export interface Margins {
267
+ top: number;
268
+ left: number;
269
+ bottom: number;
270
+ right: number;
271
+ header: number;
272
+ footer: number;
273
+ }
274
+
275
+ export declare enum ReadingOrder {
276
+ LeftToRight = 1,
277
+ RightToLeft = 2,
278
+ }
279
+
280
+ export interface Alignment {
281
+ horizontal: 'left' | 'center' | 'right' | 'fill' | 'justify' | 'centerContinuous' | 'distributed';
282
+ vertical: 'top' | 'middle' | 'bottom' | 'distributed' | 'justify';
283
+ wrapText: boolean;
284
+ shrinkToFit: boolean;
285
+ indent: number;
286
+ readingOrder: 'rtl' | 'ltr';
287
+ textRotation: number | 'vertical';
288
+ }
289
+
290
+ export interface Protection {
291
+ locked: boolean;
292
+ hidden: boolean;
293
+ }
294
+
295
+ export interface Style {
296
+ numFmt: string;
297
+ font: Partial<Font>;
298
+ alignment: Partial<Alignment>;
299
+ protection: Partial<Protection>;
300
+ border: Partial<Borders>;
301
+ fill: Fill;
302
+ }
303
+
304
+ export type DataValidationOperator =
305
+ | 'between' | 'notBetween' | 'equal' | 'notEqual' | 'greaterThan' | 'lessThan'
306
+ | 'greaterThanOrEqual' | 'lessThanOrEqual';
307
+
308
+ export interface DataValidation {
309
+ type: 'list' | 'whole' | 'decimal' | 'date' | 'textLength' | 'custom';
310
+ formulae: any[];
311
+ allowBlank?: boolean;
312
+ operator?: DataValidationOperator;
313
+ error?: string;
314
+ errorTitle?: string;
315
+ errorStyle?: string;
316
+ prompt?: string;
317
+ promptTitle?: string;
318
+ showErrorMessage?: boolean;
319
+ showInputMessage?: boolean;
320
+ }
321
+
322
+ export declare enum ErrorValue {
323
+ NotApplicable = '#N/A',
324
+ Ref = '#REF!',
325
+ Name = '#NAME?',
326
+ DivZero = '#DIV/0!',
327
+ Null = '#NULL!',
328
+ Value = '#VALUE!',
329
+ Num = '#NUM!',
330
+ }
331
+
332
+ export interface CellErrorValue {
333
+ error: '#N/A' | '#REF!' | '#NAME?' | '#DIV/0!' | '#NULL!' | '#VALUE!' | '#NUM!';
334
+ }
335
+
336
+ export interface RichText {
337
+ text: string;
338
+ font?: Partial<Font>;
339
+ }
340
+
341
+ export interface CellRichTextValue {
342
+ richText: RichText[];
343
+ }
344
+
345
+ export interface CellHyperlinkValue {
346
+ text: string;
347
+ hyperlink: string;
348
+ tooltip?: string;
349
+ }
350
+
351
+ export interface CellFormulaValue {
352
+ formula: string;
353
+ result?: number | string | boolean | Date | CellErrorValue;
354
+ date1904?: boolean;
355
+ }
356
+
357
+ export interface CellSharedFormulaValue {
358
+ sharedFormula: string;
359
+ readonly formula?: string;
360
+ result?: number | string | boolean | Date | CellErrorValue;
361
+ date1904?: boolean;
362
+ }
363
+
364
+ export declare enum ValueType {
365
+ Null = 0,
366
+ Merge = 1,
367
+ Number = 2,
368
+ String = 3,
369
+ Date = 4,
370
+ Hyperlink = 5,
371
+ Formula = 6,
372
+ SharedString = 7,
373
+ RichText = 8,
374
+ Boolean = 9,
375
+ Error = 10
376
+ }
377
+
378
+ export declare enum FormulaType {
379
+ None = 0,
380
+ Master = 1,
381
+ Shared = 2
382
+ }
383
+
384
+ export type CellValue =
385
+ | null | number | string | boolean | Date | undefined
386
+ | CellErrorValue
387
+ | CellRichTextValue | CellHyperlinkValue
388
+ | CellFormulaValue | CellSharedFormulaValue;
389
+
390
+
391
+ export interface CommentMargins {
392
+ insetmode: 'auto' | 'custom';
393
+ inset: Number[];
394
+ }
395
+
396
+ export interface CommentProtection {
397
+ locked: 'True' | 'False';
398
+ lockText: 'True' | 'False';
399
+ }
400
+
401
+ export type CommentEditAs = 'twoCells' | 'oneCells' | 'absolute';
402
+
403
+ export interface Comment {
404
+ texts?: RichText[];
405
+ margins?: Partial<CommentMargins>;
406
+ protection?: Partial<CommentProtection>;
407
+ editAs?: CommentEditAs;
408
+ autoShape?: boolean;
409
+ }
410
+
411
+ export interface CellModel {
412
+ address: Address;
413
+ style: Style;
414
+ type: ValueType;
415
+ text?: string;
416
+ hyperlink?: string;
417
+ value?: CellValue;
418
+ master: string;
419
+ formula?: string;
420
+ sharedFormula?: string;
421
+ result?: string | number | any;
422
+ comment: Comment;
423
+ }
424
+
425
+ export interface Cell extends Style, Address {
426
+ readonly worksheet: Worksheet;
427
+ readonly workbook: Workbook;
428
+
429
+ readonly effectiveType: ValueType;
430
+ readonly isMerged: boolean;
431
+ readonly master: Cell;
432
+ readonly isHyperlink: boolean;
433
+ readonly hyperlink: string; // todo
434
+ readonly text: string;
435
+ readonly fullAddress: {
436
+ sheetName: string;
437
+ address: string;
438
+ row: number;
439
+ col: number;
440
+ };
441
+ model: CellModel;
442
+ /**
443
+ * Assign (or get) a name for a cell (will overwrite any other names that cell had)
444
+ */
445
+ name: string;
446
+
447
+ /**
448
+ * Assign (or get) an array of names for a cell (cells can have more than one name)
449
+ */
450
+ names: string[];
451
+
452
+ /**
453
+ * Cells can define what values are valid or not and provide
454
+ * prompting to the user to help guide them.
455
+ */
456
+ dataValidation: DataValidation;
457
+
458
+ /**
459
+ * Value of the cell
460
+ */
461
+ value: CellValue;
462
+
463
+ /**
464
+ * comment of the cell
465
+ */
466
+ note: string | Comment;
467
+
468
+ /**
469
+ * convenience getter to access the formula
470
+ */
471
+ readonly formula: string;
472
+
473
+ /**
474
+ * convenience getter to access the formula result
475
+ */
476
+ readonly result: number | string | Date;
477
+
478
+ /**
479
+ * The type of the cell's value
480
+ */
481
+ readonly type: ValueType;
482
+
483
+ /**
484
+ * The type of the cell's formula
485
+ */
486
+ readonly formulaType: FormulaType;
487
+
488
+ /**
489
+ * The styles of the cell
490
+ */
491
+ style: Partial<Style>;
492
+
493
+ addName(name: string): void;
494
+
495
+ /**
496
+ * Remove a name from a cell
497
+ */
498
+ removeName(name: string): void;
499
+ removeAllNames(): void;
500
+
501
+ destroy(): void;
502
+ toCsvString(): string;
503
+ release(): void;
504
+ addMergeRef(): void;
505
+ releaseMergeRef(): void;
506
+ merge(master: Cell, ignoreStyle?: boolean): void;
507
+ unmerge(): void;
508
+ isMergedTo(master: Cell): boolean;
509
+ toString(): string;
510
+ }
511
+
512
+ export interface RowModel {
513
+ cells: CellModel[];
514
+ number: number;
515
+ min: number;
516
+ max: number;
517
+ height: number;
518
+ style: Partial<Style>;
519
+ hidden: boolean;
520
+ outlineLevel: number;
521
+ collapsed: boolean;
522
+ }
523
+
524
+ export interface Row extends Style {
525
+ readonly worksheet: Worksheet;
526
+ readonly hasValues: boolean;
527
+ readonly dimensions: number;
528
+ model: Partial<RowModel> | null;
529
+ /**
530
+ * Set a specific row height
531
+ */
532
+ height: number;
533
+
534
+ /**
535
+ * Make row hidden
536
+ */
537
+ hidden: boolean;
538
+
539
+ /**
540
+ * Get a row as a sparse array
541
+ */
542
+ // readonly values: CellValue[];
543
+ values: CellValue[] | { [key: string]: CellValue };
544
+
545
+ /**
546
+ * Set an outline level for rows
547
+ */
548
+ outlineLevel?: number;
549
+
550
+ /**
551
+ * The row number
552
+ */
553
+ readonly number: number;
554
+
555
+ /**
556
+ * Indicate the collapsed state based on outlineLevel
557
+ */
558
+ readonly collapsed: boolean;
559
+
560
+ /**
561
+ * Number of cells including empty ones
562
+ */
563
+ readonly cellCount: number;
564
+
565
+ /**
566
+ * Number of non-empty cells
567
+ */
568
+ readonly actualCellCount: number;
569
+
570
+ /**
571
+ * Get cell by number, column letter or column key
572
+ */
573
+ getCell(indexOrKey: number | string): Cell;
574
+
575
+ findCell(colNumber: number): Cell | undefined;
576
+
577
+ getCellEx(address: Address): Cell;
578
+
579
+ /**
580
+ * Iterate over all non-null cells in a row
581
+ */
582
+ eachCell(callback: (cell: Cell, colNumber: number) => void): void;
583
+
584
+ /**
585
+ * Iterate over all cells in a row (including empty cells)
586
+ */
587
+ eachCell(opt: { includeEmpty: boolean }, callback: (cell: Cell, colNumber: number) => void): void;
588
+
589
+ /**
590
+ * Cut one or more cells (cells to the right are shifted left)
591
+ *
592
+ * Note: this operation will not affect other rows
593
+ */
594
+ splice(start: number, count: number, ...insert: any[]): void;
595
+
596
+ /**
597
+ * Commit a completed row to stream
598
+ */
599
+ commit(): void;
600
+ destroy(): void;
601
+ addPageBreak(lft?: number, rght?: number): void;
602
+ }
603
+
604
+ export interface Column {
605
+ /**
606
+ * Can be a string to set one row high header or an array to set multi-row high header
607
+ */
608
+ header?: string | string[];
609
+
610
+ /**
611
+ * The name of the properties associated with this column in each row
612
+ */
613
+ key?: string;
614
+
615
+ /**
616
+ * The width of the column
617
+ */
618
+ width?: number;
619
+
620
+ /**
621
+ * Set an outline level for columns
622
+ */
623
+ outlineLevel: number;
624
+
625
+ /**
626
+ * Hides the column
627
+ */
628
+ hidden: boolean;
629
+
630
+ /**
631
+ * Styles applied to the column
632
+ */
633
+ style: Partial<Style>;
634
+
635
+ /**
636
+ * The cell values in the column
637
+ */
638
+ values: CellValue[];
639
+
640
+ /**
641
+ * Column letter key
642
+ */
643
+ readonly letter: string;
644
+ readonly number: number;
645
+ readonly worksheet: Worksheet;
646
+ readonly isCustomWidth: boolean;
647
+ readonly headers: string[];
648
+ readonly isDefault: boolean;
649
+ readonly headerCount: number;
650
+
651
+ /**
652
+ * Below properties read from style
653
+ */
654
+ border?: Partial<Borders>;
655
+ fill?: Fill;
656
+ numFmt?: string;
657
+ font?: Partial<Font>;
658
+ alignment?: Partial<Alignment>;
659
+ protection?: Partial<Protection>;
660
+
661
+ toString(): string
662
+ equivalentTo(other: Column): boolean
663
+
664
+ /**
665
+ * indicate the collapsed state based on outlineLevel
666
+ */
667
+ readonly collapsed: boolean;
668
+
669
+ /**
670
+ * Iterate over all current cells in this column
671
+ */
672
+ eachCell(callback: (cell: Cell, rowNumber: number) => void): void;
673
+
674
+ /**
675
+ * Iterate over all current cells in this column including empty cells
676
+ */
677
+ eachCell(opt: { includeEmpty: boolean }, callback: (cell: Cell, rowNumber: number) => void): void;
678
+
679
+ defn: any; //todo
680
+ }
681
+ export interface PageSetup {
682
+ /**
683
+ * Whitespace on the borders of the page. Units are inches.
684
+ */
685
+ margins: Margins;
686
+
687
+ /**
688
+ * Orientation of the page - i.e. taller (`'portrait'`) or wider (`'landscape'`).
689
+ *
690
+ * `'portrait'` by default
691
+ */
692
+ orientation: 'portrait' | 'landscape';
693
+
694
+ /**
695
+ * Horizontal Dots per Inch. Default value is 4294967295
696
+ */
697
+ horizontalDpi: number;
698
+
699
+ /**
700
+ * Vertical Dots per Inch. Default value is 4294967295
701
+ */
702
+ verticalDpi: number;
703
+
704
+ /**
705
+ * Whether to use fitToWidth and fitToHeight or scale settings.
706
+ *
707
+ * Default is based on presence of these settings in the pageSetup object - if both are present,
708
+ * scale wins (i.e. default will be false)
709
+ */
710
+ fitToPage: boolean;
711
+
712
+ /**
713
+ * How many pages wide the sheet should print on to. Active when fitToPage is true
714
+ *
715
+ * Default is 1
716
+ */
717
+ fitToWidth: number;
718
+
719
+ /**
720
+ * How many pages high the sheet should print on to. Active when fitToPage is true
721
+ *
722
+ * Default is 1
723
+ */
724
+ fitToHeight: number;
725
+
726
+ /**
727
+ * Percentage value to increase or reduce the size of the print. Active when fitToPage is false
728
+ *
729
+ * Default is 100
730
+ */
731
+ scale: number;
732
+
733
+ /**
734
+ * Which order to print the pages.
735
+ *
736
+ * Default is `downThenOver`
737
+ */
738
+ pageOrder: 'downThenOver' | 'overThenDown';
739
+
740
+ /**
741
+ * Print without colour
742
+ *
743
+ * false by default
744
+ */
745
+ blackAndWhite: boolean;
746
+
747
+ /**
748
+ * Print with less quality (and ink)
749
+ *
750
+ * false by default
751
+ */
752
+ draft: boolean;
753
+
754
+ /**
755
+ * Where to place comments
756
+ *
757
+ * Default is `None`
758
+ */
759
+ cellComments: 'atEnd' | 'asDisplayed' | 'None';
760
+
761
+ /**
762
+ * Where to show errors
763
+ *
764
+ * Default is `displayed`
765
+ */
766
+ errors: 'dash' | 'blank' | 'NA' | 'displayed';
767
+
768
+ /**
769
+ * What paper size to use (see below)
770
+ *
771
+ * | Name | Value |
772
+ * | ----------------------------- | --------- |
773
+ * | Letter | `undefined` |
774
+ * | Legal | `5` |
775
+ * | Executive | `7` |
776
+ * | A4 | `9` |
777
+ * | A5 | `11` |
778
+ * | B5 (JIS) | `13` |
779
+ * | Envelope #10 | `20` |
780
+ * | Envelope DL | `27` |
781
+ * | Envelope C5 | `28` |
782
+ * | Envelope B5 | `34` |
783
+ * | Envelope Monarch | `37` |
784
+ * | Double Japan Postcard Rotated | `82` |
785
+ * | 16K 197x273 mm | `119` |
786
+ */
787
+ paperSize: PaperSize;
788
+
789
+ /**
790
+ * Whether to show the row numbers and column letters, `false` by default
791
+ */
792
+ showRowColHeaders: boolean;
793
+
794
+ /**
795
+ * Whether to show grid lines, `false` by default
796
+ */
797
+ showGridLines: boolean;
798
+
799
+ /**
800
+ * Which number to use for the first page
801
+ */
802
+ firstPageNumber: number;
803
+
804
+ /**
805
+ * Whether to center the sheet data horizontally, `false` by default
806
+ */
807
+ horizontalCentered: boolean;
808
+
809
+ /**
810
+ * Whether to center the sheet data vertically, `false` by default
811
+ */
812
+ verticalCentered: boolean;
813
+
814
+ /**
815
+ * Set Print Area for a sheet, e.g. `'A1:G20'`
816
+ */
817
+ printArea: string;
818
+
819
+ /**
820
+ * Repeat specific rows on every printed page, e.g. `'1:3'`
821
+ */
822
+ printTitlesRow: string;
823
+
824
+ /**
825
+ * Repeat specific columns on every printed page, e.g. `'A:C'`
826
+ */
827
+ printTitlesColumn: string;
828
+ }
829
+
830
+ export interface HeaderFooter {
831
+ /**
832
+ * Set the value of differentFirst as true, which indicates that headers/footers for first page are different from the other pages, `false` by default
833
+ */
834
+ differentFirst: boolean,
835
+ /**
836
+ * Set the value of differentOddEven as true, which indicates that headers/footers for odd and even pages are different, `false` by default
837
+ */
838
+ differentOddEven: boolean,
839
+ /**
840
+ * Set header string for odd pages, could format the string and `null` by default
841
+ */
842
+ oddHeader: string,
843
+ /**
844
+ * Set footer string for odd pages, could format the string and `null` by default
845
+ */
846
+ oddFooter: string,
847
+ /**
848
+ * Set header string for even pages, could format the string and `null` by default
849
+ */
850
+ evenHeader: string,
851
+ /**
852
+ * Set footer string for even pages, could format the string and `null` by default
853
+ */
854
+ evenFooter: string,
855
+ /**
856
+ * Set header string for the first page, could format the string and `null` by default
857
+ */
858
+ firstHeader: string,
859
+ /**
860
+ * Set footer string for the first page, could format the string and `null` by default
861
+ */
862
+ firstFooter: string
863
+ }
864
+
865
+ export type AutoFilter = string | {
866
+ from: string | { row: number; column: number };
867
+ to: string | { row: number; column: number };
868
+ };
869
+
870
+ export interface WorksheetProtection {
871
+ objects: boolean;
872
+ scenarios: boolean;
873
+ selectLockedCells: boolean;
874
+ selectUnlockedCells: boolean;
875
+ formatCells: boolean;
876
+ formatColumns: boolean;
877
+ formatRows: boolean;
878
+ insertColumns: boolean;
879
+ insertRows: boolean;
880
+ insertHyperlinks: boolean;
881
+ deleteColumns: boolean;
882
+ deleteRows: boolean;
883
+ sort: boolean;
884
+ autoFilter: boolean;
885
+ pivotTables: boolean;
886
+ spinCount: number;
887
+ }
888
+ export interface Image {
889
+ extension: 'jpeg' | 'png' | 'gif';
890
+ base64?: string;
891
+ filename?: string;
892
+ buffer?: Buffer;
893
+ }
894
+ export interface IAnchor {
895
+ col: number;
896
+ row: number;
897
+ nativeCol: number;
898
+ nativeRow: number;
899
+ nativeColOff: number;
900
+ nativeRowOff: number;
901
+ }
902
+ export class Anchor implements IAnchor {
903
+ col: number;
904
+ nativeCol: number;
905
+ nativeColOff: number;
906
+ nativeRow: number;
907
+ nativeRowOff: number;
908
+ row: number;
909
+
910
+ private readonly colWidth: number;
911
+ private readonly rowHeight: number;
912
+ worksheet: Worksheet;
913
+
914
+ constructor(model?: IAnchor | object);
915
+ }
916
+ export interface ImageRange {
917
+ tl: Anchor;
918
+ br: Anchor;
919
+ }
920
+
921
+ export interface ImagePosition {
922
+ tl: { col: number; row: number };
923
+ ext: { width: number; height: number };
924
+ }
925
+
926
+ export interface ImageHyperlinkValue {
927
+ hyperlink: string;
928
+ tooltip?: string;
929
+ }
930
+
931
+ export interface Range extends Location {
932
+ sheetName: string;
933
+
934
+ tl: string;
935
+ $t$l: string;
936
+
937
+ br: string;
938
+ $b$r: string;
939
+
940
+ range: string;
941
+ $range: string;
942
+
943
+ shortRange: string;
944
+ $shortRange: string;
945
+
946
+ count: number;
947
+
948
+ decode(): void;
949
+ decode(v: Range): void;
950
+ decode(v: string): void;
951
+ decode(v: Location): void;
952
+ decode(top: number, left: number, bottom: number, right: number, sheetName?: string): void;
953
+ decode(tl: string, br: string, sheetName?: string): void;
954
+ decode(v: [string, string]): void;
955
+ decode(v: [string, string, string]): void;
956
+ decode(v: [number, number, number, number]): void;
957
+ decode(v: [number, number, number, number, string]): void;
958
+
959
+ expand(top: number, left: number, bottom: number, right: number): void;
960
+
961
+ expandRow(row: Row): void;
962
+
963
+ expandToAddress(addressStr: string): void;
964
+
965
+ toString(): string;
966
+
967
+ intersects(other: Range): boolean;
968
+
969
+ contains(addressStr: string): boolean;
970
+
971
+ containsEx(address: Partial<{
972
+ sheetName: string;
973
+ row: number;
974
+ col: number;
975
+ }>): boolean;
976
+ }
977
+
978
+ export interface RowBreak {
979
+ id: number;
980
+ max: number;
981
+ min: number;
982
+ man: number;
983
+ }
984
+
985
+ export interface WorksheetModel {
986
+ id: number;
987
+ name: string;
988
+ // dataValidations: this.dataValidations.model,
989
+ properties: WorksheetProperties;
990
+ pageSetup: Partial<PageSetup>;
991
+ headerFooter: Partial<HeaderFooter>;
992
+ rowBreaks: RowBreak[];
993
+ views: WorksheetView[];
994
+ autoFilter: AutoFilter;
995
+ media: Media[];
996
+ merges: Range['range'][];
997
+ }
998
+ export type WorksheetState = 'visible' | 'hidden' | 'veryHidden';
999
+
1000
+ export type CellIsOperators = 'equal' | 'notEqual' | 'greaterThan' | 'greaterThanOrEqual' | 'lessThan' | 'lessThanOrEqual' | 'between' | 'notBetween';
1001
+
1002
+ export type ContainsTextOperators = 'containsText' | 'containsBlanks' | 'notContainsBlanks' | 'containsErrors' | 'notContainsErrors';
1003
+
1004
+ export type TimePeriodTypes = 'lastWeek' | 'thisWeek' | 'nextWeek' | 'yesterday' | 'today' | 'tomorrow' | 'last7Days' | 'lastMonth'
1005
+ | 'thisMonth' | 'nextMonth';
1006
+
1007
+ export type IconSetTypes = '5Arrows' | '5ArrowsGray' | '5Boxes' | '5Quarters' | '5Rating' | '4Arrows' | '4ArrowsGray'
1008
+ | '4Rating' | '4RedToBlack' | '4TrafficLights' | 'NoIcons' | '3Arrows' | '3ArrowsGray' | '3Flags' | '3Signs'
1009
+ | '3Stars' | '3Symbols' | '3Symbols2' | '3TrafficLights1' | '3TrafficLights2' | '3Triangles';
1010
+
1011
+ export type CfvoTypes = 'percentile' | 'percent' | 'num' | 'min' | 'max' | 'formula' | 'autoMin' | 'autoMax';
1012
+
1013
+ export interface Cvfo {
1014
+ type: CfvoTypes;
1015
+ value?: number;
1016
+ }
1017
+ export interface ConditionalFormattingBaseRule {
1018
+ priority?: number;
1019
+ style?: Partial<Style>;
1020
+ }
1021
+ export interface ExpressionRuleType extends ConditionalFormattingBaseRule {
1022
+ type: 'expression';
1023
+ formulae?: any[];
1024
+ stopIfTrue?: boolean;
1025
+ }
1026
+
1027
+ export interface CellIsRuleType extends ConditionalFormattingBaseRule {
1028
+ type: 'cellIs';
1029
+ formulae?: any[];
1030
+ operator?: CellIsOperators;
1031
+ stopIfTrue?: boolean;
1032
+ }
1033
+
1034
+ export interface Top10RuleType extends ConditionalFormattingBaseRule {
1035
+ type: 'top10';
1036
+ rank: number;
1037
+ percent: boolean;
1038
+ bottom: boolean;
1039
+ stopIfTrue?: boolean;
1040
+ }
1041
+
1042
+ export interface AboveAverageRuleType extends ConditionalFormattingBaseRule {
1043
+ type: 'aboveAverage';
1044
+ aboveAverage: boolean;
1045
+ stopIfTrue?: boolean;
1046
+ }
1047
+
1048
+ export interface ColorScaleRuleType extends ConditionalFormattingBaseRule {
1049
+ type: 'colorScale';
1050
+ cfvo?: Cvfo[];
1051
+ color?: Partial<Color>[];
1052
+ }
1053
+
1054
+ export interface IconSetRuleType extends ConditionalFormattingBaseRule {
1055
+ type: 'iconSet';
1056
+ showValue?: boolean;
1057
+ reverse?: boolean;
1058
+ custom?: boolean;
1059
+ iconSet?: IconSetTypes;
1060
+ cfvo?: Cvfo[];
1061
+ }
1062
+
1063
+ export interface ContainsTextRuleType extends ConditionalFormattingBaseRule {
1064
+ type: 'containsText';
1065
+ operator?: ContainsTextOperators;
1066
+ text?: string;
1067
+ stopIfTrue?: boolean;
1068
+ }
1069
+
1070
+ export interface TimePeriodRuleType extends ConditionalFormattingBaseRule {
1071
+ type: 'timePeriod';
1072
+ timePeriod?: TimePeriodTypes;
1073
+ stopIfTrue?: boolean;
1074
+ }
1075
+
1076
+ export interface DataBarRuleType extends ConditionalFormattingBaseRule {
1077
+ type: 'dataBar';
1078
+ gradient?: boolean;
1079
+ minLength?: number;
1080
+ maxLength?: number;
1081
+ showValue?: boolean;
1082
+ border?: boolean;
1083
+ negativeBarColorSameAsPositive?: boolean;
1084
+ negativeBarBorderColorSameAsPositive?: boolean;
1085
+ axisPosition?: 'auto' | 'middle' | 'none';
1086
+ direction?: 'context' | 'leftToRight' | 'rightToLeft';
1087
+ cfvo?: Cvfo[];
1088
+ }
1089
+
1090
+ export type ConditionalFormattingRule = ExpressionRuleType | CellIsRuleType | Top10RuleType | AboveAverageRuleType | ColorScaleRuleType | IconSetRuleType
1091
+ | ContainsTextRuleType | TimePeriodRuleType | DataBarRuleType;
1092
+
1093
+
1094
+ export type RowValues = CellValue[] | { [key: string]: CellValue } | undefined | null;
1095
+
1096
+ export interface ConditionalFormattingOptions {
1097
+ ref: string;
1098
+ rules: ConditionalFormattingRule[];
1099
+ }
1100
+
1101
+ export interface Worksheet {
1102
+ readonly id: number;
1103
+ name: string;
1104
+ readonly workbook: Workbook;
1105
+ readonly hasMerges: boolean;
1106
+
1107
+ readonly dimensions: Range;
1108
+ /**
1109
+ * Contains information related to how a worksheet is printed
1110
+ */
1111
+ pageSetup: Partial<PageSetup>;
1112
+
1113
+ /**
1114
+ * Worksheet Header and Footer
1115
+ */
1116
+ headerFooter: Partial<HeaderFooter>;
1117
+
1118
+ /**
1119
+ * Worksheet State
1120
+ */
1121
+ state: WorksheetState;
1122
+
1123
+ /**
1124
+ * Worksheet Properties
1125
+ */
1126
+ properties: WorksheetProperties;
1127
+
1128
+ /**
1129
+ * Open panes representing the sheet
1130
+ */
1131
+ views: Array<Partial<WorksheetView>>;
1132
+
1133
+ /**
1134
+ * Apply an auto filter to your worksheet.
1135
+ */
1136
+ autoFilter?: AutoFilter;
1137
+
1138
+ destroy(): void;
1139
+
1140
+ /**
1141
+ * A count of the number of rows that have values. If a mid-document row is empty, it will not be included in the count.
1142
+ */
1143
+ readonly actualRowCount: number;
1144
+
1145
+ /**
1146
+ * The total column size of the document. Equal to the maximum cell count from all of the rows
1147
+ */
1148
+ readonly columnCount: number;
1149
+
1150
+ /**
1151
+ * Get the last column in a worksheet
1152
+ */
1153
+ readonly lastColumn: Column | undefined;
1154
+
1155
+ /**
1156
+ * A count of the number of columns that have values.
1157
+ */
1158
+ readonly actualColumnCount: number;
1159
+
1160
+ getColumnKey(key: string): Column;
1161
+
1162
+ setColumnKey(key: string, value: Column): void;
1163
+
1164
+ deleteColumnKey(key: string): void;
1165
+
1166
+ eachColumnKey(callback: (col: Column, index: number) => void): void;
1167
+
1168
+ /**
1169
+ * Access an individual columns by key, letter and 1-based column number
1170
+ */
1171
+ getColumn(indexOrKey: number | string): Column;
1172
+
1173
+ /**
1174
+ * Cut one or more columns (columns to the right are shifted left)
1175
+ * and optionally insert more
1176
+ *
1177
+ * If column properties have been definde, they will be cut or moved accordingly
1178
+ *
1179
+ * Known Issue: If a splice causes any merged cells to move, the results may be unpredictable
1180
+ *
1181
+ * Also: If the worksheet has more rows than values in the colulmn inserts,
1182
+ * the rows will still be shifted as if the values existed
1183
+ */
1184
+ spliceColumns(start: number, count: number, ...insert: any[][]): void;
1185
+
1186
+ /**
1187
+ * Add column headers and define column keys and widths.
1188
+ *
1189
+ * Note: these column structures are a workbook-building convenience only,
1190
+ * apart from the column width, they will not be fully persisted.
1191
+ */
1192
+ columns: Array<Partial<Column>>;
1193
+
1194
+ /**
1195
+ * The total row size of the document. Equal to the row number of the last row that has values.
1196
+ */
1197
+ readonly rowCount: number;
1198
+
1199
+ /**
1200
+ * Get the last editable row in a worksheet (or undefined if there are none)
1201
+ */
1202
+ readonly lastRow: Row | undefined;
1203
+
1204
+ /**
1205
+ * Tries to find and return row for row no, else undefined
1206
+ *
1207
+ * @param row The 1-index row number
1208
+ */
1209
+ findRow(row: number): Row | undefined;
1210
+
1211
+ /**
1212
+ * Tries to find and return rows for row no start and length, else undefined
1213
+ *
1214
+ * @param start The 1-index starting row number
1215
+ * @param length The length of the expected array
1216
+ */
1217
+ findRows(start: number, length: number): Row[] | undefined;
1218
+
1219
+ /**
1220
+ * Cut one or more rows (rows below are shifted up)
1221
+ * and optionally insert more
1222
+ *
1223
+ * Known Issue: If a splice causes any merged cells to move, the results may be unpredictable
1224
+ */
1225
+ spliceRows(start: number, count: number, ...insert: any[][]): void;
1226
+
1227
+ /**
1228
+ * Add a couple of Rows by key-value, after the last current row, using the column keys,
1229
+ * or add a row by contiguous Array (assign to columns A, B & C)
1230
+ */
1231
+ addRow(data: any[] | any, style?: string): Row;
1232
+
1233
+ /**
1234
+ * Add multiple rows by providing an array of arrays or key-value pairs
1235
+ */
1236
+ addRows(rows: any[], style?: string): Row[];
1237
+
1238
+ /**
1239
+ * Insert a Row by key-value, at the position (shifiting down all rows from position),
1240
+ * using the column keys, or add a row by contiguous Array (assign to columns A, B & C)
1241
+ */
1242
+ insertRow(pos: number, value: any[] | any, style?: string): Row;
1243
+
1244
+ /**
1245
+ * Insert multiple rows at position (shifiting down all rows from position)
1246
+ * by providing an array of arrays or key-value pairs
1247
+ */
1248
+ insertRows(pos: number, values: any[], style?: string): Row[];
1249
+
1250
+ /**
1251
+ * Duplicate rows and insert new rows
1252
+ */
1253
+ duplicateRow(rowNum: number, count: number, insert: boolean): void;
1254
+
1255
+ /**
1256
+ * Get or create row by 1-based index
1257
+ */
1258
+ getRow(index: number): Row;
1259
+
1260
+ /**
1261
+ * Get or create rows by 1-based index
1262
+ */
1263
+ getRows(start: number, length: number): Row[] | undefined;
1264
+
1265
+ /**
1266
+ * Iterate over all rows that have values in a worksheet
1267
+ */
1268
+ eachRow(callback: (row: Row, rowNumber: number) => void): void;
1269
+
1270
+ /**
1271
+ * Iterate over all rows (including empty rows) in a worksheet
1272
+ */
1273
+ eachRow(opt: { includeEmpty: boolean }, callback: (row: Row, rowNumber: number) => void): void;
1274
+
1275
+ /**
1276
+ * return all rows as sparse array
1277
+ */
1278
+ getSheetValues(): RowValues[];
1279
+
1280
+ /**
1281
+ * returns the cell at [r,c] or address given by r. If not found, return undefined
1282
+ */
1283
+ findCell(r: number | string, c: number | string): Cell | undefined;
1284
+
1285
+ /**
1286
+ * Get or create cell
1287
+ */
1288
+ getCell(r: number | string, c?: number | string): Cell;
1289
+
1290
+ /**
1291
+ * Merge cells, either:
1292
+ *
1293
+ * tlbr string, e.g. `'A4:B5'`
1294
+ *
1295
+ * tl string, br string, e.g. `'G10', 'H11'`
1296
+ *
1297
+ * t, l, b, r numbers, e.g. `10,11,12,13`
1298
+ */
1299
+ mergeCells(): void;
1300
+ mergeCells(v: Range): void;
1301
+ mergeCells(v: string): void;
1302
+ mergeCells(v: Location): void;
1303
+ mergeCells(top: number, left: number, bottom: number, right: number, sheetName?: string): void;
1304
+ mergeCells(tl: string, br: string, sheetName?: string): void;
1305
+ mergeCells(v: [string, string]): void;
1306
+ mergeCells(v: [string, string, string]): void;
1307
+ mergeCells(v: [number, number, number, number]): void;
1308
+ mergeCells(v: [number, number, number, number, string]): void;
1309
+ mergeCellsWithoutStyle(): void;
1310
+ mergeCellsWithoutStyle(v: Range): void;
1311
+ mergeCellsWithoutStyle(v: string): void;
1312
+ mergeCellsWithoutStyle(v: Location): void;
1313
+ mergeCellsWithoutStyle(top: number, left: number, bottom: number, right: number, sheetName?: string): void;
1314
+ mergeCellsWithoutStyle(tl: string, br: string, sheetName?: string): void;
1315
+ mergeCellsWithoutStyle(v: [string, string]): void;
1316
+ mergeCellsWithoutStyle(v: [string, string, string]): void;
1317
+ mergeCellsWithoutStyle(v: [number, number, number, number]): void;
1318
+ mergeCellsWithoutStyle(v: [number, number, number, number, string]): void;
1319
+
1320
+ /**
1321
+ * unmerging the cells breaks the style links
1322
+ */
1323
+ unMergeCells(): void;
1324
+ unMergeCells(v: Range): void;
1325
+ unMergeCells(v: string): void;
1326
+ unMergeCells(v: Location): void;
1327
+ unMergeCells(top: number, left: number, bottom: number, right: number, sheetName?: string): void;
1328
+ unMergeCells(tl: string, br: string, sheetName?: string): void;
1329
+ unMergeCells(v: [string, string]): void;
1330
+ unMergeCells(v: [string, string, string]): void;
1331
+ unMergeCells(v: [number, number, number, number]): void;
1332
+ unMergeCells(v: [number, number, number, number, string]): void;
1333
+
1334
+ fillFormula(range: Range | string | Location, formula: string, results?: ((r: number, c: number) => string | number) | number[] | number[][]): void;
1335
+
1336
+ /**
1337
+ * Using the image id from `Workbook.addImage`, set the background to the worksheet
1338
+ */
1339
+ addBackgroundImage(imageId: number): void;
1340
+
1341
+ getBackgroundImageId(): string;
1342
+
1343
+ /**
1344
+ * Using the image id from `Workbook.addImage`,
1345
+ * embed an image within the worksheet to cover a range
1346
+ */
1347
+ addImage(imageId: number, range: string | { editAs?: string; } & ImageRange & { hyperlinks?: ImageHyperlinkValue } | { editAs?: string; } & ImagePosition & { hyperlinks?: ImageHyperlinkValue }): void;
1348
+
1349
+ getImages(): Array<{
1350
+ type: 'image',
1351
+ imageId: string;
1352
+ range: ImageRange;
1353
+ }>;
1354
+
1355
+ commit(): void;
1356
+
1357
+ model: WorksheetModel;
1358
+
1359
+ /**
1360
+ * Worksheet protection
1361
+ */
1362
+ protect(password: string, options: Partial<WorksheetProtection>): Promise<void>;
1363
+ unprotect(): void;
1364
+
1365
+ /**
1366
+ * Add a new table and return a reference to it
1367
+ */
1368
+ addTable(tableProperties: TableProperties): Table;
1369
+ /**
1370
+ * fetch table by name or id
1371
+ */
1372
+ getTable(name: string): Table;
1373
+ /**
1374
+ * delete table by name or id
1375
+ */
1376
+ removeTable(name: string): void;
1377
+ /**
1378
+ * fetch table
1379
+ */
1380
+ getTables(): [Table, void][];
1381
+ /**
1382
+ * add conditionalFormattingOptions
1383
+ */
1384
+ addConditionalFormatting(cf: ConditionalFormattingOptions): void;
1385
+
1386
+ /**
1387
+ * delete conditionalFormattingOptions
1388
+ */
1389
+ removeConditionalFormatting(filter: any): void;
1390
+ }
1391
+
1392
+ export interface CalculationProperties {
1393
+ /**
1394
+ * Whether the application shall perform a full recalculation when the workbook is opened
1395
+ */
1396
+ fullCalcOnLoad: boolean
1397
+ }
1398
+
1399
+ export interface WorksheetProperties {
1400
+ /**
1401
+ * Color of the tab
1402
+ */
1403
+ tabColor: Partial<Color>;
1404
+
1405
+ /**
1406
+ * The worksheet column outline level (default: 0)
1407
+ */
1408
+ outlineLevelCol: number;
1409
+
1410
+ /**
1411
+ * The worksheet row outline level (default: 0)
1412
+ */
1413
+ outlineLevelRow: number;
1414
+
1415
+ /**
1416
+ * The outline properties which controls how it will summarize rows and columns
1417
+ */
1418
+ outlineProperties: {
1419
+ summaryBelow: boolean,
1420
+ summaryRight: boolean,
1421
+ };
1422
+ /**
1423
+ * Default row height (default: 15)
1424
+ */
1425
+ defaultRowHeight: number;
1426
+
1427
+ /**
1428
+ * Default column width (optional)
1429
+ */
1430
+ defaultColWidth?: number;
1431
+
1432
+ /**
1433
+ * default: 55
1434
+ */
1435
+ dyDescent: number;
1436
+ showGridLines: boolean;
1437
+ }
1438
+
1439
+ export interface AddWorksheetOptions {
1440
+ properties: Partial<WorksheetProperties>;
1441
+ pageSetup: Partial<PageSetup>;
1442
+ headerFooter: Partial<HeaderFooter>;
1443
+ views: Array<Partial<WorksheetView>>;
1444
+ state: WorksheetState;
1445
+ }
1446
+
1447
+ export interface WorkbookProperties {
1448
+ /**
1449
+ * Set workbook dates to 1904 date system
1450
+ */
1451
+ date1904: boolean;
1452
+ }
1453
+
1454
+ export interface JSZipGeneratorOptions {
1455
+ /**
1456
+ * @default DEFLATE
1457
+ */
1458
+ compression: 'STORE' | 'DEFLATE';
1459
+ compressionOptions: null | {
1460
+ /**
1461
+ * @default 6
1462
+ */
1463
+ level: number;
1464
+ };
1465
+ }
1466
+
1467
+ export interface XlsxReadOptions {
1468
+ /**
1469
+ * The list of XML node names to ignore while parsing an XLSX file
1470
+ */
1471
+ ignoreNodes: string[];
1472
+ }
1473
+
1474
+ export interface XlsxWriteOptions extends stream.xlsx.WorkbookWriterOptions {
1475
+ /**
1476
+ * The option passed to JsZip#generateAsync(options)
1477
+ */
1478
+ zip: Partial<JSZipGeneratorOptions>;
1479
+ }
1480
+
1481
+ export interface Xlsx {
1482
+ /**
1483
+ * read from a file
1484
+ */
1485
+ readFile(path: string, options?: Partial<XlsxReadOptions>): Promise<Workbook>;
1486
+
1487
+ /**
1488
+ * read from a stream
1489
+ * @param stream
1490
+ */
1491
+ read(stream: import('stream').Stream, options?: Partial<XlsxReadOptions>): Promise<Workbook>;
1492
+
1493
+ /**
1494
+ * load from an array buffer
1495
+ * @param buffer
1496
+ */
1497
+ load(buffer: Buffer, options?: Partial<XlsxReadOptions>): Promise<Workbook>;
1498
+
1499
+ /**
1500
+ * write to a buffer
1501
+ */
1502
+ writeBuffer(options?: Partial<XlsxWriteOptions>): Promise<Buffer>;
1503
+
1504
+ /**
1505
+ * write to a file
1506
+ */
1507
+ writeFile(path: string, options?: Partial<XlsxWriteOptions>): Promise<void>;
1508
+
1509
+ /**
1510
+ * write to a stream
1511
+ */
1512
+ write(stream: import('stream').Stream, options?: Partial<XlsxWriteOptions>): Promise<void>;
1513
+ }
1514
+
1515
+ // https://c2fo.github.io/fast-csv/docs/parsing/options
1516
+
1517
+ type HeaderArray = (string | undefined | null)[];
1518
+ type HeaderTransformFunction = (headers: HeaderArray) => HeaderArray;
1519
+ export interface FastCsvParserOptionsArgs {
1520
+ objectMode: boolean;
1521
+ delimiter: string;
1522
+ quote: string | null;
1523
+ escape: string;
1524
+ headers: boolean | HeaderTransformFunction | HeaderArray;
1525
+ renameHeaders: boolean;
1526
+ ignoreEmpty: boolean;
1527
+ comment: string;
1528
+ strictColumnHandling: boolean;
1529
+ discardUnmappedColumns: boolean;
1530
+ trim: boolean;
1531
+ ltrim: boolean;
1532
+ rtrim: boolean;
1533
+ encoding: string;
1534
+ maxRows: number;
1535
+ skipLines: number;
1536
+ skipRows: number;
1537
+ }
1538
+
1539
+ interface QuoteColumnMap {
1540
+ [s: string]: boolean;
1541
+ }
1542
+ declare type QuoteColumns = boolean | boolean[] | QuoteColumnMap;
1543
+
1544
+ interface RowMap {
1545
+ [key: string]: any;
1546
+ }
1547
+ declare type RowHashArray = [string, any][];
1548
+ declare type RowArray = string[];
1549
+ declare type Rows = RowArray | RowMap | RowHashArray;
1550
+ declare type RowTransformCallback = (error?: Error | null, row?: Rows) => void;
1551
+ interface RowTransformFunction {
1552
+ (row: Rows, callback: RowTransformCallback): void;
1553
+ (row: Rows): Rows;
1554
+ }
1555
+
1556
+ // https://c2fo.github.io/fast-csv/docs/formatting/options/
1557
+ export interface FastCsvFormatterOptionsArgs {
1558
+ objectMode: boolean;
1559
+ delimiter: string;
1560
+ rowDelimiter: string;
1561
+ quote: string | boolean;
1562
+ escape: string;
1563
+ quoteColumns: QuoteColumns;
1564
+ quoteHeaders: QuoteColumns;
1565
+ headers: null | boolean | string[];
1566
+ includeEndRowDelimiter: boolean;
1567
+ writeBOM: boolean;
1568
+ transform: RowTransformFunction;
1569
+ alwaysWriteHeaders: boolean;
1570
+ }
1571
+
1572
+ export interface CsvReadOptions {
1573
+ dateFormats: string[];
1574
+ map(value: any, index: number): any;
1575
+ sheetName: string;
1576
+ parserOptions: Partial<FastCsvParserOptionsArgs>;
1577
+ }
1578
+
1579
+ export interface CsvWriteOptions {
1580
+ dateFormat: string;
1581
+ dateUTC: boolean;
1582
+ sheetName: string;
1583
+ sheetId: number;
1584
+ encoding: string;
1585
+ map(value: any, index: number): any;
1586
+ includeEmptyRows: boolean;
1587
+ formatterOptions: Partial<FastCsvFormatterOptionsArgs>;
1588
+ }
1589
+
1590
+ export interface Csv {
1591
+ /**
1592
+ * read from a file
1593
+ */
1594
+ readFile(path: string, options?: Partial<CsvReadOptions>): Promise<Worksheet>;
1595
+
1596
+ /**
1597
+ * read from a stream
1598
+ */
1599
+ read(stream: import('stream').Stream, options?: Partial<CsvReadOptions>): Promise<Worksheet>;
1600
+
1601
+ /**
1602
+ * Create input stream for reading
1603
+ */
1604
+ createInputStream(options?: Partial<CsvReadOptions>): import('events').EventEmitter;
1605
+
1606
+ /**
1607
+ * write to a buffer
1608
+ */
1609
+ writeBuffer(options?: Partial<CsvWriteOptions>): Promise<Buffer>;
1610
+
1611
+ /**
1612
+ * write to a file
1613
+ */
1614
+ writeFile(path: string, options?: Partial<CsvWriteOptions>): Promise<void>;
1615
+
1616
+ /**
1617
+ * write to a stream
1618
+ */
1619
+ write(stream: import('stream').Stream, options?: Partial<CsvWriteOptions>): Promise<void>;
1620
+ }
1621
+
1622
+ export interface Media {
1623
+ type: string; // image,background
1624
+ name: string;
1625
+ extension: string;
1626
+ buffer: Buffer;
1627
+ }
1628
+
1629
+ export interface Address {
1630
+ sheetName?: string;
1631
+ address: string;
1632
+ col: string;
1633
+ row: string;
1634
+ $col$row: string;
1635
+ }
1636
+
1637
+ export interface Location {
1638
+ top: number;
1639
+ left: number;
1640
+ bottom: number;
1641
+ right: number;
1642
+ }
1643
+
1644
+ export interface CellMatrix {
1645
+ addCell(addressStr: string): void;
1646
+ getCell(addressStr: string): Cell;
1647
+ findCell(addressStr: string): Cell | undefined;
1648
+ findCellAt(sheetName: string, rowNumber: number, colNumber: number): Cell | undefined;
1649
+ addCellEx(address: string | Location): void;
1650
+ getCellEx(address: string | Location): Cell;
1651
+ findCellEx(address: string | Location, create: boolean): Cell | undefined;
1652
+ getCellAt(sheetName: string, rowNumber: number, colNumber: number): Cell;
1653
+ removeCellEx(address: string | Location): void;
1654
+ forEach(callback: (cell: Cell) => void): void;
1655
+ map<T>(callback: (cell: Cell) => T): T[];
1656
+ findSheet(address: string | Location, create: boolean): Cell[] | undefined;
1657
+ findSheetRow(sheet: Cell[][], address: string | Location, create: boolean): Row | undefined;
1658
+ findRowCell(row: any[], address: Address, create: boolean): Cell | undefined;
1659
+ }
1660
+
1661
+ export interface DefinedNamesRanges {
1662
+ name: string;
1663
+ ranges: string[];
1664
+ }
1665
+
1666
+ export type DefinedNamesModel = DefinedNamesRanges[];
1667
+
1668
+ export interface DefinedNames {
1669
+ getMatrix(name: string): CellMatrix;
1670
+ // add a name to a cell. locStr in the form SheetName!$col$row or SheetName!$c1$r1:$c2:$r2
1671
+ add(locStr: string, name?: string): void;
1672
+ addEx(location: string | Location, name: string): Cell;
1673
+
1674
+ remove(locStr: string | Location, name: string): void;
1675
+ removeEx(location: string | Location, name: string): void;
1676
+ removeAllNames(location: string | Location): void;
1677
+
1678
+ forEach(callback: (name: string, cell: Cell) => void): void;
1679
+
1680
+ // get all the names of a cell
1681
+ getNames(addressStr: string): string[];
1682
+ getNamesEx(address: string): string[];
1683
+
1684
+ getRanges(name: string, matrix?: CellMatrix): DefinedNamesRanges;
1685
+
1686
+ model: DefinedNamesModel;
1687
+ }
1688
+
1689
+ export interface WorkbookModel {
1690
+ creator: string;
1691
+ lastModifiedBy: string;
1692
+ lastPrinted: Date;
1693
+ created: Date;
1694
+ modified: Date;
1695
+ properties: WorkbookProperties;
1696
+ worksheets: Worksheet[];
1697
+ sheets: WorksheetModel[];
1698
+ definedNames: DefinedNamesModel;
1699
+ views: WorkbookView[];
1700
+ company: string;
1701
+ manager: string;
1702
+ title: string;
1703
+ subject: string;
1704
+ keywords: string;
1705
+ category: string;
1706
+ description: string;
1707
+ language: string;
1708
+ revision: Date;
1709
+ contentStatus: string;
1710
+ themes: string[];
1711
+ media: Media[];
1712
+ }
1713
+
1714
+ export class Workbook {
1715
+ category: string;
1716
+ company: string;
1717
+ creator: string;
1718
+ description: string;
1719
+ keywords: string;
1720
+ lastModifiedBy: string;
1721
+ created: Date;
1722
+ manager: string;
1723
+ modified: Date;
1724
+ lastPrinted: Date;
1725
+ properties: WorkbookProperties;
1726
+ subject: string;
1727
+ title: string;
1728
+
1729
+ /**
1730
+ * Workbook calculation Properties
1731
+ */
1732
+ calcProperties: CalculationProperties;
1733
+
1734
+ /**
1735
+ * xlsx file format operations
1736
+ */
1737
+ readonly xlsx: Xlsx;
1738
+
1739
+ /**
1740
+ * csv file format operations
1741
+ */
1742
+ readonly csv: Csv;
1743
+
1744
+ readonly nextId: number;
1745
+
1746
+ readonly definedNames: DefinedNames;
1747
+
1748
+ model: WorkbookModel;
1749
+
1750
+ /**
1751
+ * The Workbook views controls how many separate windows Excel will open when viewing the workbook.
1752
+ */
1753
+ views: WorkbookView[];
1754
+
1755
+ /**
1756
+ * return a clone of worksheets in order
1757
+ */
1758
+ worksheets: Worksheet[];
1759
+
1760
+ /**
1761
+ * Add a new worksheet and return a reference to it
1762
+ */
1763
+ addWorksheet(name?: string, options?: Partial<AddWorksheetOptions>): Worksheet;
1764
+
1765
+ removeWorksheetEx(worksheet: Worksheet): void;
1766
+ removeWorksheet(indexOrName: number | string): void;
1767
+
1768
+ /**
1769
+ * fetch sheet by name or id
1770
+ */
1771
+ getWorksheet(indexOrName?: number | string): Worksheet | undefined;
1772
+
1773
+ /**
1774
+ * Iterate over all sheets.
1775
+ *
1776
+ * Note: `workbook.worksheets.forEach` will still work but this is better.
1777
+ */
1778
+ eachSheet(callback: (worksheet: Worksheet, id: number) => void): void;
1779
+
1780
+ clearThemes(): void;
1781
+
1782
+ /**
1783
+ * Add Image to Workbook and return the id
1784
+ */
1785
+ addImage(img: Image): number;
1786
+
1787
+ getImage(id: number): Image;
1788
+ }
1789
+
1790
+ export interface TableStyleProperties {
1791
+ /**
1792
+ * The colour theme of the table
1793
+ * @default 'TableStyleMedium2'
1794
+ */
1795
+ theme?: 'TableStyleDark1' | 'TableStyleDark10' | 'TableStyleDark11' | 'TableStyleDark2' | 'TableStyleDark3' | 'TableStyleDark4' | 'TableStyleDark5' | 'TableStyleDark6' | 'TableStyleDark7' | 'TableStyleDark8' | 'TableStyleDark9' | 'TableStyleLight1' | 'TableStyleLight10' | 'TableStyleLight11' | 'TableStyleLight12' | 'TableStyleLight13' | 'TableStyleLight14' | 'TableStyleLight15' | 'TableStyleLight16' | 'TableStyleLight17' | 'TableStyleLight18' | 'TableStyleLight19' | 'TableStyleLight2' | 'TableStyleLight20' | 'TableStyleLight21' | 'TableStyleLight3' | 'TableStyleLight4' | 'TableStyleLight5' | 'TableStyleLight6' | 'TableStyleLight7' | 'TableStyleLight8' | 'TableStyleLight9' | 'TableStyleMedium1' | 'TableStyleMedium10' | 'TableStyleMedium11' | 'TableStyleMedium12' | 'TableStyleMedium13' | 'TableStyleMedium14' | 'TableStyleMedium15' | 'TableStyleMedium16' | 'TableStyleMedium17' | 'TableStyleMedium18' | 'TableStyleMedium19' | 'TableStyleMedium2' | 'TableStyleMedium20' | 'TableStyleMedium21' | 'TableStyleMedium22' | 'TableStyleMedium23' | 'TableStyleMedium24' | 'TableStyleMedium25' | 'TableStyleMedium26' | 'TableStyleMedium27' | 'TableStyleMedium28' | 'TableStyleMedium3' | 'TableStyleMedium4' | 'TableStyleMedium5' | 'TableStyleMedium6' | 'TableStyleMedium7' | 'TableStyleMedium8' | 'TableStyleMedium9';
1796
+ /**
1797
+ * Highlight the first column (bold)
1798
+ * @default false
1799
+ */
1800
+ showFirstColumn?: boolean;
1801
+ /**
1802
+ * Highlight the last column (bold)
1803
+ * @default false
1804
+ */
1805
+ showLastColumn?: boolean;
1806
+ /**
1807
+ * Alternate rows shown with background colour
1808
+ * @default false
1809
+ */
1810
+ showRowStripes?: boolean;
1811
+ /**
1812
+ * Alternate rows shown with background colour
1813
+ * @default false
1814
+ */
1815
+ showColumnStripes?: boolean;
1816
+ }
1817
+
1818
+ export interface TableColumnProperties {
1819
+ /**
1820
+ * The name of the column, also used in the header
1821
+ */
1822
+ name: string;
1823
+ /**
1824
+ * Switches the filter control in the header
1825
+ * @default false
1826
+ */
1827
+ filterButton?: boolean;
1828
+ /**
1829
+ * Label to describe the totals row (first column)
1830
+ * @default 'Total'
1831
+ */
1832
+ totalsRowLabel?: string;
1833
+ /**
1834
+ * Name of the totals function
1835
+ * @default 'none'
1836
+ */
1837
+ totalsRowFunction?: 'none' | 'average' | 'countNums' | 'count' | 'max' | 'min' | 'stdDev' | 'var' | 'sum' | 'custom';
1838
+ /**
1839
+ * Optional formula for custom functions
1840
+ */
1841
+ totalsRowFormula?: string;
1842
+
1843
+ /**
1844
+ * Styles applied to the column
1845
+ */
1846
+ style?: Partial<Style>;
1847
+ }
1848
+
1849
+
1850
+ export interface TableProperties {
1851
+ /**
1852
+ * The name of the table
1853
+ */
1854
+ name: string;
1855
+ /**
1856
+ * The display name of the table
1857
+ */
1858
+ displayName?: string;
1859
+ /**
1860
+ * Top left cell of the table
1861
+ */
1862
+ ref: string;
1863
+ /**
1864
+ * Show headers at top of table
1865
+ * @default true
1866
+ */
1867
+ headerRow?: boolean;
1868
+ /**
1869
+ * Show totals at bottom of table
1870
+ * @default false
1871
+ */
1872
+ totalsRow?: boolean;
1873
+ /**
1874
+ * Extra style properties
1875
+ * @default {}
1876
+ */
1877
+ style?: TableStyleProperties;
1878
+ /**
1879
+ * Column definitions
1880
+ */
1881
+ columns: TableColumnProperties[]
1882
+ /**
1883
+ * Rows of data
1884
+ */
1885
+ rows: any[][]
1886
+ }
1887
+
1888
+ export type TableColumn = Required<TableColumnProperties>
1889
+
1890
+ export interface Table extends Required<TableProperties> {
1891
+ /**
1892
+ * Commit changes
1893
+ */
1894
+ commit: () => void
1895
+ /**
1896
+ * Remove a rows of data
1897
+ */
1898
+ removeRows: (rowIndex: number, count: number) => void
1899
+ /**
1900
+ * Add a row of data, either insert at rowNumber or append
1901
+ */
1902
+ addRow: (values: any[], rowNumber?: number) => void
1903
+ /**
1904
+ * Get column
1905
+ */
1906
+ getColumn: (colIndex: number) => TableColumn
1907
+ /**
1908
+ * Add a new column, including column defn and values
1909
+ * inserts at colNumber or adds to the right
1910
+ */
1911
+ addColumn: (column: TableColumnProperties, values: any[], colIndex: number) => void
1912
+ /**
1913
+ * Remove a column with data
1914
+ */
1915
+ removeColumns: (colIndex: number, count: number) => void
1916
+ }
1917
+
1918
+ export namespace config {
1919
+ function setValue(key: 'promise', promise: any): void;
1920
+ }
1921
+
1922
+ export namespace stream {
1923
+ namespace xlsx {
1924
+ interface WorkbookWriterOptions {
1925
+ /**
1926
+ * Specifies a writable stream to write the XLSX workbook to.
1927
+ */
1928
+ stream: import('stream').Stream;
1929
+
1930
+ /**
1931
+ * If stream not specified, this field specifies the path to a file to write the XLSX workbook to.
1932
+ */
1933
+ filename: string;
1934
+
1935
+ /**
1936
+ * Specifies whether to use shared strings in the workbook. Default is false
1937
+ */
1938
+ useSharedStrings: boolean;
1939
+
1940
+ /**
1941
+ * Specifies whether to add style information to the workbook.
1942
+ * Styles can add some performance overhead. Default is false
1943
+ */
1944
+ useStyles: boolean;
1945
+ }
1946
+
1947
+ interface ArchiverZipOptions {
1948
+ comment: string;
1949
+ forceLocalTime: boolean;
1950
+ forceZip64: boolean;
1951
+ store: boolean;
1952
+ zlib: Partial<ZlibOptions>;
1953
+ }
1954
+
1955
+ interface ZlibOptions {
1956
+ /**
1957
+ * @default constants.Z_NO_FLUSH
1958
+ */
1959
+ flush: number;
1960
+ /**
1961
+ * @default constants.Z_FINISH
1962
+ */
1963
+ finishFlush: number;
1964
+ /**
1965
+ * @default 16*1024
1966
+ */
1967
+ chunkSize: number;
1968
+ windowBits: number;
1969
+ level: number; // compression only
1970
+ memLevel: number; // compression only
1971
+ strategy: number; // compression only
1972
+ dictionary: Buffer | NodeJS.TypedArray | DataView | ArrayBuffer; // deflate/inflate only, empty dictionary by default
1973
+ }
1974
+
1975
+ interface WorkbookStreamWriterOptions extends WorkbookWriterOptions {
1976
+
1977
+ /**
1978
+ * Specifies whether to add style information to the workbook.
1979
+ * Styles can add some performance overhead. Default is false
1980
+ */
1981
+ zip: Partial<ArchiverZipOptions>;
1982
+ }
1983
+
1984
+ class WorkbookWriter extends Workbook {
1985
+ constructor(options: Partial<WorkbookStreamWriterOptions>);
1986
+ // commit all worksheets, then add suplimentary files
1987
+ commit(): Promise<void>;
1988
+ addStyles(): Promise<void>;
1989
+ addThemes(): Promise<void>;
1990
+ addOfficeRels(): Promise<void>;
1991
+ addContentTypes(): Promise<void>;
1992
+ addApp(): Promise<void>;
1993
+ addCore(): Promise<void>;
1994
+ addSharedStrings(): Promise<void>;
1995
+ addWorkbookRels(): Promise<void>;
1996
+ addWorkbook(): Promise<void>;
1997
+ }
1998
+
1999
+
2000
+ interface WorkbookStreamReaderOptions {
2001
+ /**
2002
+ * @default 'emit'
2003
+ */
2004
+ worksheets?: 'emit' | 'ignore';
2005
+ /**
2006
+ * @default 'cache'
2007
+ */
2008
+ sharedStrings?: 'cache' | 'emit' | 'ignore';
2009
+ /**
2010
+ * @default 'ignore'
2011
+ */
2012
+ hyperlinks?: 'cache' | 'emit' | 'ignore';
2013
+ /**
2014
+ * @default 'ignore'
2015
+ */
2016
+ styles?: 'cache' | 'ignore';
2017
+ /**
2018
+ * @default 'ignore'
2019
+ */
2020
+ entries?: 'emit' | 'ignore';
2021
+ }
2022
+
2023
+ class WorkbookReader extends Workbook {
2024
+ constructor(input: string | import('stream').Stream, options: Partial<WorkbookStreamReaderOptions>);
2025
+ read(): Promise<void>;
2026
+ [Symbol.asyncIterator](): AsyncGenerator<WorksheetReader>;
2027
+ parse(): AsyncIterator<any>;
2028
+ }
2029
+
2030
+ interface WorksheetReaderOptions {
2031
+ workbook: Workbook;
2032
+ id: number;
2033
+ entry: import('stream').Stream;
2034
+ options: WorkbookStreamReaderOptions;
2035
+ }
2036
+
2037
+ class WorksheetReader {
2038
+ constructor(options: WorksheetReaderOptions);
2039
+ read(): Promise<void>;
2040
+ [Symbol.asyncIterator](): AsyncGenerator<Row>;
2041
+ parse(): AsyncIterator<Array<any>>;
2042
+ dimensions(): number;
2043
+ columns(): number;
2044
+ getColumn(c: number): Column;
2045
+ }
2046
+ }
2047
+ }