boardplot 0.52.5 → 0.54.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 (388) hide show
  1. package/CHANGELOG.md +58 -0
  2. package/README.md +13 -12
  3. package/dist/{ReaderBox-VUNSFKZY.js → ReaderBox-YXC5XK7D.js} +6 -5
  4. package/dist/{annotateEngine-H7OW4H3W.js → annotateEngine-5O3IRSQL.js} +3 -1
  5. package/dist/build-identity.json +3 -3
  6. package/dist/{chunk-ZSLGN6CO.js → chunk-23RWLBZF.js} +1 -1
  7. package/dist/{chunk-HAAUJDGB.js → chunk-24BHMKDD.js} +2 -2
  8. package/dist/{chunk-MDYLOIS2.js → chunk-26P4WRQC.js} +1 -1
  9. package/dist/{chunk-EWVKBRLV.js → chunk-2DR5MMDY.js} +2 -2
  10. package/dist/{chunk-3ZCKEANJ.js → chunk-2HXKW6U6.js} +3 -3
  11. package/dist/{chunk-GWQIXU37.js → chunk-2IXDYW6O.js} +30 -28
  12. package/dist/{chunk-OLNORNCT.js → chunk-2THWIKRB.js} +4 -4
  13. package/dist/{chunk-JRPI64AQ.js → chunk-32X7JGH3.js} +18 -15
  14. package/dist/{chunk-PUVGWJQ5.js → chunk-35ZTANEK.js} +4 -4
  15. package/dist/{chunk-FOKEGVPB.js → chunk-3CLLHMFF.js} +3 -3
  16. package/dist/{chunk-XYONCO5Q.js → chunk-3FNY7ZCG.js} +19 -16
  17. package/dist/{chunk-X7TXGKRX.js → chunk-3P4PJJND.js} +6 -6
  18. package/dist/{chunk-4DNOEV3Q.js → chunk-3RMTPAEJ.js} +79 -2
  19. package/dist/{chunk-NYEY6W5R.js → chunk-3UBTO342.js} +8 -8
  20. package/dist/{chunk-MCOIEWW6.js → chunk-3V7AA3IZ.js} +1 -1
  21. package/dist/{chunk-RJQ5YS3Q.js → chunk-43OQ26TL.js} +10 -6
  22. package/dist/{chunk-V422EKLW.js → chunk-46ZPFJAM.js} +3 -3
  23. package/dist/{chunk-W7UZXD5D.js → chunk-47BO6MYI.js} +18 -15
  24. package/dist/{chunk-5T5YW52S.js → chunk-4FFCIQDG.js} +1 -1
  25. package/dist/{chunk-KU4YS6HN.js → chunk-4MREJWRM.js} +1 -1
  26. package/dist/{chunk-IDTLHPTK.js → chunk-4TPHMIE5.js} +2 -2
  27. package/dist/{chunk-2MTWKMEG.js → chunk-4WK3CNW5.js} +13 -6
  28. package/dist/{chunk-ORUJI3VB.js → chunk-4WQ2MBE7.js} +1 -1
  29. package/dist/chunk-4ZGN4ZUN.js +164 -0
  30. package/dist/{chunk-YQ2B3YVF.js → chunk-53OYF4ZT.js} +1 -1
  31. package/dist/{chunk-JL5BRMDT.js → chunk-57ZGVAU3.js} +1 -1
  32. package/dist/{chunk-VYMGZ27S.js → chunk-5A6MO4AR.js} +3 -2
  33. package/dist/{chunk-WHSTEAVP.js → chunk-5PCCSSII.js} +1 -1
  34. package/dist/{chunk-Z256ACGC.js → chunk-5SJQOPL7.js} +2 -2
  35. package/dist/{chunk-RNOD2UWF.js → chunk-6BJQULXR.js} +12 -12
  36. package/dist/{chunk-2DHJJ2EN.js → chunk-6BWSF5PS.js} +3 -3
  37. package/dist/{chunk-CAE2HK2G.js → chunk-6I7YZTY7.js} +3 -11
  38. package/dist/{chunk-XW5J5JAX.js → chunk-6K2TMVPF.js} +2 -2
  39. package/dist/{chunk-IZ35GMGB.js → chunk-6NLH6TEP.js} +13 -10
  40. package/dist/{chunk-TTR7EWNH.js → chunk-6TJDWMZV.js} +4 -4
  41. package/dist/{chunk-KSYVTEKR.js → chunk-6ZXMA4TY.js} +3 -3
  42. package/dist/{chunk-OH7FA4TF.js → chunk-7EOLHBI6.js} +1 -1
  43. package/dist/{chunk-3W23F7EY.js → chunk-7EVIIADO.js} +1 -1
  44. package/dist/{chunk-EC2NAYPQ.js → chunk-7HFUG25L.js} +3 -3
  45. package/dist/{chunk-DLC23CKC.js → chunk-7JQAUJOL.js} +1 -1
  46. package/dist/{chunk-3I6RANBJ.js → chunk-7NWFKHSG.js} +36 -32
  47. package/dist/{chunk-RNXITK5M.js → chunk-7R5EV5MS.js} +3 -3
  48. package/dist/{chunk-ELYU6TRQ.js → chunk-7X3UZM7F.js} +1 -1
  49. package/dist/{chunk-UZF3G2FN.js → chunk-A5TY7H5T.js} +5 -5
  50. package/dist/{chunk-XEGRWWNO.js → chunk-AA4U62G6.js} +2 -2
  51. package/dist/{chunk-TXINIAFL.js → chunk-AG2CJ4JY.js} +10 -5
  52. package/dist/{chunk-R5SWC3EW.js → chunk-AHQ4L3BE.js} +1 -1
  53. package/dist/{chunk-35DZP2R2.js → chunk-AJHYXD5U.js} +2 -2
  54. package/dist/{chunk-TPYV2FTV.js → chunk-ATUZTGZI.js} +3 -3
  55. package/dist/{chunk-S53OGZL6.js → chunk-AVMKRVNP.js} +1 -1
  56. package/dist/{chunk-R3WI7ZLE.js → chunk-AZIRTSVP.js} +14 -11
  57. package/dist/{chunk-II7652VA.js → chunk-B3F4TS3V.js} +47 -20
  58. package/dist/{chunk-DCCJRLAJ.js → chunk-B6LHZLLK.js} +5 -0
  59. package/dist/{chunk-M6KTNAND.js → chunk-BRPOSOK5.js} +17 -11
  60. package/dist/{chunk-EQT3EPTB.js → chunk-BWTX7LUG.js} +1 -1
  61. package/dist/{chunk-BVWU6GOB.js → chunk-BXEM2CVW.js} +2 -2
  62. package/dist/{chunk-A7A4PDG5.js → chunk-BYD7VLAI.js} +3 -3
  63. package/dist/{chunk-JFG4DHKQ.js → chunk-C3O45JWU.js} +1 -1
  64. package/dist/{chunk-BKYMLFUG.js → chunk-C54QLNE4.js} +1 -1
  65. package/dist/{chunk-7JVAQX6C.js → chunk-CEY646NZ.js} +4 -4
  66. package/dist/{chunk-GZ4RHGIW.js → chunk-CICWSCLC.js} +19 -19
  67. package/dist/{chunk-QHFQHQDC.js → chunk-CPKHL7FK.js} +2 -2
  68. package/dist/{chunk-NXNQQ3DS.js → chunk-D3D7XHBI.js} +7 -14
  69. package/dist/{chunk-RSWVH7DB.js → chunk-D7GZPMHW.js} +3 -3
  70. package/dist/chunk-DAVHGK27.js +657 -0
  71. package/dist/{chunk-7VXZDB45.js → chunk-DDI2W4TR.js} +1 -1
  72. package/dist/{chunk-JLCAWQ3H.js → chunk-DHWCFQNO.js} +3 -3
  73. package/dist/{chunk-GQS46LC3.js → chunk-DSZUV3TM.js} +11 -3
  74. package/dist/{chunk-H57TJD3B.js → chunk-E42JZ2DA.js} +1 -1
  75. package/dist/{chunk-YTSSXSZR.js → chunk-E64MTTBC.js} +3 -3
  76. package/dist/{chunk-NT3HAZYT.js → chunk-EHDWWFNV.js} +1 -1
  77. package/dist/{chunk-FT3F72C3.js → chunk-EHVESNLV.js} +1 -1
  78. package/dist/{chunk-W2RGSGRR.js → chunk-ELPQZIGR.js} +13 -10
  79. package/dist/{chunk-7IFLQMJL.js → chunk-ENOCOA3F.js} +5 -4
  80. package/dist/{chunk-KPMGGE4W.js → chunk-EP54VZI5.js} +1 -1
  81. package/dist/{chunk-QG6MOQLI.js → chunk-EYLWVI26.js} +17 -14
  82. package/dist/{chunk-NEVSQGOI.js → chunk-EYZ6SLF3.js} +2 -2
  83. package/dist/{chunk-HFG76JTS.js → chunk-F35DA442.js} +3 -3
  84. package/dist/{chunk-A372DLQX.js → chunk-F7X53SZM.js} +3 -3
  85. package/dist/{chunk-PTVOXB5T.js → chunk-FHA3KMFC.js} +6 -2
  86. package/dist/{chunk-S4F27M7N.js → chunk-FILDYFT4.js} +2 -2
  87. package/dist/{chunk-WMJPFLF3.js → chunk-FMFCGYCE.js} +29 -25
  88. package/dist/{chunk-TPZB2YWR.js → chunk-FPPN5NAR.js} +2 -2
  89. package/dist/{chunk-5DJXJXDE.js → chunk-FV32N6AF.js} +1 -1
  90. package/dist/{chunk-MJMJEURO.js → chunk-G57ZO7DB.js} +10 -10
  91. package/dist/{chunk-WDUNR2VI.js → chunk-G63ROSY5.js} +22 -19
  92. package/dist/{chunk-V4VC25UL.js → chunk-G6XCUX3I.js} +4 -4
  93. package/dist/{chunk-JLZM7XMZ.js → chunk-GEBGBJBD.js} +14 -11
  94. package/dist/{chunk-FT47HQ5U.js → chunk-GGO43PHB.js} +4 -4
  95. package/dist/{chunk-XDLQRSSH.js → chunk-GSMWHKOW.js} +2 -2
  96. package/dist/{chunk-2JAWQ7VV.js → chunk-GVKFFJ23.js} +11 -10
  97. package/dist/{chunk-Q6XJOJTY.js → chunk-GYNZ72GO.js} +2 -2
  98. package/dist/{chunk-WRHFBCVY.js → chunk-H4SYN3QA.js} +3 -3
  99. package/dist/{chunk-MEISCROL.js → chunk-HC4NDND6.js} +3 -3
  100. package/dist/{chunk-I322G5UG.js → chunk-HDZGZJKR.js} +17 -14
  101. package/dist/{chunk-3GZECHOK.js → chunk-HGGLJYPZ.js} +12 -12
  102. package/dist/{chunk-B67K5X4M.js → chunk-HHS6333D.js} +1 -1
  103. package/dist/{chunk-6UBEGKIQ.js → chunk-HNVW3YDS.js} +3 -3
  104. package/dist/{chunk-GZ2VNM4L.js → chunk-HW7BPJNQ.js} +3 -3
  105. package/dist/{chunk-NG5IGZXC.js → chunk-HZG5NB7Q.js} +23 -20
  106. package/dist/{chunk-S7VDRUED.js → chunk-HZZH3MQI.js} +1 -1
  107. package/dist/{chunk-CS4DHFNG.js → chunk-I2E3YDNZ.js} +3 -3
  108. package/dist/{chunk-YAYRRKC7.js → chunk-I5L3QTKQ.js} +3 -3
  109. package/dist/{chunk-KYELSLDJ.js → chunk-IDT7DJ7F.js} +1 -1
  110. package/dist/{chunk-JETXFF3M.js → chunk-IK4BHOPZ.js} +1 -1
  111. package/dist/{chunk-GDQ3NGDZ.js → chunk-IM4WUIR7.js} +2 -2
  112. package/dist/chunk-IMJXJHFW.js +88 -0
  113. package/dist/{chunk-5C7TWNYZ.js → chunk-ISWU5YB3.js} +1 -1
  114. package/dist/{chunk-5KWXRYAT.js → chunk-J2ROMB7J.js} +17 -11
  115. package/dist/{chunk-WJMUMN3I.js → chunk-J33RA3YO.js} +2 -2
  116. package/dist/{chunk-627P6T25.js → chunk-JAKRPSWP.js} +21 -18
  117. package/dist/{chunk-PEN2DK7T.js → chunk-JB4YPOMT.js} +2 -2
  118. package/dist/{chunk-YP3I6W7T.js → chunk-JDEVGTSX.js} +3 -3
  119. package/dist/{chunk-JSX3C6LL.js → chunk-JEL6665C.js} +5 -5
  120. package/dist/{chunk-DFKTS6XJ.js → chunk-JEYJRJ7M.js} +1 -1
  121. package/dist/{chunk-JA755JHN.js → chunk-JJJ2KAHR.js} +10 -7
  122. package/dist/{chunk-SGSPYHFE.js → chunk-JTJNQKPM.js} +8 -5
  123. package/dist/{chunk-DGDOGOTQ.js → chunk-K2KU4HHT.js} +3 -3
  124. package/dist/{chunk-CRZKGHZ6.js → chunk-K4K6KGEF.js} +17 -19
  125. package/dist/{chunk-QVABTUDS.js → chunk-K4RCWNLC.js} +7 -7
  126. package/dist/{chunk-GULJ6KVT.js → chunk-KAQH75T6.js} +14 -14
  127. package/dist/{chunk-2UVTHU7A.js → chunk-KBFPMESI.js} +37 -27
  128. package/dist/{chunk-S5ADHIZK.js → chunk-KFWEO4UA.js} +28 -25
  129. package/dist/{chunk-MIXKQJ64.js → chunk-KJEZFOO6.js} +18 -18
  130. package/dist/{chunk-NLOMCLKI.js → chunk-KL2XJQAA.js} +8 -8
  131. package/dist/{chunk-2AKWCMS4.js → chunk-KNZD53L4.js} +3 -3
  132. package/dist/{chunk-DVKBU23L.js → chunk-KORHKDJW.js} +1 -1
  133. package/dist/{chunk-NMCOUVN5.js → chunk-KSQEG6DX.js} +3 -3
  134. package/dist/{chunk-TVHLKVUO.js → chunk-KVSJ2O4Q.js} +3 -3
  135. package/dist/{chunk-XTNV2YMB.js → chunk-L3JWM7FR.js} +1 -1
  136. package/dist/{chunk-IZCOG3FS.js → chunk-L7FSCT4M.js} +4 -4
  137. package/dist/{chunk-Z5VSLLNY.js → chunk-L7RHB734.js} +1 -1
  138. package/dist/{chunk-B2EBEXIS.js → chunk-LFX7W4B7.js} +1 -1
  139. package/dist/chunk-LINZPU5D.js +8 -0
  140. package/dist/{chunk-COKHNEJP.js → chunk-LMPZKCDM.js} +3 -3
  141. package/dist/{chunk-ZVTFZF4V.js → chunk-LTMF75MR.js} +8 -8
  142. package/dist/{chunk-A6XCAQ52.js → chunk-LVXOY5WL.js} +7 -6
  143. package/dist/{chunk-3HHNQPAH.js → chunk-LYVOL4TQ.js} +1 -1
  144. package/dist/{chunk-HJXXFPOL.js → chunk-MBVXROCI.js} +2 -2
  145. package/dist/{chunk-76ANFJOI.js → chunk-MCYM3RNF.js} +1 -1
  146. package/dist/{chunk-F77BNDAT.js → chunk-MEG4NMSI.js} +2 -2
  147. package/dist/{chunk-C64FBRJO.js → chunk-MKVV7GVJ.js} +5 -5
  148. package/dist/{chunk-XPWRD424.js → chunk-MONVTUHR.js} +3 -3
  149. package/dist/{chunk-YI2ZVTCB.js → chunk-MT4MP3UZ.js} +1 -1
  150. package/dist/{chunk-V4DYVLOO.js → chunk-MYCLO35J.js} +5 -5
  151. package/dist/{chunk-4SM2ONUC.js → chunk-MZJBPDIL.js} +1 -1
  152. package/dist/{chunk-CYDZP5W6.js → chunk-NGRIT3CY.js} +26 -23
  153. package/dist/{chunk-2SGIHKKU.js → chunk-NQSDIDRO.js} +1 -1
  154. package/dist/{chunk-WVSNSWBJ.js → chunk-NRF223FR.js} +1 -1
  155. package/dist/{chunk-QXILAMAU.js → chunk-NRHTC2SQ.js} +1 -1
  156. package/dist/{chunk-H7UZZ7KP.js → chunk-NWQTSZYC.js} +3 -3
  157. package/dist/{chunk-OAPCJO6W.js → chunk-O3VN6BTL.js} +1 -0
  158. package/dist/{chunk-LO2DANS6.js → chunk-OD3IH6FG.js} +5 -5
  159. package/dist/{chunk-S62M63LU.js → chunk-OM67S6S4.js} +3 -3
  160. package/dist/{chunk-UEU46Q3D.js → chunk-OMNQXHFF.js} +7 -7
  161. package/dist/{chunk-HZQEQ34U.js → chunk-OMVYFSOM.js} +3 -3
  162. package/dist/{chunk-COYPDRJK.js → chunk-OTW5SEFS.js} +2 -2
  163. package/dist/{chunk-GH3ZMBFX.js → chunk-OU5K2JPF.js} +11 -11
  164. package/dist/{chunk-AZOUSKZD.js → chunk-OURX73UJ.js} +1 -1
  165. package/dist/{chunk-27QQEWNV.js → chunk-OZUTYDV4.js} +2 -2
  166. package/dist/{chunk-TSR5YDPS.js → chunk-P52JHUUM.js} +23 -20
  167. package/dist/{chunk-YFG4E3N2.js → chunk-PBYUJSEY.js} +14 -14
  168. package/dist/{chunk-A3ULWR5N.js → chunk-PDG4IM3L.js} +1 -1
  169. package/dist/{chunk-AFK47A6O.js → chunk-PGV25HTX.js} +3 -3
  170. package/dist/{chunk-A5JWFZVU.js → chunk-PJWLKCFX.js} +80 -81
  171. package/dist/{chunk-MNJ2DHU6.js → chunk-QJ4WGAC6.js} +8 -8
  172. package/dist/{chunk-VB2MJLET.js → chunk-QQNPU27R.js} +1 -1
  173. package/dist/{chunk-6JUJ2DU3.js → chunk-QR35TD2B.js} +37 -37
  174. package/dist/{chunk-LC3PSQJJ.js → chunk-QY5ZKUWY.js} +1 -1
  175. package/dist/{chunk-ASAON7G4.js → chunk-RGZGLKFB.js} +4 -4
  176. package/dist/{chunk-S4ONWRJE.js → chunk-RK4S3VPS.js} +2 -2
  177. package/dist/{chunk-TXZBBZOG.js → chunk-RKITD2UJ.js} +2 -2
  178. package/dist/{chunk-ETHWK2RZ.js → chunk-RNOJSEES.js} +1 -1
  179. package/dist/{chunk-PGIQMQRU.js → chunk-RZB4RPPD.js} +228 -95
  180. package/dist/{chunk-XO5ONLVM.js → chunk-S32YYDIB.js} +1 -1
  181. package/dist/{chunk-QN6JHMGU.js → chunk-S4QSJAGY.js} +1 -1
  182. package/dist/{chunk-IXSZ7OKR.js → chunk-S6CRZKPO.js} +1 -1
  183. package/dist/{chunk-YHTO46W2.js → chunk-SFQ5ADIG.js} +35 -31
  184. package/dist/{chunk-Y4PXIJMD.js → chunk-SHH2AHIU.js} +14 -14
  185. package/dist/{chunk-HUF6TQ2J.js → chunk-SZCPKGYG.js} +3 -3
  186. package/dist/{chunk-K2HNV4LE.js → chunk-T3PNYRDM.js} +12 -12
  187. package/dist/{chunk-QNHZXFRA.js → chunk-T7ZCYYQZ.js} +3 -3
  188. package/dist/{chunk-JY4R3GML.js → chunk-TKQKXBGC.js} +1 -1
  189. package/dist/{chunk-XDS4UZGR.js → chunk-TNHD4UTC.js} +3 -3
  190. package/dist/{chunk-FGAGGPFF.js → chunk-TNNK4IIY.js} +8 -8
  191. package/dist/{chunk-LC6DYCTG.js → chunk-TSPWXAAI.js} +1 -1
  192. package/dist/{chunk-HX3MQ3H4.js → chunk-U2ES66IN.js} +3 -3
  193. package/dist/{chunk-MFLH5ZDQ.js → chunk-U2HQELXL.js} +2 -2
  194. package/dist/{chunk-SXGTRZFN.js → chunk-U4P6TQRW.js} +3 -2
  195. package/dist/{chunk-KFFNCDX6.js → chunk-U6CJPTOB.js} +3 -3
  196. package/dist/{chunk-GQPESFAF.js → chunk-U7LLQ7XM.js} +11 -11
  197. package/dist/{chunk-IN4QT33I.js → chunk-ULTSSIOU.js} +1 -1
  198. package/dist/{chunk-HUFCSX2Y.js → chunk-UTQGZF37.js} +17 -6
  199. package/dist/{chunk-CCQNL33L.js → chunk-UYNAL3Y3.js} +9 -9
  200. package/dist/{chunk-7QDAHY5M.js → chunk-V7RAPZHX.js} +2 -2
  201. package/dist/{chunk-6XE3GVGU.js → chunk-VAEC53B3.js} +3 -2
  202. package/dist/{chunk-YKO3VCTF.js → chunk-VDVXGAIP.js} +3 -3
  203. package/dist/{chunk-WYJMV62X.js → chunk-VGWWUCAB.js} +3 -3
  204. package/dist/{chunk-5ENRZX6I.js → chunk-VNLSTZES.js} +19 -16
  205. package/dist/{chunk-D4BIV6WG.js → chunk-VWYUUBBP.js} +19 -16
  206. package/dist/{chunk-JMH5MD5A.js → chunk-WDONXBQE.js} +1 -1
  207. package/dist/{chunk-62FR4FYJ.js → chunk-WEPAE4KG.js} +2 -2
  208. package/dist/{chunk-A5LZUYK4.js → chunk-WGIO6AHP.js} +3 -2
  209. package/dist/{chunk-UQSVWO7Z.js → chunk-WJKVNRCR.js} +8 -7
  210. package/dist/{chunk-24WB3HMB.js → chunk-WKWMOZNE.js} +22 -7
  211. package/dist/{chunk-V667FCIJ.js → chunk-WMZCOGD6.js} +1 -1
  212. package/dist/{chunk-33CBPK5Q.js → chunk-WQ55QPEB.js} +51 -45
  213. package/dist/{chunk-SLTMRTXV.js → chunk-WUKSZNHL.js} +15 -12
  214. package/dist/{chunk-QETGGFH2.js → chunk-WZBMTZBM.js} +3 -3
  215. package/dist/{chunk-XY5O74BH.js → chunk-X4U6PT3Z.js} +3 -3
  216. package/dist/{chunk-E2HEVF23.js → chunk-XNA6DATU.js} +10 -10
  217. package/dist/{chunk-ALKTNXMR.js → chunk-XTGWCYAR.js} +37 -37
  218. package/dist/{chunk-3XQ635KD.js → chunk-XXNLNZ7E.js} +3 -3
  219. package/dist/{chunk-YEDYBMCW.js → chunk-YF2PYLC4.js} +1 -1
  220. package/dist/{chunk-ZJKOLOVF.js → chunk-YS56RSTZ.js} +26 -20
  221. package/dist/{chunk-RTJXOIIQ.js → chunk-YWP7XFKD.js} +1 -1
  222. package/dist/{chunk-ATTE3FYC.js → chunk-ZBJNEJSL.js} +3 -3
  223. package/dist/{chunk-A2FHZH7E.js → chunk-ZNHF2XCP.js} +35 -21
  224. package/dist/{chunk-ERAIVAK5.js → chunk-ZTH6YSVA.js} +37 -4
  225. package/dist/{chunk-KS7DXCXH.js → chunk-ZWJTHFWB.js} +3 -3
  226. package/dist/{chunk-EKQMYG2B.js → chunk-ZXOD37BE.js} +18 -18
  227. package/dist/cli/index.js +2 -2
  228. package/dist/{core-5Z6UW5DS.js → core-34KIMTK6.js} +2 -1
  229. package/dist/{core-XXIOJY2X.js → core-3CWPIFAL.js} +3 -1
  230. package/dist/{core-WLVU2HWX.js → core-7R3ARYNI.js} +3 -1
  231. package/dist/{core-DU77ZYPR.js → core-7YKLT7KY.js} +3 -1
  232. package/dist/{core-QUYSNTC7.js → core-AEYGGH7X.js} +3 -1
  233. package/dist/{core-CPN2HF75.js → core-ASBJZZTP.js} +2 -1
  234. package/dist/{core-JQV7STNF.js → core-CJ7FFPDU.js} +3 -1
  235. package/dist/{core-PL64QPOH.js → core-CJZXX2V3.js} +3 -1
  236. package/dist/{core-T5Q4DSH2.js → core-DAFZ7YJW.js} +2 -1
  237. package/dist/{core-RUA3EWW3.js → core-DJPGSTXB.js} +3 -1
  238. package/dist/{core-KBH3EJZV.js → core-DKJUX7Q4.js} +2 -1
  239. package/dist/{core-FFLPH5XK.js → core-EAIFSTDE.js} +3 -1
  240. package/dist/{core-E6YD7VU4.js → core-GEUPUZUY.js} +3 -1
  241. package/dist/{core-OK2ZY5OJ.js → core-JLJTP7P6.js} +2 -1
  242. package/dist/{core-RY6IFRKM.js → core-JLXFDYHX.js} +3 -1
  243. package/dist/{core-ZH7XTJTD.js → core-KCORN7F7.js} +3 -1
  244. package/dist/{core-IZVZ2B7Y.js → core-KF6GJOGW.js} +2 -1
  245. package/dist/{core-DBRILYNB.js → core-KII4CH3W.js} +2 -1
  246. package/dist/{core-TJX3I7KH.js → core-KZK3WCUG.js} +3 -1
  247. package/dist/{core-RE3L6YCM.js → core-L5KTPXHC.js} +2 -1
  248. package/dist/{core-CS7AKNME.js → core-L7Y7YXWR.js} +2 -1
  249. package/dist/{core-IV26EL5C.js → core-MN45UFF4.js} +3 -1
  250. package/dist/{core-PVINU5JJ.js → core-MNUVP5IJ.js} +3 -1
  251. package/dist/{core-OW5V74Q4.js → core-O2K4BDYH.js} +3 -1
  252. package/dist/{core-ZHE7N4NS.js → core-ONNGSKWQ.js} +3 -1
  253. package/dist/{core-KFBW5PRT.js → core-PFXIBWLD.js} +3 -1
  254. package/dist/{core-ZJYLJWZQ.js → core-QXIAQFHM.js} +2 -1
  255. package/dist/{core-KWGXHBJE.js → core-R27R6J5M.js} +3 -1
  256. package/dist/{core-OV5MPTZP.js → core-RCFFJANI.js} +3 -1
  257. package/dist/{core-WQPHNVNY.js → core-RGLOYY73.js} +3 -1
  258. package/dist/{core-SE67HHFG.js → core-V7I4F6JW.js} +3 -1
  259. package/dist/{core-6LLJNZ4O.js → core-W7AZNHOX.js} +3 -1
  260. package/dist/{core-MZMR2DF4.js → core-WHI4ABF2.js} +2 -1
  261. package/dist/{core-6ANZ2OWO.js → core-WJSKT5XM.js} +2 -1
  262. package/dist/{core-EE55P6XK.js → core-XKV7GMPG.js} +3 -1
  263. package/dist/{core-ULUA5ZB2.js → core-YPH723Z7.js} +3 -1
  264. package/dist/{core-SCWEVNUY.js → core-YVNOHIQ4.js} +3 -1
  265. package/dist/{dataTable-IL7HVDHL.js → dataTable-VKEHFLJM.js} +3 -2
  266. package/dist/{engine-MYLZI5VH.js → engine-PPXKJJFI.js} +12 -11
  267. package/dist/fixtures.js +3 -1
  268. package/dist/{fontTables-ZYBUCJ5N.js → fontTables-WYCZNRE7.js} +1 -1
  269. package/dist/fonts.js +1 -1
  270. package/dist/index.js +21 -19
  271. package/dist/{main-ISJ53IS5.js → main-53MXACOU.js} +12 -10
  272. package/dist/mcp/server.js +18 -15
  273. package/dist/react/bar.js +3 -1
  274. package/dist/react/bartable.js +2 -1
  275. package/dist/react/box.js +3 -1
  276. package/dist/react/bullet.js +3 -1
  277. package/dist/react/butterfly.js +3 -1
  278. package/dist/react/choropleth.js +2 -1
  279. package/dist/react/cohort.js +3 -1
  280. package/dist/react/column.js +3 -1
  281. package/dist/react/combo.js +3 -1
  282. package/dist/react/creative.js +2 -1
  283. package/dist/react/diagram.js +2 -1
  284. package/dist/react/dimswitch.js +3 -1
  285. package/dist/react/dot.js +3 -1
  286. package/dist/react/export.js +20 -18
  287. package/dist/react/funnel.js +3 -1
  288. package/dist/react/gantt.js +2 -1
  289. package/dist/react/grid.js +3 -1
  290. package/dist/react/heatmap.js +3 -1
  291. package/dist/react/histogram.js +3 -1
  292. package/dist/react/index.js +86 -84
  293. package/dist/react/kpi.js +2 -1
  294. package/dist/react/likert.js +3 -1
  295. package/dist/react/line.js +3 -1
  296. package/dist/react/mekko.js +3 -1
  297. package/dist/react/pareto.js +3 -1
  298. package/dist/react/pie.js +3 -1
  299. package/dist/react/prepare.js +20 -18
  300. package/dist/react/pvm.js +3 -1
  301. package/dist/react/pyramid.js +3 -1
  302. package/dist/react/sankey.js +2 -1
  303. package/dist/react/scatter.js +3 -1
  304. package/dist/react/slope.js +3 -1
  305. package/dist/react/sparkline.js +2 -1
  306. package/dist/react/spec.js +36 -26
  307. package/dist/react/status.js +2 -1
  308. package/dist/react/story.js +4 -3
  309. package/dist/react/table.js +3 -1
  310. package/dist/react/theme.js +4 -3
  311. package/dist/react/tilemap.js +2 -1
  312. package/dist/react/treemap.js +2 -1
  313. package/dist/react/variance.js +3 -1
  314. package/dist/react/waffle.js +2 -1
  315. package/dist/react/waterfall.js +3 -1
  316. package/dist/rows.js +2 -2
  317. package/dist/{rowsModule-3Y4I3M3E.js → rowsModule-L3MBGPBH.js} +2 -1
  318. package/dist/{schema-STGL44TL.js → schema-26YUL3MG.js} +4 -1
  319. package/dist/{schema-5YTNQ6JY.js → schema-33ZF6WKL.js} +4 -1
  320. package/dist/{schema-E6YOSOWB.js → schema-3W7IFXVN.js} +3 -1
  321. package/dist/{schema-G4KFMQBL.js → schema-4ZXJCRZR.js} +4 -1
  322. package/dist/{schema-QJJPRRE7.js → schema-5E5J43CF.js} +4 -1
  323. package/dist/{schema-34ZELWRQ.js → schema-6ZV532RM.js} +4 -1
  324. package/dist/{schema-P63S63GE.js → schema-733PO52K.js} +4 -1
  325. package/dist/{schema-QEVSIMGO.js → schema-AQD3H5VV.js} +4 -1
  326. package/dist/{schema-EVLLL5UF.js → schema-B4GFRYIP.js} +4 -1
  327. package/dist/{schema-EQQB43AY.js → schema-CMXL5F5L.js} +4 -1
  328. package/dist/{schema-IF5N3J56.js → schema-FT37ZEYY.js} +4 -1
  329. package/dist/{schema-2GUBWOBC.js → schema-GK6MD4EG.js} +4 -1
  330. package/dist/{schema-MEAFRXVH.js → schema-GSE3QXUK.js} +4 -2
  331. package/dist/{schema-4735XAZX.js → schema-GVHM2HEF.js} +4 -1
  332. package/dist/{schema-E2ISJ65D.js → schema-H7RKVTVO.js} +4 -1
  333. package/dist/{schema-XYYDUUHS.js → schema-HGUBNXUY.js} +4 -1
  334. package/dist/{schema-KFC4WYH4.js → schema-HRHNGOFC.js} +3 -1
  335. package/dist/{schema-PNC3Z7AH.js → schema-HWU55RJL.js} +4 -1
  336. package/dist/{schema-3BHL2B76.js → schema-IOKAZVL7.js} +4 -1
  337. package/dist/{schema-7J3NAIN2.js → schema-IOWE3RQO.js} +4 -1
  338. package/dist/{schema-2BMZOHXI.js → schema-KFXLS67Q.js} +4 -1
  339. package/dist/{schema-EYQ5IBLF.js → schema-KH62LDYK.js} +4 -1
  340. package/dist/{schema-S3EQKVOT.js → schema-KHCLVE2V.js} +4 -1
  341. package/dist/{schema-PA2MXYY4.js → schema-KORNUIC6.js} +4 -1
  342. package/dist/{schema-AOJJ7JZB.js → schema-LYBOPAGQ.js} +4 -1
  343. package/dist/{schema-GH7IKSOU.js → schema-MNG24WU2.js} +4 -1
  344. package/dist/{schema-PDZ6256H.js → schema-NOPOI5G2.js} +4 -1
  345. package/dist/{schema-T4NE2EAO.js → schema-PNUC54GC.js} +4 -1
  346. package/dist/{schema-P7LJFJAJ.js → schema-Q4IPIR6W.js} +4 -1
  347. package/dist/{schema-TQYTESG3.js → schema-QLH2DZFI.js} +4 -1
  348. package/dist/{schema-D3RCMN3T.js → schema-QNI6MNQ2.js} +4 -1
  349. package/dist/{schema-W376PAJG.js → schema-SLQPM32G.js} +4 -1
  350. package/dist/{schema-EYZVD73N.js → schema-SY3MKF5S.js} +4 -1
  351. package/dist/{schema-JJYJOQTT.js → schema-WAKLKLBB.js} +4 -1
  352. package/dist/{schema-IG7JIR4H.js → schema-WCDYWS4K.js} +4 -1
  353. package/dist/{schema-CVMV4LRA.js → schema-ZCZCY34J.js} +4 -1
  354. package/dist/{schema-L7263JMT.js → schema-ZSYX76MO.js} +4 -1
  355. package/dist/{specValidation-NVBIZMEE.js → specValidation-H5B4MQST.js} +3 -1
  356. package/dist/theme.js +3 -2
  357. package/dist/{themeShapeRules-5C2463YH.js → themeShapeRules-54U5EIZR.js} +1 -1
  358. package/dist/types/core/annotateEngine.d.ts +14 -0
  359. package/dist/types/core/charts/gantt/layout.d.ts +7 -0
  360. package/dist/types/core/charts/grid/schema.d.ts +1 -1
  361. package/dist/types/core/deferred.d.ts +6 -1
  362. package/dist/types/core/formatSpec.d.ts +2 -0
  363. package/dist/types/core/label/solver.d.ts +5 -1
  364. package/dist/types/core/rows.d.ts +2 -0
  365. package/dist/types/core/theme.d.ts +3 -1
  366. package/dist/types/core/themeShape.d.ts +3 -3
  367. package/dist/types/core/themeValidate.d.ts +3 -3
  368. package/dist/types/core/types/annotations.d.ts +6 -2
  369. package/dist/types/core/types/data.d.ts +8 -3
  370. package/dist/types/core/types/theme.d.ts +2 -1
  371. package/dist/types/react/rowsStore.d.ts +5 -0
  372. package/dist/types/react/spec.d.ts +17 -0
  373. package/dist/types/rows.d.ts +6 -1
  374. package/dist/validate.js +8 -6
  375. package/docs/manual.md +19 -5
  376. package/docs/reference/box.md +1 -1
  377. package/docs/reference/fixtures.md +1 -0
  378. package/docs/reference/gantt.md +11 -5
  379. package/docs/reference/histogram.md +1 -1
  380. package/docs/reference/line.md +1 -1
  381. package/docs/reference/react.md +3 -0
  382. package/docs/reference/table.md +1 -1
  383. package/docs/reference/theme.md +2 -3
  384. package/docs/use-cases.md +198 -0
  385. package/llms.txt +4 -3
  386. package/package.json +2 -1
  387. package/dist/chunk-2GELJH37.js +0 -88
  388. package/dist/chunk-4GB7TBY7.js +0 -373
