@sheetxl/react 0.8.0-beta.2 → 0.8.0-beta.21

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 (405) hide show
  1. package/LICENSE.md +8 -7
  2. package/browser/esm/6lfBozPNyWlFBEDn.mjs +19 -0
  3. package/browser/esm/B7TCFLHs7nnOgLMi.mjs +79 -0
  4. package/browser/esm/BQur1iFrng9Y4kh4.mjs +2706 -0
  5. package/browser/esm/BjnWnPjhT1QFkbUC.mjs +60 -0
  6. package/browser/esm/BwMC6jAg2neI4LTH.mjs +32 -0
  7. package/browser/esm/BzCq_Z7J2qQlY4Dp.mjs +134 -0
  8. package/browser/esm/BzFKdDmdCdg3cXdh.mjs +262 -0
  9. package/browser/esm/C2HjD-DbaqXq93R7.mjs +45 -0
  10. package/browser/esm/C46qV9hBGqlz6_Kt.mjs +323 -0
  11. package/browser/esm/C9dHNoiKtX9PLY1g.mjs +20 -0
  12. package/browser/esm/CA6w64diOtRCgr4n.mjs +67 -0
  13. package/browser/esm/CCL3pFmdsuwahoCR.mjs +42 -0
  14. package/browser/esm/CHgyrBEiFmspcFXV.mjs +8 -0
  15. package/browser/esm/CPwcEeQtvkrESNEy.mjs +303 -0
  16. package/browser/esm/CdE8JeJkTtdh5qqp.mjs +78 -0
  17. package/browser/esm/CkYId3pjG9v3XZM2.mjs +36 -0
  18. package/browser/esm/Co65nK3fyBcyVzrS.mjs +401 -0
  19. package/browser/esm/DG1f60gvSkz8Y3qb.mjs +197 -0
  20. package/browser/esm/DL2WZkJdK1lZfpJo.mjs +341 -0
  21. package/browser/esm/Dl0ye0MfTml4mjhA.mjs +9560 -0
  22. package/browser/esm/_T8e_9xhVAagwkPD.mjs +31 -0
  23. package/browser/esm/chart.mjs +41 -0
  24. package/browser/esm/control.mjs +217 -0
  25. package/browser/esm/fHDciYUZvXpLzoID.mjs +128 -0
  26. package/browser/esm/group.mjs +123 -0
  27. package/browser/esm/index.mjs +22374 -13204
  28. package/browser/esm/k1IvXgw5-153QQUo.mjs +14092 -0
  29. package/browser/esm/mOYnwl3MMod-yX7a.mjs +63 -0
  30. package/browser/esm/note.mjs +112 -0
  31. package/browser/esm/picture.mjs +7 -0
  32. package/browser/esm/shape.mjs +7 -0
  33. package/browser/esm/slicer.mjs +277 -0
  34. package/browser/esm/zTaXN_1rvsoWg94m.mjs +145 -0
  35. package/licenses/dependencies.txt +284 -565
  36. package/node/esm/8PerdW56-NyRf0pg.mjs +134 -0
  37. package/node/esm/B2a1mRx9B8XMRd8H.mjs +2706 -0
  38. package/node/esm/B4qJFO-8Vml8JbaC.mjs +146 -0
  39. package/node/esm/BBBfGP0lLhBFoR9F.mjs +198 -0
  40. package/node/esm/BQpm93aEyzN5TiU6.mjs +8 -0
  41. package/node/esm/BadjRr_jKKGvmEW-.mjs +80 -0
  42. package/node/esm/Bzuh8HcJcFD2dYTY.mjs +128 -0
  43. package/node/esm/CD1OBtF4vEthYy6e.mjs +35 -0
  44. package/node/esm/CGEbcsNJ40cYQEWX.mjs +1697 -0
  45. package/node/esm/CNYzecnb2TInTI8p.mjs +80 -0
  46. package/node/esm/COg8aOu0d67g_Pg5.mjs +37 -0
  47. package/node/esm/CdKkuM4Yy04LbhRL.mjs +19 -0
  48. package/node/esm/Df-nWyFJwXaVd79x.mjs +263 -0
  49. package/node/esm/DtrPF3bSD4CZC5VG.mjs +45 -0
  50. package/node/esm/EXPN4LM0alUK5Zw7.mjs +20 -0
  51. package/node/esm/JrDkDzP0l4TgHusH.mjs +32 -0
  52. package/node/esm/Mq8a4csdTfwY5CnZ.mjs +63 -0
  53. package/node/esm/cgqViNUwnlIX8-UW.mjs +328 -0
  54. package/node/esm/chart.mjs +41 -0
  55. package/node/esm/control.mjs +217 -0
  56. package/node/esm/fM9xnrz0LJWdndYE.mjs +68 -0
  57. package/node/esm/group.mjs +123 -0
  58. package/node/esm/index.mjs +18717 -9431
  59. package/node/esm/note.mjs +113 -0
  60. package/node/esm/picture.mjs +305 -0
  61. package/node/esm/shape.mjs +342 -0
  62. package/node/esm/slicer.mjs +279 -0
  63. package/node/esm/tRhXTPxocmY7ZY3z.mjs +66 -0
  64. package/node/esm/uzlKB6H0b-ol8pDK.mjs +406 -0
  65. package/package.json +56 -15
  66. package/resources/contents.json +36 -0
  67. package/resources/locales/contents.json +84 -0
  68. package/resources/locales/de/chart.cmd.json +82 -0
  69. package/resources/locales/de/movable.cmd.json +68 -0
  70. package/resources/locales/de/picture.cmd.json +188 -0
  71. package/resources/locales/de/pivot.cmd.json +79 -0
  72. package/resources/locales/de/shape.cmd.json +17 -0
  73. package/resources/locales/de/sheet.cmd.json +314 -27
  74. package/resources/locales/de/slicer.cmd.json +17 -0
  75. package/resources/locales/de/sparkline.cmd.json +301 -0
  76. package/resources/locales/de/table.cmd.json +13 -2
  77. package/resources/locales/de/ui.msg.json +367 -3
  78. package/resources/locales/de/workbook.cmd.json +8 -1
  79. package/resources/locales/en/chart.cmd.json +82 -0
  80. package/resources/locales/en/movable.cmd.json +68 -0
  81. package/resources/locales/en/picture.cmd.json +188 -0
  82. package/resources/locales/en/pivot.cmd.json +79 -0
  83. package/resources/locales/en/shape.cmd.json +17 -0
  84. package/resources/locales/en/sheet.cmd.json +328 -29
  85. package/resources/locales/en/slicer.cmd.json +17 -0
  86. package/resources/locales/en/sparkline.cmd.json +301 -0
  87. package/resources/locales/en/table.cmd.json +13 -2
  88. package/resources/locales/en/ui.msg.json +369 -3
  89. package/resources/locales/en/workbook.cmd.json +8 -1
  90. package/types/chart.d.ts +2 -0
  91. package/types/control.d.ts +2 -0
  92. package/types/group.d.ts +2 -0
  93. package/types/note.d.ts +2 -0
  94. package/types/picture.d.ts +2 -0
  95. package/types/shape.d.ts +2 -0
  96. package/types/slicer.d.ts +2 -0
  97. package/types/src/annotation/RangeAnnotationLayer.d.ts +110 -0
  98. package/types/src/annotation/RangeAnnotationTag.d.ts +23 -0
  99. package/types/src/annotation/RangeAnnotations.d.ts +180 -0
  100. package/types/src/annotation/index.d.ts +4 -0
  101. package/types/src/autoFill/FillMenu.d.ts +2 -2
  102. package/types/src/autoFill/FillSeries.d.ts +2 -2
  103. package/types/src/border/StaticBorderRenderer.d.ts +18 -1
  104. package/types/src/border/useBorders.d.ts +95 -3
  105. package/types/src/cell/CellCheckboxRenderer.d.ts +20 -0
  106. package/types/src/cell/CellContent.d.ts +68 -0
  107. package/types/src/cell/CellControlContext.d.ts +37 -0
  108. package/types/src/cell/{FormulaCellRenderer.d.ts → CellFormulaRenderer.d.ts} +10 -7
  109. package/types/src/cell/CellImageRenderer.d.ts +11 -0
  110. package/types/src/cell/CellRenderers.d.ts +190 -0
  111. package/types/src/cell/{SheetCellRenderer.d.ts → CellTextRenderer.d.ts} +11 -8
  112. package/types/src/cell/ColumnButton.d.ts +3 -3
  113. package/types/src/cell/CornerTriangle.d.ts +6 -0
  114. package/types/src/cell/OutlineButton.d.ts +123 -0
  115. package/types/src/cell/PivotButton.d.ts +55 -0
  116. package/types/src/cell/SheetHeaderRenderer.d.ts +6 -1
  117. package/types/src/cell/StaticCellRenderer.d.ts +3 -3
  118. package/types/src/cell/_DropdownFace.d.ts +29 -0
  119. package/types/src/cell/index.d.ts +10 -2
  120. package/types/src/cell/useFormulaViewAnchor.d.ts +3 -3
  121. package/types/src/cell/useInsertableCellControls.d.ts +25 -0
  122. package/types/src/chart/ChartCommands.d.ts +15 -0
  123. package/types/src/chart/ChartEditor.d.ts +12 -2
  124. package/types/src/chart/ChartElement.d.ts +122 -0
  125. package/types/src/chart/ChartKind.d.ts +7 -0
  126. package/types/src/chart/PresetChartTypeDescriptors.d.ts +3 -1
  127. package/types/src/chart/index.d.ts +2 -1
  128. package/types/src/chart/paint/_fills.d.ts +24 -0
  129. package/types/src/chart/paint/_graphics.d.ts +38 -0
  130. package/types/src/chart/paint/_mode.d.ts +6 -0
  131. package/types/src/chart/paint/echarts.d.ts +33 -0
  132. package/types/src/chart/paint/index.d.ts +12 -0
  133. package/types/src/chart/paint/kinds/ChartPaintKind.d.ts +140 -0
  134. package/types/src/chart/paint/kinds/_Area.d.ts +3 -0
  135. package/types/src/chart/paint/kinds/_Bar.d.ts +3 -0
  136. package/types/src/chart/paint/kinds/_BoxWhisker.d.ts +3 -0
  137. package/types/src/chart/paint/kinds/_Bubble.d.ts +3 -0
  138. package/types/src/chart/paint/kinds/_Funnel.d.ts +3 -0
  139. package/types/src/chart/paint/kinds/_Histogram.d.ts +3 -0
  140. package/types/src/chart/paint/kinds/_Line.d.ts +10 -0
  141. package/types/src/chart/paint/kinds/_OfPie.d.ts +3 -0
  142. package/types/src/chart/paint/kinds/_Pie.d.ts +21 -0
  143. package/types/src/chart/paint/kinds/_Placeholder.d.ts +7 -0
  144. package/types/src/chart/paint/kinds/_Radar.d.ts +3 -0
  145. package/types/src/chart/paint/kinds/_Scatter.d.ts +3 -0
  146. package/types/src/chart/paint/kinds/_Sunburst.d.ts +3 -0
  147. package/types/src/chart/paint/kinds/_Surface.d.ts +3 -0
  148. package/types/src/chart/paint/kinds/_Treemap.d.ts +3 -0
  149. package/types/src/chart/paint/kinds/_Waterfall.d.ts +3 -0
  150. package/types/src/chart/paint/kinds/_builtIns.d.ts +3 -0
  151. package/types/src/chart/paint/toEChartsOption.d.ts +42 -0
  152. package/types/src/checklist/ValueChecklist.d.ts +60 -19
  153. package/types/src/clipboard/ClipboardCommands.d.ts +3 -3
  154. package/types/src/clipboard/SheetClipboardLayer.d.ts +2 -2
  155. package/types/src/commands/ContextualToolbar.d.ts +19 -0
  156. package/types/src/commands/createTransactionalMiddleware.d.ts +4 -1
  157. package/types/src/commands/index.d.ts +1 -0
  158. package/types/src/comment/CommentCardRequest.d.ts +94 -0
  159. package/types/src/comment/CommentUtils.d.ts +43 -0
  160. package/types/src/comment/NoteEditor.d.ts +20 -0
  161. package/types/src/comment/index.d.ts +5 -0
  162. package/types/src/comment/useCommentThread.d.ts +37 -0
  163. package/types/src/comment/useSheetComments.d.ts +28 -0
  164. package/types/src/conditionalFormat/ConditionalFormatPresets.d.ts +6 -6
  165. package/types/src/context/WorksheetContext.d.ts +18 -0
  166. package/types/src/context/index.d.ts +1 -1
  167. package/types/src/control/FormControlRenderers.d.ts +22 -0
  168. package/types/src/editableLabel/EditableLabel.d.ts +3 -1
  169. package/types/src/editor/EditorCommands.d.ts +3 -3
  170. package/types/src/editor/FunctionPreviewPanel.d.ts +1 -1
  171. package/types/src/editor/SheetCellEditorLayer.d.ts +2 -10
  172. package/types/src/editor/SheetCellEditorStartLayer.d.ts +61 -0
  173. package/types/src/editor/SheetCellInput.d.ts +14 -0
  174. package/types/src/editor/SheetEditable.d.ts +6 -6
  175. package/types/src/editor/SheetReferenceHeaderLayer.d.ts +1 -1
  176. package/types/src/editor/SheetReferenceLayer.d.ts +4 -4
  177. package/types/src/editor/VirtualKeyboardLayer.d.ts +50 -0
  178. package/types/src/editor/formulaAnchor.d.ts +12 -0
  179. package/types/src/editor/index.d.ts +3 -0
  180. package/types/src/editor/pickedReference.d.ts +3 -3
  181. package/types/src/editor/useEditRejectedNotice.d.ts +3 -3
  182. package/types/src/editor/useFormulaHints.d.ts +3 -3
  183. package/types/src/editor/useFormulaInput.d.ts +15 -3
  184. package/types/src/editor/validationAlert.d.ts +24 -0
  185. package/types/src/form/FormulaInput.d.ts +5 -2
  186. package/types/src/form/useEditCommit.d.ts +23 -3
  187. package/types/src/form/useInputField.d.ts +2 -3
  188. package/types/src/frame/CommandContext.d.ts +101 -3
  189. package/types/src/group/GroupEditor.d.ts +25 -0
  190. package/types/src/index.d.ts +12 -1
  191. package/types/src/layer/BorderLayer.d.ts +5 -2
  192. package/types/src/layer/CellErrorLayer.d.ts +18 -7
  193. package/types/src/layer/CellFillLayer.d.ts +2 -2
  194. package/types/src/layer/CellIndicatorLayer.d.ts +31 -0
  195. package/types/src/layer/CellInsertLayer.d.ts +71 -0
  196. package/types/src/layer/CircularIndicatorLayer.d.ts +3 -3
  197. package/types/src/layer/CommentCardLayer.d.ts +43 -0
  198. package/types/src/layer/CommentsLayer.d.ts +35 -0
  199. package/types/src/layer/ConditionalBarLayer.d.ts +2 -2
  200. package/types/src/layer/ConditionalIcons.d.ts +4 -4
  201. package/types/src/layer/ConditionalIconsLayer.d.ts +2 -2
  202. package/types/src/layer/ContextMenuLayer.d.ts +2 -2
  203. package/types/src/layer/FreezeDragLines.d.ts +17 -0
  204. package/types/src/layer/GridFreezeLayer.d.ts +11 -0
  205. package/types/src/layer/HeaderFreezeLayer.d.ts +12 -0
  206. package/types/src/layer/HeaderResizerLayer.d.ts +2 -1
  207. package/types/src/layer/HeaderSelectionLayer.d.ts +4 -4
  208. package/types/src/layer/HyperlinkLayer.d.ts +116 -0
  209. package/types/src/layer/MovableKindScope.d.ts +17 -0
  210. package/types/src/layer/PivotLayer.d.ts +47 -0
  211. package/types/src/layer/PivotToolbar.d.ts +29 -0
  212. package/types/src/layer/ProtectionLayer.d.ts +4 -5
  213. package/types/src/layer/RangeToolbar.d.ts +75 -0
  214. package/types/src/layer/ResizeIndicator.d.ts +11 -10
  215. package/types/src/layer/ResizeTooltip.d.ts +13 -0
  216. package/types/src/layer/SheetBackgroundLayer.d.ts +3 -3
  217. package/types/src/layer/SheetCellLayer.d.ts +15 -8
  218. package/types/src/layer/SheetColumnButtonLayer.d.ts +2 -2
  219. package/types/src/layer/SheetGridLineLayer.d.ts +25 -15
  220. package/types/src/layer/SheetHeaderCellLayer.d.ts +10 -1
  221. package/types/src/layer/SheetLayers.d.ts +171 -0
  222. package/types/src/layer/SheetMovableLayer.d.ts +4 -3
  223. package/types/src/layer/SheetOutlineLayer.d.ts +40 -0
  224. package/types/src/layer/SheetPivotCommandLayer.d.ts +13 -0
  225. package/types/src/layer/SheetSparklineCommandLayer.d.ts +14 -0
  226. package/types/src/layer/SheetTableCommandLayer.d.ts +2 -2
  227. package/types/src/layer/SparklineLayer.d.ts +32 -0
  228. package/types/src/layer/SpillLayer.d.ts +2 -2
  229. package/types/src/layer/TableLayer.d.ts +6 -5
  230. package/types/src/layer/TableToolbar.d.ts +23 -0
  231. package/types/src/layer/ValidationDropdownLayer.d.ts +2 -2
  232. package/types/src/layer/ValidationIndicatorLayer.d.ts +2 -2
  233. package/types/src/layer/ValidationPromptLayer.d.ts +47 -16
  234. package/types/src/layer/_sheetBorders.d.ts +6 -0
  235. package/types/src/layer/_tableColor.d.ts +6 -0
  236. package/types/src/layer/_visibleCellFeatures.d.ts +11 -0
  237. package/types/src/layer/cellTip.d.ts +13 -0
  238. package/types/src/layer/freezeDragState.d.ts +21 -0
  239. package/types/src/layer/index.d.ts +17 -0
  240. package/types/src/layer/resizeIndicatorState.d.ts +3 -1
  241. package/types/src/layer/useFreezeDrag.d.ts +22 -0
  242. package/types/src/layer/useNormalBorderLines.d.ts +15 -0
  243. package/types/src/layer/useSheetFeatureRegions.d.ts +2 -2
  244. package/types/src/layer/useSheetVisibleCells.d.ts +5 -6
  245. package/types/src/layer/useSheetVisibleDecorations.d.ts +2 -2
  246. package/types/src/layer/useTableHeaderCells.d.ts +2 -2
  247. package/types/src/layer/useValidationPicker.d.ts +3 -3
  248. package/types/src/layer/useVisibleTables.d.ts +2 -2
  249. package/types/src/layer/validationMark.d.ts +3 -3
  250. package/types/src/listener/index.d.ts +5 -0
  251. package/types/src/listener/useCell.d.ts +29 -0
  252. package/types/src/listener/useCellRange.d.ts +23 -0
  253. package/types/src/listener/useCellValue.d.ts +26 -0
  254. package/types/src/listener/useModelListener.d.ts +8 -8
  255. package/types/src/listener/useRangeListener.d.ts +13 -7
  256. package/types/src/listener/useRangeSnapshot.d.ts +35 -0
  257. package/types/src/listener/useTable.d.ts +26 -0
  258. package/types/src/movable/ConnectionSites.d.ts +18 -0
  259. package/types/src/movable/DefaultMovable.d.ts +8 -0
  260. package/types/src/movable/IMovableArea.d.ts +56 -0
  261. package/types/src/movable/MovableAdornment.d.ts +26 -0
  262. package/types/src/movable/MovableCommandGroups.d.ts +22 -0
  263. package/types/src/movable/MovableCommands.d.ts +8 -3
  264. package/types/src/movable/MovableControl.d.ts +80 -0
  265. package/types/src/movable/MovableEdit.d.ts +22 -0
  266. package/types/src/movable/MovableFrame.d.ts +18 -14
  267. package/types/src/movable/MovableLayer.d.ts +30 -5
  268. package/types/src/movable/MovableRenderers.d.ts +210 -0
  269. package/types/src/movable/PlaceholderFrames.d.ts +11 -0
  270. package/types/src/movable/RotateHandle.d.ts +37 -0
  271. package/types/src/movable/TextBox.d.ts +34 -0
  272. package/types/src/movable/connect.d.ts +16 -0
  273. package/types/src/movable/framePlacement.d.ts +72 -0
  274. package/types/src/movable/geometry.d.ts +61 -0
  275. package/types/src/movable/index.d.ts +11 -0
  276. package/types/src/movable/pressTarget.d.ts +20 -0
  277. package/types/src/movable/useFramePreview.d.ts +17 -0
  278. package/types/src/picker/cellPickerOpen.d.ts +3 -3
  279. package/types/src/picker/useCellPicker.d.ts +7 -5
  280. package/types/src/picture/PictureCommands.d.ts +20 -0
  281. package/types/src/picture/PictureKind.d.ts +7 -0
  282. package/types/src/picture/_pictureHyperlink.d.ts +13 -0
  283. package/types/src/picture/index.d.ts +0 -1
  284. package/types/src/picture/pictureCrop.d.ts +32 -0
  285. package/types/src/pivot/PivotAreas.d.ts +16 -0
  286. package/types/src/pivot/PivotChip.d.ts +33 -0
  287. package/types/src/pivot/PivotChipMenu.d.ts +74 -0
  288. package/types/src/pivot/PivotCommands.d.ts +24 -0
  289. package/types/src/pivot/PivotFieldList.d.ts +14 -0
  290. package/types/src/pivot/PivotFields.d.ts +47 -0
  291. package/types/src/pivot/PivotFieldsModel.d.ts +143 -0
  292. package/types/src/pivot/PivotTablePane.d.ts +47 -0
  293. package/types/src/pivot/_PivotFieldsContext.d.ts +41 -0
  294. package/types/src/pivot/_pivotNew.d.ts +12 -0
  295. package/types/src/pivot/_pivotRegion.d.ts +14 -0
  296. package/types/src/pivot/index.d.ts +9 -0
  297. package/types/src/pivot/usePivotFields.d.ts +17 -0
  298. package/types/src/presence/PresenceCommands.d.ts +35 -0
  299. package/types/src/presence/PresenceHost.d.ts +58 -0
  300. package/types/src/presence/PresenceMessages.d.ts +42 -0
  301. package/types/src/presence/PresenceStore.d.ts +165 -0
  302. package/types/src/presence/PresenceTypes.d.ts +78 -0
  303. package/types/src/presence/index.d.ts +7 -0
  304. package/types/src/presence/usePresence.d.ts +20 -0
  305. package/types/src/richText/RichTextEditor.d.ts +41 -0
  306. package/types/src/richText/index.d.ts +2 -0
  307. package/types/src/selection/SelectionCommands.d.ts +2 -2
  308. package/types/src/selection/SheetSelectionLayer.d.ts +6 -12
  309. package/types/src/shape/ConnectorControl.d.ts +46 -0
  310. package/types/src/shape/ShapeCommands.d.ts +11 -0
  311. package/types/src/shape/ShapeControl.d.ts +8 -0
  312. package/types/src/shape/ShapeEditor.d.ts +15 -2
  313. package/types/src/shape/ShapeGallery.d.ts +31 -0
  314. package/types/src/shape/ShapeHandles.d.ts +28 -0
  315. package/types/src/shape/ShapeKind.d.ts +7 -0
  316. package/types/src/shape/ShapeSVG.d.ts +22 -0
  317. package/types/src/shape/ShapeText.d.ts +17 -0
  318. package/types/src/shape/icons/ShapeIcons.d.ts +16 -0
  319. package/types/src/shape/icons/_ShapeIconPack.d.ts +4 -0
  320. package/types/src/shape/index.d.ts +3 -1
  321. package/types/src/shape/shapeFrame.d.ts +50 -0
  322. package/types/src/shape/shapeStyle.d.ts +82 -0
  323. package/types/src/sheet/ISheetHeaderElement.d.ts +3 -3
  324. package/types/src/sheet/{ISheetElement.d.ts → IWorksheetElement.d.ts} +111 -81
  325. package/types/src/sheet/OpaqueSheetElement.d.ts +21 -0
  326. package/types/src/sheet/SheetCommandProvider.d.ts +14 -6
  327. package/types/src/sheet/SheetCommands.d.ts +20 -5
  328. package/types/src/sheet/SheetKindIcon.d.ts +14 -0
  329. package/types/src/sheet/SheetOutlineElement.d.ts +70 -0
  330. package/types/src/sheet/SheetPanels.d.ts +11 -0
  331. package/types/src/sheet/SheetScrollbar.d.ts +4 -13
  332. package/types/src/sheet/TopLeftCorner.d.ts +2 -2
  333. package/types/src/sheet/WorksheetElement.d.ts +12 -0
  334. package/types/src/sheet/_freezeAt.d.ts +10 -0
  335. package/types/src/sheet/_hyperlinkEdit.d.ts +7 -0
  336. package/types/src/sheet/_useHeaderMetrics.d.ts +11 -0
  337. package/types/src/sheet/circularReferences.d.ts +4 -4
  338. package/types/src/sheet/index.d.ts +5 -2
  339. package/types/src/sheet/useCycleHighlight.d.ts +2 -2
  340. package/types/src/slicer/SlicerCommands.d.ts +10 -0
  341. package/types/src/slicer/SlicerEditor.d.ts +8 -2
  342. package/types/src/slicer/SlicerKind.d.ts +7 -0
  343. package/types/src/slicer/SlicerStylePreview.d.ts +18 -0
  344. package/types/src/slicer/index.d.ts +2 -1
  345. package/types/src/slicer/slicerStyles.d.ts +32 -0
  346. package/types/src/sparkline/PictureCache.d.ts +37 -0
  347. package/types/src/sparkline/SparklineCommands.d.ts +23 -0
  348. package/types/src/sparkline/SparklinePictures.d.ts +7 -0
  349. package/types/src/sparkline/paint/_drawing.d.ts +24 -0
  350. package/types/src/sparkline/paint/echarts.d.ts +8 -0
  351. package/types/src/sparkline/paint/index.d.ts +8 -0
  352. package/types/src/tabStrip/SheetTab.d.ts +1 -1
  353. package/types/src/tabStrip/Sortable.d.ts +5 -5
  354. package/types/src/tabStrip/TabStrip.d.ts +13 -6
  355. package/types/src/tabStrip/TabStripItem.d.ts +15 -13
  356. package/types/src/table/TableCommands.d.ts +2 -2
  357. package/types/src/taskPane/CellControlPane.d.ts +15 -0
  358. package/types/src/taskPane/MovablePane.d.ts +15 -0
  359. package/types/src/taskPane/TaskPaneArea.d.ts +7 -0
  360. package/types/src/taskPane/TaskPaneFrame.d.ts +4 -4
  361. package/types/src/taskPane/TaskPaneKeys.d.ts +38 -0
  362. package/types/src/taskPane/TaskPaneRegistry.d.ts +32 -12
  363. package/types/src/taskPane/_paneReasons.d.ts +7 -0
  364. package/types/src/taskPane/index.d.ts +3 -0
  365. package/types/src/taskPane/useTaskPane.d.ts +6 -3
  366. package/types/src/theme/ThemeState.d.ts +15 -2
  367. package/types/src/theme/buildDocThemeCSS.d.ts +4 -1
  368. package/types/src/theme/buildOOXMLThemeCSS.d.ts +2 -2
  369. package/types/src/theme/useGridColorScheme.d.ts +3 -3
  370. package/types/src/theme/useSystemColors.d.ts +2 -2
  371. package/types/src/workbook/DefaultMovableRenderers.d.ts +20 -0
  372. package/types/src/workbook/DefaultRenderers.d.ts +5 -4
  373. package/types/src/workbook/IWorkbookElement.d.ts +108 -23
  374. package/types/src/workbook/WorkbookCommands.d.ts +8 -3
  375. package/types/src/workbook/WorkbookStrip.d.ts +14 -5
  376. package/browser/cjs/Bo9Kx3L_XQkGPBJ5.cjs +0 -1
  377. package/browser/cjs/Pl04-kDEQSO8_qFU.cjs +0 -156
  378. package/browser/cjs/index.cjs +0 -41
  379. package/browser/esm/Dsn3z1hmkv-bWGVr.mjs +0 -6286
  380. package/node/esm/CyU4sKDpHyc6kF7j.mjs +0 -9
  381. package/types/src/chart/templates/area-stacked-percent-template.json.d.ts +0 -10
  382. package/types/src/chart/templates/area-stacked-template.json.d.ts +0 -10
  383. package/types/src/chart/templates/area-template.json.d.ts +0 -9
  384. package/types/src/chart/templates/bar-stacked-percent-template.json.d.ts +0 -10
  385. package/types/src/chart/templates/bar-stacked-template.json.d.ts +0 -10
  386. package/types/src/chart/templates/bar-template.json.d.ts +0 -9
  387. package/types/src/chart/templates/column-stacked-percent-template.json.d.ts +0 -10
  388. package/types/src/chart/templates/column-stacked-template.json.d.ts +0 -10
  389. package/types/src/chart/templates/column-template.json.d.ts +0 -9
  390. package/types/src/chart/templates/line-markers-template.json.d.ts +0 -10
  391. package/types/src/chart/templates/line-stacked-markers-template.json.d.ts +0 -11
  392. package/types/src/chart/templates/line-stacked-percent-markers-template.json.d.ts +0 -11
  393. package/types/src/chart/templates/line-stacked-percent-template.json.d.ts +0 -10
  394. package/types/src/chart/templates/line-stacked-template.json.d.ts +0 -10
  395. package/types/src/chart/templates/line-template.json.d.ts +0 -9
  396. package/types/src/chart/templates/pie-doughnut-template.json.d.ts +0 -10
  397. package/types/src/chart/templates/pie-template.json.d.ts +0 -9
  398. package/types/src/chart/templates/scatter-lines-markers-smooth-template.json.d.ts +0 -10
  399. package/types/src/chart/templates/scatter-lines-markers-template.json.d.ts +0 -10
  400. package/types/src/chart/templates/scatter-lines-smooth-template.json.d.ts +0 -10
  401. package/types/src/chart/templates/scatter-lines-template.json.d.ts +0 -10
  402. package/types/src/chart/templates/scatter-markers-template.json.d.ts +0 -10
  403. package/types/src/context/SheetContext.d.ts +0 -18
  404. package/types/src/movable/MoveableBundle.d.ts +0 -4
  405. package/types/src/sheet/SheetElement.d.ts +0 -15
