boardplot 0.53.0 → 0.55.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.
- package/CHANGELOG.md +475 -0
- package/README.md +15 -14
- package/dist/{ReaderBox-VOJSJ66R.js → ReaderBox-3FFPHWSI.js} +15 -10
- package/dist/{annotateEngine-DLMFJZ67.js → annotateEngine-ET4DM2OK.js} +5 -1
- package/dist/build-identity.json +3 -3
- package/dist/{chunk-SS42FJVN.js → chunk-2ALFFOKB.js} +460 -148
- package/dist/chunk-2BP6X5GX.js +125 -0
- package/dist/chunk-2C4SYWZ3.js +25 -0
- package/dist/{chunk-7X2ZYVAX.js → chunk-2TAK2ELB.js} +3 -3
- package/dist/{chunk-XZOHR765.js → chunk-2YNF6AHH.js} +5 -5
- package/dist/{chunk-DDI2W4TR.js → chunk-32IKJMUF.js} +3 -3
- package/dist/{chunk-ADKCLH3Z.js → chunk-33FCWTGT.js} +1 -1
- package/dist/{chunk-AQROQDLR.js → chunk-37A6CLR5.js} +1729 -196
- package/dist/{chunk-DCTCUZ5L.js → chunk-3AJY353W.js} +3 -3
- package/dist/chunk-3B3CFJ2H.js +48 -0
- package/dist/{chunk-M4EUXOLU.js → chunk-3B3K7TD5.js} +83 -9
- package/dist/{chunk-QSXK6PJL.js → chunk-3C24WWUQ.js} +1 -1
- package/dist/{chunk-BWTX7LUG.js → chunk-3L2VXXM4.js} +9 -4
- package/dist/{chunk-DO5OZJAO.js → chunk-3OZRODC4.js} +39 -21
- package/dist/{chunk-A6CQPJWR.js → chunk-3XOWXLLQ.js} +6 -7
- package/dist/{chunk-TBGUEF3M.js → chunk-3ZAH24P6.js} +164 -51
- package/dist/{chunk-TGK6KUGN.js → chunk-4CJ6UCX4.js} +33 -16
- package/dist/{chunk-VDAZPGR2.js → chunk-4DZFR52I.js} +2 -2
- package/dist/{chunk-323YZWYJ.js → chunk-4WT3T5SH.js} +124 -54
- package/dist/{chunk-O3S2KNIW.js → chunk-4X3HNETE.js} +3 -3
- package/dist/{chunk-FBB4BWKN.js → chunk-4Y7BA2NW.js} +4 -4
- package/dist/{chunk-AWTG3RFF.js → chunk-4YHZSPAJ.js} +6 -7
- package/dist/{chunk-CNX7EGSU.js → chunk-5DMHMQFP.js} +7 -7
- package/dist/{chunk-BPKXEMRE.js → chunk-5SHI57XD.js} +45 -14
- package/dist/{chunk-H63XQ3OO.js → chunk-5SLJGRUO.js} +139 -47
- package/dist/{chunk-5LYXD6ME.js → chunk-5UVJKB7L.js} +137 -70
- package/dist/{chunk-ZNHFLJSY.js → chunk-63L35UCI.js} +6 -6
- package/dist/{chunk-YCNLQYTC.js → chunk-6C64IBOG.js} +5 -5
- package/dist/{chunk-N3TPMXS3.js → chunk-6D4EO3S7.js} +5 -5
- package/dist/chunk-6H3OSHEY.js +25 -0
- package/dist/chunk-6WZZADRL.js +25 -0
- package/dist/{chunk-6RBTTCQD.js → chunk-75TWO5B2.js} +89 -57
- package/dist/chunk-7ADUVRG5.js +14 -0
- package/dist/{chunk-3QWZAEW5.js → chunk-7DAH2E4T.js} +4 -3
- package/dist/{chunk-VKQNDOAI.js → chunk-7FKY6YWU.js} +11 -7
- package/dist/{chunk-NSSNYY6Y.js → chunk-7GVYMGLK.js} +6 -3
- package/dist/{chunk-KZS46KDY.js → chunk-7Q2WV6D2.js} +3 -3
- package/dist/{chunk-JFBEAUJ6.js → chunk-7Q37C6GZ.js} +1 -1
- package/dist/{chunk-SPTPFY4S.js → chunk-7UPZPFHQ.js} +41 -34
- package/dist/{chunk-V6O6KVOA.js → chunk-7Z73MM35.js} +14 -6
- package/dist/{chunk-MJZHFH5R.js → chunk-AB35GVPG.js} +80 -31
- package/dist/{chunk-MYMT5KJL.js → chunk-AF7EB6N6.js} +151 -84
- package/dist/chunk-AIU4GZV5.js +24 -0
- package/dist/{chunk-KSJVENRU.js → chunk-AM2CG7VX.js} +13 -3
- package/dist/{chunk-XN4ARQ2W.js → chunk-APQPYM2Z.js} +3 -3
- package/dist/{chunk-AHQ4L3BE.js → chunk-AZM4YNRE.js} +2 -2
- package/dist/{chunk-XXOHXA3A.js → chunk-B3AXM3MT.js} +2 -2
- package/dist/{chunk-BWGRWGVA.js → chunk-BDGLMWPO.js} +14 -14
- package/dist/{chunk-EHBB2Z4D.js → chunk-BFFPYT3Y.js} +13 -7
- package/dist/{chunk-2QT5ZUHO.js → chunk-BGJRCG7N.js} +135 -114
- package/dist/{chunk-RNOJSEES.js → chunk-BK6P6KMW.js} +1 -1
- package/dist/{chunk-XB4KZ6WO.js → chunk-BSATR6ZO.js} +40 -13
- package/dist/{chunk-4UVW5WU6.js → chunk-BVYIKLQ5.js} +1 -1
- package/dist/chunk-BWVNCLUS.js +19 -0
- package/dist/{chunk-LCWJS34U.js → chunk-CKNOLGRR.js} +1 -1
- package/dist/chunk-CLGUFVHM.js +24 -0
- package/dist/{chunk-NY5NUFDZ.js → chunk-COQEHO7B.js} +3 -3
- package/dist/{chunk-3EZRM4YM.js → chunk-CPGASWNN.js} +25 -1
- package/dist/{chunk-GTG3IGLF.js → chunk-CVIW2MV4.js} +284 -150
- package/dist/chunk-CYKIX3IQ.js +24 -0
- package/dist/{chunk-DIHUGBZO.js → chunk-CZ3WCG55.js} +5 -4
- package/dist/{chunk-DRTA6JG5.js → chunk-D2B3KP35.js} +26 -15
- package/dist/{chunk-6OCR6ITN.js → chunk-D2QMNHCC.js} +4 -5
- package/dist/{chunk-EUADDXAV.js → chunk-D7G27EYZ.js} +4 -4
- package/dist/{chunk-NOSDEJ3K.js → chunk-DB2JKPOX.js} +806 -69
- package/dist/{chunk-2CVH5E57.js → chunk-DEYAI662.js} +60 -13
- package/dist/{chunk-HA4IPWMM.js → chunk-DRHQG44U.js} +23 -5
- package/dist/{chunk-WZGJSQKN.js → chunk-DZ3S4RPI.js} +15 -1
- package/dist/{chunk-B6GFKYBZ.js → chunk-E44W4EEG.js} +8 -5
- package/dist/{chunk-YCRGWQBS.js → chunk-E5OEWMNX.js} +66 -12
- package/dist/chunk-E6HDUEGK.js +26 -0
- package/dist/{chunk-A7IEVBYI.js → chunk-E76U5H52.js} +1 -5
- package/dist/{chunk-NKIYLFXZ.js → chunk-EAR43REB.js} +213 -73
- package/dist/{chunk-NQDVMUHX.js → chunk-EBC5TMI2.js} +29 -8
- package/dist/chunk-EBVJCVXL.js +25 -0
- package/dist/chunk-EC2PGJ64.js +24 -0
- package/dist/chunk-EGPXEY2K.js +24 -0
- package/dist/{chunk-CUVUDK4O.js → chunk-EQRFSVDD.js} +2 -1
- package/dist/{chunk-CYOJZ3GQ.js → chunk-EW47LNWH.js} +228 -58
- package/dist/{chunk-7EVIIADO.js → chunk-EXDMYV5W.js} +3 -1
- package/dist/{chunk-VJ3FCGQF.js → chunk-EZZ533MH.js} +1 -1
- package/dist/{chunk-IBXXZVG7.js → chunk-F5V7YFKS.js} +11 -8
- package/dist/{chunk-COYOTQC2.js → chunk-F6CVYNDY.js} +5 -4
- package/dist/{chunk-66RFKRGO.js → chunk-F6OLHND5.js} +2 -2
- package/dist/chunk-FI5EXISD.js +27 -0
- package/dist/{chunk-CAQ5P4VN.js → chunk-FQF7GSJK.js} +46 -27
- package/dist/{chunk-XJP5DKIL.js → chunk-FS6ZE5TG.js} +2 -2
- package/dist/{chunk-7CTKTIPF.js → chunk-G63WXSQP.js} +75 -34
- package/dist/{chunk-3A2IEBCN.js → chunk-GCSCHK5Y.js} +4 -18
- package/dist/{chunk-REOPXBUR.js → chunk-GD5TYS5R.js} +32 -21
- package/dist/{chunk-RGZGLKFB.js → chunk-GDVR3XHT.js} +418 -62
- package/dist/{chunk-XQCQZBGX.js → chunk-GDZI5ZJ7.js} +1 -1
- package/dist/{chunk-P5RNWMZC.js → chunk-GFIT3FRE.js} +277 -291
- package/dist/chunk-GM2HIU6C.js +24 -0
- package/dist/{chunk-DOFYKPTC.js → chunk-GMJFCBR6.js} +1 -1
- package/dist/{chunk-CRNMNZJD.js → chunk-H3AEYPRP.js} +66 -43
- package/dist/{chunk-BUPLB3EX.js → chunk-H3IBJQ5A.js} +6 -2
- package/dist/chunk-H4VDQ7OE.js +24 -0
- package/dist/{chunk-J6I2YFJH.js → chunk-H5L2P2GO.js} +6 -4
- package/dist/{chunk-X4YNDLVA.js → chunk-HFRQLMKK.js} +12 -7
- package/dist/{chunk-YG5GUELW.js → chunk-HGT3UKDW.js} +91 -48
- package/dist/{chunk-CWDHCSL2.js → chunk-HJRNBKIT.js} +801 -76
- package/dist/{chunk-FV3VF36K.js → chunk-HLOXWM2O.js} +119 -63
- package/dist/{chunk-3SQCCESO.js → chunk-HR2BKLS3.js} +113 -128
- package/dist/{chunk-S4QSJAGY.js → chunk-HZUAEMN5.js} +1 -1
- package/dist/{chunk-QWXWVPNE.js → chunk-IF2ZABAM.js} +2 -2
- package/dist/chunk-IF76JRXT.js +24 -0
- package/dist/chunk-IGNBQT23.js +248 -0
- package/dist/{chunk-DCCJRLAJ.js → chunk-IGVAWAOK.js} +31 -96
- package/dist/{chunk-DDCB7ZA5.js → chunk-ILFQ75N4.js} +253 -141
- package/dist/chunk-INHDHZNP.js +8 -0
- package/dist/chunk-IOKWBUQP.js +25 -0
- package/dist/{chunk-33PB4V6K.js → chunk-IQDMZ33D.js} +20 -9
- package/dist/{chunk-IDDA5INB.js → chunk-IVRYF7QA.js} +7 -4
- package/dist/{chunk-L7RHB734.js → chunk-J5PL6JLL.js} +1 -1
- package/dist/chunk-JBMWRXDS.js +24 -0
- package/dist/{chunk-RPIW5T55.js → chunk-JKOEHRGV.js} +1 -1
- package/dist/chunk-JMGB444D.js +26 -0
- package/dist/chunk-JU7S52HI.js +26 -0
- package/dist/{chunk-BBL3R5YZ.js → chunk-JXBZIJCG.js} +1 -1
- package/dist/{chunk-WLZ54FWG.js → chunk-JYAZPMSA.js} +70 -1
- package/dist/chunk-K5S3K6QK.js +24 -0
- package/dist/{chunk-5LGSRWFC.js → chunk-KAYBRD4F.js} +3 -3
- package/dist/{chunk-N3G2FYDL.js → chunk-KC52E5G4.js} +31 -20
- package/dist/{chunk-LNKY5Z2X.js → chunk-KDSYZLF6.js} +2 -3
- package/dist/{chunk-B67K6OWJ.js → chunk-KEDNHCGB.js} +4 -4
- package/dist/chunk-KFGZMHIB.js +28 -0
- package/dist/{chunk-KPKXJYQH.js → chunk-KHRAJDBM.js} +1 -1
- package/dist/{chunk-2V6CLH33.js → chunk-KND4OM4B.js} +117 -102
- package/dist/{chunk-X6SUFTD7.js → chunk-KZH2QI6S.js} +2 -2
- package/dist/{chunk-IYEFEBRN.js → chunk-KZJ5VM6E.js} +14 -3
- package/dist/{chunk-JSEYUJUQ.js → chunk-LA5OYJ5P.js} +146 -69
- package/dist/{chunk-MVV6RQMG.js → chunk-LAVVML3X.js} +33 -9
- package/dist/{chunk-4G2O2ZPJ.js → chunk-LD4LML5P.js} +10 -8
- package/dist/{chunk-OURX73UJ.js → chunk-LF6RTFNK.js} +13 -11
- package/dist/{chunk-SVZDXFPX.js → chunk-LFUJTEJO.js} +100 -36
- package/dist/{chunk-53OYF4ZT.js → chunk-LHKDZAWN.js} +16 -8
- package/dist/{chunk-GCBOHVDZ.js → chunk-LLDKKEUD.js} +1 -1
- package/dist/{chunk-VTEV3WVF.js → chunk-LRCO4G7C.js} +314 -92
- package/dist/{chunk-5HECRVXJ.js → chunk-LSF76AS3.js} +7 -3
- package/dist/chunk-M427S3G7.js +25 -0
- package/dist/{chunk-ZMF7WEGG.js → chunk-MEMPP7VZ.js} +3 -3
- package/dist/{chunk-D7SHZDA3.js → chunk-MJMOKPTF.js} +186 -167
- package/dist/chunk-MLGEBFEX.js +47 -0
- package/dist/chunk-MLW72KWN.js +24 -0
- package/dist/chunk-MQYIBGZE.js +19 -0
- package/dist/{chunk-SDSONLMZ.js → chunk-MTRV3BJL.js} +301 -130
- package/dist/{chunk-H4H4O62O.js → chunk-N5HN5QGH.js} +1 -1
- package/dist/chunk-N5TZL74Y.js +53 -0
- package/dist/chunk-N7N5NIAU.js +211 -0
- package/dist/{chunk-XN7MQO45.js → chunk-NA6WLZ66.js} +66 -26
- package/dist/{chunk-B54RN2FD.js → chunk-NB7M4KX4.js} +99 -56
- package/dist/{chunk-ADWSGPH5.js → chunk-NCZWLV7T.js} +4 -4
- package/dist/{chunk-C54QLNE4.js → chunk-NGA7ICG4.js} +1 -1
- package/dist/{chunk-TJSND556.js → chunk-NHYKSPL4.js} +155 -100
- package/dist/chunk-NMTWUYUF.js +30 -0
- package/dist/{chunk-Q3CV2JJ2.js → chunk-NOCIN2EM.js} +425 -251
- package/dist/{chunk-SKRSCTT5.js → chunk-NUCYUKVH.js} +3 -3
- package/dist/{chunk-S32YYDIB.js → chunk-NVGAEQ6M.js} +4 -3
- package/dist/{chunk-N23YFPPI.js → chunk-O2KKQNGW.js} +4 -1
- package/dist/chunk-O36WX56O.js +13 -0
- package/dist/{chunk-FF23FYQD.js → chunk-O4WJWHCH.js} +187 -85
- package/dist/{chunk-H67RTX46.js → chunk-O6NJDRXE.js} +2 -2
- package/dist/{chunk-2DOR5SS6.js → chunk-O7DVW3IE.js} +141 -68
- package/dist/{chunk-2VWJ5BGO.js → chunk-O7W35PT3.js} +13 -12
- package/dist/{chunk-MF6IVSBJ.js → chunk-ODZJ4LW7.js} +6 -3
- package/dist/{chunk-FG6EDGMI.js → chunk-OHGEDG46.js} +1 -1
- package/dist/{chunk-HZI56ASJ.js → chunk-OJ2BPQGQ.js} +11 -5
- package/dist/chunk-ONKSGT2M.js +28 -0
- package/dist/{chunk-2WNYRWHG.js → chunk-OOFSQ5AS.js} +1 -1
- package/dist/{chunk-IYMI7YI4.js → chunk-OY2UJ4XK.js} +64 -42
- package/dist/{chunk-6Y7EXYLR.js → chunk-P6TA7M3G.js} +102 -32
- package/dist/{chunk-MQFCG4KS.js → chunk-PQYJZMCR.js} +99 -92
- package/dist/{chunk-BWLOXQDV.js → chunk-PYV6ZIR6.js} +41 -14
- package/dist/chunk-PZ46S2SY.js +69 -0
- package/dist/{chunk-IL5T7I2A.js → chunk-Q3E74U2W.js} +4 -4
- package/dist/{chunk-TXS3U77A.js → chunk-QBJDHFJJ.js} +4 -2
- package/dist/chunk-QBRRJ5OR.js +24 -0
- package/dist/{chunk-P6KZIZDV.js → chunk-QEP3X3OV.js} +141 -79
- package/dist/{chunk-CCCEBIUZ.js → chunk-QKWBDH2L.js} +2 -2
- package/dist/{chunk-QY5ZKUWY.js → chunk-QOWE55RR.js} +9 -3
- package/dist/{chunk-SREWFAAJ.js → chunk-QRVIS2QB.js} +6 -5
- package/dist/chunk-R27IDIJI.js +24 -0
- package/dist/{chunk-G5FMTRG5.js → chunk-RNIYG6PI.js} +2 -2
- package/dist/{chunk-PEUSKIFV.js → chunk-RO2PSSAI.js} +13 -23
- package/dist/{chunk-ZQF34VPS.js → chunk-ROLR7HRB.js} +12 -6
- package/dist/{chunk-YF2PYLC4.js → chunk-RSCRIWAH.js} +1 -1
- package/dist/{chunk-L6DJ4ZY5.js → chunk-RTXRIZYU.js} +370 -134
- package/dist/{chunk-VK5ZDV67.js → chunk-RUWNG2JC.js} +6 -5
- package/dist/chunk-RYPJB3RO.js +132 -0
- package/dist/{chunk-DAVHGK27.js → chunk-S7NRL66K.js} +46 -23
- package/dist/{chunk-VABRPZVC.js → chunk-SA46CNMS.js} +5 -1
- package/dist/{chunk-3H2W76TB.js → chunk-SBR2RLEQ.js} +72 -38
- package/dist/chunk-SC42DPNV.js +24 -0
- package/dist/{chunk-27QADBDV.js → chunk-SFG7NG23.js} +20 -3
- package/dist/{chunk-AG2CJ4JY.js → chunk-SNQ7D5R7.js} +18 -1
- package/dist/{chunk-QTZVVZ2A.js → chunk-SPSGUFTI.js} +11 -3
- package/dist/chunk-SRUV7AT6.js +51 -0
- package/dist/{chunk-F6CNPC4L.js → chunk-SZXKV3BX.js} +1 -1
- package/dist/{chunk-UB6ODJHO.js → chunk-T5Y4HXYO.js} +7 -4
- package/dist/{chunk-EJPVVGD7.js → chunk-U7W7GYXP.js} +37 -37
- package/dist/{chunk-LFX7W4B7.js → chunk-UDKYY27B.js} +1 -1
- package/dist/{chunk-24BHMKDD.js → chunk-UF3HSFAE.js} +25 -2
- package/dist/chunk-UIYXMPDW.js +24 -0
- package/dist/{chunk-N7J7CZS6.js → chunk-UNMIUILK.js} +1 -1
- package/dist/chunk-V3MSLNSD.js +24 -0
- package/dist/chunk-V634AXDM.js +31 -0
- package/dist/{chunk-57ZGVAU3.js → chunk-V7F4F6JA.js} +39 -6
- package/dist/{chunk-4X66BTP5.js → chunk-VBVG6NEL.js} +6 -6
- package/dist/chunk-VL7WLE4H.js +24 -0
- package/dist/chunk-W45AR6EW.js +94 -0
- package/dist/{chunk-RL3NUWMY.js → chunk-WALYNKBN.js} +444 -101
- package/dist/{chunk-DYS7EIXY.js → chunk-WAPCCJUB.js} +70 -26
- package/dist/{chunk-FBAYZSFC.js → chunk-WDIVAU5U.js} +241 -118
- package/dist/{chunk-EHVESNLV.js → chunk-WEMUCDPK.js} +1 -1
- package/dist/{chunk-N73IBH55.js → chunk-WFSOKGGA.js} +2 -2
- package/dist/{chunk-WI5ITCOH.js → chunk-WG5CJGLU.js} +2 -2
- package/dist/{chunk-S6UX7KB6.js → chunk-WQT6HIIY.js} +18 -17
- package/dist/{chunk-MZL6LGKO.js → chunk-WSJDLZSZ.js} +78 -47
- package/dist/{chunk-XJI6SWFS.js → chunk-WWIY6BBY.js} +77 -38
- package/dist/{chunk-33PLBIMA.js → chunk-WXJ5MHLH.js} +3 -2
- package/dist/chunk-X3YP4DUV.js +76 -0
- package/dist/{chunk-MBKZYJRC.js → chunk-X7XTIM6U.js} +50 -36
- package/dist/chunk-XJQXFVXY.js +24 -0
- package/dist/{chunk-KZJOV4QW.js → chunk-XMN3Z43K.js} +5 -5
- package/dist/{chunk-2ND7ZITT.js → chunk-XPOMQWXY.js} +90 -70
- package/dist/chunk-XVUQMZWV.js +24 -0
- package/dist/chunk-XYYRHGQI.js +24 -0
- package/dist/{chunk-NHQGRKEA.js → chunk-XZLU3G23.js} +7 -7
- package/dist/chunk-Y2CAIAUI.js +24 -0
- package/dist/{chunk-QO6HEXIZ.js → chunk-Y3L655X6.js} +6 -6
- package/dist/{chunk-QKL7IY42.js → chunk-Y54LU4CU.js} +1 -1
- package/dist/chunk-YGTNVZJE.js +89 -0
- package/dist/{chunk-LIWLBLCT.js → chunk-YLC42C3M.js} +1 -1
- package/dist/{chunk-SGD3ZHID.js → chunk-YOOHNQ3L.js} +15 -4
- package/dist/{chunk-DRW6KGBK.js → chunk-YTCIGJUU.js} +116 -42
- package/dist/{chunk-ULTSSIOU.js → chunk-YV5KYGE5.js} +1 -1
- package/dist/{chunk-4RRNJLCM.js → chunk-YXM4W3TN.js} +146 -67
- package/dist/{chunk-2L2Q53EP.js → chunk-Z2X4JQNY.js} +81 -21
- package/dist/{chunk-LS7HVBI7.js → chunk-Z5V6ZM76.js} +3 -3
- package/dist/{chunk-DU4A5AOY.js → chunk-Z7NHFNH3.js} +165 -79
- package/dist/{chunk-HOAH5XBR.js → chunk-ZBSNF5F7.js} +208 -62
- package/dist/chunk-ZGHBDMYF.js +24 -0
- package/dist/{chunk-TM4OC53S.js → chunk-ZHFUMVW7.js} +2 -1
- package/dist/{chunk-TWOREVKJ.js → chunk-ZLYQWUNR.js} +84 -50
- package/dist/chunk-ZTMZOKVC.js +61 -0
- package/dist/cli/index.js +3 -3
- package/dist/{core-LA6XDYG7.js → core-2SICIP63.js} +6 -1
- package/dist/{core-5HQBPCHL.js → core-2YTKFBNZ.js} +6 -1
- package/dist/{core-FVR3WZEC.js → core-3647Z25D.js} +5 -1
- package/dist/{core-GES44OTS.js → core-3IJPBNGC.js} +3 -1
- package/dist/{core-KKQS3WI2.js → core-6HMJHFRR.js} +9 -1
- package/dist/{core-QY7AVIKZ.js → core-7JKE7H32.js} +6 -1
- package/dist/{core-WUQVFARS.js → core-BMY7OL76.js} +6 -1
- package/dist/{core-4BZQQSHS.js → core-CAL7YNFC.js} +4 -1
- package/dist/{core-NP4VHWXL.js → core-CBEGB2NO.js} +4 -1
- package/dist/{core-C6YUSTZI.js → core-CLLIG7ZU.js} +3 -1
- package/dist/{core-MJ7JWQT5.js → core-CTZLHGXE.js} +2 -1
- package/dist/{core-UHECQHJ2.js → core-EYJ3WJK4.js} +4 -1
- package/dist/{core-ETAGQBZO.js → core-FX7HRKTF.js} +3 -1
- package/dist/{core-Z2F3IGSR.js → core-GQC6VDW5.js} +4 -1
- package/dist/{core-IKD3EE3S.js → core-GRWI22NS.js} +4 -1
- package/dist/{core-OJUQLIQ5.js → core-H7KMWYP5.js} +5 -1
- package/dist/{core-WGM4XUN3.js → core-HJUGHAX7.js} +3 -1
- package/dist/{core-V5FV4NWL.js → core-JMYMIH6Z.js} +9 -1
- package/dist/{core-GGQREDSI.js → core-KEB5PBCO.js} +6 -1
- package/dist/{core-6RYHWUJO.js → core-MEC6A5DD.js} +5 -1
- package/dist/{core-GCTFVYMH.js → core-MV6KGAUV.js} +4 -1
- package/dist/{core-MR52YBRX.js → core-NTWHFDM4.js} +3 -1
- package/dist/{core-SBQMHWTA.js → core-OIC5KJSD.js} +7 -1
- package/dist/{core-Q6VLFFYC.js → core-OWCTIPHD.js} +6 -1
- package/dist/{core-NSIJEKLI.js → core-PMYCLXT7.js} +6 -1
- package/dist/{core-EEB7HTCL.js → core-PTRQPQTO.js} +4 -1
- package/dist/{core-3VCCUFVX.js → core-QABTVASG.js} +3 -1
- package/dist/{core-AJTVU6X7.js → core-RPQBIOU4.js} +5 -1
- package/dist/{core-4VT4MHNB.js → core-SKRADU7T.js} +4 -1
- package/dist/{core-EFMVDWNH.js → core-T2KHX5LG.js} +4 -1
- package/dist/{core-PB3VUQSS.js → core-T4ZH3FAU.js} +3 -1
- package/dist/{core-JM4R426L.js → core-UAY2G7LN.js} +2 -1
- package/dist/{core-NQLNZDX5.js → core-ULZ7XUQP.js} +5 -1
- package/dist/{core-MLROKJ2M.js → core-VBR253SM.js} +4 -1
- package/dist/{core-7BZJCIXN.js → core-VMIBBHXI.js} +4 -1
- package/dist/{core-5535KXRD.js → core-XMTKUXLO.js} +4 -1
- package/dist/{core-HRYOV6QD.js → core-YEFGEW3Z.js} +4 -1
- package/dist/{dataTable-3CPPIHB3.js → dataTable-2ZXK54TP.js} +4 -2
- package/dist/{engine-FXFBCWHB.js → engine-HGXSWGOI.js} +27 -27
- package/dist/fixtures.js +7 -1
- package/dist/{fontTables-WYCZNRE7.js → fontTables-ZPZQ6IR3.js} +1 -1
- package/dist/fonts.js +2 -1
- package/dist/geo/dach.js +3 -1
- package/dist/geo/de-states.js +3 -1
- package/dist/geo/eu27.js +3 -1
- package/dist/geo/europe.js +3 -1
- package/dist/geo/index.js +4 -2
- package/dist/geo/us-states.js +3 -1
- package/dist/geo/world.js +3 -1
- package/dist/index.js +31 -26
- package/dist/{main-YLKBTHJP.js → main-PVT6FMGC.js} +55 -24
- package/dist/mcp/server.js +51 -23
- package/dist/{module-SVEW5ZUE.js → module-ZSR7KTAS.js} +1 -1
- package/dist/react/bar.js +7 -1
- package/dist/react/bartable.js +7 -1
- package/dist/react/box.js +7 -1
- package/dist/react/bullet.js +5 -1
- package/dist/react/butterfly.js +6 -1
- package/dist/react/choropleth.js +5 -1
- package/dist/react/cohort.js +5 -1
- package/dist/react/column.js +10 -1
- package/dist/react/combo.js +4 -1
- package/dist/react/creative.js +3 -1
- package/dist/react/diagram.js +4 -1
- package/dist/react/dimswitch.js +5 -1
- package/dist/react/dot.js +10 -1
- package/dist/react/export.js +34 -31
- package/dist/react/funnel.js +5 -1
- package/dist/react/gantt.js +4 -1
- package/dist/react/grid.js +5 -1
- package/dist/react/heatmap.js +5 -1
- package/dist/react/histogram.js +7 -1
- package/dist/react/index.js +95 -90
- package/dist/react/kpi.js +3 -1
- package/dist/react/likert.js +8 -1
- package/dist/react/line.js +5 -1
- package/dist/react/mekko.js +6 -1
- package/dist/react/pareto.js +4 -1
- package/dist/react/pie.js +6 -1
- package/dist/react/prepare.js +34 -28
- package/dist/react/pvm.js +5 -1
- package/dist/react/pyramid.js +6 -1
- package/dist/react/sankey.js +5 -1
- package/dist/react/scatter.js +5 -1
- package/dist/react/slope.js +7 -1
- package/dist/react/sparkline.js +5 -1
- package/dist/react/spec.js +25 -31
- package/dist/react/status.js +4 -1
- package/dist/react/story.js +7 -4
- package/dist/react/table.js +5 -1
- package/dist/react/theme.js +7 -3
- package/dist/react/tilemap.js +5 -1
- package/dist/react/treemap.js +4 -1
- package/dist/react/variance.js +6 -1
- package/dist/react/waffle.js +4 -1
- package/dist/react/waterfall.js +5 -1
- package/dist/{resvg-ZOVDIZTV.js → resvg-VB7S5HRF.js} +1 -1
- package/dist/rows.js +2 -3
- package/dist/{rowsModule-YVLAROIP.js → rowsModule-JTDPTWXG.js} +3 -1
- package/dist/{schema-BNRNHGHQ.js → schema-2M3LXR35.js} +3 -1
- package/dist/{schema-5HA5DSYN.js → schema-2Q7IJ22V.js} +3 -1
- package/dist/{schema-FA6XIHTW.js → schema-3OLBUVMZ.js} +3 -1
- package/dist/{schema-F3WYTR65.js → schema-3XLO43SX.js} +3 -1
- package/dist/{schema-RTWES6NR.js → schema-5753NOAL.js} +3 -1
- package/dist/{schema-S3TCLTYD.js → schema-5KHDHTIX.js} +3 -1
- package/dist/{schema-WOSEZNKG.js → schema-76XRTBCJ.js} +3 -1
- package/dist/{schema-MPXZNWV3.js → schema-7CPGNCOL.js} +3 -1
- package/dist/{schema-2KIHLTYI.js → schema-BKHQ3ZUH.js} +3 -1
- package/dist/{schema-JB2H6KPA.js → schema-BMD5JR3Y.js} +3 -1
- package/dist/{schema-5BKQV56C.js → schema-BOGTPL7F.js} +3 -1
- package/dist/{schema-ORTRMYI6.js → schema-BUTNGYTT.js} +3 -1
- package/dist/{schema-SWWMOLOR.js → schema-C7NVOQNV.js} +6 -3
- package/dist/{schema-O4YNAGIY.js → schema-FNTAAXQ3.js} +3 -1
- package/dist/{schema-7TLSFG6M.js → schema-FYULDJFB.js} +3 -1
- package/dist/{schema-NHNQK6XO.js → schema-FZKNIAIH.js} +3 -1
- package/dist/{schema-B7CZPPB4.js → schema-G2PLJCYL.js} +3 -1
- package/dist/{schema-ZUUUY3QS.js → schema-GGG2VOY7.js} +3 -2
- package/dist/{schema-6RYJS2GM.js → schema-GLN7IHSH.js} +3 -1
- package/dist/{schema-OJCML6LV.js → schema-HIDW4BA4.js} +3 -1
- package/dist/{schema-S36SRYGO.js → schema-J53LCIY3.js} +3 -1
- package/dist/{schema-2K6C3U24.js → schema-KIJA53MB.js} +4 -1
- package/dist/{schema-O7AKK232.js → schema-LEQNLBNG.js} +2 -1
- package/dist/{schema-AMFRKUFS.js → schema-LHMEXFLY.js} +3 -1
- package/dist/{schema-65FOKNHK.js → schema-MT6NA5AL.js} +3 -3
- package/dist/{schema-4S5CXHAO.js → schema-MUTAVQMI.js} +3 -1
- package/dist/{schema-Y6KBWUUR.js → schema-NVMEOHAW.js} +3 -1
- package/dist/{schema-6OHZWHUI.js → schema-TA3MSAPQ.js} +3 -1
- package/dist/{schema-YQYTLKSW.js → schema-U26KG42U.js} +3 -1
- package/dist/{schema-E4MRCGPZ.js → schema-UHHFTVGS.js} +3 -1
- package/dist/{schema-4HY2MWZC.js → schema-V3BPW4LA.js} +3 -1
- package/dist/{schema-PJ6P52BC.js → schema-WIZ2TZAT.js} +3 -1
- package/dist/{schema-NN6UPDPW.js → schema-WZLWHOMY.js} +3 -1
- package/dist/{schema-6W4M3WJ4.js → schema-XATDKZPW.js} +3 -1
- package/dist/{schema-5NKJPSBD.js → schema-XHKSGMUH.js} +3 -1
- package/dist/{schema-GZNOW4LX.js → schema-XKY2EQFH.js} +3 -1
- package/dist/{schema-HEIDGCSL.js → schema-ZE7WUNFS.js} +3 -1
- package/dist/{specValidation-VNWIKLHH.js → specValidation-X5XJBPTP.js} +4 -1
- package/dist/theme.js +5 -2
- package/dist/{themeShapeRules-2D3KWSPQ.js → themeShapeRules-PW4BQHKL.js} +1 -1
- package/dist/types/core/a11y/recordsShared.d.ts +4 -0
- package/dist/types/core/annotate.d.ts +39 -0
- package/dist/types/core/annotateArms.d.ts +1 -1
- package/dist/types/core/annotateEngine.d.ts +14 -0
- package/dist/types/core/axis.d.ts +2 -0
- package/dist/types/core/calendarLabels.d.ts +15 -0
- package/dist/types/core/charts/band/stacks.d.ts +71 -2
- package/dist/types/core/charts/bartable/types.d.ts +10 -0
- package/dist/types/core/charts/choropleth/index.d.ts +7 -0
- package/dist/types/core/charts/choropleth/layout.d.ts +7 -0
- package/dist/types/core/charts/choropleth/schema.d.ts +36 -0
- package/dist/types/core/charts/cohort/types.d.ts +8 -1
- package/dist/types/core/charts/column/layout.d.ts +1 -1
- package/dist/types/core/charts/column/model.d.ts +4 -0
- package/dist/types/core/charts/combo/endpoints.d.ts +1 -1
- package/dist/types/core/charts/creative/types.d.ts +1 -1
- package/dist/types/core/charts/dimswitch/compile.d.ts +2 -0
- package/dist/types/core/charts/dimswitch/types.d.ts +8 -0
- package/dist/types/core/charts/grid/normalize.d.ts +18 -1
- package/dist/types/core/charts/heatmap/fixtures.d.ts +2 -2
- package/dist/types/core/charts/histogram/types.d.ts +14 -2
- package/dist/types/core/charts/likert/layout.d.ts +14 -9
- package/dist/types/core/charts/logAxis.d.ts +55 -0
- package/dist/types/core/charts/pvm/types.d.ts +6 -0
- package/dist/types/core/charts/pyramid/types.d.ts +7 -4
- package/dist/types/core/charts/sankey/types.d.ts +3 -1
- package/dist/types/core/charts/scatter/clamp.d.ts +155 -0
- package/dist/types/core/charts/scatter/frontier.d.ts +21 -0
- package/dist/types/core/charts/scatter/index.d.ts +9 -0
- package/dist/types/core/charts/scatter/layout.d.ts +26 -0
- package/dist/types/core/charts/scatter/logAxis.d.ts +14 -0
- package/dist/types/core/charts/scatter/model.d.ts +258 -0
- package/dist/types/core/charts/scatter/schema.d.ts +57 -0
- package/dist/types/core/charts/scatter/trend.d.ts +54 -0
- package/dist/types/core/charts/scatter/valueLines.d.ts +47 -0
- package/dist/types/core/charts/sparkline/fixtures.d.ts +1 -1
- package/dist/types/core/charts/status/layout.d.ts +5 -3
- package/dist/types/core/charts/table/resolve.d.ts +0 -7
- package/dist/types/core/charts/tilemap/index.d.ts +6 -0
- package/dist/types/core/charts/tilemap/layout.d.ts +5 -0
- package/dist/types/core/charts/tilemap/schema.d.ts +4 -0
- package/dist/types/core/charts/treemap/types.d.ts +2 -2
- package/dist/types/core/charts/variance/fixtures.d.ts +2 -1
- package/dist/types/core/charts/waffle/types.d.ts +2 -0
- package/dist/types/core/dateFormat.d.ts +1 -1
- package/dist/types/core/deferred.d.ts +6 -1
- package/dist/types/core/doc/diagnostics.d.ts +8 -0
- package/dist/types/core/doc/document.d.ts +9 -1
- package/dist/types/core/doc/ownedDocumentCopy.d.ts +2 -1
- package/dist/types/core/fontMetrics/index.d.ts +1 -1
- package/dist/types/core/footer.d.ts +9 -1
- package/dist/types/core/format.d.ts +4 -1
- package/dist/types/core/formatSpec.d.ts +84 -6
- package/dist/types/core/frame.d.ts +41 -8
- package/dist/types/core/geo/packs/registry.d.ts +3 -2
- package/dist/types/core/geometry.d.ts +19 -0
- package/dist/types/core/icons.d.ts +11 -0
- package/dist/types/core/inputError.d.ts +3 -0
- package/dist/types/core/isoDate.d.ts +2 -0
- package/dist/types/core/label/categoryRow.d.ts +8 -0
- package/dist/types/core/label/occupied.d.ts +5 -0
- package/dist/types/core/label/solver.d.ts +31 -2
- package/dist/types/core/notes.d.ts +13 -1
- package/dist/types/core/ols.d.ts +38 -0
- package/dist/types/core/periodYears.d.ts +5 -1
- package/dist/types/core/registry.d.ts +12 -0
- package/dist/types/core/request.d.ts +3 -2
- package/dist/types/core/scale.d.ts +7 -0
- package/dist/types/core/schema/capability.d.ts +17 -20
- package/dist/types/core/schema/namedColumns.d.ts +6 -0
- package/dist/types/core/schema/refusals.d.ts +1 -4
- package/dist/types/core/shareRounding.d.ts +8 -0
- package/dist/types/core/sizing.d.ts +17 -12
- package/dist/types/core/story.d.ts +3 -0
- package/dist/types/core/target.d.ts +6 -0
- package/dist/types/core/text.d.ts +8 -0
- package/dist/types/core/theme.d.ts +55 -2
- package/dist/types/core/themeShape.d.ts +3 -3
- package/dist/types/core/themeValidate.d.ts +3 -3
- package/dist/types/core/types/annotations.d.ts +15 -3
- package/dist/types/core/types/data.d.ts +4 -1
- package/dist/types/core/types/diagram.d.ts +81 -2
- package/dist/types/core/types/optionInput.d.ts +13 -0
- package/dist/types/core/types/options.d.ts +65 -24
- package/dist/types/core/types/scene.d.ts +79 -2
- package/dist/types/core/types/table.d.ts +9 -0
- package/dist/types/core/types/theme.d.ts +50 -4
- package/dist/types/index.d.ts +28 -27
- package/dist/types/optionTypes.d.ts +44 -0
- package/dist/types/react/DimSwitchChart.d.ts +2 -1
- package/dist/types/react/RefusalBoundary.d.ts +25 -0
- package/dist/types/react/SceneRenderer.d.ts +3 -1
- package/dist/types/react/SizePlaceholder.d.ts +2 -1
- package/dist/types/react/TableChart.d.ts +8 -4
- package/dist/types/react/barrelCharts.d.ts +1521 -1012
- package/dist/types/react/charts/bar.d.ts +36 -25
- package/dist/types/react/charts/bartable.d.ts +36 -25
- package/dist/types/react/charts/box.d.ts +36 -25
- package/dist/types/react/charts/bullet.d.ts +36 -25
- package/dist/types/react/charts/butterfly.d.ts +36 -25
- package/dist/types/react/charts/choropleth.d.ts +36 -25
- package/dist/types/react/charts/cohort.d.ts +76 -50
- package/dist/types/react/charts/column.d.ts +36 -25
- package/dist/types/react/charts/combo.d.ts +2 -1
- package/dist/types/react/charts/creative.d.ts +31 -25
- package/dist/types/react/charts/diagram.d.ts +302 -160
- package/dist/types/react/charts/dot.d.ts +36 -25
- package/dist/types/react/charts/funnel.d.ts +36 -25
- package/dist/types/react/charts/gantt.d.ts +36 -25
- package/dist/types/react/charts/grid.d.ts +38 -27
- package/dist/types/react/charts/heatmap.d.ts +36 -25
- package/dist/types/react/charts/histogram.d.ts +36 -25
- package/dist/types/react/charts/kpi.d.ts +36 -25
- package/dist/types/react/charts/likert.d.ts +36 -25
- package/dist/types/react/charts/line.d.ts +36 -25
- package/dist/types/react/charts/mekko.d.ts +36 -25
- package/dist/types/react/charts/pareto.d.ts +33 -25
- package/dist/types/react/charts/pie.d.ts +36 -25
- package/dist/types/react/charts/pvm.d.ts +36 -25
- package/dist/types/react/charts/pyramid.d.ts +33 -25
- package/dist/types/react/charts/sankey.d.ts +36 -25
- package/dist/types/react/charts/scatter.d.ts +36 -25
- package/dist/types/react/charts/slope.d.ts +36 -25
- package/dist/types/react/charts/sparkline.d.ts +36 -25
- package/dist/types/react/charts/status.d.ts +36 -25
- package/dist/types/react/charts/tilemap.d.ts +36 -25
- package/dist/types/react/charts/treemap.d.ts +36 -25
- package/dist/types/react/charts/variance.d.ts +36 -25
- package/dist/types/react/charts/waffle.d.ts +36 -25
- package/dist/types/react/charts/waterfall.d.ts +36 -25
- package/dist/types/react/createChartComponent.d.ts +11 -9
- package/dist/types/react/footerFrame.d.ts +1 -1
- package/dist/types/react/hover/engine.d.ts +2 -1
- package/dist/types/react/hover/labelCard.d.ts +14 -2
- package/dist/types/react/prepare.d.ts +2 -2
- package/dist/types/react/prepared.d.ts +5 -1
- package/dist/types/react/rowsStore.d.ts +5 -0
- package/dist/types/react/useContainerSize.d.ts +2 -0
- package/dist/types/rows.d.ts +1 -1
- package/dist/validate.js +13 -8
- package/docs/manual.md +143 -37
- package/docs/reference/bar.md +10 -7
- package/docs/reference/bartable.md +7 -3
- package/docs/reference/box.md +5 -2
- package/docs/reference/bullet.md +7 -5
- package/docs/reference/butterfly.md +12 -5
- package/docs/reference/choropleth.md +9 -7
- package/docs/reference/cohort.md +3 -2
- package/docs/reference/column.md +14 -7
- package/docs/reference/combo.md +8 -6
- package/docs/reference/creative.md +1 -1
- package/docs/reference/diagram.md +94 -18
- package/docs/reference/dimswitch.md +16 -13
- package/docs/reference/dot.md +7 -4
- package/docs/reference/fixtures.md +49 -5
- package/docs/reference/funnel.md +4 -3
- package/docs/reference/gantt.md +1 -1
- package/docs/reference/grid.md +1 -1
- package/docs/reference/heatmap.md +6 -4
- package/docs/reference/histogram.md +7 -4
- package/docs/reference/kpi.md +11 -8
- package/docs/reference/likert.md +7 -3
- package/docs/reference/line.md +9 -8
- package/docs/reference/mekko.md +4 -4
- package/docs/reference/options.md +34 -32
- package/docs/reference/pareto.md +4 -4
- package/docs/reference/pie.md +8 -7
- package/docs/reference/pvm.md +4 -2
- package/docs/reference/pyramid.md +4 -4
- package/docs/reference/react.md +20 -11
- package/docs/reference/sankey.md +5 -3
- package/docs/reference/scatter.md +3 -3
- package/docs/reference/slope.md +7 -6
- package/docs/reference/sparkline.md +6 -5
- package/docs/reference/status.md +6 -4
- package/docs/reference/table.md +28 -26
- package/docs/reference/theme.md +94 -87
- package/docs/reference/tilemap.md +7 -6
- package/docs/reference/treemap.md +6 -5
- package/docs/reference/variance.md +8 -5
- package/docs/reference/waffle.md +2 -1
- package/docs/reference/waterfall.md +12 -9
- package/docs/use-cases.md +221 -0
- package/llms.txt +2 -1
- package/package.json +2 -1
- package/dist/chunk-2FNNAPCI.js +0 -24
- package/dist/chunk-2RSG7JYI.js +0 -24
- package/dist/chunk-3JEQGGVD.js +0 -19
- package/dist/chunk-3XHJHQWU.js +0 -42
- package/dist/chunk-4JLBVIGW.js +0 -24
- package/dist/chunk-6KWIQ5KF.js +0 -18
- package/dist/chunk-7X65ZQN4.js +0 -38
- package/dist/chunk-BBRBCMNR.js +0 -28
- package/dist/chunk-BMRD6MAH.js +0 -24
- package/dist/chunk-BW5VLBSZ.js +0 -15
- package/dist/chunk-CJGSJKPO.js +0 -25
- package/dist/chunk-CN7JRHST.js +0 -25
- package/dist/chunk-DJHIQWSG.js +0 -25
- package/dist/chunk-E4IQ6M4S.js +0 -24
- package/dist/chunk-EFUWFB64.js +0 -24
- package/dist/chunk-FIANWJXX.js +0 -19
- package/dist/chunk-GZTNTHSW.js +0 -21
- package/dist/chunk-H5G7T35P.js +0 -24
- package/dist/chunk-HKYTOJLV.js +0 -33
- package/dist/chunk-HYY5V2KL.js +0 -19
- package/dist/chunk-I6VAWNNU.js +0 -24
- package/dist/chunk-IK4BHOPZ.js +0 -33
- package/dist/chunk-ILSXT6KT.js +0 -24
- package/dist/chunk-JR7Y5ONB.js +0 -27
- package/dist/chunk-K3HSQPSM.js +0 -24
- package/dist/chunk-KDMKHR5A.js +0 -32
- package/dist/chunk-KOJ5QETJ.js +0 -8
- package/dist/chunk-L3JWM7FR.js +0 -50
- package/dist/chunk-L4S6UFTL.js +0 -26
- package/dist/chunk-LFTAMH7I.js +0 -24
- package/dist/chunk-MIAPBQCA.js +0 -24
- package/dist/chunk-NCB3YLHF.js +0 -28
- package/dist/chunk-ONZLC47B.js +0 -88
- package/dist/chunk-OUEGGWH7.js +0 -24
- package/dist/chunk-P25VEGGX.js +0 -24
- package/dist/chunk-P26Z62UV.js +0 -24
- package/dist/chunk-PFVTYFSL.js +0 -24
- package/dist/chunk-QGCEHR6S.js +0 -13
- package/dist/chunk-QOIVXZUF.js +0 -24
- package/dist/chunk-RA66JA3D.js +0 -24
- package/dist/chunk-SMCDXUIO.js +0 -24
- package/dist/chunk-T3IGJARD.js +0 -22
- package/dist/chunk-TKOJZQAJ.js +0 -24
- package/dist/chunk-UBZXQIDR.js +0 -24
- package/dist/chunk-VERLFNWR.js +0 -25
- package/dist/chunk-VH2UUU7K.js +0 -24
- package/dist/chunk-Z6CL7AR6.js +0 -24
- package/dist/chunk-ZU425HNM.js +0 -24
- package/dist/chunk-ZZU5R5UU.js +0 -24
- /package/dist/{DiagnosticDetails-UNYNYCAH.js → DiagnosticDetails-JFBBXOT2.js} +0 -0
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.
|
|
@@ -26,19 +28,25 @@ Every chart is one JSON object, the spec.
|
|
|
26
28
|
"subtitle": { "measure": "Revenue by line" },
|
|
27
29
|
"unit": "$m"
|
|
28
30
|
},
|
|
29
|
-
"theme": "
|
|
31
|
+
"theme": "bridge"
|
|
30
32
|
}
|
|
31
33
|
```
|
|
32
34
|
|
|
33
|
-
- `name` is optional: the output file name and the chart's identity, default `chart`.
|
|
35
|
+
- `name` is optional: the output file name and the chart's identity, default `chart`. A valid file stem stays unchanged. Other string names lose diacritics, become lowercase, replace unsafe character runs with `-`, trim edge hyphens and dots, and stop at 100 characters. `"Revenue Q3 2024"` becomes `revenue-q3-2024`, with a `name-slugified` warning and a fix. An empty result is refused. Names in a versioned document keep their existing rules.
|
|
34
36
|
- `type` names the chart type. `boardplot_list` returns all of them with their aliases.
|
|
35
37
|
- `data` has the shape of that type. `boardplot_describe` lists its fields.
|
|
36
38
|
- `options` is optional. It holds the title, subtitle, unit, source, axes and labels, plus the options of the type. `options.target` names the medium the chart is read in and `options.size` its slot; see [Sizing](#sizing). The subtitle prints the unit after its measure ("Revenue in $m"); a unit that neither the subtitle, an axis title nor a value label prints gets the warning `unit-not-shown`.
|
|
37
|
-
- `annotations` is optional. An annotation attaches a callout, note, difference arrow, CAGR arrow or value line to a data id, and the engine computes the number it prints.
|
|
39
|
+
- `annotations` is optional. An annotation attaches a callout, note, difference arrow, CAGR arrow or value line to a data id, and the engine computes the number it prints. A `cagr` draws a bracket over the marks. With `shape: "arrow"` it draws one straight arrow with the rate in an oval on it, and falls back to the bracket with the warning `cagr-arrow-no-room` where no straight line clears the chart or the span is too short for the oval.
|
|
38
40
|
- `theme` is optional. It takes a preset name or a theme object; see [Themes](#themes).
|
|
39
41
|
|
|
42
|
+
`options.valueAxis.tickStep` sets ticks at multiples of a positive step and extends the linear axis outward without cutting data, except that dot keeps its data ends when at least two multiples fit inside. The step must give 1 to 20 intervals, otherwise nice ticks are drawn with `tick-step-ignored`.
|
|
43
|
+
|
|
40
44
|
A field the type does not list is an error. `boardplot_render`, `boardplot_measure`, the CLI and the React component `BoardplotChart` all take this spec.
|
|
41
45
|
|
|
46
|
+
A KPI accepts `data.label: ""` to omit its label and the space for the label. The accessible name falls back to `KPI`.
|
|
47
|
+
|
|
48
|
+
Where the chart supports sorting, `options.sort: "sheet"`, `"asc"`, `"desc"` or `"reverse"` sets `sort.categories`. `sort: true` means `{ categories: "desc" }`. A positive integer `options.topN: n` means `{ n }`. Charts keep their existing restrictions on sorting and Top-N.
|
|
49
|
+
|
|
42
50
|
## Choosing a chart
|
|
43
51
|
|
|
44
52
|
The table maps a frequent business message to a Boardplot type, the most common first. Get the fixture with `boardplot_fixtures` and the type and id, then change the data. The table does not decide what the exhibit should show; that stays the author's choice.
|
|
@@ -75,7 +83,7 @@ The MCP server `boardplot` has six tools. Each answers with JSON; a rejected cal
|
|
|
75
83
|
| `boardplot_fixtures` | start from a complete example | runnable specs with real-looking data, by `type` or `id` |
|
|
76
84
|
| `boardplot_feedback` | report a Boardplot problem | a draft report and `issueUrl`, a prefilled GitHub issue the user opens and submits; it sends nothing |
|
|
77
85
|
|
|
78
|
-
A render refusal keeps its size estimate in `expected.minimum` and `fix`. Library `canDraw()` returns it as `minimum`. Measurement
|
|
86
|
+
A render refusal keeps its size estimate in `expected.minimum` and `fix`. Library `canDraw()` returns it as `minimum`. A render that draws reports `plot-under-floor`, `aspect-cap`, `height-off-ladder` and `plot-under-min` with no `fix`, because render has not drawn the height a patch would name. Their `suggest` says to call `measure` for a verified size or to leave the height out, and for the aspect warnings also to widen the chart. Measurement draws each size it names. For `plot-under-floor` and a refusal it names a size that draws without a size warning, and CLI and MCP measurement return the refusal size as `required`. For `aspect-cap`, `height-off-ladder` and `plot-under-min` it tries the heights of the standard ladder that the aspect cap allows, nearest first, and names the first that draws with no size warning. A table with a fixed height that draws wider than its frame reports `table-overflow` with no `fix` in a render, and measurement names the width and the height the wider frame needs. A data warning such as `dual-axis` does not reject a size. The height search is bounded. If no tested size draws within the bound, the warning carries no `fix`, and `suggest` asks for less content, a wider chart or a changed setting.
|
|
79
87
|
|
|
80
88
|
A worked example, an EBIT bridge. Ask for the waterfall contract:
|
|
81
89
|
|
|
@@ -140,15 +148,33 @@ The result holds the chart as an image content block and this JSON, shown here i
|
|
|
140
148
|
|
|
141
149
|
Each derived reading has `visible: true` when it has displayed text. A calculation that is not printed has `visible: false` and `displayed: "Not displayed"`. `reading.omissions` lists each hidden label and its destination. This includes axis labels removed before placement and values moved straight to a note. A label without a replacement label or note has destination `reading.omissions`, which keeps its text. One `label-hidden` warning reports the missing labels for the chart. Redundant labels, whose information is printed elsewhere, do not cause this warning.
|
|
142
150
|
|
|
151
|
+
A treemap leaves out items whose `value` is zero or null, warns `treemap-item-left-out` and names the items in a note. Only drawn items enter totals, shares and cell counts; negative values and data without a value above zero are refused.
|
|
152
|
+
|
|
153
|
+
A slope with more than two categories draws the first versus the last, warns `slope-too-many-points` and names the omitted category labels in a note. The diverging slope still requires exactly two categories.
|
|
154
|
+
|
|
155
|
+
A football field leaves out methods whose cells are null or have no `range`, warns `football-field-method-without-range` and names the methods in a note. At least one method must have a range; only those methods enter sorting, the scale and computed numbers.
|
|
156
|
+
|
|
143
157
|
`reading.counts` lists structural counts and their exact phrases in the accessible description. A host can match these phrases without parsing prose. See [Chart reading counts](reference/reading.md).
|
|
144
158
|
|
|
145
159
|
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
160
|
|
|
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
|
|
161
|
+
`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 chart with characters the theme font has no width for, such as emoji or CJK, is drawn by Chrome when Chrome is installed, because resvg draws them as boxes and loses the whole label with them. On macOS and Windows, which ship those fonts, Chrome clears the warning; on other systems the warning `png-glyph-coverage` stays, because Chrome draws boxes when no installed font covers a character. Without Chrome the render keeps the resvg PNG and warns `png-glyph-coverage`, naming the labels that can be lost. A PNG above 100 million pixels (width x height x `scale` squared) is refused with `png-too-large` (exit 1), because the rasterizer would run out of memory; draw the SVG, lower `scale` or shrink the canvas. `boardplot_list` reports the limit as `limits.pngPixelsMax`. 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.
|
|
162
|
+
|
|
163
|
+
### Accepted input forms
|
|
164
|
+
|
|
165
|
+
Plain numeric strings such as `"120"`, `"-3.5"` and `"1e3"` are accepted where the schema needs a number, after trimming whitespace.
|
|
166
|
+
The conversion uses `Number(text)` and refuses more than 15 significant digits, overflow and underflow to zero.
|
|
167
|
+
Strings with grouping marks or units stay refused. Grouping and decimal marks come only from `options.locale`; `"1,200"`, `"1.234"`, `"12%"` and `"$5"` are not guessed.
|
|
168
|
+
Boolean options accept `"true"` and `"false"` in any case. Numeric `id` fields in data become strings.
|
|
169
|
+
Chart types, aliases and enum values accept a unique case-insensitive match, including grid panel types and the CLI/MCP format, target, background and return arguments. Names are not trimmed or respelled.
|
|
170
|
+
Table status cells accept green as on-track, amber or yellow as at-risk, and red as off-track. Status keys and traffic-light words accept any case; column labels still control display text.
|
|
171
|
+
Scenario `LY` means `PY` (last year), in any case. Value conversions report `input-converted` with a JSON Patch fix that writes the converted value.
|
|
172
|
+
MCP render and measure parse an object spec sent as a JSON string and report `spec-parsed-from-string`. Invalid JSON and non-object results stay refused.
|
|
173
|
+
Explicit `--format svg` or MCP `format: "svg"`, without return or an output path, includes the SVG and reports `svg-returned`. An omitted format keeps the reading-only response.
|
|
148
174
|
|
|
149
175
|
### Rows as data
|
|
150
176
|
|
|
151
|
-
A query result does not have to be copied into `data`. `boardplot_render` and `boardplot_measure` take a flat table, one row per category and series pair, as `rows` inline or as `rowsFile`, the absolute path of a local `.json` file (an array of row objects) or `.csv` file (a header row) of at most
|
|
177
|
+
A query result does not have to be copied into `data`. `boardplot_render` and `boardplot_measure` take a flat table, one row per category and series pair, as `rows` inline or as `rowsFile`, the absolute path of a local `.json` file (an array of row objects), or a `.csv`, `.tsv` or `.txt` file (a header row) of at most 10 MB. A CSV whose header line holds more semicolons than commas is read as semicolon-separated, as German-locale exports are, and a file whose header line holds more tabs than commas and semicolons is read as tab-separated, as a table pasted from a spreadsheet is; a tab-separated file keeps the dot as its decimal mark. In a semicolon file the value column reads a decimal comma as a decimal (0,505 is 0.505); a number with grouping marks such as 1.234,5 is refused with its row, and so is 1.234, which could be 1234 or 1.234. A leading byte order mark is skipped. Read from a file, the numbers never pass through the model. `columns` names the source column for each role: `category`, `series` and `value` are required, `categoryLabel`, `seriesLabel`, `unit`, `date` and `state` (`na`, `nm` or `suppressed` for a cell whose value is null; a heatmap keeps it as the series' `states`) are optional. Each role names its own column, with one exception: `date` may name the category column, so one SQL date column gives both the category ids and their dates. A category without a `categoryLabel` gets no label, so an ISO date id such as `2026-01-01` prints as a short date ('Jan', with the year on its own row) on the axis and in the hover card. `valueKind` says how the value column is written: `number` (the default), `percent` (50.5 is 50.5 %) or `fraction` (0.505 is 50.5 %).
|
|
152
178
|
|
|
153
179
|
The MCP server reads a `rowsFile` only from an allowed folder. The allowed folders are the roots the client sends (the server asks for them when the client declares the roots capability), the server's working directory (unless it is the filesystem root), the system temp folder, and every folder in the environment variable `BOARDPLOT_ROWS_ROOTS` (several separated by `:`, on Windows by `;`). The check runs on the resolved path, so a symlink that points outside is refused too. A file outside these folders is refused with `rows-outside-roots`, and nothing is read. `outDir` follows the same rule: a path outside these folders, also through a symlinked folder, is refused with `out-outside-roots`, and nothing is written. The CLI's `--rows` and `--out` take any path you name.
|
|
154
180
|
|
|
@@ -170,8 +196,12 @@ The MCP server reads a `rowsFile` only from an allowed folder. The allowed folde
|
|
|
170
196
|
|
|
171
197
|
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
198
|
|
|
199
|
+
A repeated CSV header warns `rows-header-repeated`: the first column keeps the name, and the next reads as `name.1`, `name.2` and so on.
|
|
200
|
+
|
|
173
201
|
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
202
|
|
|
203
|
+
A number in a category, series or other text column reads as its text, as a CSV cell does, so `"year": 2024` names the series `2024`.
|
|
204
|
+
|
|
175
205
|
### Waterfall and scatter rows
|
|
176
206
|
|
|
177
207
|
Waterfall (alias `bridge`) takes one row per item. Use `--columns label=item,value=amount,type=kind`, or the MCP object `columns: { "label": "item", "value": "amount", "type": "kind" }`. `label` and `value` are required. The optional `type` column uses the waterfall names `delta`, `subtotal`, and `total`; an absent or blank type means `delta`. Row order is item order. A delta adds its value. An opening total sets the starting value. Later subtotals and totals use the running sum; their supplied value is a check value. A mismatch warns `derived-mismatch` and draws the running sum. Use null or a blank value for a total with no check value.
|
|
@@ -186,6 +216,8 @@ Both mappings generate ids `row-1`, `row-2`, and so on. Labels can repeat. Rows
|
|
|
186
216
|
|
|
187
217
|
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.
|
|
188
218
|
|
|
219
|
+
A `date` column takes ISO date cells. Its `format` takes a pattern such as `dd.MM.yyyy` or an example such as `30.09.2026`, `09/30/2026`, `September 2026` or `2026`. Month and weekday names can be English or the names of `options.locale.language`. Quarter tokens are `Q` (1), `QQ` (Q1) and `QQQ` (Quarter 1). Excel `mmm`, `mmmm` and `dd/mm/yyyy` work. `YYYY`/`YY` mean year and `D`/`DD` mean day. Numeric dates use a day above 12 to choose the order. Otherwise they read day first and warn `date-format-ambiguous`. A year in front keeps year/month/day. A month name with a two-digit year, such as `Sep-26`, reads month/year. A space or comma warns when the year could be a day. `FY26` reads the calendar year and gives `date-format-fiscal-year` (info). A fiscal year starting in another month is not supported. Unreadable text warns `date-format-unknown` and uses the default `d MMM yyyy`. Warnings name the column's format once per column.
|
|
220
|
+
|
|
189
221
|
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`.
|
|
190
222
|
|
|
191
223
|
### Histogram and box rows
|
|
@@ -196,13 +228,13 @@ Every row is an observation, so nothing is dropped without a word. A null, blank
|
|
|
196
228
|
|
|
197
229
|
### Map rows and classes
|
|
198
230
|
|
|
199
|
-
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.
|
|
231
|
+
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. Region ids match without regard to case, with exact matches first. Unknown ids are left out with a warning and a note; a map whose listed ids are all unknown is refused. Duplicate regions and invalid values are refused. The reading includes the row count and SHA-256, as for category charts.
|
|
200
232
|
|
|
201
|
-
Maps use a continuous ramp unless `classes` or `steps` is set. `classes` breaks on round numbers: steps of 1, 2, 2.5 or 5 times a power of ten, on a grid through 0 or through the diverging midpoint
|
|
233
|
+
Maps use a continuous ramp unless `classes` or `steps` is set. `classes` breaks on round numbers: steps of 1, 2, 2.5 or 5 times a power of ten, on a grid through 0 or through the diverging midpoint. One class holds at most 40 % of the regions when a round step allows it. On a diverging scale with values on both sides of the midpoint, an odd class count mirrors its breaks around the midpoint, for example `-10, -5, 5, 10`. The centre class then holds the midpoint and takes the midpoint grey, and the end classes are open-ended. An even class count keeps a break on the midpoint: a value exactly on it takes the midpoint grey and its own key entry, and the class above it starts with "Over". `steps: [15, 25, 35, 45]` reuses the cohort chart's four ascending thresholds and defines five classes. A value on a threshold enters the higher class. The first and last classes are open-ended. `classes`, if also set, must be 5. The format must print the thresholds exactly. A choropleth key prints one range under each class, for example `<20`, `20–<40` and `≥80`. The key has no title unless you set `keyTitle`.
|
|
202
234
|
|
|
203
235
|
A choropleth writes each region's code on its shape. A region too small for its code gets the code beside the shape on a short leader. `valueTable` adds a table of every region with its swatch, code and value; the top regions are bold. `'auto'` (default) shows the table for at most 20 regions: beside the map when there is room, else below it when the frame can grow, else not at all. `'side'` and `'below'` set the place, and `false` turns the table off. With the table on, the map prints codes only.
|
|
204
236
|
|
|
205
|
-
A listed region with `value: null` has a hatch and the key says “Value missing”. An unlisted region
|
|
237
|
+
A listed region with `value: null` has a hatch and the key says “Value missing”. An unlisted region draws as pale land without an outline, and the key says “Not in data”. On a choropleth it gets no automatic code; `labels: 'all'` or `labelRegions` still names it. This distinction is automatic. A status glyph reserves space before labels are placed. Tile glyphs stay inside one tile. A glyph that cannot fit is omitted with a warning. Labels that move to the tile note also produce a warning.
|
|
206
238
|
|
|
207
239
|
### Fraction values in chart data
|
|
208
240
|
|
|
@@ -211,7 +243,7 @@ Set `data.series[].valueKind: "fraction"` for one series, such as a combo line b
|
|
|
211
243
|
The engine converts `0.153` to `{ "pct": 15.3 }` once at input. Labels, axes, hover records, accessible text and calculations use percent units.
|
|
212
244
|
A percent format sets the printed style; it does not multiply values by 100. `percent-scale-suspect` warns when an undeclared series has values within ±1 and a percent format, percent cells or percent labels on a chart that shows the authored values. Composition charts derive shares from weights and do not need this warning. Grid panels get the same checks as separate charts. Numeric values without a percent claim keep their numeric units.
|
|
213
245
|
Numeric cells and their ranges convert. Null stays missing. Explicit `{ "pct": 15.3 }` cells already use percent units and do not convert again.
|
|
214
|
-
Formats, targets and axis bounds still use percent units. A numeric `valueLine` also uses percent units by default. Set its own `valueKind: "fraction"` to multiply its value and tolerance by 100. This setting is independent of `data.valueKind`. `"0.0%"` and `"1.0%"` both mean one decimal.
|
|
246
|
+
Formats, targets and axis bounds still use percent units. A numeric `valueLine` also uses percent units by default. Set its own `valueKind: "fraction"` to multiply its value and tolerance by 100. This setting is independent of `data.valueKind`. A value line within ±1 far below fraction data warns `percent-scale-suspect` with this fix. `"0.0%"` and `"1.0%"` both mean one decimal.
|
|
215
247
|
This field applies to bar, column, line, combo, dot, butterfly, slope, variance, heatmap, mekko, pie and funnel data. Sparkline uses `data.valueKind` for its single series.
|
|
216
248
|
Other data schemas refuse the field. For a combo rate, keep its separate percent axis and the required `secondaryAxis.acknowledge` setting.
|
|
217
249
|
|
|
@@ -219,13 +251,49 @@ Other data schemas refuse the field. For a combo rate, keep its separate percent
|
|
|
219
251
|
|
|
220
252
|
Without an authored format, each table column and each chart series gets one precision from its largest value. Below 1, that value keeps two significant digits: 0.0341 gives three decimals, so 0.0123 and 0.0051 print 0.012 and 0.005. No automatic format prints more than four decimals. A nonzero value below the last shown digit prints its bound: `<0.001` at three decimals, `>−0.001` below zero, `<1` for whole numbers. A signed change label keeps its sign: `<+0.001` and `>−0.001`, so it reads as a change like its neighbours. Below 0.0001 it prints in scientific form, `1.2 × 10⁻⁹`. A true zero prints in the column's format, such as `0.0`. Set `options.smallValues: "zero"` for spreadsheet style (`0.000`) or `"scientific"` for a power of ten. `"p-value"` prints every value from 0 to 1 as APA 7 writes a p-value: three decimals without the leading zero (`.042`) and `<.001` below. An authored format prints as authored.
|
|
221
253
|
|
|
222
|
-
A `k`, `M` or `B` after the digits
|
|
254
|
+
A `k`, `M` or `B` after the digits scales the value: `"$1.2M"` prints 2,456,000 as `$2.5M`. A spaced magnitude beside a currency (`"$1.2 k"`) also scales. A scale inside a currency affix (`"USDm 1.2"`, `"1.2 €m"`) holds its divisor. Without a currency, spaced letters remain units: `"12 m/s"` and `"50 B"` print the value as it is. The words `mn`, `bn`, `Mio.`, `Mrd.`, `thousand`, `million` and `billion` scale with or without a space.
|
|
255
|
+
|
|
256
|
+
- A unit-only format (`"$M"`, `"€bn"`, `"%"`, `"x"`) picks precision from the field's data. A computed field whose values do not exist yet keeps the stand-in precision.
|
|
257
|
+
- Spreadsheet number codes translate to examples with warning `format-spreadsheet-code`. Percent values stay percent points: 12.5 prints `12.5%`.
|
|
258
|
+
- Direction glyphs such as ▲/▼ and ↑/↓ at the start or end of the example print the sign by value and disappear on zero. A glyph inside the prefix or unit stays literal text. `±` means a plus on positives and a minus on negatives. A trailing minus (`"1,234-"`) prints only on negatives.
|
|
259
|
+
- `"1st"` prints English ordinal suffixes, and `"1.2E+06"` prints scientific notation.
|
|
260
|
+
- `options.locale.thousands` also accepts the typed apostrophe (`"'"`) and the narrow no-break space (`"\u202f"`). Grouping and decimal marks come from `options.locale`.
|
|
261
|
+
|
|
262
|
+
A plain example fixes decimals: `"$1.2M"` prints 4,270,000 as `$4.3M`. With no digit, one `@` per figure fixes significant figures:
|
|
263
|
+
|
|
264
|
+
| Value | `"$@@@M"` | `"$1.2M"` |
|
|
265
|
+
| --- | --- | --- |
|
|
266
|
+
| 42,700,000 | $42.7M | $42.7M |
|
|
267
|
+
| 4,270,000 | $4.27M | $4.3M |
|
|
268
|
+
| 430,000 | $0.430M | $0.4M |
|
|
269
|
+
|
|
270
|
+
Trailing zeros stay. The value rolls up at 1000: 999,600 prints `$1.00M`, and 999,960,000 prints `$1.00B`. A scale word holds the authored scale for a value far below it. Axis ticks keep the example's style and take their digits from their spacing: `$10M`, not `$10.0M`. Write every `@` in one run. A split run such as `"@@.@%"` is refused with the fix `"@@@%"`. More than 15 figures are refused. A digit anywhere makes an ordinary example, where `@` stays literal text.
|
|
271
|
+
|
|
272
|
+
An example with one dot before three digits, such as `"1.234"`, can be a thousands group or three decimals. The chart's numbers decide. Where every number is below 1000 and one has a fraction, it means three decimals: 0.512 prints `0.512`. Otherwise it is a group: 1,200 prints `1,200`, and where a small number loses its fraction beside large ones, the warning `format-reads-as-group` names it. `"0.000"` always means three decimals, and `"1,234"` always means a group.
|
|
223
273
|
|
|
224
274
|
### Shares that add up
|
|
225
275
|
|
|
226
|
-
An authored `options.format` fixes its decimals, including trailing zeroes. Series formats and cell formats override it. Without an authored format, precision follows the data. On a percent mekko, a percent example formats shares; absolute column totals keep a number format. Their unit comes from `series[].unit` when every data series declares the same unit. `options.unit` names the shares and never labels those absolute totals.
|
|
276
|
+
An authored `options.format` fixes its decimals, including trailing zeroes. A percent example such as `1.0%` also sets the decimals of the computed shares on a 100 % bar or column and on a pie. On a pie it formats the slice values only when they are percents (a `%` unit, percent cells, or values that add to 100). For counts or money it warns `percent-format-on-values` and the slice values print in the automatic format. Series formats and cell formats override it. A mekko column total takes more decimals only where the format would print a nonzero total as 0. Without an authored format, precision follows the data. On a percent mekko, a percent example formats shares; absolute column totals keep a number format. Their unit comes from `series[].unit` when every data series declares the same unit. `options.unit` names the shares and never labels those absolute totals.
|
|
277
|
+
|
|
278
|
+
Rounded one by one, the shares of a whole can print a sum such as 100.6 %. `options.rounding` applies on bar, bartable, column, combo, line, mekko and pie. Bar, column and combo stacks, a bartable cascade and a stacked100 area default to `"sum-consistent"`. Mekko and pie default to `"nearest"`, and a pie warns `share-rounding-drift` when its printed shares miss 100 %. Under `"sum-consistent"` a chart prints every share of a whole at the finest precision one of them needs and moves the fewest shares one step, those that rounding moved furthest, until the printed shares add up to 100 %; no share moves a whole step from its value. The reading lists each moved share under `rounding` with its value, what it prints on its own and what it prints now. A bar, bartable, column, combo or line chart with a moved share also adds one method note to its notes list, which prints under the chart only where `notes.show` lists `"method"`. On a column or bar stack with `sharesOfOneWhole`, the same note says when the authored parts miss 100 and each share is taken of the stack total. The allocation uses the largest-remainder rule. For equal remainders, when the sum must go up, round up the smaller share first; when the sum must go down, take the step from the larger share first. Equal-size ties use the first input index. Use `options.format: "1.0%"` for one decimal when whole-percent adjustments are too coarse. Other types refuse the option.
|
|
279
|
+
|
|
280
|
+
### Category order and topN
|
|
281
|
+
|
|
282
|
+
`options.sort.categories` accepts `sheet`, `reverse`, `asc` and `desc`. `sheet` keeps authored order. `reverse` reverses authored order. `asc` and `desc` rank by the chart's measure, with ties in authored order and missing values last.
|
|
283
|
+
|
|
284
|
+
- Variance ranks by the signed drawn difference: delta percent in `relative`, absolute difference otherwise.
|
|
285
|
+
- Bullet ranks by value divided by target when every row has a positive target, otherwise by raw value. `desc` means highest first, including on lower-is-better rows.
|
|
286
|
+
- Likert ranks statements by net score. The response scale keeps its order. `sort.categories` overrides the direction or mode of `sortBy`.
|
|
287
|
+
- Butterfly ranks by its `sortBy` measure (`a`, `b`, `sum` or `diff`), defaulting to `sum`. `sort.categories` sets direction or mode. A topN rest row stays last.
|
|
227
288
|
|
|
228
|
-
|
|
289
|
+
Dated variance, bullet and butterfly categories keep authored order when a growth or difference annotation spans periods. The chart warns when that replaces the requested order.
|
|
290
|
+
|
|
291
|
+
`options.topN: { n: 2 }` keeps the two largest categories by the chart's ranking size before `sort.categories` orders them.
|
|
292
|
+
|
|
293
|
+
- Dot keeps the n largest absolute first-series values, or absolute gaps on a dumbbell.
|
|
294
|
+
- Variance keeps the n largest absolute drawn differences: delta percent in `relative`, absolute difference otherwise. Missing differences count as zero.
|
|
295
|
+
|
|
296
|
+
Dot and variance draw no Others row because scores and ratios are not additive. Kept categories retain authored order unless `sort.categories` reorders them. A disclosure note and `topn-omitted` name the kept count, total count and omitted categories. When a cut is needed, authored `rest: true`, `restLabel`, `showRestCount` or `threshold` produces one `topn-rest-unsupported` warning that names the ignored settings. A request with `n` at least the category count changes nothing and adds no topN warning.
|
|
229
297
|
|
|
230
298
|
### Missing stack parts
|
|
231
299
|
|
|
@@ -239,7 +307,7 @@ SVG `id` attributes and their references use a hash of the drawing, locale and r
|
|
|
239
307
|
|
|
240
308
|
### Gantt and grid formats
|
|
241
309
|
|
|
242
|
-
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
|
|
310
|
+
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.
|
|
243
311
|
|
|
244
312
|
### Metric stack
|
|
245
313
|
|
|
@@ -249,7 +317,7 @@ Store counts once in `data.measures`. Each panel names either a sum or a numerat
|
|
|
249
317
|
|
|
250
318
|
Mark a running category `partial: true`. Declare unavailable outcome panels in `data.states.partial.panels`. Declare the maturing range and its affected panels in `data.states.maturing`. The grid draws one continuous band across those panels. Provisional bars use light fills and dashed outlines. Provisional lines use grey dashes and hollow points. Partial points never connect. Dashes denote projected or provisional data. One panel may set `emphasis: true`.
|
|
251
319
|
|
|
252
|
-
The engine owns label space, one panel gap and one shared readout gutter. Use `stack.heights` for plot heights in layout pixels, or `rows` for proportional heights. Too-small authored gaps, gutters or heights are refused. A width-only size grows to the content height. Slide text can need more height than report text. The example fixtures are `metric-stack-volume` and `metric-stack-steps`. Existing grids keep their current layout.
|
|
320
|
+
The engine owns label space, one panel gap and one shared readout gutter. Use `stack.heights` for plot heights in layout pixels, or `rows` for proportional heights. Too-small authored gaps, gutters or heights are refused. A width-only size grows to the content height. On a fixed height shorter than that, default plot heights shrink to their readout floor. Below the floor, the readout puts the unit beside the name and the headline and span on one line, and the panels sit closer together. Slide text can need more height than report text. The example fixtures are `metric-stack-volume` and `metric-stack-steps`. Existing grids keep their current layout.
|
|
253
321
|
|
|
254
322
|
## Getting a chart with the CLI
|
|
255
323
|
|
|
@@ -282,7 +350,7 @@ The second command prints the same JSON as `boardplot_render`, here in part:
|
|
|
282
350
|
|
|
283
351
|
The exit code is 0 when the call succeeded, 1 when the input was rejected and 2 for an internal error. The other commands: `boardplot list`, `boardplot describe waterfall --full`, `boardplot describe mekko --path valueAxis.break`, `boardplot describe column --schema options`, `boardplot render spec.json --rows sales.csv --columns category=month,series=segment,value=revenue` (a relative rows path resolves against the working directory), `boardplot fixtures --type waterfall`, `boardplot measure spec.json --width 400`, `boardplot render spec.json --format png --out ./charts` (a PNG goes to a file), `boardplot fonts build <font-dir>`, `boardplot telemetry status`, `boardplot feedback --category bug --summary "..."` and `boardplot --version`.
|
|
284
352
|
|
|
285
|
-
A file in `--out` takes the chart's name, `chart` when the spec has none; a taken name gets `-2`, so a render keeps existing files by default, and the warning `out-name-taken` names the requested and the written path. `--overwrite` replaces existing output files at the requested paths. The MCP tool uses `overwrite: true` for the same result. Duplicate chart names within one call still get separate files. `--quiet` prints only `ok` and `outputs` when the render succeeds, which keeps a shell loop over many variants readable; a refused spec still prints its errors. An `--out` that cannot be a folder, such as an existing file or a folder without write permission, is refused with `out-unwritable` and exit 1.
|
|
353
|
+
A file in `--out` takes the chart's name, `chart` when the spec has none; a taken name gets `-2`, so a render keeps existing files by default, and the warning `out-name-taken` names the requested and the written path. `--overwrite` replaces existing output files at the requested paths. The MCP tool uses `overwrite: true` for the same result. Duplicate chart names within one call still get separate files. `--quiet` prints only `ok` and `outputs` when the render succeeds, which keeps a shell loop over many variants readable; a refused spec still prints its errors. An `--out` that cannot be a folder, such as an existing file or a folder without write permission, is refused with `out-unwritable` and exit 1. A new `--out` path that ends in another file extension made of letters, such as `chart.jpg` or `chart.pdf`, is refused with `invalid-argument`, because Boardplot writes SVG and PNG only; end the path with `/` to make a folder of that name. `--out -` writes the one chart to stdout, the SVG text or the PNG bytes, and prints the JSON answer on stderr: `boardplot render spec.json --out - > chart.svg`.
|
|
286
354
|
|
|
287
355
|
### Problem reports and usage counts
|
|
288
356
|
|
|
@@ -332,12 +400,16 @@ export async function Orders() {
|
|
|
332
400
|
|
|
333
401
|
A host that draws its own card around a chart switches Boardplot's frame text off: `title: false`, `legend: 'none'`, `footnotes: false`, and no `subtitle` or `source`. `footnotes: false` also leaves off the method notes Boardplot derives, and the info lint `footnotes-off` names each one so the card can print it; the render's notes list holds them all. A disclosure that `notes.show` prints stays: a table's rounding note, a partial period, values the chart does not print. The source line and a required map credit stay: leave `source` out for no source line, and a map licence credit cannot be switched off. `legend: 'none'` leaves off the key of a table, heatmap, cohort or variance, and the scatter size key, and the info lint `legend-off` names that key and its entries so the card can draw its own.
|
|
334
402
|
|
|
335
|
-
An invalid spec renders an error card with the same errors the CLI returns. Each type also has its own component with flat props, such as `WaterfallChart` from `boardplot/react/waterfall`, which takes `data`, `annotations` and the options as props (`title`, `unit`, `valueAxis`). Such a component refuses a prop its type does not take with the same `unknown-option` card. It checks the keys and leaves the option values and a grid's panel options to the spec path. Props, container sizing, server preparation and export to SVG, PNG and
|
|
403
|
+
An invalid spec renders an error card with the same errors the CLI returns. Each type also has its own component with flat props, such as `WaterfallChart` from `boardplot/react/waterfall`, which takes `data`, `annotations` and the options as props (`title`, `unit`, `valueAxis`). Such a component refuses a prop its type does not take with the same `unknown-option` card. It checks the keys and leaves the option values and a grid's panel options to the spec path. Props, container sizing, server preparation and export to SVG, PNG and CSV are in [the React reference](reference/react.md). For a PDF, print the page from the browser or place an exported SVG in a document tool.
|
|
404
|
+
|
|
405
|
+
Per-type components take `className` and `style` on one wrapper, and a number for `size` or `fallbackSize` as the width in pixels. SVG components also take `background="transparent"` to leave out the canvas rectangle. Halos and hollow marks keep the theme background colour. An invalid size or theme draws the refusal card during server rendering too.
|
|
336
406
|
|
|
337
407
|
A `dimswitch` row id is `JSON.stringify([variant, memberId, measureId])`; a member row in by-member omits `measureId`. React `onRowSelect` and `isRowSelectable` get these ids, and `dimswitchRowId(variant, memberId, measureId)` builds them (exported from `boardplot`).
|
|
338
408
|
|
|
339
409
|
A per-type entry is the small one: it links its own chart and the shared layout core. A page pays for the core once, and each further type adds only its own engine. Two core modules are not in that load, because most charts never reach them. The annotation placement engine, with the event lane, loads when a chart carries an annotation (an event included), a value line, a target or a derived callout. The checks a PATCHED theme goes through load when a caller passes `theme={{ preset, overrides }}`. Pareto and likert are the two types that need one on every chart — the cumulative threshold line and the statement-label theme patch — so their entries link it rather than fetch it. While such a chunk loads the component draws the busy placeholder and then the chart, byte for byte the chart it drew before; a graph that already links the module — the CLI, the MCP server, `boardplot/react/prepare`, the `boardplot/react` barrel — never waits in the browser. A server pass, and the client pass that hydrates it, count only what the chart's own entry links, because a server process can hold a module that the page in the browser does not: `renderToStaticMarkup` of an annotated chart or a patched theme from a per-type entry (`boardplot/react/<type>`) writes the placeholder unless the component gets `prepared`, and the chart follows once the page has hydrated. The barrel's components draw it, because the barrel links both modules.
|
|
340
410
|
|
|
411
|
+
When a refused or empty chart's card has not loaded, `renderToString` writes the loading fallback. Hydration then reports React error 419 in production before the client draws the card. Use `renderToPipeableStream` to wait for the card on the server.
|
|
412
|
+
|
|
341
413
|
### Rows in React
|
|
342
414
|
|
|
343
415
|
Every chart component takes query rows in place of `data`, with the same `columns` and the same refusals as `rows` in `boardplot_render`. `data` is then the template: a series it already names keeps its label and colour role. A SQL date column can be the category and the date at once, `columns: { category: 'month', date: 'month', series: 'product', value: 'revenue' }`; the months then print as 'Jan', 'Feb' and so on.
|
|
@@ -358,13 +430,13 @@ export function WeeklyRevenue() {
|
|
|
358
430
|
}
|
|
359
431
|
```
|
|
360
432
|
|
|
361
|
-
`onRowsReading` receives the reading: the row count, the columns no role names and the cells a `state` column
|
|
433
|
+
`onRowsReading` receives the reading: the row count, the columns no role names and the cells a `state` column marked. A map and a heatmap draw such a cell hatched and name its state in the key; the other charts draw it as an empty one, so only the reading tells them apart. Rows that do not map draw the error card with the CLI's `code` and the row, such as `invalid-value` at `rows.3.revenue`. `BoardplotChart` takes `rows` and `columns` too, beside a bare chart spec. The mapping loads as its own chunk the first time a chart gets rows, so a page without rows does not pay for it; `prepareChart` takes the same rows for a server render. [Rows from a query](reference/react.md#rows-from-a-query) has the details.
|
|
362
434
|
|
|
363
|
-
`specFromRows` from `boardplot/rows` runs the same mapping as a function, in the browser or in Node, and returns `{ spec, reading }`: use it to build a spec yourself, for example in a server component. Rows that do not map throw an `InputError` with the CLI's `code`, message and `details.path`, such as `/rows/3/revenue`. The entry links no chart engine and no zod. It reads no file: `rowsFile` is for the CLI and the MCP server.
|
|
435
|
+
`specFromRows` from `boardplot/rows` runs the same mapping as a function, in the browser or in Node, and returns `{ spec, reading }`: use it to build a spec yourself, for example in a server component. Rows that do not map throw an `InputError` with the CLI's `code`, message and `details.path`, such as `/rows/3/revenue`. The entry links no chart engine and no zod. It reads no file: `rowsFile` is for the CLI and the MCP server. Region ids match without regard to case. The adapter checks duplicate choropleth regions when the page has imported the map pack (`boardplot/geo/<id>`); the chart leaves out unknown region ids with a warning and a note. A tilemap checks its region ids when it draws. `specFromRows` is also exported from `boardplot`.
|
|
364
436
|
|
|
365
437
|
### Small bundles
|
|
366
438
|
|
|
367
|
-
With esbuild 0.28.2, code splitting, minification and React external, a column's first load through `boardplot/react/spec` is about
|
|
439
|
+
With esbuild 0.28.2, code splitting, minification and React external, a column's first load through `boardplot/react/spec` is about 354 kB gzip. The initial entry is about 194 kB; validation adds about 86 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.
|
|
368
440
|
|
|
369
441
|
`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`.
|
|
370
442
|
|
|
@@ -411,6 +483,10 @@ The panel shows up to four title lines and ten body lines. A cut title or body r
|
|
|
411
483
|
|
|
412
484
|
## Notes under the chart
|
|
413
485
|
|
|
486
|
+
`**bold**` in the title, subtitle (company, measure and period), notes and source draws bold and wraps at the bold weight. A single `*` stays literal.
|
|
487
|
+
|
|
488
|
+
`options.footnotes` accepts one string as a one-item array. `options.source` accepts an array of strings, joined with `; ` into one source line. An empty array prints no source. Set `options.strings.source: ""` to print the credit without a prefix or colon.
|
|
489
|
+
|
|
414
490
|
Boardplot sorts every note under a chart by kind. In the live React chart, the render target decides how much of it the frame prints. A React chart with `fit="content"` takes its height from its content and prints the footer of the static image: every note of the kinds `notes.show` lists, in full, with no line budget, so it is as tall as `boardplot render` at the same width. Under `notes.placement: 'info'` a "Notes and sources (N)" button opens the notes the image does not print; it sits in the space the image leaves free for it.
|
|
415
491
|
|
|
416
492
|
Boardplot prints none of its own notes under a chart by default, on every target and surface: the `method` and `disclosure` notes go to the notes list only. `notes.show` prints them where the author asks for them. A spec that asks for notes another way gets them too: `methodNote: true` or an authored `notes.placement` prints the method notes and disclosures, as `notes.show: ['note', 'method', 'disclosure']` does. A changed note wording alone (`strings.incompleteStacks`) prints nothing. Static SVG, PNG and clipboard images print the full author notes, the kinds `notes.show` adds, the source and the credit. Compact charts retain note reference numbers. Grid panels move notes that do not fit into the outer footer, under the panel title and ID. They have no notes button or "+N notes" pointer. The notes start at the normal footer gap below the chart's last element. They use the existing footer space first. If they need more room, the canvas grows below its original boundary. The plot keeps its position and size. `footnotes: false` still suppresses notes other than the disclosures `notes.show` prints.
|
|
@@ -462,7 +538,7 @@ A theme override of `type.secondary.size` sets the key text size. An override of
|
|
|
462
538
|
|
|
463
539
|
**Equal text across charts on one page or slide.** `options.textSize` pins the primary label size in px, the same at every width, from 6 to 32. Every other text role keeps its ratio to the primary label in the middle width class (720 to 1079 px): on the `report` target, `textSize: 13` draws a 560 px chart with the sizes a 1010 px chart has. A chart of 1080 px or more draws smaller than its default under `textSize: 13`, because its default class is larger. On `slide` and `print`, `textSize` is in layout px, not pt. Set the same `textSize` on every chart of the page or slide, on `BoardplotTheme` for all charts below it, or once on a grid, where it applies to every panel; a panel that sets another value is refused. It works on every chart type, in `boardplot render`, `boardplot measure`, the MCP tools, the API and React. `textSize` and `textScale` together are refused: keep one. The floors stay: a `textSize` under the target's sizes stops each text at its floor.
|
|
464
540
|
|
|
465
|
-
`--width` and `--height` take a number of px, or a number with `px`, `pt` or `mm`. The MCP `width` and `height` are px; put a physical size in `options.size` with its `unit`. 1 pt is 96/72 px and 1 mm is 96/25.4 px. A width alone leaves the height automatic. Over a pinned height, a width alone keeps that height; over a size preset, it keeps the preset's shape (`slide-4x3` at `--width 840` draws 840 × 632 px, the same ladder step).
|
|
541
|
+
`--width` and `--height` take a number of px, or a number with `px`, `pt` or `mm`. The MCP `width` and `height` are px; put a physical size in `options.size` with its `unit`. 1 pt is 96/72 px and 1 mm is 96/25.4 px. A width alone leaves the height automatic. Without a size, `kpi`, `bullet` and `sparkline` keep their card size on `slide` and `print`, and a framed sparkline (title, subtitle, source or note) is as wide as its title and at least 320 px (never wider than the target's canvas). Over a pinned height, a width alone keeps that height; over a size preset, it keeps the preset's shape (`slide-4x3` at `--width 840` draws 840 × 632 px, the same ladder step).
|
|
466
542
|
|
|
467
543
|
```json
|
|
468
544
|
{
|
|
@@ -481,7 +557,7 @@ The answer gives the size in layout px: 660 × 360 pt is 880 × 480 px.
|
|
|
481
557
|
{ "ok": true, "size": { "width": 880, "height": 480 } }
|
|
482
558
|
```
|
|
483
559
|
|
|
484
|
-
The layout width selects a class: S below 720 px, M from 720 px, L from 1080 px. In the M class, title, label, axis and footnote are 20, 13, 13 and 12 px for `report`; 18, 13, 13 and 12 px for `dashboard`; 20, 14, 14 and 10 pt for `slide`; and 16, 11, 11 and 9 pt for `print`. KPI and bullet use the M sizes at every width. To fit, the engine wraps, moves or discloses labels; it never sets text below the target's floor. A chart that still does not fit is refused with the size it needs. A theme that sets a smaller size renders with one warning.
|
|
560
|
+
The layout width selects a class: S below 720 px, M from 720 px, L from 1080 px. In the M class, title, label, axis and footnote are 20, 13, 13 and 12 px for `report`; 18, 13, 13 and 12 px for `dashboard`; 20, 14, 14 and 10 pt for `slide`; and 16, 11, 11 and 9 pt for `print`. KPI and bullet use the M sizes at every width. To fit, the engine wraps, moves or discloses labels; it never sets text below the target's floor. A `slide` or `print` canvas that is too small for these sizes is laid out once more with the label at its floor (12 pt on a slide, 9 pt in print) and every other text scaled by the same factor down to its own floor. A chart that then draws carries the info lint `type-stepped`, which names the size that draws the full sizes. An authored `textScale`, `textSize` or `belowMinimum: 'refuse'` skips this step. A chart that still does not fit is refused with the size it needs. A theme that sets a smaller size renders with one warning.
|
|
485
561
|
|
|
486
562
|
Without a size, `report` starts at 720 × 405 px and `dashboard` at 480 × 270 px; both take the height their content needs. `slide` is fixed at 888 × 396 pt (1184 × 528 px), the content frame of a 960 × 540 pt slide. `print` is fixed at 267 × 180 mm, landscape A4 inside 15 mm margins. The presets `slide-16x9` (720 × 405 px), `slide-4x3` (720 × 540 px), `a4` (1052 × 744 px) and `dashboard` (480 × 270 px) keep their sizes. `a4-landscape-content` (267 × 180 mm) and `a4-portrait-content` (180 × 267 mm) are new. A preset sets the size, not the target: use `target: "print"` with the A4 content presets. A full slide is `size: { "width": 960, "height": 540, "unit": "pt" }` with `target: "slide"`.
|
|
487
563
|
|
|
@@ -493,7 +569,7 @@ A chart in a narrow phone layout needs a new layout, not shrinking. Render it ag
|
|
|
493
569
|
|
|
494
570
|
Each type has a floor, `minWidth` × `minHeight` in layout px, and a fit, listed by `boardplot_list` and `boardplot_describe`. A `fill` type uses the whole frame. A `content` type such as `bar`, `table` or `kpi` takes the height its rows need.
|
|
495
571
|
|
|
496
|
-
The width floor of a row chart (bar, bartable, funnel, butterfly, likert, gantt, cohort, heatmap) and of a band chart (waterfall, pareto, variance, pyramid, box, mekko, pvm) is the width its content measures, and never less than the card minimum of 280 px. The chart draws full where its content fits. Below that it draws compact, and it is refused only when compact does not fit either; the refusal names the size compact needs. This also holds for a width alone. Every row and band type has a compact form, except mekko, whose `mode` names its calculation, and bullet, which compacts only by `density: 'compact'`. A horizontal waterfall and a status grid keep a 480 px floor for now. A bullet chart's width floor is the width its rows measure. A diagram draws on a card down to 280 px when no card or group text is cut and no group frame overlaps another there; otherwise it keeps a 480 px floor. A node, group, caption, badge or edge label that the narrow card would hide, or an edge label it would cut, also keeps the 480 px floor. Column, line, combo, histogram, scatter and dot keep a 480 px floor and draw below `minWidth` or `minHeight`, on either axis, down to a `compactFloor`. A pie keeps its 320 px height floor for an automatic height; a pinned pie draws compact below it, down to 160 px, while its circle keeps a radius of at least 36 px. A pinned slope draws compact under its 270 px height floor, down to 180 px, while its plot keeps 80 px; with an automatic height it takes its content height. An authored grid of several columns that refuses under 480 px draws compact: its panels stack in one column, in authored order, down to the width its widest panel measures. Metric stacks, category tiers, legacy facet grids and grids with `anchors` or `alignmentRules` have no compact form.
|
|
572
|
+
The width floor of a row chart (bar, bartable, funnel, butterfly, likert, gantt, cohort, heatmap) and of a band chart (waterfall, pareto, variance, pyramid, box, mekko, pvm) is the width its content measures, and never less than the card minimum of 280 px. The chart draws full where its content fits. Below that it draws compact, and it is refused only when compact does not fit either; the refusal names the size compact needs. This also holds for a width alone. Every row and band type has a compact form, except mekko, whose `mode` names its calculation, and bullet, which compacts only by `density: 'compact'`. A horizontal waterfall and a status grid keep a 480 px floor for now. A bullet chart's width floor is the width its rows measure. A diagram draws on a card down to 280 px when no card or group text is cut and no group frame overlaps another there; otherwise it keeps a 480 px floor. A node, group, caption, badge or edge label that the narrow card would hide, or an edge label it would cut, also keeps the 480 px floor. Column, line, combo, histogram, scatter and dot keep a 480 px floor and draw below `minWidth` or `minHeight`, on either axis, down to a `compactFloor`. A KPI card, a pie, a choropleth and a column also draw narrower than 280 px, down to 120 px (160 px for a map) and below their `compactFloor`, while their content fits: the KPI's figure, the pie's circle and labels, the map's key and small members, and the column's bars, each at least 3 px wide. Otherwise the refusal names the width the content needs. A pie keeps its 320 px height floor for an automatic height; a pinned pie draws compact below it, down to 160 px, while its circle keeps a radius of at least 36 px. A pinned slope draws compact under its 270 px height floor, down to 180 px, while its plot keeps 80 px; with an automatic height it takes its content height. An authored grid of several columns that refuses under 480 px draws compact: its panels stack in one column, in authored order, down to the width its widest panel measures. Metric stacks, category tiers, legacy facet grids and grids with `anchors` or `alignmentRules` have no compact form.
|
|
497
573
|
|
|
498
574
|
Compact mode sets minimal labels, tight spacing and the key in the footnote size. It keeps the series key, the whole title and the subtitle; a canvas too short for them is refused with the height they need. A `fill` chart in compact mode keeps a plot of at least 80 px, whichever side of the canvas is short. On a fixed width and height a canvas that cannot hold it draws the plot under that floor, down to the type's hard minimum (step 7 under "Fixed height"), and warns `plot-under-floor` with the height it needs. `belowMinimum: 'refuse'` refuses below the measured floor instead of drawing compact. A type without a compact floor refuses below its minimum. Every refusal names the minimum it needs.
|
|
499
575
|
|
|
@@ -503,8 +579,9 @@ These rules apply on every target.
|
|
|
503
579
|
|
|
504
580
|
- The title is never cut. It wraps to three lines; a title that needs more takes more lines. The subtitle wraps until every word shows. The frame grows; the plot does not shrink for it.
|
|
505
581
|
- A chart with two or more series always names them: a key row or a direct name at each series. Compact mode keeps the key, in the footnote size, and keeps an explicit `options.legend`. A line whose end names do not fit puts its key in a row above the plot at 480 px wide and narrower, never beside the plot.
|
|
506
|
-
-
|
|
507
|
-
-
|
|
582
|
+
- `options.legend` takes `'top'` (the default: one row above the plot), `'bottom'`, `'right'`, `'left'`, `'none'` or `'auto'`. `'right'` and `'left'` put the key in a column beside the plot where the plot block keeps at least 68% of the chart width and the column fits the height. Otherwise the key stays in the row above the plot and the warning `legend-side-fallback` says why. A tilemap and a choropleth take the same values. The gradient key of a heatmap stands at the right edge for `'right'` and stays above the matrix for `'left'`.
|
|
583
|
+
- A grid panel names its own series when its title names its one series, when a line or combo draws an end label with the name of every series, or when the panel draws its own key row. A grid whose panels all name their series draws no grid key under `legend: 'none'`. Otherwise the grid key row lists only the series no panel names, and the info lint `grid-legend-required` names them. A grid with no `legend` set follows the same rule when a chart panel draws two or more series.
|
|
584
|
+
- An automatic height (no height, or a width alone) reserves the plot first. The plot gets at least half of the canvas and at least 160 px (`dashboard`: 140 px). Title lines, key, annotations and notes then grow the canvas. A `fill` type starts at its own minimum height, never at a 16:9 strip of a narrow width, and at card widths (under 480 px) a fill chart is never shorter than at 480 px, compact or full. Pie, waffle, choropleth and tilemap take the height of their content, and a framed sparkline card scales its trend band with its width (an authored width, or any width from 320 px on a dashboard): their marks scale with the width, so a narrower card of these can be shorter. Wider charts keep their aspect height. A chart whose plot does not take more height (variance tiers) keeps its start height. A `content` type keeps the height of its content; at card widths a butterfly, diagram, funnel, grid, heatmap, KPI or status card is never shorter than at the next wider card step (400, then 480 px). A grid of fill panels also keeps the plot floor. When title, key, notes and the axis-label row take more of a fill chart's automatic height than the furniture budget (half of the canvas under 720 px, 40% from 720 px), the chart grows to the smallest height inside the size ladder that keeps the budget, never past the tallest ladder step; where no such height exists, the `furniture-budget` warning stands.
|
|
508
585
|
|
|
509
586
|
### Fixed height
|
|
510
587
|
|
|
@@ -520,7 +597,7 @@ On a fixed compact card, the plot first tries its hard minimum with the source l
|
|
|
520
597
|
6. The subtitle moves into the notes list (warning `subtitle-moved-to-notes`). It stays readable there and in the React notes panel. The source line stays with the host, as step 3 left it. A unit line ("Revenue in $m" without the measure) can stay on the canvas.
|
|
521
598
|
7. The plot goes under its floor, down to the type's hard minimum: a bar's rows get thinner than its segment labels need, and labels that do not fit are hidden. A column, line, combo, histogram, scatter or band chart keeps a plot of at least 40 px with room for two value-label rows, which holds two labelled value ticks; its other measured needs (end labels, rows) still apply. A value label that loses its seat goes to the note, as the note rules say.
|
|
522
599
|
|
|
523
|
-
The title is never cut and the key is never dropped. When the plot ends under its floor (160 px, `dashboard` 140 px), or a row type draws at its hard minimum, the chart is still drawn and warns `plot-under-floor`.
|
|
600
|
+
The title is never cut and the key is never dropped. When the plot ends under its floor (160 px, `dashboard` 140 px), or a row type draws at its hard minimum, the chart is still drawn and warns `plot-under-floor`. The message gives an estimated height from the drawn frame, and the warning carries no `fix`. Use `measure` for the exact verified size. Only when step 7 still misses is the chart refused with the size it needs (`size-below-floor`). Steps 6 and 7 apply on a fixed width and height in compact mode. At step 7 a heatmap row drops its 28 px comfort height to its text line and 2 px, and a dot row keeps 1 px of air instead of 4.
|
|
524
601
|
|
|
525
602
|
In React the HTML footer takes exactly the height the layout reserved for the footer it replaces, and the notes panel opens over the chart, so a chart in a fixed-height slot never grows past it. A React container without a host height hands the engine its width alone, so it takes the same automatic height and plot floor as the CLI.
|
|
526
603
|
|
|
@@ -637,6 +714,8 @@ The KPI hero figure prefers 1.5 × the M title size, rounded in the table unit,
|
|
|
637
714
|
|
|
638
715
|
A callout that uses a side other than `preferSide` reports `callout-side-changed` at info level. The warning names the callout and the side used. It does not change placement.
|
|
639
716
|
|
|
717
|
+
A callout or note text wider than any free seat wraps to two to four lines at the width that fits, next to its point. A line break written as `\n` stays where the author put it. Text that still finds no seat is named in the "Not labelled on the chart" note, as before.
|
|
718
|
+
|
|
640
719
|
`story-text-truncated` reports a story title cut at four lines or a body cut at ten lines. Its severity is `warn`. It names the step id, the line limit and `options.story.steps[index].title` or `.body`. It reports only the chosen panel layout. The suggested fix is to shorten that field or give the panel more width.
|
|
641
720
|
|
|
642
721
|
Every error and warning has one shape:
|
|
@@ -667,21 +746,23 @@ EOF
|
|
|
667
746
|
```
|
|
668
747
|
|
|
669
748
|
- `path` is a JSON Pointer into the spec you sent.
|
|
670
|
-
- `fix` is a JSON Patch. Apply it to that spec as it is, or read `suggest` and change the field yourself. It is absent when the engine has no single repair.
|
|
749
|
+
- `fix` is a JSON Patch. Apply it to that spec as it is, or read `suggest` and change the field yourself. It is absent when the engine has no single repair. A size warning on a chart that draws never carries one, and `measure` names a drawn size instead.
|
|
671
750
|
- `docs` names the reference section that describes the field.
|
|
672
751
|
- Errors come sorted by path, at most ten, then one `more-errors` entry with the count.
|
|
673
752
|
|
|
753
|
+
`options.locale: "de"` means `{ language: "de" }`. A language sets words only. Decimal and grouping marks come only from `options.locale.decimal` and `options.locale.thousands`. A root `locale` on a bare chart remains invalid, with a fix that moves its value into options.
|
|
754
|
+
|
|
674
755
|
Column, combo, bar and line charts use locale strings for built-in labels and notes. English mean labels read `Average 27.5`. German mean labels keep `Ø`. Set `options.strings.average` to change that word. Other keys cover status labels, missing-value notes, ranks, ranges and anomaly rules. Each key is listed in the reference. `options.strings` also works through the React theme provider. Authored text stays as written. Unsupported languages use English built-in wording.
|
|
675
756
|
|
|
676
757
|
A partial category is named once, such as `W38 to date`. On combo, column, bar and variance charts, and on a line chart with one line, the words stand under the running value itself where a single value or total prints there and they fit its column; the chart then draws no partial key or axis words. On a time axis (`xAxis.type: "time"`), the words stand under the running value where they have room, else after the end value in the key, else under the reading below the axis, in a row of their own where the tick rows have no room. Otherwise its key comes after the series keys. With no partial key, the chart adds a note. Set `strings.toDate` to change the suffix and `strings.partial` to change a generic partial key. Combo charts hide the default value axis when all column totals are labelled. An explicit `valueAxis.show` still wins. Column and combo category rows try a smaller font before rotation. Combo line end labels stay inside the plot and clear the columns; a moved label has a leader to its point.
|
|
677
758
|
|
|
678
|
-
Warnings have the same shape, arrive in `warnings`, and leave the drawing in place. `label-hidden`, for example, says the solver dropped a label that had no free space; `derived-mismatch` says an authored total differs from the computed one. A label collision that no size resolves refuses the chart with the error `label-collision`, which names each hidden label and what blocks it. More room does not lift it, so React shows it at once. A size refusal, and a hidden-label refusal that more width can clear, waits in a container that is still growing until the size holds still. A value, a series name, a value line or a pinned label that finds no seat is still on the page: the chart names it in a note, "Not labelled on the chart: North 42 (Q3).". The note is a disclosure: it is in the notes list and the `values-in-note` warning, and prints under the plot, also under `footnotes: false`, where `notes.show` lists `'disclosure'`. It is one note per chart. It names as many items as fit two footer lines at the drawn width, at most 8, reference lines and line end values first, then the rest in data order, and ends with a count, "and 236 more". A lone last item is named instead of "and 1 more" when it fits. When not even one name fits, the note only counts, "18 of 36 values". On a pinned height where the two-line note would push values off the plot, the note counts instead. A callout or note annotation that prints a value with `${value}` is that value's label, so the note does not name the value again. When the height is not pinned the chart first tries more height, so labels that can be drawn are drawn; the cap applies to what is left. Every item stays in the reading's `omissions` and in the hover records. `notes.maxListed` sets the number: `'all'` names every item, and `0` names none and only counts them, "18 of 36 values". `strings.moreListed` sets the wording of the count (a React chart with hover on adds "(hover shows each value)" to the default). The info warning `values-in-note` lists every value and name a chart moved into a note, once per chart, so a check of the warnings sees them. A canvas too small to name them all is refused with `size-below-floor` and the height it needs. `unknown-slot` and `pin-blocked` list a label's valid slots and, apart, the ones free now, so a pin can be corrected from the message alone.
|
|
759
|
+
Warnings have the same shape, arrive in `warnings`, and leave the drawing in place. `label-hidden`, for example, says the solver dropped a label that had no free space; `derived-mismatch` says an authored total differs from the computed one. A label collision that no size resolves refuses the chart with the error `label-collision`, which names each hidden label and what blocks it. More room does not lift it, so React shows it at once. A size refusal, and a hidden-label refusal that more width can clear, waits in a container that is still growing until the size holds still. A value, a series name, a value line or a pinned label that finds no seat is still on the page: the chart names it in a note, "Not labelled on the chart: North 42 (Q3).". The note is a disclosure: it is in the notes list and the `values-in-note` warning, and prints under the plot, also under `footnotes: false`, where `notes.show` lists `'disclosure'`. It is one note per chart. It names as many items as fit two footer lines at the drawn width, at most 8, reference lines and line end values first, then the rest in data order, and ends with a count, "and 236 more". A lone last item is named instead of "and 1 more" when it fits. When not even one name fits, the note only counts, "18 of 36 values". On a pinned height where the two-line note would push values off the plot, the note counts instead. A callout or note annotation that prints a value with `${value}` is that value's label, so the note does not name the value again. When the height is not pinned the chart first tries more height, so labels that can be drawn are drawn; the cap applies to what is left. Every item stays in the reading's `omissions` and in the hover records. `notes.maxListed` sets the number: `'all'` names every item, and `0` names none and only counts them, "18 of 36 values". `strings.moreListed` sets the wording of the count (a React chart with hover on adds "(tap or hover shows each value)" to the default). The info warning `values-in-note` lists every value and name a chart moved into a note, once per chart, so a check of the warnings sees them. A canvas too small to name them all is refused with `size-below-floor` and the height it needs. `unknown-slot` and `pin-blocked` list a label's valid slots and, apart, the ones free now, so a pin can be corrected from the message alone.
|
|
679
760
|
|
|
680
761
|
A chart with nothing to draw (no categories, series, rows or points) is reported with the one code `empty-data`, in the CLI and MCP findings, in the layout error and in React. In React, `onEmpty` is called once, and the chart shows `strings.emptyMessage` of the provider (default "No data to show.") instead of an error. `canDraw(request)` from `boardplot` answers without drawing: `{ ok: true }`, or `{ ok: false, code, minimum? }`, where `code` is `empty-data`, `too-many-items` or `size-below-floor` and `minimum` is the size the chart needs, so a host can hide a card. A table with no rows still draws its header and counts as drawn.
|
|
681
762
|
|
|
682
|
-
A chart whose drawn list holds more than 2,000 entries (the categories of a column, bar, combo, dot, variance, butterfly, funnel, waffle or bartable chart; the rows and columns of a heatmap or status matrix; the rows of a bullet or gantt chart; the items of a pareto, waterfall, likert or treemap chart; the bands of a pyramid; the cohorts of a cohort chart; a likert chart draws at most 500 items, and a mekko chart 20,000 categories) refuses at once with `too-many-items`, at the path of that list. Its layout would take minutes, and no entry would be wider than a pixel. The budget counts what the chart draws: the categories left after `topN` (bar, butterfly, column, mekko, pareto, likert, pyramid), after `viewDomain` and `window.last` on a column or combo, and after a pareto's automatic fold of a crowded tail into Rest. Aggregate the list first, or keep the largest with `topN` where the type takes it. A pie keeps its seven largest slices by default, and a pvm bridge draws aggregate effects, so neither has a budget. A dated line or area samples a long series instead, and
|
|
763
|
+
A chart whose drawn list holds more than 2,000 entries (the categories of a column, bar, combo, dot, variance, butterfly, funnel, waffle or bartable chart; the rows and columns of a heatmap or status matrix; the rows of a bullet or gantt chart; the items of a pareto, waterfall, likert or treemap chart; the bands of a pyramid; the cohorts of a cohort chart; a likert chart draws at most 500 items, and a mekko chart 20,000 categories) refuses at once with `too-many-items`, at the path of that list. Its layout would take minutes, and no entry would be wider than a pixel. The budget counts what the chart draws: the categories left after `topN` (bar, butterfly, column, dot, mekko, pareto, likert, pyramid, variance), after `viewDomain` and `window.last` on a column or combo, and after a pareto's automatic fold of a crowded tail into Rest. Aggregate the list first, or keep the largest with `topN` where the type takes it. A pie keeps its seven largest slices by default, and a pvm bridge draws aggregate effects, so neither has a budget. A dated line or area samples a long series instead. A line or area also refuses with `too-many-items`, at `/data/series`, when its cost is over 300,000 (drawn categories times series, plus 100 for each series; 1,999 categories by 200 series ran out of memory), or when drawn categories times series times series is over 100 million (300 categories by 700 series is only 210,000 points and still runs out of memory), counted after `viewDomain`, `window.last` and the sampling, so draw fewer series, aggregate the periods or draw part of them. A combo refuses the same way when its cost is over 20,000 (drawn categories times all its series, plus 40 for each series; 300 categories by 51 series take 10 s and 2.1 GB, and 10 by 1,000 do not finish). A column or bar chart with many series keeps its limit on categories only. Tables, scatter, histogram and box plots draw every row.
|
|
683
764
|
|
|
684
|
-
On a canvas the host pinned, a chart of a type with a compact floor (bar, bartable, box, butterfly, cohort, column, combo, dot, funnel, gantt, heatmap, histogram, likert, line, pareto, pvm, pyramid, scatter, variance, waffle, waterfall) that lacks room in full mode is drawn compact, and refused only when compact does not fit either; the refusal names the size compact needs. `belowMinimum: 'refuse'` keeps the full-mode refusal. A chart with no size
|
|
765
|
+
On a canvas the host pinned, a chart of a type with a compact floor (bar, bartable, box, butterfly, cohort, column, combo, dot, funnel, gantt, heatmap, histogram, likert, line, pareto, pvm, pyramid, scatter, variance, waffle, waterfall) that lacks room in full mode is drawn compact, and refused only when compact does not fit either; the refusal names the size compact needs. `belowMinimum: 'refuse'` keeps the full-mode refusal. A width alone and the fixed default canvas of `target: "slide"` and `target: "print"` count as pinned too. A chart with no size on `dashboard` or `report` grows to its full floor instead.
|
|
685
766
|
|
|
686
767
|
React reader cards reserve the chart frame. Loading and reader frames scale with the host, as the SVG does; `fixedSize` keeps their intrinsic size. A cold content-sized chart estimates its height from the data row count and row pitch plus fixed space for the chart frame. Pass `prepared` for the exact loading height, including measured text and automatic content height. The message sits in the centre and uses the chart theme. Valid full theme objects keep their tokens even when the spec is invalid. Invalid themes use the default theme. The card keeps a supplied title and source. A long host message shows at most three lines; its `title` attribute keeps the full text. The reader body and host refusal content load when needed. The server and first browser pass use a minimal busy frame with the title and source. This frame inherits host typography and paint; theme resolution and theme tokens load with the reader body. It keeps findings in `data-bp-diagnostics`; individual code and path markers load with the reader body. Developer details load only in full mode.
|
|
687
768
|
|
|
@@ -695,9 +776,19 @@ Provider strings `refusalMessage`, `refusalHint`, `emptyMessage`, `emptyHint`, `
|
|
|
695
776
|
|
|
696
777
|
In code, `refused` on a layout from `layoutResolvedRequest` marks a size refusal only. A layout whose own lints carry severity `error` is refused too: render answers it with those errors and the components draw the error card. `isRefused(layout)` from `boardplot` is true in both cases; `measure` reports both in `refused`, without `geometry`. The second argument of `measure(request, context)` takes only `theme`, `locale` and `strings`; any other key is ignored with the warning `unknown-context-key`, and a width or height belongs in `options.size`.
|
|
697
778
|
|
|
779
|
+
### Ignored options
|
|
780
|
+
|
|
781
|
+
An option a chart type does not read is ignored with an `option-ignored` warning and a JSON Patch that removes the setting. A setting that already matches the drawing gives the same warning at `info` level: for example, `valueAxis.show: false` on a chart without a value axis, or `legend: 'none'` on slope and box charts. Unsupported settings that change a number or a scale still refuse the chart.
|
|
782
|
+
|
|
783
|
+
`valueLabels` modes other than `'all'` are ignored on stacked, stacked100, football-field and tornado variants. These variants keep their normal labels and value axis.
|
|
784
|
+
|
|
698
785
|
### Design advice
|
|
699
786
|
|
|
700
|
-
Bar, line and
|
|
787
|
+
Bar, line, waterfall and diagram have a design card: what the chart says, when to use it and when not, and four to eight rules. `boardplot_describe` prints the message, the use, the not-when and the first two rules; `path: "design"` (CLI: `boardplot describe bar --path design`) prints every rule. Each rule is marked `engine` or `describe`. Render checks the `engine` rules on the drawn chart and returns each finding as a warning with severity `advice`, a code that starts with `design-`, one sentence and a `docs` link to the rule. A `fix` patch is included only when it can apply to the input as sent. Otherwise follow `suggest`; for example, a waterfall built from rows gets written advice when a patch would target generated items. Advice never changes the drawing and never refuses. A render returns at most three, the MCP server returns each code once per session, and a refused render returns none. The `describe` rules need the author's judgment, such as the business order of a bridge.
|
|
788
|
+
|
|
789
|
+
## Log scales on a line
|
|
790
|
+
|
|
791
|
+
Set `options.valueAxis.log` to `true` or `'y'` to draw a plain line with positive values and value-axis bounds on a log10 axis. Area and bump variants, percent mode, trends, phases, monotone fans, and gap fills with mismatched or monotone interpolation are refused.
|
|
701
792
|
|
|
702
793
|
## Named reference bands on a line
|
|
703
794
|
|
|
@@ -732,6 +823,8 @@ Common mistakes:
|
|
|
732
823
|
|
|
733
824
|
The line reference has the full recipe under "Cycle bands", and the fixture `cycle-bands` draws 583 monthly points this way.
|
|
734
825
|
|
|
826
|
+
`valueLine.text` is read as `label` when `label` is absent or equal, with an info warning and a rename fix. Different `text` and `label` values remain refused. `indicator100.text` remains refused.
|
|
827
|
+
|
|
735
828
|
For a `valueLine` with `value: "mean"`, `seriesId` selects the series. A paired `from` and `to` selects the inclusive category window. The mean line spans only that window. Adjacent shaded `band` annotations have a hairline between them, so each period remains distinct.
|
|
736
829
|
|
|
737
830
|
## Times and numbers on the x axis of a line
|
|
@@ -755,7 +848,8 @@ A line or area draws `data.categories` as evenly spaced names by default. For re
|
|
|
755
848
|
|
|
756
849
|
- `type` is `"time"` or `"number"`. A time is an ISO date-time; without an offset it is a wall time in `zone` (an IANA name, default `"UTC"`). A time with an offset, such as `Z` or `+01:00`, names its instant, and `zone` sets only the labels.
|
|
757
850
|
- When the clocks go back, a wall time occurs twice. The second reading of a repeated time counts as the later instant only when the order of the readings proves it, as above. Otherwise the render refuses `x-time-ambiguous`; give the offset. A wall time the change skips refuses `x-time-skipped`. The chart notes the zone and its offsets under it.
|
|
758
|
-
- `min` and `max` set the range. `tickStep` (`{ "unit": "hour", "step": 6 }`, or a number) or `ticks` (values, or `{ "value", "label" }`) set the ticks; `maxTicks` caps the automatic ones. `format` takes a
|
|
851
|
+
- `min` and `max` set the range. `tickStep` (`{ "unit": "hour", "step": 6 }`, or a number) or `ticks` (values, or `{ "value", "label" }`) set the ticks; `maxTicks` caps the automatic ones. A time axis `format` takes a pattern such as `"HH:mm"` or `"dd.MM.yyyy"`, or an example such as `"Jan 2026"`, `"Q1 2026"`, `"September 2026"` or `"2026"`. A number axis takes a number example such as `"1.5"`. `title` and, on a number axis, `unit` name the axis.
|
|
852
|
+
- Time patterns use `yyyy`, `yy`, `MMMM`, `MMM`, `MM`, `M`, `dddd`, `ddd`, `dd`, `d`, `HH`, `H`, `hh`, `h`, `mm`, `ss`, `SSS`, `a` and `'quoted literals'`. Quarter tokens are `Q` (1), `QQ` (Q1) and `QQQ` (Quarter 1). Excel `mmm` and `mmmm` name months. Lowercase `m`/`mm` in `dd/mm/yyyy` means month when the pattern has another date token and no hour or seconds token. A lone `mm`, `mm:ss` and `HH:mm` keep minutes. `YYYY`/`YY` mean year and `D`/`DD` mean day. Examples use the same numeric date reading as table dates: a day above 12 chooses the order, otherwise day first with `date-format-ambiguous`. `FY26` reads the calendar year and gives `date-format-fiscal-year` (info). Unreadable text warns `date-format-unknown` and uses the default ticks. Format warnings appear once per axis.
|
|
759
853
|
- Automatic ticks never use hours for readings that all sit at midnight in `zone`. Whole-month readings start at month ticks, and whole-year readings start at year ticks. Crowded ticks use coarser steps. This also applies to zoom views and buckets. Authored `tickStep` or `ticks` wins.
|
|
760
854
|
- Events and bands stand at any x. A value line, a delta, a callout or a target names the x of a reading. A trend fits on elapsed time and prints its slope per second, minute, hour, day or week, or per `unit` on a number axis.
|
|
761
855
|
- On a time axis, `data.x` and every annotation x anchor accept epoch milliseconds. This includes `at`, `from`, `to`, object `categoryId`, and event `date` and `end`. An epoch value names an instant; the zone sets its labels. For example, `1772496000000` is `2026-03-03T00:00:00Z`. A numeric `delta.vs` stays a comparison value. Use `vs: { categoryId: 1772496000000 }` to compare with that reading.
|
|
@@ -764,19 +858,29 @@ A line or area draws `data.categories` as evenly spaced names by default. For re
|
|
|
764
858
|
|
|
765
859
|
The fixtures `x-time-daily`, `x-time-berlin-dst`, `x-time-uneven-sensors` and `x-number-trail` show the forms.
|
|
766
860
|
|
|
861
|
+
## Calendar ticks on dated categories
|
|
862
|
+
|
|
863
|
+
A line, column or combo chart takes `options.categoryAxis.dateTicks` (`years`, `quarters`, `months`, `weeks` or `days`) when every category has an ISO `date`. A short tick under the row marks the first category of each interval, and the labels name those intervals. On column and combo the tick stands at the middle of its band, and every column keeps its place. A category without a date, or categories not in date order (for example sorted by value), leave the option unused and warn `date-ticks-unsupported`. `categoryAxis.crossesBetween` is a line setting: column and combo ignore `false` and warn `cross-between-ignored`.
|
|
864
|
+
|
|
767
865
|
## Themes
|
|
768
866
|
|
|
769
|
-
A theme sets colours, type sizes, spacing and the scenario patterns. The presets are `
|
|
867
|
+
A theme sets colours, type sizes, spacing and the scenario patterns. The presets are `bridge` (the default), `bridge-dark` (its dark pair), `boardroom`, `standard`, `standard-dark`, `notation`, `notation-dark`, `capital`, `studio` and `glass`. Use `theme: "boardroom"` for the old light look and `theme: "standard-dark"` for the old dark look. The host passes `bridge-dark` when it needs a dark chart. Presets do not switch automatically.
|
|
868
|
+
|
|
869
|
+
Bridge keeps the engine's measured default font stack: `'Helvetica Neue', Helvetica, Arial, Roboto, sans-serif`. Bridge keeps the engine's role type sizes, which the render target replaces for a preset. A host with width tables for its own licensed brand font can set `type.family` and pass its own measurer, as described in [FONTS.md](FONTS.md).
|
|
770
870
|
|
|
771
871
|
The `notation` preset follows the IBCS® Standards; IBCS is a registered trademark of the IBCS Institute, and the standards are published under CC BY-SA 4.0 at [www.ibcs.com](https://www.ibcs.com).
|
|
772
872
|
|
|
873
|
+
A theme object containing only `{ overrides }`, at the spec root or in `options.theme`, uses the default `bridge` preset. A full theme object keeps its existing meaning.
|
|
874
|
+
|
|
875
|
+
`space.canvas` overrides can contain only `base` or `wide`, and any subset of `top`, `right`, `bottom` and `left`. Missing classes and sides keep the preset values. Each side stays within 0 to 96 px. A class needs a side object, so write `{ base: { top: 16 } }` instead of `{ base: 16 }`.
|
|
876
|
+
|
|
773
877
|
A brand theme is a preset plus overrides:
|
|
774
878
|
|
|
775
879
|
```json
|
|
776
880
|
{
|
|
777
881
|
"type": "column",
|
|
778
882
|
"data": { "categories": ["2024", "2025"], "series": [{ "id": "revenue", "values": [120, 135] }] },
|
|
779
|
-
"theme": { "preset": "
|
|
883
|
+
"theme": { "preset": "bridge", "overrides": { "color": { "highlight": "#0B5CAD", "series": ["#0B5CAD", "#5B8DB8", "#A9C1D9"] } } }
|
|
780
884
|
}
|
|
781
885
|
```
|
|
782
886
|
|
|
@@ -784,10 +888,12 @@ The target replaces the type sizes of a preset; a size that `overrides` names st
|
|
|
784
888
|
|
|
785
889
|
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.
|
|
786
890
|
|
|
787
|
-
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
|
|
891
|
+
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`.
|
|
788
892
|
|
|
789
893
|
### Design system colours
|
|
790
894
|
|
|
895
|
+
Set `colorblindSafe: true` to use the theme's colour-blind good/bad pair on supported marks, including KPI deltas and chips and waterfall and pvm steps. Every chart accepts the option, and a chart with no affected marks draws the same.
|
|
896
|
+
|
|
791
897
|
Colour fields accept hex, the supported colour keywords, `rgb()` / `rgba()`, `hsl()` / `hsla()` and `oklch()`. For example, `oklch(65% 0.15 270)` becomes `#6c88ea`. Space-separated functions accept `/ alpha`, as in `hsl(210 50% 40% / 50%)`. Hue accepts degrees, `deg`, `grad`, `rad` and `turn`. OKLCH lightness accepts a number or percent; 100% chroma means 0.4. Missing components (`none`) become zero. Relative colours, `calc()`, `color-mix()` and other colour spaces are not supported. Use their computed literal colour instead.
|
|
792
898
|
|
|
793
899
|
Boardplot converts new colour forms to 8-bit sRGB before drawing. It clips each linear RGB channel to 0–1, applies the sRGB transfer function, then rounds each channel to the nearest byte. Alpha is kept. This is a fixed channel clip, so a colour outside sRGB can differ from a browser's gamut mapping. Contrast checks use the same bytes that the SVG draws. Existing hex and comma-separated RGB spellings keep their output bytes.
|
|
@@ -802,7 +908,7 @@ import { ColumnChart } from 'boardplot/react/column';
|
|
|
802
908
|
|
|
803
909
|
export function BrandChart({ dark = false }) {
|
|
804
910
|
const theme = {
|
|
805
|
-
preset: dark ? '
|
|
911
|
+
preset: dark ? 'bridge-dark' : 'bridge',
|
|
806
912
|
overrides: { color: { series: [dark ? '#8cbcff' : '#1f4e79'] } },
|
|
807
913
|
};
|
|
808
914
|
return <BoardplotTheme theme={theme}>
|
|
@@ -830,7 +936,7 @@ const visibleSeries = colouredSeries.filter(s => selectedIds.has(s.id));
|
|
|
830
936
|
|
|
831
937
|
Map every id whose colour must stay fixed. Unmapped series keep the automatic order-based colours. The map is application data; no provider state or new Boardplot option is needed. Roles follow the active theme, so a light-to-dark theme change keeps the series' rank while the theme chooses its colour. Use a shared map to `fill` instead when each id must keep an exact literal colour, and check that colour on both page themes.
|
|
832
938
|
|
|
833
|
-
If the ramp runs out, Boardplot keeps its repeat policy and warns. `series-colour-repeated` names each group that shares a colour. `series-indistinguishable` names keys with the same colour and shape. Group the tail into an “Other” series only when the values add. Otherwise use small multiples, or supply more distinct colours and assign them with `colorRole` or `fill`. Changing `seriesOverflow` to `cycle` still repeats colours.
|
|
939
|
+
If the ramp runs out, Boardplot keeps its repeat policy and warns. `series-colour-repeated` names each group that shares a colour. `series-indistinguishable` names keys with the same colour and shape. Group the tail into an “Other” series only when the values add. Otherwise use small multiples, or supply more distinct colours and assign them with `colorRole` or `fill`. Changing `seriesOverflow` to `cycle` still repeats colours. The `boardroom` preset keeps its old eight colours and their order.
|
|
834
940
|
|
|
835
941
|
Render checks colour roles present in the chart layout. `validateTheme(theme)` from `boardplot/validate` checks the full theme. Colour findings name the measured colours, vision mode and floor; contrast ratios round down to two decimals.
|
|
836
942
|
|