@@ -3,7 +3,10 @@ export { InputError } from './core/inputError.js';
3
3
  /**
4
4
  * Which source column holds each role. Category charts name category, series
5
5
  * and value; choropleth and tilemap name category and value; waterfall names
6
- * label and value; scatter names x and y; sankey names source, target and value.
6
+ * label and value; scatter names x and y; sankey names source, target and value. A table may name label and id; its
7
+ * spec's data.columns declares the columns, each input column reading the
8
+ * source field named like its id. Histogram names value; box names category
9
+ * (the group id) and value.
7
10
  */
8
11
  export interface RowsColumns {
9
12
  category?: string;
@@ -28,6 +31,8 @@ export interface RowsColumns {
28
31
  /** Sankey: the stages of the two nodes, for flows between segments month to month. */
29
32
  sourceStage?: string;
30
33
  targetStage?: string;
34
+ /** Table row id. Without it the rows are row-1, row-2, ... */
35
+ id?: string;
31
36
  /** fraction when a share of one half arrives as 0.5, percent when it arrives as 50, number otherwise. */
32
37
  valueKind?: 'number' | 'percent' | 'fraction';
33
38
  }
package/dist/validate.js CHANGED
@@ -1,9 +1,9 @@
1
1
  import {
2
2
  parseThemeJson
3
- } from "./chunk-RJQ5YS3Q.js";
3
+ } from "./chunk-43OQ26TL.js";
4
4
  import {
5
5
  registerCatalogue
6
- } from "./chunk-A5JWFZVU.js";
6
+ } from "./chunk-PJWLKCFX.js";
7
7
 