@@ -0,0 +1,15 @@
1
+ import { Command } from '@sheetxl/utils-react';
2
+ import { MovableKindCommandData } from '../movable';
3
+ /**
4
+ * The chart kind's commands, for the active chart. Chrome is the `chart` catalog.
5
+ *
6
+ * Excel's Chart Design tab, as far as the model goes: `chartChangeType` takes what the Insert Chart
7
+ * gallery states (a descriptor, or a type name) and draws every series as that type; `chartSwitchRowColumn`
8
+ * plots the other way; `chartSelectData` takes an address, or asks for one, and plots those cells;
9
+ * `chartAddElement` takes an element by VBA's name (`legendTop`), and the toggles are the Add Chart
10
+ * Element checkboxes, each with the element's state. Quick layouts, chart styles and colors wait on
11
+ * the style parts. Each setter is one step to undo on its own; the middleware
12
+ * reports an error and arms repeat.
13
+ */
14
+ export declare const contributeChartCommands: Command.DynamicCommandContributor<MovableKindCommandData>;
15
+ //# sourceMappingURL=ChartCommands.d.ts.map
@@ -1,17 +1,27 @@
1
1
  import { default as React } from 'react';
2
2
  import { IChart } from '@sheetxl/sdk';
3
3
  import { MovableElementProps } from '../movable';