8
8
 
9
9
 
@@ -144,7 +144,7 @@ import {
144
144
 
145
145
  import {
146
146
  linkAnnotateEngine
147
- } from "./chunk-GWQIXU37.js";
147
+ } from "./chunk-2IXDYW6O.js";
148
148
 
149
149
 
150
150
 
@@ -177,7 +177,8 @@ import {
177
177
 
178
178
  import {
179
179
  linkThemeShapeRules
180
- } from "./chunk-CAE2HK2G.js";
180
+ } from "./chunk-6I7YZTY7.js";
181
+
181
182
 
182
183
 
183
184
 
@@ -187,7 +188,7 @@ import {
187
188
  import {
188
189
  getChartDefinition,
189
190
  listCharts
190
- } from "./chunk-GQPESFAF.js";
191
+ } from "./chunk-U7LLQ7XM.js";
191
192
 
192
193
 
193
194
 
@@ -200,7 +201,8 @@ import {
200
201
 
201
202
  import {
202
203
  validateTheme
203
- } from "./chunk-2MTWKMEG.js";
204
+ } from "./chunk-4WK3CNW5.js";
205
+
204
206
 
205
207
 
206
208
 
package/docs/manual.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # Boardplot manual
2
2
 
3
+ To have an AI agent build a slide deck, an analysis page, a React dashboard or a report with Boardplot charts, start with [Use cases](use-cases.md).
4
+
3
5
  ## What Boardplot is