4
+ import { IChartElement } from './ChartElement';
5
+ export { ChartElement, nextSelected, type ChartElementProps, type ChartElementAttributes, type ChartElementPress, type IChartElement } from './ChartElement';
4
6
  export interface ChartEditorAttributes {
5
7
  isChartEditor: () => true;
6
8
  }
7
- export interface IChartEditorElement extends HTMLDivElement, ChartEditorAttributes {
9
+ export interface IChartEditorElement extends IChartElement, ChartEditorAttributes {
8
10
  }
9
11
  export interface ChartEditorProps extends MovableElementProps {
10
12
  chart: IChart;
11
13
  ref?: React.Ref<IChartEditorElement>;
12
14
  }
13
15
  /**
14
- * Placeholder for chart editors.
16
+ * Paints a chart in its movable's frame: a {@link ChartElement} that takes the frame's zoom and
17
+ * shows the frame's states (disabled, dragging).
18
+ *
19
+ * @remarks
20
+ * The chart is drawn in the grid's color scheme, as the cells about it are.
21
+ *
22
+ * A press inside the chart selects what is under the pointer in the sheet view's chart element
23
+ * selection, Excel's way (the series first, its point next), and is the element's: the frame
24
+ * drags the chart from its chart area alone, as Excel does.
15
25
  */
16
26
  export declare const ChartEditor: React.NamedExoticComponent<Omit<ChartEditorProps, "ref"> & React.RefAttributes<IChartEditorElement>>;
17
27
  //# sourceMappingURL=ChartEditor.d.ts.map
@@ -0,0 +1,122 @@
1
+ import { default as React } from 'react';
2
+ import { IChart, IChartElementSelection } from '@sheetxl/sdk';
3
+ import { Point } from '@sheetxl/utils';
4
+ import { ThemeMode } from '@sheetxl/utils-react';
5
+ export interface ChartElementAttributes {
6
+ isChartElement: () => true;
7
+ /** The chart drawn; `null` until a `Promise` input resolves. */
8
+ getChart: () => IChart | null;
9
+ /**
10
+ * The chart as an SVG document of the element's unzoomed size; `null` while the chart has no
11
+ * layout or the element no size. It is drawn light, a chart area with no fill of its own white,
12
+ * unless `darkMode`.
13
+ */
14
+ toSVG: (options?: {
15
+ darkMode?: boolean;
16
+ }) => Promise<string | null>;
17
+ /**
18
+ * The chart element drawn under a point of the page (`clientX`, `clientY`), as the chart is
19
+ * painted now; `null` outside the chart, or before it is painted.
20
+ */
21
+ getElementAt: (clientX: number, clientY: number) => IChart.IElement | null;
22
+ }
23
+ export interface IChartElement extends HTMLDivElement, ChartElementAttributes {
24
+ }
25
+ /** A press on the chart, as {@link ChartElementProps.onElementPress} reports it. */
26
+ export interface ChartElementPress {
27
+ /** The element under the pointer; `null` outside the chart. The chart area is the chart itself. */
28
+ element: IChart.IElement | null;
29
+ /** Where, in px from the chart's top-left, unzoomed. */
30
+ point: Point;
31
+ event: React.PointerEvent<HTMLDivElement>;
32
+ }
33
+ export interface ChartElementProps extends React.HTMLAttributes<HTMLDivElement> {
34
+ /**
35
+ * The chart to draw: one in a workbook, or one made outside it with `createChart`, or a
36
+ * `Promise` for either. A promise draws nothing until it resolves and shows the error if it
37
+ * rejects; while a later promise resolves, the chart already drawn is kept.
38
+ *
39
+ * This can be accessed (once resolved) via the element ref.
40
+ */
41
+ chart: IChart | Promise<IChart>;
42
+ /**
43
+ * Called with the chart once {@link ChartElementProps.chart} resolves, and again whenever a new
44
+ * input resolves to a different one. Until the first input resolves, or if an input fails, the
45
+ * chart is `null`.
46
+ *
47
+ * @remarks
48
+ * Lets an app pass a `Promise` here and hold the live chart in its own state, without awaiting
49
+ * or suspending.
50
+ *
51
+ * @example
52
+ * ```tsx
53
+ * const [pending] = useState(() => sheet.getCharts().add('A1:D5', { type: 'line' }));
54
+ * const [chart, setChart] = useState<IChart | null>(null);
55
+ * return <ChartElement chart={pending} onChartChange={setChart} />;
56
+ * ```
57
+ */
58
+ onChartChange?: (chart: IChart | null) => void;
59
+ /**
60
+ * The scale the chart is drawn at, where `1` is unscaled: the element's box is measured at the
61
+ * scale and the chart laid out at the unscaled size.
62
+ * @defaultValue 1
63
+ */
64
+ zoom?: number;
65
+ /**
66
+ * The element's width, as `style.width`; by default the element fills its parent. A number is
67
+ * taken as the box's width without waiting to measure it.
68
+ */
69
+ width?: number | string;
70
+ /** The element's height, as `style.height`; a number as the box's height. */
71
+ height?: number | string;
72
+ /**
73
+ * The selection a press inside the chart changes, and whose selected elements are outlined: the
74
+ * sheet view's (`getChartElementSelection`) for a chart on a sheet, or one made for the chart
75
+ * (`new ChartElementSelection({ chart })`). Without one, a press selects nothing.
76
+ *
77
+ * @remarks
78
+ * As in Excel, the first press on a series selects the series and the next one its point; on
79
+ * the legend, the legend and then its entry; on a series' labels, all of them and then the one.
80
+ * A press on the chart area empties the selection: the chart is then what is selected.
81
+ */
82
+ selection?: IChartElementSelection | null;
83
+ /**
84
+ * Whether the chart is drawn light or dark. Dark, its colors are drawn as a dark grid draws its
85
+ * cells. A chart area with no fill of its own is the surface's background
86
+ * (`--sxl-color-base-100`) in either mode.
87
+ * @defaultValue the app's scheme (`useAppColorScheme`); a chart on a sheet is drawn in the grid's
88
+ */
89
+ colorScheme?: ThemeMode;
90
+ /**
91
+ * Called on a press inside the chart with what is under the pointer, before the selection (if
92
+ * any) changes.
93
+ */
94
+ onElementPress?: (press: ChartElementPress) => void;
95
+ ref?: React.Ref<IChartElement>;
96
+ }
97
+ /**
98
+ * The element a press selects, given what is under the pointer and what is selected: Excel's two
99
+ * steps, the whole first and the part of it on the next press.
100
+ */
101
+ export declare const nextSelected: (hit: IChart.IElement, active: IChart.IElement | null) => IChart.IElement;
102
+ /**
103
+ * Draws a chart, anywhere: a `div` the chart fills.
104
+ *
105
+ * @remarks
106
+ * The chart is laid out at the box's unzoomed px (`IChart.getLayout`) and painted as laid out,
107
+ * so the same chart in two elements is drawn twice, each at its own size. It is laid out again
108
+ * when the box is resized and whenever the chart says its layout may have changed
109
+ * (`onLayoutChange`: an edit, a cell it plots, a font arriving). The painter is loaded on the
110
+ * first mount through `ChartPaint`; a chart with no model (a `cx:` chart) draws nothing.
111
+ *
112
+ * Nothing of a sheet or a movable is needed: `ChartEditor` is this element inside a movable's
113
+ * frame, and a chart made with `createChart` draws from its own JSON. The chart may be given as a
114
+ * `Promise` (the one `getCharts().add` answers, say); `onChartChange` hands the app the chart
115
+ * once it is there.
116
+ *
117
+ * A press inside the chart is hit-tested against the layout painted (`IChart.getElementAt`), and
118
+ * with a {@link ChartElementProps.selection} selects what is pressed, Excel's way; the selected
119
+ * elements are outlined over the chart.
120
+ */
121
+ export declare const ChartElement: React.NamedExoticComponent<Omit<ChartElementProps, "ref"> & React.RefAttributes<IChartElement>>;
122
+ //# sourceMappingURL=ChartElement.d.ts.map
@@ -0,0 +1,7 @@
1
+ import { MovableRendererModule } from '../movable/MovableRenderers';
2
+ /**
3
+ * The chart kind, as the renderer registry loads it: one module, so a failed fetch can be
4
+ * imported again whole.
5
+ */
6
+ export declare const ChartKind: MovableRendererModule;
7
+ //# sourceMappingURL=ChartKind.d.ts.map
@@ -1,4 +1,5 @@
1
1
  import { default as React } from 'react';
2
+ import { IChart } from '@sheetxl/sdk';
2
3
  export declare const PresetChartType: {
3
4
  readonly Column: "column";
4
5
  readonly ColumnStacked: "columnStacked";
@@ -29,7 +30,8 @@ export type PresetChartType = typeof PresetChartType[keyof typeof PresetChartTyp
29
30
  export interface ChartTypeDescriptor {
30
31
  Icon: React.FC<React.SVGProps<SVGSVGElement>>;
31
32
  description: string;
32
- template: any;
33
+ /** The chart type the gallery entry inserts. */
34
+ type: IChart.Type;
33
35
  }
34
36
  export declare const presetChartTypeDescriptor: (presetType: PresetChartType) => ChartTypeDescriptor;
35
37
  //# sourceMappingURL=PresetChartTypeDescriptors.d.ts.map
@@ -1,3 +1,4 @@
1
- export * from './ChartEditor';
2
1
  export * from './PresetChartTypeDescriptors';
2
+ export { ChartPaintKinds, type ChartPaintKind } from './paint/kinds/ChartPaintKind';
3
+ export { ChartElement, nextSelected, type ChartElementProps, type ChartElementAttributes, type ChartElementPress, type IChartElement } from './ChartElement';
3
4
  //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1,24 @@
1
+ import { IFill, IStroke, IText } from '@sheetxl/sdk';
2
+ /** A pattern preset's tile, row by row; `null` for a name that is not one of Excel's. */
3
+ export declare const patternTile: (preset: string | undefined) => boolean[][] | null;
4
+ /**
5
+ * What ECharts colors a shape with for `fill`: a CSS color, a gradient, or a repeated tile.
6
+ *
7
+ * @param none What draws no fill: `'transparent'` for a series, `'none'` for a `graphic` element.
8
+ */
9
+ export declare const paintOf: (fill: IFill.JSON | null | undefined, none?: string) => any;
10
+ /** One color for `fill`, where ECharts takes no more (a tooltip's swatch): a gradient's first stop, a pattern's foreground. */
11
+ export declare const colorOf: (fill: IFill.JSON | null | undefined) => string | null;
12
+ /** A line's width in px. */
13
+ export declare const widthOf: (stroke: IStroke.JSON | null | undefined) => number;
14
+ /** A line's dash in px; `undefined` for a solid line. */
15
+ export declare const dashOf: (stroke: IStroke.JSON) => number[] | undefined;
16
+ /** A run's typeface. */
17
+ export declare const familyOf: (run: IText.RunPropertiesJSON) => string;
18
+ export declare const isBold: (run: IText.RunPropertiesJSON) => boolean;
19
+ export declare const isItalic: (run: IText.RunPropertiesJSON) => boolean;
20
+ /** A run's size in px. */
21
+ export declare const sizeOf: (run: IText.RunPropertiesJSON) => number;
22
+ /** What a run's text is filled with, as ECharts colors text. */
23
+ export declare const textPaintOf: (run: IText.RunPropertiesJSON) => any;
24
+ //# sourceMappingURL=_fills.d.ts.map
@@ -0,0 +1,38 @@
1
+ import { ChartLayout, IFill, IStroke, IText } from '@sheetxl/sdk';
2
+ type Font = IText.RunPropertiesJSON;
3
+ type MarkerLayout = ChartLayout.MarkerLayout;
4
+ type Stroke = IStroke.JSON;
5
+ /**
6
+ * What every painter of a layout shares: fonts, strokes and markers as ECharts states them, and
7
+ * the `graphic` elements for text boxes, lines and up/down bars. Echarts is never imported here:
8
+ * these are plain objects an option carries.
9
+ */
10
+ export declare const fontStyle: (font: Font) => Record<string, unknown>;
11
+ /** A run as a canvas font: `italic bold 13.33px Calibri`. */
12
+ export declare const fontOf: (font: Font, size?: number) => string;
13
+ /** A stroke as a `graphic` element's style states it. */
14
+ export declare const strokeStyle: (stroke: Stroke | null | undefined) => Record<string, unknown>;
15
+ /** A stroke as a series' `lineStyle` states it. */
16
+ export declare const lineStyle: (stroke: Stroke | null | undefined) => Record<string, unknown>;
17
+ /** Lines across a unit square: Excel's x, star and plus, drawn in the marker's outline color. */
18
+ export declare const MARKER_LINES: Readonly<Record<string, readonly [number, number, number, number][]>>;
19
+ export declare const markerSymbol: (marker: MarkerLayout) => {
20
+ symbol: string;
21
+ symbolSize: number | [number, number];
22
+ symbolOffset?: [number, number];
23
+ };
24
+ /** The square under a filled x, star or plus, as Excel draws it; `null` for any other marker. */
25
+ export declare const markerFill: (marker: MarkerLayout | null) => IFill.JSON | null;
26
+ /** A marker of the layout's centered on (`cx`, `cy`), as `graphic` elements (a legend key's). */
27
+ export declare const markerGraphic: (marker: MarkerLayout, cx: number, cy: number, z: number) => any[];
28
+ /**
29
+ * A text box of the layout (an axis title, a data label) as `graphic` elements: its box, where it
30
+ * has a fill or a line, and its text centered in it, turned about the box's center.
31
+ */
32
+ export declare const textGraphic: (text: ChartLayout.TextLayout, fill: IFill.JSON | null, border: Stroke | null, lineHeight?: number) => any[];
33
+ /** A group's lines (high-low, drop, series lines) as `graphic` lines over its series (z 3). */
34
+ export declare const linesGraphic: (lines: ChartLayout.LinesLayout | undefined) => any[];
35
+ /** A group's up/down bars as `graphic` rects over its series (z 3), as Excel draws them. */
36
+ export declare const upDownBarsGraphic: (upDown: ChartLayout.UpDownBarsLayout | undefined) => any[];
37
+ export {};
38
+ //# sourceMappingURL=_graphics.d.ts.map
@@ -0,0 +1,6 @@
1
+ import { ChartLayout } from '@sheetxl/sdk';
2
+ /** A concrete CSS color as a dark grid draws it; one that cannot be read as it is. */
3
+ export declare const darkColor: (css: string) => string;
4
+ /** The layout with each of its colors as a dark grid draws it; the layout itself when light. */
5
+ export declare const layoutInMode: (layout: ChartLayout, darkMode: boolean) => ChartLayout;
6
+ //# sourceMappingURL=_mode.d.ts.map
@@ -0,0 +1,33 @@
1
+ import { ChartLayout } from '@sheetxl/sdk';
2
+ import { TranslateOptions } from './toEChartsOption';
3
+ import * as echarts from 'echarts/core';
4
+ /** Registers the renderer and the components, once. The series types come with the kinds. */
5
+ export declare function ensureRegistered(): void;
6
+ export type EChartsInstance = echarts.ECharts;
7
+ /**
8
+ * An ECharts instance with no DOM, sized at the layout, with the layout set. The caller
9
+ * disposes it. For tests that read ECharts' geometry; `renderChartToSVG` is the product.
10
+ */
11
+ export declare function createHeadlessChart(layout: ChartLayout, options?: TranslateOptions): EChartsInstance;
12
+ /**
13
+ * Paints the layout headless, as an SVG document string of the layout's size.
14
+ */
15
+ export declare function renderChartToSVG(layout: ChartLayout, options?: TranslateOptions): string;
16
+ /**
17
+ * A chart painted into an element. What is drawn is the layout's alone: a host that wants to know
18
+ * what is under the pointer asks the chart (`IChart.getElementAt`) with the layout it painted.
19
+ */
20
+ export interface MountedChart {
21
+ /**
22
+ * Paints a new layout; a new size resizes the instance first.
23
+ * @param options How it is translated now; by default as it was mounted.
24
+ */
25
+ update(layout: ChartLayout, options?: TranslateOptions): void;
26
+ dispose(): void;
27
+ }
28
+ /**
29
+ * Paints the layout into `host`, sized at the layout's px. The host is not measured: the frame
30
+ * scales it.
31
+ */
32
+ export declare function mountChart(host: HTMLElement, layout: ChartLayout, options?: TranslateOptions): MountedChart;
33
+ //# sourceMappingURL=echarts.d.ts.map
@@ -0,0 +1,12 @@
1
+ export { toEChartsOption, type TranslateOptions } from './toEChartsOption';
2
+ export { ChartPaintKinds, type ChartPaintKind } from './kinds/ChartPaintKind';
3
+ export type { MountedChart, EChartsInstance } from './echarts';
4
+ /** What the painter module exports. */
5
+ export type ChartPaintModule = typeof import('./echarts');
6
+ /**
7
+ * The painter. It carries ECharts, so nothing imports it statically: it loads the first time a
8
+ * chart is painted or rendered to SVG, or earlier when `LazyModules.prefetch` warms the lazy
9
+ * modules.
10
+ */
11
+ export declare const ChartPaint: import('@sheetxl/utils').LazyModule<typeof import("./echarts")>;
12
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1,140 @@
1
+ import { ChartLayout, IFill, IStroke } from '@sheetxl/sdk';
2
+ import { Bounds } from '@sheetxl/utils';
3
+ /**
4
+ * How a kind of chart group is painted: the ECharts series and `graphic` elements for a group of
5
+ * the kind's layout, and the key its series show in the legend. The built-in kinds register
6
+ * through {@link ChartPaintKinds} the way a host's kind does; a custom group
7
+ * (`ChartLayout.CustomGroupLayout`) is painted by the kind registered under `custom:<its kind>`.
8
+ *
9
+ * @remarks
10
+ * The painter translates the layout and decides nothing: a kind reads where the
11
+ * layout put things, in px, and says how ECharts draws them. It is given the shared vocabulary as
12
+ * a {@link ChartPaintKind.Context}: fills and strokes as ECharts states them, markers, text boxes,
13
+ * and for a group on axes the grid indexes and how a series' data is placed on them.
14
+ *
15
+ * @beta
16
+ */
17
+ export interface ChartPaintKind {
18
+ /** The layout group types the kind paints: `'bar'`, `'line'`..., or `custom:<kind>` for a custom group. */
19
+ readonly types: readonly string[];
20
+ /**
21
+ * The ECharts pieces the kind's series need (`echarts/charts`, `echarts/components`), registered
22
+ * with `echarts.use` before a chart with a group of the kind is first painted. A kind drawn as
23
+ * `graphic` elements alone needs none.
24
+ */
25
+ modules?(): readonly unknown[];
26
+ /**
27
+ * Whether the kind's series sit on the grid's axes.
28
+ * @defaultValue the group names two axes
29
+ */
30
+ readonly grid?: boolean;
31
+ /** Whether the group's categories run up a vertical axis (horizontal bars), which the grid is told. */
32
+ horizontal?(group: ChartLayout.GroupLayout): boolean;
33
+ /** The ECharts series for a group. */
34
+ series?(group: ChartLayout.GroupLayout, context: ChartPaintKind.Context): any[];
35
+ /** The `graphic` elements for a group, drawn with its series: a radar's spokes, an of-pie's bar. */
36
+ graphic?(group: ChartLayout.GroupLayout, context: ChartPaintKind.Context): any[];
37
+ /**
38
+ * The key a legend entry for one of the group's series shows, as `graphic` elements in `key`:
39
+ * a line's line and marker, a slice's colors. `undefined` for the default, a swatch of the
40
+ * series' fill and line.
41
+ */
42
+ legendKey?(entry: ChartLayout.LegendEntryLayout, series: ChartLayout.SeriesLayout, group: ChartLayout.GroupLayout, key: Bounds, context: ChartPaintKind.Context): any[] | undefined;
43
+ }
44
+ export declare namespace ChartPaintKind {
45
+ /** A group on the grid's axes: where its series go and how their data is placed. */
46
+ interface Cartesian {
47
+ xAxisIndex: number;
48
+ yAxisIndex: number;
49
+ /** Whether the value axis is logarithmic: nothing is drawn at zero or below. */
50
+ isLog: boolean;
51
+ /**
52
+ * A series' data as ECharts places it: by category index, or on a date axis as `[slot, value]`
53
+ * pairs; a log axis's zero and negative values dropped.
54
+ */
55
+ placed(series: ChartLayout.SeriesLayout, data: any[]): any[];
56
+ /** What every ECharts series of the group states: its id and name, axes, data and no emphasis. */
57
+ base(series: ChartLayout.SeriesLayout): Record<string, any>;
58
+ }
59
+ /** What a kind is given to paint a group. */
60
+ interface Context {
61
+ /** The layout to paint, its colors already in the mode painted. */
62
+ readonly layout: ChartLayout;
63
+ /** Whether the chart is drawn as a dark grid draws its cells. */
64
+ readonly darkMode: boolean;
65
+ /**
66
+ * A concrete CSS color of the kind's own (not the layout's, which are in the mode already) as
67
+ * the chart is drawn: as a dark grid draws it when {@link darkMode}.
68
+ */
69
+ color(css: string): string;
70
+ axisOf(id: number): ChartLayout.AxisLayout | undefined;
71
+ /** The grid a group's axes are on. */
72
+ cartesian(group: {
73
+ axisIds: number[];
74
+ }): Cartesian;
75
+ /** A fill as ECharts paints it; `none` for no fill. */
76
+ paint(fill: IFill.JSON | null | undefined, none?: string): any;
77
+ /** A stroke as a `graphic` element's style states it. */
78
+ stroke(stroke: IStroke.JSON | null | undefined): Record<string, unknown>;
79
+ /** A stroke as a series' `lineStyle` states it. */
80
+ line(stroke: IStroke.JSON | null | undefined): Record<string, unknown>;
81
+ /** A stroke's width in px, 0 for none. */
82
+ width(stroke: IStroke.JSON | null | undefined): number;
83
+ /** A series drawn as a line with its markers, straight or smooth, broken or not at a blank. */
84
+ lineSeries(series: ChartLayout.SeriesLayout, smooth: boolean, spanBlanks?: boolean): Record<string, any>;
85
+ /** `drawn` with, beneath it, the squares under the series' filled x, star or plus markers. */
86
+ withMarkerFills(series: ChartLayout.SeriesLayout, drawn: any): any[];
87
+ readonly marker: {
88
+ /** How ECharts draws a marker: its symbol, box and offset. */
89
+ symbol(marker: ChartLayout.MarkerLayout): {
90
+ symbol: string;
91
+ symbolSize: number | [number, number];
92
+ symbolOffset?: [number, number];
93
+ };
94
+ /** The square under a filled x, star or plus; `null` for any other marker. */
95
+ fill(marker: ChartLayout.MarkerLayout | null): IFill.JSON | null;
96
+ /** A marker centered on a point, as `graphic` elements. */
97
+ graphic(marker: ChartLayout.MarkerLayout, cx: number, cy: number, z: number): any[];
98
+ };
99
+ /** A text box of the layout as `graphic` elements. */
100
+ text(text: ChartLayout.TextLayout, fill: IFill.JSON | null, border: IStroke.JSON | null, lineHeight?: number): any[];
101
+ /** A group's lines (high-low, drop, series lines) as `graphic` lines. */
102
+ lines(lines: ChartLayout.LinesLayout | undefined): any[];
103
+ /** A group's up/down bars as `graphic` rects. */
104
+ upDownBars(bars: ChartLayout.UpDownBarsLayout | undefined): any[];
105
+ }
106
+ }
107
+ /**
108
+ * The painters of chart groups, by layout group type: the built-ins, and any a host registers.
109
+ *
110
+ * @remarks
111
+ * The built-ins register when a layout is first translated, so before that {@link get} answers
112
+ * `undefined` for `'bar'`; a host's kind registered under a built-in type keeps its place when they
113
+ * do. A registration is a call, never a side effect of an import.
114
+ *
115
+ * @beta
116
+ */
117
+ export declare namespace ChartPaintKinds {
118
+ /**
119
+ * Registers a kind under each of its types, replacing any earlier registration of them.
120
+ *
121
+ * @returns A function that removes the registration.
122
+ */
123
+ function register(kind: ChartPaintKind): () => void;
124
+ /** The kind registered under a layout group type, or `undefined`. */
125
+ function get(type: string): ChartPaintKind | undefined;
126
+ function has(type: string): boolean;
127
+ /** The registered types. */
128
+ function getTypes(): string[];
129
+ /** The type a layout group is registered under: its type, or `custom:<kind>` for a custom group. */
130
+ function typeOf(group: ChartLayout.GroupLayout): string;
131
+ /** The kind that paints `group`, or `undefined` when none is registered for it. */
132
+ function of(group: ChartLayout.GroupLayout): ChartPaintKind | undefined;
133
+ /**
134
+ * Registers the painter's own kinds, once, under the types no host has taken. The translation
135
+ * calls it before its first use.
136
+ * @hidden
137
+ */
138
+ function registerBuiltIns(builtInKinds: (register: (kind: ChartPaintKind) => () => void) => void): void;
139
+ }
140
+ //# sourceMappingURL=ChartPaintKind.d.ts.map
@@ -0,0 +1,3 @@
1
+ import { ChartPaintKind } from './ChartPaintKind';
2
+ export declare const AreaPaint: ChartPaintKind;
3
+ //# sourceMappingURL=_Area.d.ts.map
@@ -0,0 +1,3 @@
1
+ import { ChartPaintKind } from './ChartPaintKind';
2
+ export declare const BarPaint: ChartPaintKind;
3
+ //# sourceMappingURL=_Bar.d.ts.map
@@ -0,0 +1,3 @@
1
+ import { ChartPaintKind } from './ChartPaintKind';
2
+ export declare const BoxWhiskerPaint: ChartPaintKind;
3
+ //# sourceMappingURL=_BoxWhisker.d.ts.map
@@ -0,0 +1,3 @@
1
+ import { ChartPaintKind } from './ChartPaintKind';
2
+ export declare const BubblePaint: ChartPaintKind;
3
+ //# sourceMappingURL=_Bubble.d.ts.map
@@ -0,0 +1,3 @@
1
+ import { ChartPaintKind } from './ChartPaintKind';
2
+ export declare const FunnelPaint: ChartPaintKind;
3
+ //# sourceMappingURL=_Funnel.d.ts.map
@@ -0,0 +1,3 @@
1
+ import { ChartPaintKind } from './ChartPaintKind';
2
+ export declare const HistogramPaint: ChartPaintKind;
3
+ //# sourceMappingURL=_Histogram.d.ts.map
@@ -0,0 +1,10 @@
1
+ import { ChartLayout } from '@sheetxl/sdk';
2
+ import { Bounds } from '@sheetxl/utils';
3
+ import { ChartPaintKind } from './ChartPaintKind';
4
+ /**
5
+ * A line key: the series' line across the key, with its marker on the middle when it has one
6
+ * (Excel's picture of a scatter's legend; a marker-only series shows the marker alone).
7
+ */
8
+ export declare const lineLegendKey: (series: ChartLayout.SeriesLayout, key: Bounds, context: ChartPaintKind.Context) => any[];
9
+ export declare const LinePaint: ChartPaintKind;
10
+ //# sourceMappingURL=_Line.d.ts.map
@@ -0,0 +1,3 @@
1
+ import { ChartPaintKind } from './ChartPaintKind';
2
+ export declare const OfPiePaint: ChartPaintKind;
3
+ //# sourceMappingURL=_OfPie.d.ts.map
@@ -0,0 +1,21 @@
1
+ import { ChartLayout } from '@sheetxl/sdk';
2
+ import { Bounds, Point } from '@sheetxl/utils';
3
+ import { ChartPaintKind } from './ChartPaintKind';
4
+ type SliceLayout = ChartLayout.SliceLayout;
5
+ /** A slice and the name its tooltip gives it. */
6
+ export interface NamedSlice {
7
+ slice: SliceLayout;
8
+ name: string;
9
+ }
10
+ /**
11
+ * Slices that go round a pie at `center` as ECharts pies, its ring from `inner` to `outer`. Each
12
+ * slice's value is its span in degrees, so ECharts' share of 360 puts every edge where the layout
13
+ * did. An exploded slice has a center of its own, which a pie series cannot give one slice, so it
14
+ * is drawn by a pie of its own at that center, the rest of that pie's ring left transparent.
15
+ */
16
+ export declare const piesOf: (id: string, name: string, center: Point, inner: number, outer: number, slices: NamedSlice[], context: ChartPaintKind.Context) => any[];
17
+ /** A swatch of a fill and a line in the key, as a legend entry for one point shows its colors. */
18
+ export declare const swatchKey: (fill: ChartLayout.SliceLayout["fill"] | undefined, stroke: ChartLayout.SliceLayout["stroke"] | null | undefined, key: Bounds, context: ChartPaintKind.Context) => any[];
19
+ export declare const PiePaint: ChartPaintKind;
20
+ export {};
21
+ //# sourceMappingURL=_Pie.d.ts.map
@@ -0,0 +1,7 @@
1
+ import { ChartPaintKind } from './ChartPaintKind';
2
+ /**
3
+ * A region map, painted as its layout's placeholder: the label in the plot saying the type is not
4
+ * drawn, and nothing else of the group. A host may register a painter of its own under the type.
5
+ */
6
+ export declare const PlaceholderPaint: ChartPaintKind;
7
+ //# sourceMappingURL=_Placeholder.d.ts.map
@@ -0,0 +1,3 @@
1
+ import { ChartPaintKind } from './ChartPaintKind';
2
+ export declare const RadarPaint: ChartPaintKind;
3
+ //# sourceMappingURL=_Radar.d.ts.map
@@ -0,0 +1,3 @@
1
+ import { ChartPaintKind } from './ChartPaintKind';
2
+ export declare const ScatterPaint: ChartPaintKind;
3
+ //# sourceMappingURL=_Scatter.d.ts.map
@@ -0,0 +1,3 @@
1
+ import { ChartPaintKind } from './ChartPaintKind';
2
+ export declare const SunburstPaint: ChartPaintKind;
3
+ //# sourceMappingURL=_Sunburst.d.ts.map
@@ -0,0 +1,3 @@
1
+ import { ChartPaintKind } from './ChartPaintKind';
2
+ export declare const SurfacePaint: ChartPaintKind;
3
+ //# sourceMappingURL=_Surface.d.ts.map
@@ -0,0 +1,3 @@
1
+ import { ChartPaintKind } from './ChartPaintKind';
2
+ export declare const TreemapPaint: ChartPaintKind;
3
+ //# sourceMappingURL=_Treemap.d.ts.map
@@ -0,0 +1,3 @@
1
+ import { ChartPaintKind } from './ChartPaintKind';
2
+ export declare const WaterfallPaint: ChartPaintKind;
3
+ //# sourceMappingURL=_Waterfall.d.ts.map
@@ -0,0 +1,3 @@
1
+ import { ChartPaintKind } from './ChartPaintKind';
2
+ export declare function registerBuiltInPaintKinds(register: (kind: ChartPaintKind) => () => void): void;
3
+ //# sourceMappingURL=_builtIns.d.ts.map
@@ -0,0 +1,42 @@
1
+ import { EChartsCoreOption } from 'echarts/core';
2
+ import { ChartLayout } from '@sheetxl/sdk';
3
+ /**
4
+ * How the layout is translated.
5
+ */
6
+ export interface TranslateOptions {
7
+ /**
8
+ * Whether the chart answers the pointer: tooltips. Off when rendering headless.
9
+ * @defaultValue true
10
+ */
11
+ interactive?: boolean;
12
+ /**
13
+ * How the legend is drawn: by ECharts' `legend` component placed at the layout's rect, which
14
+ * flows the entries itself, or as `graphic` elements at exactly the layout's entry rects.
15
+ * @defaultValue 'graphic'
16
+ */
17
+ legend?: 'native' | 'graphic';
18
+ /**
19
+ * Whether the chart is drawn as a dark grid draws its cells: each color through `IColor.toRGBA(true)`.
20
+ * @defaultValue false
21
+ */
22
+ darkMode?: boolean;
23
+ /**
24
+ * What a chart area that states no fill is filled with, light: the background of where it is
25
+ * drawn. `'transparent'` leaves it to what is behind the chart.
26
+ * @defaultValue '#FFFFFF'
27
+ */
28
+ background?: string;
29
+ }
30
+ /**
31
+ * Translates a {@link ChartLayout} to an ECharts option.
32
+ *
33
+ * @remarks
34
+ * A translation table and nothing else: the grid is the plot rect in px with
35
+ * `containLabel:false`; value axes get `min`, `max` and `interval` and a formatter that answers
36
+ * the layout's strings; bars get `barWidth` in px and `barGap` from the overlap; every DrawingML
37
+ * axis is an ECharts axis, a deleted one with `show:false`. Nothing is left for ECharts to decide.
38
+ */
39
+ export declare function toEChartsOption(layout: ChartLayout, options?: TranslateOptions): EChartsCoreOption;
40
+ /** A concrete color for ECharts: it parses colors, so a CSS variable would not do. */
41
+ export declare const isConcreteColor: (color: string) => boolean;
42
+ //# sourceMappingURL=toEChartsOption.d.ts.map