4
6
 
5
7
  Boardplot draws consulting-grade charts: 37 chart types, tables and maps among them, with every label placed by one collision solver. The output is deterministic SVG or a React component, so the same spec gives the same drawing byte for byte. Totals, differences, shares and growth rates are computed from the data, and each render reports the numbers the engine derived.
@@ -144,7 +146,7 @@ Each derived reading has `visible: true` when it has displayed text. A calculati
144
146
 
145
147
  The last item has no value, so the engine computed the FY25 total of 133. A total that carries a value is checked against the sum; the computed value is drawn and the render warns `derived-mismatch`.
146
148
 
147
- `boardplot_render` takes `spec` and optionally `format` (`svg` or `png`), `target` (see [Sizing](#sizing)), `width` and `height` in px, `scale` (PNG pixels per layout pixel, default 2), `background` (`theme` by default; `transparent` leaves the canvas out, while halos and hollow marks keep the theme background colour, so place the chart on a surface of that colour), `return` (`["reading"]` by default; add `"svg"` for the markup) and `outDir`, an absolute directory to write the files to. PNG uses `@resvg/resvg-js`, an optional dependency, when it is installed, and otherwise Chrome or Chromium, found on the usual paths or through `BOARDPLOT_CHROME_PATH`. With neither, the render returns the SVG and the warning `no-rasterizer`. Chrome's exit code does not decide: on a busy machine Chrome writes the PNG and then exits 2, so a PNG that decodes at the requested size counts as drawn. Without one, Boardplot runs Chrome once more and then fails with `png-export-failed` (exit 2), whose message names the cause: a browser that would not start, the 60 s timeout, a crash, or Chrome's exit code with its last line of output. On Linux, resvg draws with the first family of the theme stack that fontconfig lists, else Liberation Sans, Arimo, Nimbus Sans, DejaVu Sans or Noto Sans; with none of them installed Chrome draws the PNG, and without Chrome the render returns the SVG and the warning `raster-fonts-missing`. A label with characters the theme font has no width for, such as emoji or CJK, gets the warning `png-glyph-coverage`, because resvg draws them as boxes or leaves them out. A PNG records 96 dpi times `scale`, so PowerPoint, Keynote and Word place a scale-2 PNG at the chart's own size.
149
+ `boardplot_render` takes `spec` and optionally `format` (`svg` or `png`), `target` (see [Sizing](#sizing)), `width` and `height` in px, `scale` (PNG pixels per layout pixel, default 2), `background` (`theme` by default; `transparent` leaves the canvas out, while halos and hollow marks keep the theme background colour, so place the chart on a surface of that colour), `return` (`["reading"]` by default; add `"svg"` for the markup) and `outDir`, an absolute directory to write the files to. PNG uses `@resvg/resvg-js`, an optional dependency, when it is installed, and otherwise Chrome or Chromium, found on the usual paths or through `BOARDPLOT_CHROME_PATH`. With neither, the render returns the SVG and the warning `no-rasterizer`. Chrome's exit code does not decide: on a busy machine Chrome writes the PNG and then exits 2, so a PNG that decodes at the requested size counts as drawn. Without one, Boardplot runs Chrome once more and then fails with `png-export-failed` (exit 2), whose message names the cause: a browser that would not start, the 60 s timeout, a crash, or Chrome's exit code with its last line of output. On Linux, resvg draws with the first family of the theme stack that fontconfig lists, else Liberation Sans, Arimo, Nimbus Sans, DejaVu Sans or Noto Sans; with none of them installed Chrome draws the PNG, and without Chrome the render returns the SVG and the warning `raster-fonts-missing`. A label with characters the theme font has no width for, such as emoji or CJK, gets the warning `png-glyph-coverage`, because resvg draws them as boxes or leaves them out. A PNG records 96 dpi times `scale`. [PowerPoint or Keynote deck](use-cases.md#powerpoint-or-keynote-deck) says how slide and document tools place it.
148
150
 
149
151
  ### Rows as data
150
152
 
@@ -170,7 +172,7 @@ The MCP server reads a `rowsFile` only from an allowed folder. The allowed folde
170
172
 
171
173
  The rows here are inline; `"rowsFile": "/data/exports/channel-share.csv"` in their place reads the same columns from a file. An absent category/series pair becomes `null`, which means unknown. A composition with a missing component withholds its share labels. When the source proves that a pair has no value, supply an explicit zero row. For example, `{ "category": "A", "series": "S1", "value": 12 }` and `{ "category": "A", "series": "S2", "value": 0 }` form a complete composition under `columns: { category: "category", series: "series", value: "value" }`. Keep unknown pairs as null.
172
174
 
173
- For category charts, the rows become the spec's `data.categories` and `data.series`, in the order they first appear. A category or series the spec already names keeps its other fields, such as a label or a `colorRole`, so a spec works as a template the rows refill; a column the map names wins. Rows fill one bare spec of a type whose data is categories and series (bar, bartable, butterfly, column, combo, dot, funnel, heatmap, line, mekko, pie, slope, variance). A pair that appears twice, a text value, a state beside a value and a named column no row has are refused with the row that holds them, and rows with no data row (a CSV with only its header, an empty array) are refused as `rows-empty`. The reading gains `data`: the row count, the `sha256` of the file bytes (of the canonical JSON for inline rows), the source, the columns nothing read and the cells a state suppressed. `boardplot_measure` returns the same `data`.
175
+ For category charts, the rows become the spec's `data.categories` and `data.series`, in the order they first appear. A category or series the spec already names keeps its other fields, such as a label or a `colorRole`, so a spec works as a template the rows refill; a column the map names wins. Rows fill one bare spec of a type whose data is categories and series (bar, bartable, butterfly, column, combo, dot, funnel, heatmap, line, mekko, pie, slope, variance). A `bartable` takes the categories as its table rows and the series as its bar segments, and the value column fills one panel. The spec's first panel is the template for that panel: the panel keeps its id, label, unit, weight, format and aggregate. Without a template, the panel's id is the value column's name. The rows drop the template's `ends`, any other panel and the number `columns`, because these lists hold one value per authored row. Percent values fill the panel as plain numbers, and the panel unit becomes `%` when neither the rows nor the template name a unit. The panel adds its segments, so rows with two different units, percent values beside plain numbers, or a value cell with more than its number (such as a `format`) are refused at their row. A pair that appears twice, a text value, a state beside a value and a named column no row has are refused with the row that holds them, and rows with no data row (a CSV with only its header, an empty array) are refused as `rows-empty`. The reading gains `data`: the row count, the `sha256` of the file bytes (of the canonical JSON for inline rows), the source, the columns nothing read and the cells a state suppressed. `boardplot_measure` returns the same `data`.
174
176
 
175
177
  ### Waterfall and scatter rows
176
178
 
@@ -182,6 +184,18 @@ Sankey takes one row per link, the shape of a `GROUP BY source, target` result.
182
184
 
183
185
  Both mappings generate ids `row-1`, `row-2`, and so on. Labels can repeat. Rows replace `data.items` or `data.points`; other authored data stays in the spec. Named columns must exist in the source. Invalid cells report their source row and column. The reading and measure report the row count, SHA-256 and ignored columns, as for category rows. `valueKind` applies to the waterfall value or both scatter coordinates; bubble size stays a number. For different coordinate kinds, pass numeric cells in JSON rows and set each axis format in the spec. These mappings work with CLI render/measure and MCP `boardplot_render`/`boardplot_measure`, for inline rows and JSON or CSV files.
184
186
 
187
+ ### Table rows
188
+
189
+ Table (alias `tbl`) takes one row per table row. The spec's `data.columns` declares the columns; the engine infers no column from the rows. Each `value`, `text`, `status` or `date` column reads its cells from the source field with the same name as the column id. The `rowLabel` column shows the row label, which comes from the `label` role. `computed` and `encoding` columns keep their definitions and read no source field. Use `--columns label=region,id=code`, or the MCP object `columns: { "label": "region", "id": "code" }`. Both roles are optional; without `id`, the rows get the ids `row-1`, `row-2`, and so on. A table takes no `valueKind` other than `number`: write a percent column in points and give it a percent format.
190
+
191
+ Numbers, text, null and table cell objects pass through as cells, and a field that a row lacks becomes null. Only a `value` column reads CSV text as a number, with the decimal comma of a semicolon CSV. A column whose field no row has, text that a `value` column cannot read as a number, a boolean or other invalid cell, and an empty or repeated row id are refused with the source row and field; a table warning about a source cell names that row and field too. Rows keep their source order and columns keep the spec's order. A spec row with the same id keeps its authored fields, such as `role`, `parentId`, `calc` or `format`, so totals, hierarchy and formulas stay in the spec; spec rows that no source row names are not drawn, and a drawn row whose `parentId` or `calc` names such a row is refused at that spec field. The reading reports the source fields that no column and no role reads in `ignoredColumns`.
192
+
193
+ ### Histogram and box rows
194
+
195
+ Histogram (aliases `distribution`, `frequency`) takes one row per observation: `--columns value=days`, or `columns: { "value": "days" }`. Box (aliases `boxplot`, `box-and-whisker`) takes one row per observation and groups the rows by the `category` column: `--columns category=team,value=days`. `category` and `value` are required; the optional `categoryLabel` and `date` give each group its label and observation date, and `date` may name the category column. Groups keep the order in which they first appear. A group the spec already names keeps its other fields. A group with two different labels or two different dates, a label or date that is not text, and a repeated group id in the spec are refused.
196
+
197
+ Every row is an observation, so nothing is dropped without a word. A null, blank, non-numeric or non-finite observation is refused with `missing-value` or `invalid-value` and its source row and field; remove or fix those rows before the call. A histogram still needs at least four observations. These shapes take no `valueKind` other than `number`; set the number format in the spec options.
198
+
185
199
  ### Map rows and classes
186
200
 
187
201
  Choropleth and tilemap accept the same `rows` and `rowsFile` inputs. Set `columns: { "category": "area", "value": "score" }`. Each row supplies one region. Keep `data.pack` and any `data.overlays` in the spec. Maps accept `state` and `valueKind`; region names come from the pack, so other column roles are refused. Duplicate regions and invalid values are refused. The reading includes the row count and SHA-256, as for category charts.
@@ -227,7 +241,7 @@ SVG `id` attributes and their references use a hash of the drawing, locale and r
227
241
 
228
242
  ### Gantt and grid formats
229
243
 
230
- Gantt and ordinary grid compositions have no numeric value labels of their own. Metric stacks set mark precision with panel `decimals` and `divisor`. A chart-level `format` is accepted and warns in this release. It will be refused in the next release. Set each numeric grid panel's `options.format` instead. Gantt uses calendar date options.
244
+ Gantt and ordinary grid compositions have no numeric value labels of their own. Metric stacks set mark precision with panel `decimals` and `divisor`. A chart-level `format` is accepted, ignored and warns. Set each numeric grid panel's `options.format` instead. Gantt uses calendar date options.
231
245
 
232
246
  ### Metric stack
233
247
 
@@ -352,7 +366,7 @@ export function WeeklyRevenue() {
352
366
 
353
367
  ### Small bundles
354
368
 
355
- With esbuild 0.28.2, code splitting, minification and React external, a column's first load through `boardplot/react/spec` is about 351 kB gzip. The initial entry is about 199 kB; validation adds about 83 kB, then the column schema and engine load. The validation chunk is shared across chart types. Importing `ColumnChart` from `boardplot/react/column` starts at about 203 kB gzip. These are package measurements with gzip level 9; the host build can produce different chunk sizes.
369
+ With esbuild 0.28.2, code splitting, minification and React external, a column's first load through `boardplot/react/spec` is about 408 kB gzip. The initial entry is about 243 kB; validation adds about 88 kB, of which about 32 kB is zod, then the column schema and engine load. The validation chunk is shared across chart types. Importing `ColumnChart` from `boardplot/react/column` starts at about 237 kB gzip and links no zod. These sizes assume code splitting, the default in the production builds of Vite, webpack and Next.js; a bundle without splitting inlines the chunks a chart loads on demand and is about 57 to 87 kB larger per chart type. These are package measurements with gzip level 9; the host build can produce different chunk sizes.
356
370
 
357
371
  `boardplot/react` registers every chart core when it loads, so a page that imports it links the whole catalogue, whatever it draws. For a small page, import each chart from its own entry, or draw through `BoardplotChart` from `boardplot/react/spec`. Take the theme provider and the other shared pieces from `boardplot/react/theme`: `BoardplotTheme`, `useBoardplotTheme`, `ScaleGroup`, `useScaleGroupPlan` and `SceneRenderer`. That entry registers no chart core, so the page links only the cores it draws. Bundle with code splitting, as the production builds of Vite, webpack and Next.js do. A per-type entry loads the annotation engine, the checks a patched theme goes through and the hover and data-table records on demand; a single-file bundle inlines them into the page for every chart type, and `BoardplotChart` then inlines every engine. `useChartLayout` lays out any type by name and registers every core; it stays in `boardplot/react`.
358
372
 
@@ -772,7 +786,7 @@ The target replaces the type sizes of a preset; a size that `overrides` names st
772
786
 
773
787
  A theme key that Boardplot removed is refused with `invalid-theme-override` or `invalid-theme`, a suggest and a patch that removes it. `type.eyebrow.case` is removed: KPI eyebrows and waffle panel labels print names as written, so write capitals in the name to keep them. If the theme widened `type.eyebrow.tracking` for capitals, set `type.eyebrow.tracking` back or remove it. Absent means no letter-spacing, and a name in mixed case reads too wide with capital tracking.
774
788
 
775
- An override can give `color.series` one or two colours. These colours come first. The remaining slots come from the preset, with colours that repeat an authored colour skipped. An override with three or more colours keeps its own ramp and overflow policy. A full theme needs at least three colours.
789
+ An override can give `color.series` one or two colours. These colours come first. The remaining slots come from the preset, with colours that repeat an authored colour skipped. An override with three or more colours keeps its own ramp and overflow policy. A full theme needs at least one colour. It draws a two-series chart in exactly its two colours, and series past the end of its ramp follow `color.seriesOverflow`.
776
790
 
777
791
  ### Design system colours
778
792
 
@@ -37,7 +37,7 @@ One form; its chart ID is `box`.
37
37
 
38
38
  | Path | Type | Required | Meaning |
39
39
  |---|---|---|---|
40
- | groups | array | yes | Observation groups whose quartiles and whiskers are computed by the engine. |
40
+ | groups | array | yes | Observation groups whose quartiles and whiskers are computed by the engine. Rows: category,value; optional categoryLabel,date. |
41
41
  | groups[].id | string | yes | Nonempty stable identifier used to match data, labels and annotation anchors. |
42
42
  | groups[].label | string | | Visible group name; defaults to the group id. |
43
43
  | groups[].date | string | | ISO observation date for CAGR between group snapshots; requires a positive date interval. |
@@ -667,6 +667,7 @@ Every fixture is a complete spec that renders. `boardplot_fixtures` returns them
667
667
  | right-edge-milestone-row | gantt | torture | Regression: last row with only a right-edge milestone keeps its activity label centered |
668
668
  | workstream-status-plan | gantt | example | Workstream status plan (weekly view, owners, due dates, and semantic status) |
669
669
  | metadata-column-headers | gantt | example | Three delivery rows with owner and due-date headers |
670
+ | status-timeline | gantt | example | Status timeline (row sublabels, status-coloured spans, change events) |
670
671
  | torture-long-labels | gantt | torture | Torture: long names at a generous size read whole, never cut |
671
672
  | item-labels-off | gantt | torture | Rows and status remain when item labels are off |
672
673
  | five-nearby-milestones | gantt | torture | Five nearby milestones retain their names |
@@ -46,14 +46,15 @@ One form; its chart ID is `gantt`.
46
46
  | rows | array | yes | Task and cadence rows displayed in the supplied order. |
47
47
  | rows[].id (rows[] branch 1) | string | yes | Unique timeline row identity. |
48
48
  | rows[].label (rows[] branch 1) | string | yes | Visible timeline row name. |
49
+ | rows[].sublabel (rows[] branch 1) | string | | Second line under the row name, such as what the row measures. Printed in the label font and muted ink, on one line and never cut; the name band takes the wider of name and sublabel. On narrow canvases it follows the name on the row's name line. labels.activity: false hides it with the name. |
49
50
  | rows[].indent (rows[] branch 1) | integer | | Nonnegative indentation level for the row label. |
50
51
  | rows[].cols (rows[] branch 1) | array | | Metadata columns beside the row label, such as owner and status; up to three are displayed. A cell is text, or text with a tone. |
51
52
  | rows[].cols[].text (rows[] branch 1) | string | yes | Cell text, such as a status word. |
52
- | rows[].cols[].tone (rows[] branch 1) | string | yes | Status tone, drawn as a small filled marker in the tone's colour before the text. The row's bars and chevrons without a colorRole take the same colour, as do those of rows indented under it without a status, so the status column keys them. One of `'good'`, `'warn'`, `'bad'`, `'neutral'`. |
53
+ | rows[].cols[].tone (rows[] branch 1) | string | | Status tone; omitted, the cell is plain text. A tone is drawn as a small filled marker in the tone's colour before the text. The row's bars and chevrons without a colorRole take the same colour, as do those of rows indented under it without a status, so the status column keys them. One of `'good'`, `'warn'`, `'bad'`, `'neutral'`. |
53
54
  | rows[].kind (rows[] branch 1) | string | | Task row containing individual timeline items; task is the default row kind. One of `'task'`. |
54
55
  | rows[].items (rows[] branch 1) | array | yes | Timeline items placed in this task row. |
55
56
  | rows[].items[].id (rows[] branch 1) | string | yes | Unique item identity used by annotations and scene elements. |
56
- | rows[].items[].kind (rows[] branch 1) | string | yes | Timeline mark. Milestone labels try their row bands before the lane; unsafe leaders use a numbered key. One of `'bar'`, `'milestone'`, `'chevron'`, `'bracket'`, `'shade'`. |
57
+ | rows[].items[].kind (rows[] branch 1) | string | yes | Timeline mark. Milestone labels try their row bands before the lane; unsafe leaders use a numbered key. 'rule' is a quiet span for the state before a change: a 2 px neutral line at the bottom of the bar box with its label above it in muted ink, flush left; it never takes a colour or a colour-key entry. One of `'bar'`, `'milestone'`, `'chevron'`, `'bracket'`, `'shade'`, `'rule'`. |
57
58
  | rows[].items[].start (rows[] branch 1) | string | yes | ISO 8601 start date; an anchor can move it while preserving duration. |
58
59
  | rows[].items[].end (rows[] branch 1) | string | | Inclusive ISO 8601 end date for an interval; omission uses the start date. |
59
60
  | rows[].items[].label (rows[] branch 1) | string | | Displayed item name. An omitted name leaves category content empty. |
@@ -66,10 +67,11 @@ One form; its chart ID is `gantt`.
66
67
  | rows[].items[].anchor.offsetDays (rows[] branch 1) | integer | | Signed number of days added to the target edge; defaults to zero. |
67
68
  | rows[].id (rows[] branch 2) | string | yes | Unique timeline row identity. |
68
69
  | rows[].label (rows[] branch 2) | string | yes | Visible timeline row name. |
70
+ | rows[].sublabel (rows[] branch 2) | string | | Second line under the row name, such as what the row measures. Printed in the label font and muted ink, on one line and never cut; the name band takes the wider of name and sublabel. On narrow canvases it follows the name on the row's name line. labels.activity: false hides it with the name. |
69
71
  | rows[].indent (rows[] branch 2) | integer | | Nonnegative indentation level for the row label. |
70
72
  | rows[].cols (rows[] branch 2) | array | | Metadata columns beside the row label, such as owner and status; up to three are displayed. A cell is text, or text with a tone. |
71
73
  | rows[].cols[].text (rows[] branch 2) | string | yes | Cell text, such as a status word. |
72
- | rows[].cols[].tone (rows[] branch 2) | string | yes | Status tone, drawn as a small filled marker in the tone's colour before the text. The row's bars and chevrons without a colorRole take the same colour, as do those of rows indented under it without a status, so the status column keys them. One of `'good'`, `'warn'`, `'bad'`, `'neutral'`. |
74
+ | rows[].cols[].tone (rows[] branch 2) | string | | Status tone; omitted, the cell is plain text. A tone is drawn as a small filled marker in the tone's colour before the text. The row's bars and chevrons without a colorRole take the same colour, as do those of rows indented under it without a status, so the status column keys them. One of `'good'`, `'warn'`, `'bad'`, `'neutral'`. |
73
75
  | rows[].kind (rows[] branch 2) | string | yes | Cadence row showing repeated dated event markers. One of `'cadence'`. |
74
76
  | rows[].events (rows[] branch 2) | array | yes | Dated events placed along this cadence row. |
75
77
  | rows[].events[].id (rows[] branch 2) | string | yes | Unique event identity shared with the timeline mark id namespace. |
@@ -82,10 +84,13 @@ One form; its chart ID is `gantt`.
82
84
  | Path | Type | Values | Default | Meaning |
83
85
  |---|---|---|---|---|
84
86
  | labels | false \| object | `false` (or another value of its type) | | False hides timeline item labels. Row names, metadata cells and column headers remain. Use labels.activity: false to hide those, or labels.item: false to hide only item labels. For milestones, labels.item: ['category'] prints the item name without its date; ['absolute'] or the legacy ['value'] prints only the date. Span items print the inclusive date range. Parts follow the supplied order. An empty requested part is named in a note. |
85
- | today | string | | | Authored ISO 8601 date for the dashed today marker; the system clock is not read. The marker, like an event rule, passes the period names of the calendar head with a gap. |
87
+ | today | string | | | Authored ISO 8601 date for the dashed today marker; the system clock is not read. The marker, like an event rule, passes the period names of the calendar head with a gap. A bar, arrow or shade name with no seat clear of the marker and the event rules sits inside its mark across them, and the rules break over that mark. |
86
88
  | elapsed | boolean | | | Tint the visible time before today; defaults to true when the today marker is displayed. |
87
89
  | weekends | boolean | | | Shade Saturday and Sunday at week granularity; defaults to false. |
88
90
  | rowTint | boolean | | | Apply alternating faint row backgrounds; defaults to false. |
91
+ | calendar | object | | | Calendar head and span. The defaults keep the ISO week head over whole periods. |
92
+ | calendar.weeks | string | `'isoWeek'`, `'startDay'` | | Week cell names. 'isoWeek' (default): ISO week numbers such as 'W11'. 'startDay': the day of the month each week cell starts on ('9'), flush left in its cell under the month tier, so the number reads as the day the week starts; a clipped first or last cell names the day it starts on. Week granularity only; elsewhere it is ignored with the info lint calendar-weeks-ignored. |
93
+ | calendar.span | string | `'periods'`, `'data'` | | Timeline span. 'periods' (default): whole calendar periods of the head's finer tier. 'data': from the first item or cadence day to the later of the last item end and options.today, so the arrows end at the edge. A milestone or cadence marker on the first or last day keeps room for its radius inside the edge. Event annotations and a today before the first item do not extend the span; they are left out with event-out-of-range or today-out-of-range. |
89
94
  | colHeaders | array | | | Positional headers for up to three existing metadata columns. Omitted or empty entries have no header; entries without a displayed column are ignored. |
90
95
 
91
96
  Plus the [shared options](options.md). This type does not accept `detailFields`, `categoryLabels`, `valueAxis`, `categoryAxis`, `secondaryAxis`, `rowLabels`, `sort`, `topN`, `hatchStrength`, `colorblindSafe`, `rounding`.
@@ -96,7 +101,7 @@ An annotation anchor is a category or item id string, or an object with category
96
101
 
97
102
  | Kind | Purpose | Required | Anchors | Optional fields | Notes |
98
103
  |---|---|---|---|---|---|
99
- | event | Places a dated event in the lane above the plot as a block with a pole to the data, or, when it does not fit, as a numbered marker with an entry in the event key below the plot; periods draw a thin bar. | at, label | at: AnchorRef | tone: neutral \| bad \| good, default the group tone, else neutral. Column, combo and line paint the glyph, the marker ring and the period bar in it; gantt paints a bad rule. | An ISO date or a schedule item id positions the rule. Above three events the labels move to numbered footnotes. |
104
+ | event | Places a dated event in the lane above the plot as a block with a pole to the data, or, when it does not fit, as a numbered marker with an entry in the event key below the plot; periods draw a thin bar. | at, label | at: AnchorRef | tone: neutral \| bad \| good, default the group tone, else neutral. Column, combo and line paint the glyph, the marker ring and the period bar in it; gantt paints a bad rule. labelPlacement: top \| inline \| badge, default top. inline (line) sets the block beside its rule inside the plot. badge (gantt) draws the label, at most 3 characters, in a filled circle at the top of its rule; badge events never go to the numbered key. | An ISO date or a schedule item id positions the rule. Above three events the labels move to numbered footnotes. |
100
105
 
101
106
  ## Sizing
102
107
 
@@ -119,6 +124,7 @@ Below the floor a render is refused with `size-below-floor` and the pixels it ne
119
124
  | right-edge-milestone-row | torture | Regression: last row with only a right-edge milestone keeps its activity label centered |
120
125
  | workstream-status-plan | example | Workstream status plan (weekly view, owners, due dates, and semantic status) |
121
126
  | metadata-column-headers | example | Three delivery rows with owner and due-date headers |
127
+ | status-timeline | example | Status timeline (row sublabels, status-coloured spans, change events) |
122
128
  | torture-long-labels | torture | Torture: long names at a generous size read whole, never cut |
123
129
  | item-labels-off | torture | Rows and status remain when item labels are off |
124
130
  | five-nearby-milestones | torture | Five nearby milestones retain their names |
@@ -33,7 +33,7 @@ One form; its chart ID is `histogram`.
33
33
 
34
34
  | Path | Type | Required | Meaning |
35
35
  |---|---|---|---|
36
- | observations | array | yes | Raw observations, at least four. Pre-binned counts and edges are rejected: bins the engine cannot recompute cannot be checked. |
36
+ | observations | array | yes | Raw observations, at least four. Pre-binned counts and edges are rejected: bins the engine cannot recompute cannot be checked. Rows: value. |
37
37
 
38
38
  ## Options
39
39
 
@@ -238,7 +238,7 @@ An annotation anchor is a category or item id string, or an object with category
238
238
  | valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. seriesId: string. Series whose mean is measured. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. side: left \| right, default right. Side of the plot the label sits on. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. attainment: boolean \| { seriesId, direction }. Shades each category between its actual and the line. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
239
239
  | indicator100 | Maps 100 through the chart's value scale and draws a side tick with a 100% label. | | | side: left \| right, default left. Side of the plot the 100% mark sits on. | No anchor is required. The chart needs a value scale that can represent 100. |
240
240
  | abs | Reads the anchored data value and places its formatted absolute value in a collision-managed label. | at | at: AnchorRef | | Drawn reference series accept anchors. Bad anchors report the cause and valid ids. |
241
- | event | Places a dated event in the lane above the plot as a block with a pole to the data, or, when it does not fit, as a numbered marker with an entry in the event key below the plot; periods draw a thin bar. | label | at: categoryId (optional) | date: ISO date yyyy-mm-dd, in place of at: the event sits at the last category whose date is on or before it, and the block header and the key print it as d MMM. Every category needs an ISO date; a date outside the categories warns event-out-of-range. end: ISO date, with date: the event is a period, drawn as a thin bar to the end of that day. to: Category id, with at: the event is a period to the end of that category. group: Id of a group in options.events.groups, which gives the kind label, tone and glyph. detail: string \| string[]. Authored lines under the title, at most three in the lane; nothing is cut, a longer block moves to the key. items: { label, detail? }[]. More changes on the same date, after this event's own label and detail. The lane and the key draw a compact +N after the title; the hover card, the SVG title and description, and the interaction records list every item in full. placement: auto \| key, default options.events.placement. key numbers this event into the key below the plot. tone: neutral \| bad \| good, default the group tone, else neutral. Column, combo and line paint the glyph, the marker ring and the period bar in it; gantt paints a bad rule. labelPlacement: top \| inline, default top. inline sets the block beside its rule inside the plot. | Exactly one of at (a category id) and date (an ISO date) places the event; end or to makes it a period. The event lane above the plot sets a block of group and date, title and detail with a thin pole to the data; an event that does not fit, a second event on one category and every event under options.events.placement 'key' get a numbered marker and an entry in the key below the plot, numbered in time order; under footnotes: false they are left off and listed in the footnotes-off lint. The full date, title and detail of every event stay in the SVG title and description, the interaction records and the hover card, whether or not the lane or the key prints the detail. In compact mode the lane is one row of numbered markers and the key packs "n date title" into as few lines as the width allows; where the plot would still fall under 80px the key keeps "n title" and the info lint event-lane-compact says so. options.events.rows sets the lane rows (default by canvas width: 1 under 1080px, 2 from 1080px); a row gives way while the plot band left under the lane would keep less than 40% of the canvas height. |
241
+ | event | Places a dated event in the lane above the plot as a block with a pole to the data, or, when it does not fit, as a numbered marker with an entry in the event key below the plot; periods draw a thin bar. | label | at: categoryId (optional) | date: ISO date yyyy-mm-dd, in place of at: the event sits at the last category whose date is on or before it, and the block header and the key print it as d MMM. Every category needs an ISO date; a date outside the categories warns event-out-of-range. end: ISO date, with date: the event is a period, drawn as a thin bar to the end of that day. to: Category id, with at: the event is a period to the end of that category. group: Id of a group in options.events.groups, which gives the kind label, tone and glyph. detail: string \| string[]. Authored lines under the title, at most three in the lane; nothing is cut, a longer block moves to the key. items: { label, detail? }[]. More changes on the same date, after this event's own label and detail. The lane and the key draw a compact +N after the title; the hover card, the SVG title and description, and the interaction records list every item in full. placement: auto \| key, default options.events.placement. key numbers this event into the key below the plot. tone: neutral \| bad \| good, default the group tone, else neutral. Column, combo and line paint the glyph, the marker ring and the period bar in it; gantt paints a bad rule. labelPlacement: top \| inline \| badge, default top. inline (line) sets the block beside its rule inside the plot. badge (gantt) draws the label, at most 3 characters, in a filled circle at the top of its rule; badge events never go to the numbered key. | Exactly one of at (a category id) and date (an ISO date) places the event; end or to makes it a period. The event lane above the plot sets a block of group and date, title and detail with a thin pole to the data; an event that does not fit, a second event on one category and every event under options.events.placement 'key' get a numbered marker and an entry in the key below the plot, numbered in time order; under footnotes: false they are left off and listed in the footnotes-off lint. The full date, title and detail of every event stay in the SVG title and description, the interaction records and the hover card, whether or not the lane or the key prints the detail. In compact mode the lane is one row of numbered markers and the key packs "n date title" into as few lines as the width allows; where the plot would still fall under 80px the key keeps "n title" and the info lint event-lane-compact says so. options.events.rows sets the lane rows (default by canvas width: 1 under 1080px, 2 from 1080px); a row gives way while the plot band left under the lane would keep less than 40% of the canvas height. |
242
242
  | band | Draws an inclusive category span as a shaded band or bracket, or a value-axis plan corridor, tolerance band or attainment fill, with a collision-managed label. | | from: categoryId (optional); to: categoryId (optional) | | Era shade/bracket needs inclusive category IDs. Corridor and tolerance use finite low/high on the value scale, with optional from/to as a category clip. Attainment needs a plan value and shades each resolved actual; missing cells are skipped. Divider applies only to bracket bands. Scenario AC/PY/PL/FC paints a plan corridor (default PL). |
243
243
 
244
244
  ## Trend lines
@@ -35,8 +35,11 @@ export function RevenueMix() {
35
35
  | `target` | The medium the chart is read in: `report` (the default), `dashboard`, `slide` or `print`. It overrides `spec.options.target` and the provider's `target`; see [Targets](#targets). |
36
36
  | `onWarnings` | Called with the warnings of the layout and with a finding when the chart shows narrower than its safe minimum; see [Targets](#targets). |
37
37
  | `hover` | Label card and series highlight on pointer hover; see [Hover](#hover). |
38
+ | `onSpecError` | Called after commit with the findings `SpecErrorCard` shows: an invalid spec or setting, or a chunk that did not load (code `chunk-load-failed`). It is called once per distinct set of findings, so a host may set state from it; a rerender with the same findings, or StrictMode's repeated effects, call it no second time. It is called once with `[]` when a later valid spec replaces the error card (its chart engine is ready, or its data is empty), without waiting for the chart to draw, because a valid spec can still wait for its container or refuse its size. A first spec that draws calls nothing, and a set the host had no `onSpecError` for is reported when the prop arrives. Empty data stays on `onEmpty`, and a layout refusal on `onRefused`. |
38
39
  | `onSeriesClick` | Called with the series id when the reader clicks a series: its line or area, its name label or its legend entry. The name label and the legend label are keyboard buttons (Enter or Space); the line, area and swatches take the pointer only. SVG charts only. |
39
40
  | `onRecordClick` | Called with `(record, event)` when the reader clicks a mark: the record the hover card names there, a bar, a point, a slice or a category band, with its category and series ids in `record.target.owner`, its source value in `record.value.raw` and its labels. Use it for a drill-down. A mark that prints everything it carries, such as a plain diagram node, opens no hover card but is still clicked and focused. An annotation (a value line, an event) is read but never calls it, from the pointer or the keyboard. It works with `hover` off. A click on a mark then fires no `onSeriesClick`; the name label and the legend entry keep their series click. Enter or Space on the record the keyboard has focused calls it too, with the keyboard event; see [Keyboard](#keyboard). SVG charts only. |
41
+ | `onRowSelect` | Called with `(rowId, { row, event, columnId })` when the reader picks a table row: a click in it outside a link or a button, or Enter or Space on its focused cell; see [The table component](#the-table-component). Table only (`table`, alias `tbl`); BoardplotChart passes it to no other type. A `dimswitch` spec draws as SVG here and takes no row pick; use `DimSwitchChart` for that. |
42
+ | `isRowSelectable` | Called with `(row, { collapsed })`; the rows it answers false for take no pick. Absent, every row but a section heading is selectable. Table only. |
40
43
  | `zoom` | Line and area on a time, date or number x: `true` or `{ aggregate, grains, range, onZoom }`. Ctrl or Cmd with the wheel, or a trackpad pinch, zooms around the pointer; the plain wheel scrolls the page. See [Zoom](#zoom). SVG charts only. |
41
44
  | `renderHoverContent` | Your own hover card content, for a link or a free layout: `(record, { records, defaultContent, source })` returns what the card shows. `record` is the record `onRecordClick` receives for the same mark. Return `defaultContent` to keep the default card, wrap it to add to it, return your own content to replace it, or `null` for no card on that record. Turns on `hover` when it is absent; see [Your own card content](#your-own-card-content). SVG charts only. |
42
45
  | `prepared` | The server result of `prepareChart` for the same spec and settings; see [Server preparation](#server-preparation). |
@@ -186,7 +186,7 @@ Consulting-grade table: hierarchy with honest totals (derive/validate/source), t
186
186
  | columns[].encoding.type (columns[] branch 7) | string | yes | Per-row mini line or column over sourceColumns; null values leave gaps in source order. One of `'sparkline'`. |
187
187
  | columns[].encoding.kind (columns[] branch 7) | string | | Shape. Default 'line'. 'column' is zero-anchored. One y-domain is shared across visible rows of this column. One of `'line'`, `'column'`. |
188
188
  | columns[].encoding.sourceColumns (columns[] branch 7) | array | yes | Ordered numeric source columns; they remain visible. The last observed source value is labelled from that cell's formatted text. Without a column width the track is 88 px or wider, so that label prints whole; a width fixes the track and cuts a longer label. |
189
- | rows | array | yes | Row hierarchy; totalPosition determines resolved display order. |
189
+ | rows | array | yes | Row hierarchy; totalPosition determines resolved display order. Rows: optional label,id; each value, text, status or date column reads the source field named like its id. |
190
190
  | rows[].id | string | yes | Nonempty reference id. |
191
191
  | rows[].label | string | | Visible name; defaults to id. |
192
192
  | rows[].parentId | string | | Flat canonical hierarchy. Alternative: nested `children` sugar. |
@@ -62,7 +62,7 @@ Defaults are the `standard` preset.
62
62
  | color.reference | string | | | | The rails of a slope chart, the two verticals the values are read against. Absent means color.axis. Held to 3:1 on the background once set (contrast-reference). |
63
63
  | color.leader | string | yes | | `'#9AA6B1'` | Leader line ink for labels placed away from their mark. |
64
64
  | color.background | string | yes | | `'#FFFFFF'` | Chart canvas background. Tint stages mix toward this color, so it must be a real surface color. |
65
- | color.series | array | yes | | `["#075A8E","#55BEF7","#2AB1A9","#838CDA","#208668","#9259AC","#680000","#B85800"]` | Categorical ramp, index 0 first. A preset override with one or two colours fills the remaining slots from the preset, skipping colours already authored. A complete theme needs at least three entries. Index 0 also bases the sequential ramps (tints of series 1). |
65
+ | color.series | array | yes | | `["#075A8E","#55BEF7","#2AB1A9","#838CDA","#208668","#9259AC","#680000","#B85800"]` | Categorical ramp, index 0 first. A preset override with one or two colours fills the remaining slots from the preset, skipping colours already authored. A complete theme needs at least one entry; series past the end of the ramp follow color.seriesOverflow. Index 0 also bases the sequential ramps (tints of series 1). |
66
66
  | color.casePair | array | | | | Tornado low/high fills. Absent resolves to neutralLight/series 1. |
67
67
  | color.stack | array | | | `["#075A8E","#4C95C8","#A9C6DC"]` | Fills of the plain series of a stacked or 100% column or bar, strongest on the page first and the quietest last (2 or more). More series than steps share the ramp evenly between its ends; authored fills, colour roles, palettes and highlights win. Absent keeps the series order. |
68
68
  | color.seriesOverflow | string | | `'repeatLast'`, `'cycle'` | `'repeatLast'` | What a series index beyond the ramp does: 'repeatLast' reuses the last entry, 'cycle' restarts the ramp. Default 'repeatLast'. |
@@ -285,7 +285,6 @@ Defaults are the `standard` preset.
285
285
  | table.weights.subtotal | number | | | | Subtotal label weight. Default table.weights.emphasis. |
286
286
  | table.weights.result | number | | | | Result label weight. Default table.weights.emphasis. |
287
287
  | table.weights.block | number | | | | Strong block-column figure weight. Default table.weights.emphasis. |
288
- | table.weights.change | number | | | | Deprecated: accepted and ignored in this release; refused in the next. Remove this key. An authored key warns option-deprecated with removal guidance. |
289
288
  | table.weights.figures | object | | | | Figure weights per presentation kind. |
290
289
  | table.weights.figures.member | number | | | | Member figure weight. Default 400 on a leaf and table.weights.emphasis on a parent. |
291
290
  | table.weights.figures.measure | number | | | | Measure figure weight. Default 400 on a leaf and table.weights.emphasis on a parent. |
@@ -352,7 +351,7 @@ Defaults are the `standard` preset.
352
351
  | good-bad-similar | good and bad are nearly identical |
353
352
  | family-outside-metric-class | warning: the leading family of a type stack is not Inter, Geist, Helvetica, Helvetica Neue, Arial or a metric clone, so text can render wider than measured; pass tables built by `boardplot fonts build`, see docs/FONTS.md |
354
353
 
355
- An unknown key, such as the retired `space.barGap`, comes with a suggest that names it and a JSON Patch that removes it. The CLI, the MCP tools, React and `parseThemeJson` from `boardplot/validate` give the same suggest and patch; `parseThemeJson` throws it as an `invalid-theme` error whose patch paths start at the theme file.
354
+ A retired key, such as `space.barGap`, is accepted for good: the theme draws without it and warns `option-deprecated` with a JSON Patch that removes it. A retired preset name, such as `ibcs`, draws as its successor and warns with a patch that rewrites it. An unknown key that never existed is refused with a suggest that names it and a JSON Patch that removes it. The CLI, the MCP tools, React and `parseThemeJson` from `boardplot/validate` give the same warnings, suggests and patches; `parseThemeJson` throws a refusal as an `invalid-theme` error whose patch paths start at the theme file.
356
355
 
357
356
  A resolved theme is FROZEN, all the way down. `resolveTheme`, the `theme` on a resolved request and the one a React component reads are the same deeply frozen object, so a write to one throws where it is written instead of changing a theme the engine has already judged and cached. A variant is a new object: spread the resolved theme, or pass `overrides` and let the engine merge and check them.
358
357
 
@@ -0,0 +1,198 @@
1
+ # Use cases: Boardplot with an AI agent
2
+
3
+ This page shows how to get finished results from an AI agent such as Claude Code or Codex with Boardplot: a slide deck, an analysis page, a React dashboard, a Word report or a weekly report. Install Boardplot once, then name it in the prompt. The agent writes the chart specs, draws the charts with the Boardplot tools and puts them into the result.
4
+
5
+ Each use case has the same parts: what you get, example prompts to copy, what the agent does, tips for better results, and the limits. The [manual](manual.md) explains the spec, the tools and every option.
6
+
7
+ ## Install
8
+
9
+ - **Claude Code and Codex:** install the plugin. It adds the Boardplot MCP server and the `boardplot-chart` skill. See [AI agents](../README.md#ai-agents) in the README.
10
+ - **Other MCP clients:** install the package globally and add the stdio server `boardplot-mcp`. The same README section has the config.
11
+ - **React apps:** add the package to the project. See [React](../README.md#react) in the README.
12
+
13
+ To check the install, start a new session and ask:
14
+
15
+ ```text
16
+ Use Boardplot to draw a small column chart from sample data as PNG. Tell me the Boardplot version and the file path.
17
+ ```
18
+
19
+ The agent calls `boardplot_render`, writes the PNG and reports the version that every Boardplot tool returns. [The plugin setup](../release/plugin/boardplot-marketplace/plugins/boardplot/SETUP.md) has the full checks and the troubleshooting.
20
+
21
+ **Tips for every use case:**
22
+
23
+ - **Give the data as a file.** Name a CSV or JSON export in the prompt, for example `data/orders.csv`. The agent passes the file to Boardplot as `rowsFile`, so the numbers go from the file to the chart and never pass through the model. See [Rows as data](manual.md#rows-as-data).
24
+ - **Name the destination.** Say "for a slide", "for a Word report" or "for a dashboard". The agent then sets the `target`, which sets the type sizes for that medium. See [Sizing](manual.md#sizing).
25
+ - **Give your brand colours.** Give the hex codes of your highlight and series colours, or a theme file. The agent passes them as a theme, for example `{ "preset": "standard", "overrides": { "color": { "highlight": "#0B5CAD" } } }`. See [the theme reference](reference/theme.md).
26
+ - **Say what each chart should show.** A title that states the finding, such as "Online orders keep growing", gives a better chart than "Orders by week".
27
+
28
+ ## PowerPoint or Keynote deck
29
+
30
+ **You get:** a new deck with Boardplot charts, or your existing deck with its charts replaced by Boardplot charts.
31
+
32
+ **Example prompts:**
33
+
34
+ ```text
35
+ Build a 10-slide quarterly review deck from data/q3-sales.csv. Use Boardplot for every chart.
36
+ ```
37
+
38
+ ```text
39
+ Revise my presentation board-update.pptx and replace all charts with Boardplot charts. Keep the slide text and layout.
40
+ ```
41
+
42
+ ```text
43
+ Add a revenue bridge from FY24 to FY25 to slide 4 of strategy.pptx, drawn with Boardplot, in our colours #0B5CAD and #A9C1D9.
44
+ ```
45
+
46
+ **What the agent does:** Boardplot draws the chart images, and the agent's own PowerPoint tool, such as a pptx skill or a Python library, places them in the file. For each chart, the agent:
47
+
48
+ 1. Reads the data from your file, or from the chart it replaces.
49
+ 2. Calls `boardplot_describe` for the chart type and writes the spec.
50
+ 3. Calls `boardplot_render` with `target: "slide"`, `format: "png"` and the size of the picture box, for example `options.size: { "width": 660, "height": 372, "unit": "pt" }`.
51
+ 4. Places the PNG in the picture box.
52
+
53
+ The PNG has 2 pixels per layout pixel, the default `scale`, and records 192 dpi. PowerPoint, Keynote and Word read the dpi, so they place a scale-2 PNG at the chart's own size, with sharp text. Without a size, a `slide` chart is 888 × 396 pt, the content area of a 16:9 slide.
54
+
55
+ **Tips:**
56
+
57
+ - Give the size of the picture box, or say "full slide". A box that is too small for the chart is refused, and the error's `suggest` names the size that fits, for example "Pass height 372pt.".
58
+ - Ask for SVG instead of PNG when the deck stays in PowerPoint. A `slide` SVG carries its size in pt and stays sharp at any zoom.
59
+ - For a dark slide background, ask for a dark preset such as `standard-dark`. A transparent background keeps the theme's background colour in the label halos.
60
+
61
+ **Limits:**
62
+
63
+ - The charts are pictures. Colleagues cannot edit their data in PowerPoint. To change a chart, ask the agent to draw it again.
64
+ - Keynote: the agent builds a `.pptx` file, and Keynote opens it.
65
+ - Google Slides does not insert SVG files. Use PNG there.
66
+ - A PNG draws with the fonts installed on the machine that renders. For a brand font, see [Custom fonts](FONTS.md).
67
+
68
+ ## Analysis page or Claude artifact
69
+
70
+ **You get:** an analysis written as an HTML page, such as a Claude artifact or a report page, with the charts in the page.
71
+
72
+ **Example prompts:**
73
+
74
+ ```text
75
+ Analyse data/churn.csv: which customer segments churn most, and since when? Write the result as an artifact and draw every chart with Boardplot.
76
+ ```
77
+
78
+ ```text
79
+ Write a one-page HTML report on last month's marketing spend from exports/spend.csv. Use Boardplot for the charts and our colours #0B5CAD and #A9C1D9.
80
+ ```
81
+
82
+ **What the agent does:**
83
+
84
+ 1. Analyses the data and decides which finding each chart shows.
85
+ 2. Calls `boardplot_render` with the data file as `rowsFile` and `return: ["reading", "svg"]`. The answer carries the chart's SVG markup in `svg`.
86
+ 3. Puts each SVG inline in the page. The page needs no script and loads nothing from the network to show the charts.
87
+ 4. Reads the `reading` of each render, the numbers Boardplot computed (totals, differences, growth rates), and uses them in the text, so text and chart agree.
88
+
89
+ **Tips:**
90
+
91
+ - Ask the agent to state the finding in each chart title.
92
+ - Ask it to check the warnings of each render, such as `label-hidden`, before it writes the page.
93
+ - Say the column width of the page if it is not about 720 px. The agent renders at that width instead of shrinking a wider chart.
94
+
95
+ **Limits:**
96
+
97
+ - The SVG is a static image: no hover cards or filters. Those need the React components.
98
+ - The SVG names the theme's font stack and embeds no font. The preset themes use system fonts. A brand web font must be loaded by the page.
99
+
100
+ ## React dashboard
101
+
102
+ **You get:** a new React or Next.js dashboard with Boardplot charts, or an existing dashboard with its charts moved to Boardplot.
103
+
104
+ **Example prompts:**
105
+
106
+ ```text
107
+ Build the sales dashboard in Next.js from the API in src/api/sales.ts and use Boardplot for the chart work.
108
+ ```
109
+
110
+ ```text
111
+ Move the charts of this dashboard from our current chart library to Boardplot. Keep the data loading and the page layout as they are.
112
+ ```
113
+
114
+ **What the agent does:**
115
+
116
+ 1. Calls `boardplot_list` and `boardplot_describe` to choose the chart types and their options.
117
+ 2. Uses the per-type components, such as `ColumnChart` from `boardplot/react/column`, with `size="container"`, so each chart lays out in its card.
118
+ 3. Wraps the page in `BoardplotTheme` with `target="dashboard"` and your theme, so every chart shares one look.
119
+ 4. In Next.js, prepares the charts on the server with `prepareChart`, so the first paint shows the chart.
120
+
121
+ The [React reference](reference/react.md) has each part: [per-type components](reference/react.md#per-type-components), [container sizing](reference/react.md#container-sizing), [theme provider](reference/react.md#theme-provider), [server preparation](reference/react.md#server-preparation), [rows from a query](reference/react.md#rows-from-a-query) and [export](reference/react.md#export).
122
+
123
+ **Tips:**
124
+
125
+ - Ask the agent to draw each chart once with `boardplot_render` before it writes the component. A refusal or a warning then shows up before the page is built.
126
+ - Name the chart for each card if you know it, for example "a waterfall for the margin bridge".
127
+ - When you move a dashboard, ask the agent to list each old chart with the Boardplot type it chose.
128
+
129
+ **Limits:**
130
+
131
+ - React 18 or 19. The package has ES module entries only.
132
+ - `boardplot_list` names chart forms that Boardplot does not draw. The agent keeps those charts in the old library or proposes another type.
133
+ - A parent that takes its width from its content keeps the chart at its fallback width. See [container sizing](reference/react.md#container-sizing).
134
+ - A strict content security policy needs a style nonce. See [content security policy](reference/react.md#content-security-policy).
135
+
136
+ ## Word or PDF report
137
+
138
+ **You get:** a Word document or PDF with print-quality charts.
139
+
140
+ **Example prompts:**
141
+
142
+ ```text
143
+ Write the monthly finance report as a Word document from exports/finance.csv. Draw the charts with Boardplot for print.
144
+ ```
145
+
146
+ ```text
147
+ Turn this analysis into a PDF report on A4. Use Boardplot for all charts, 300 dpi.
148
+ ```
149
+
150
+ **What the agent does:** Boardplot draws the chart images, and the agent's own Word or PDF tool places them in the document. For each chart, the agent calls `boardplot_render` with `target: "print"`, the text column width in mm, for example `options.size: { "width": 160, "unit": "mm" }`, `format: "png"` and `scale: 3.125` for 300 dpi. Word places the PNG at 160 mm.
151
+
152
+ **Tips:**
153
+
154
+ - Give the page format and margins, or the text column width.
155
+ - Ask for the `print` target. A `report` chart in print keeps screen type sizes.
156
+
157
+ **Limits:**
158
+
159
+ - The charts are pictures. Colleagues cannot edit their data in Word.
160
+ - A PNG draws with the fonts installed on the machine that renders.
161
+
162
+ ## Recurring report
163
+
164
+ **You get:** the same report every week or month, such as a weekly business review, with charts from the latest query export.
165
+
166
+ **Example prompts:**
167
+
168
+ ```text
169
+ Every Monday, read exports/orders.csv and write the weekly business review with Boardplot charts. Reuse the chart specs in reports/specs/.
170
+ ```
171
+
172
+ ```text
173
+ Write a script that renders the charts in reports/specs/ from the latest exports with the Boardplot CLI, so our scheduled job can run it without an agent.
174
+ ```
175
+
176
+ **What the agent does:** in the first run, the agent writes one spec per chart and saves it as a template, without data. In each later run, it calls `boardplot_render` with the template, the new export as `rowsFile` and the column names in `columns`. A refused call has `ok: false` and errors with a `path`, a `suggest` sentence and often a `fix`, a JSON Patch the agent applies to the spec. See [Reading errors and warnings](manual.md#reading-errors-and-warnings).
177
+
178
+ A scheduled job needs no agent. It runs the CLI on the same templates:
179
+
180
+ ```sh
181
+ boardplot render weekly-orders.json --rows exports/orders.csv \
182
+ --columns category=week,series=channel,value=orders \
183
+ --format png --out "out/$(date +%F)" --quiet
184
+ ```
185
+
186
+ It writes `out/<date>/weekly-orders.png` and prints `{"ok":true,"outputs":[...]}` with the file path. The CLI exits 1 when it refuses the input, for example a renamed column (`missing-column`), and 2 for an internal error. Let the job fail on a non-zero exit.
187
+
188
+ **Tips:**
189
+
190
+ - Keep the templates in the repository. Each run then draws the same charts with new data.
191
+ - Name every series with its label in the template. A series that only the rows name prints its raw id.
192
+ - Write each run to a dated folder, or pass `--overwrite`. A taken file name otherwise gets `-2`.
193
+
194
+ **Limits:**
195
+
196
+ - The MCP server reads `rowsFile` only from its allowed folders: the client's roots, its working directory, the system temp folder and the folders in `BOARDPLOT_ROWS_ROOTS`. Other paths are refused with `rows-outside-roots`.
197
+ - PNG needs `@resvg/resvg-js`, an optional dependency, or Chrome. On a Linux server, install one of the fonts the manual lists, or the render returns only the SVG with the warning `raster-fonts-missing`. See [Getting a chart with MCP](manual.md#getting-a-chart-with-mcp).
198
+ - A CSV with grouping marks in numbers, such as `1.234,5`, is refused. Export plain numbers.
package/llms.txt CHANGED
@@ -7,6 +7,7 @@ Every chart is one spec, `{ "type", "data", "options", "annotations", "theme" }`
7
7
  ## Start here
8
8
 
9
9
  - [Manual](docs/manual.md): the spec, the tools, the CLI, React, targets and sizing, errors and themes
10
+ - [Use cases](docs/use-cases.md): example prompts and agent steps for a slide deck, an analysis page, a React dashboard, a Word or PDF report and a recurring report
10
11
 
11
12
  ## Chart references
12
13
 
@@ -14,7 +15,7 @@ Every chart is one spec, `{ "type", "data", "options", "annotations", "theme" }`
14
15
  - [bar](docs/reference/bar.md): Horizontal bars per item
15
16
  - [line](docs/reference/line.md): Lines and areas over time
16
17
  - [dimswitch](docs/reference/dimswitch.md): KPIs by one dimension and period, from sums
17
- - [table](docs/reference/table.md): Management table with totals
18
+ - [table](docs/reference/table.md): Management table with totals; rows [label,id]
18
19
  - [waterfall](docs/reference/waterfall.md): Bridge; rows label,value[,type]
19
20
  - [kpi](docs/reference/kpi.md): Single-metric card
20
21
  - [combo](docs/reference/combo.md): Columns with line or area overlays
@@ -40,8 +41,8 @@ Every chart is one spec, `{ "type", "data", "options", "annotations", "theme" }`
40
41
  - [choropleth](docs/reference/choropleth.md): Region map coloured by value
41
42
  - [butterfly](docs/reference/butterfly.md): Two mirrored bar panes
42
43
  - [likert](docs/reference/likert.md): Diverging bars for survey scales
43
- - [histogram](docs/reference/histogram.md): Equal-width bins of raw values
44
- - [box](docs/reference/box.md): Box plots of raw observations
44
+ - [histogram](docs/reference/histogram.md): Equal-width bins of raw values; rows value
45
+ - [box](docs/reference/box.md): Box plots of raw observations; rows category,value[,categoryLabel,date]
45
46
  - [waffle](docs/reference/waffle.md): Share of a whole as a grid of cells
46
47
  - [pyramid](docs/reference/pyramid.md): Mirrored bands on one scale
47
48
  - [diagram](docs/reference/diagram.md): Node and edge diagrams
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "boardplot",
3
- "version": "0.52.5",
3
+ "version": "0.54.0",
4
4
  "description": "Consulting-grade charts for AI agents and React: one JSON spec gives a deterministic SVG, PNG or React chart.",
5
5
  "mcpName": "io.github.boardplot/boardplot",
6
6
  "type": "module",
@@ -346,6 +346,7 @@
346
346
  "docs/manual.md",
347
347
  "docs/reference",
348
348
  "docs/FONTS.md",
349
+ "docs/use-cases.md",
349
350
  "docs/TELEMETRY.md",
350
351
  "NOTICE.md",
351
352
  "THIRD_PARTY_NOTICES.md",