boardplot 0.0.0-stage → 0.53.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 +49 -0
- package/LICENSE +201 -0
- package/NOTICE.md +180 -0
- package/README.md +208 -2
- package/THIRD_PARTY_NOTICES.md +1110 -0
- package/dist/DiagnosticDetails-UNYNYCAH.js +69 -0
- package/dist/ReaderBox-VOJSJ66R.js +137 -0
- package/dist/annotateEngine-DLMFJZ67.js +30 -0
- package/dist/build-identity.json +6 -0
- package/dist/chunk-24BHMKDD.js +83 -0
- package/dist/chunk-263SZKIL.js +8 -0
- package/dist/chunk-27QADBDV.js +211 -0
- package/dist/chunk-2CVH5E57.js +128 -0
- package/dist/chunk-2DOR5SS6.js +446 -0
- package/dist/chunk-2EQE4E3I.js +22 -0
- package/dist/chunk-2FNNAPCI.js +24 -0
- package/dist/chunk-2L2Q53EP.js +251 -0
- package/dist/chunk-2LMCD3ZR.js +6 -0
- package/dist/chunk-2ND7ZITT.js +3069 -0
- package/dist/chunk-2QT5ZUHO.js +2937 -0
- package/dist/chunk-2RSG7JYI.js +24 -0
- package/dist/chunk-2V6CLH33.js +1392 -0
- package/dist/chunk-2VWJ5BGO.js +566 -0
- package/dist/chunk-2WNYRWHG.js +51 -0
- package/dist/chunk-323YZWYJ.js +548 -0
- package/dist/chunk-33PB4V6K.js +382 -0
- package/dist/chunk-33PLBIMA.js +176 -0
- package/dist/chunk-3A2IEBCN.js +195 -0
- package/dist/chunk-3D3D3D23.js +25 -0
- package/dist/chunk-3EZRM4YM.js +92 -0
- package/dist/chunk-3H2W76TB.js +2353 -0
- package/dist/chunk-3JEQGGVD.js +19 -0
- package/dist/chunk-3QWZAEW5.js +26 -0
- package/dist/chunk-3SIRPKMP.js +12 -0
- package/dist/chunk-3SQCCESO.js +1592 -0
- package/dist/chunk-3XHJHQWU.js +42 -0
- package/dist/chunk-4G2O2ZPJ.js +83 -0
- package/dist/chunk-4JLBVIGW.js +24 -0
- package/dist/chunk-4RRNJLCM.js +746 -0
- package/dist/chunk-4UVW5WU6.js +76 -0
- package/dist/chunk-4X66BTP5.js +344 -0
- package/dist/chunk-53OYF4ZT.js +687 -0
- package/dist/chunk-57ZGVAU3.js +179 -0
- package/dist/chunk-5HECRVXJ.js +62 -0
- package/dist/chunk-5LGSRWFC.js +63 -0
- package/dist/chunk-5LYXD6ME.js +1112 -0
- package/dist/chunk-66RFKRGO.js +28 -0
- package/dist/chunk-6KWIQ5KF.js +18 -0
- package/dist/chunk-6OCR6ITN.js +72 -0
- package/dist/chunk-6RBTTCQD.js +802 -0
- package/dist/chunk-6Y7EXYLR.js +563 -0
- package/dist/chunk-7CTKTIPF.js +613 -0
- package/dist/chunk-7EVIIADO.js +185 -0
- package/dist/chunk-7X2ZYVAX.js +89 -0
- package/dist/chunk-7X65ZQN4.js +38 -0
- package/dist/chunk-A4QZXLXF.js +7 -0
- package/dist/chunk-A6CQPJWR.js +49 -0
- package/dist/chunk-A7IEVBYI.js +35 -0
- package/dist/chunk-ACXX2JNL.js +6 -0
- package/dist/chunk-ADKCLH3Z.js +98 -0
- package/dist/chunk-ADWSGPH5.js +23 -0
- package/dist/chunk-AG2CJ4JY.js +203 -0
- package/dist/chunk-AHQ4L3BE.js +30 -0
- package/dist/chunk-AOQ6VF5H.js +6 -0
- package/dist/chunk-AQROQDLR.js +3303 -0
- package/dist/chunk-AWTG3RFF.js +85 -0
- package/dist/chunk-B54RN2FD.js +692 -0
- package/dist/chunk-B67K6OWJ.js +48 -0
- package/dist/chunk-B6GFKYBZ.js +40 -0
- package/dist/chunk-BBL3R5YZ.js +186 -0
- package/dist/chunk-BBRBCMNR.js +28 -0
- package/dist/chunk-BIDIGDGH.js +6 -0
- package/dist/chunk-BLFWUMTD.js +12 -0
- package/dist/chunk-BM6SFFWF.js +6 -0
- package/dist/chunk-BMRD6MAH.js +24 -0
- package/dist/chunk-BPKXEMRE.js +197 -0
- package/dist/chunk-BUPLB3EX.js +129 -0
- package/dist/chunk-BW5VLBSZ.js +15 -0
- package/dist/chunk-BWGRWGVA.js +295 -0
- package/dist/chunk-BWLOXQDV.js +131 -0
- package/dist/chunk-BWTX7LUG.js +203 -0
- package/dist/chunk-C54QLNE4.js +69 -0
- package/dist/chunk-CAQ5P4VN.js +296 -0
- package/dist/chunk-CCCEBIUZ.js +296 -0
- package/dist/chunk-CDZHNLO6.js +42 -0
- package/dist/chunk-CJGSJKPO.js +25 -0
- package/dist/chunk-CN7JRHST.js +25 -0
- package/dist/chunk-CNX7EGSU.js +266 -0
- package/dist/chunk-COYOTQC2.js +75 -0
- package/dist/chunk-CRNMNZJD.js +1161 -0
- package/dist/chunk-CUVUDK4O.js +68 -0
- package/dist/chunk-CWDHCSL2.js +2919 -0
- package/dist/chunk-CYOJZ3GQ.js +631 -0
- package/dist/chunk-D4SOADBD.js +19 -0
- package/dist/chunk-D7SHZDA3.js +1808 -0
- package/dist/chunk-DAVHGK27.js +657 -0
- package/dist/chunk-DCCJRLAJ.js +422 -0
- package/dist/chunk-DCTCUZ5L.js +51 -0
- package/dist/chunk-DDCB7ZA5.js +2511 -0
- package/dist/chunk-DDI2W4TR.js +149 -0
- package/dist/chunk-DIHUGBZO.js +61 -0
- package/dist/chunk-DJHIQWSG.js +25 -0
- package/dist/chunk-DO5OZJAO.js +302 -0
- package/dist/chunk-DOFYKPTC.js +18 -0
- package/dist/chunk-DRTA6JG5.js +160 -0
- package/dist/chunk-DRW6KGBK.js +1062 -0
- package/dist/chunk-DU4A5AOY.js +1156 -0
- package/dist/chunk-DYS7EIXY.js +294 -0
- package/dist/chunk-E4IQ6M4S.js +24 -0
- package/dist/chunk-EFUWFB64.js +24 -0
- package/dist/chunk-EHBB2Z4D.js +290 -0
- package/dist/chunk-EHVESNLV.js +30 -0
- package/dist/chunk-EJPVVGD7.js +67 -0
- package/dist/chunk-EKQK5D6G.js +14 -0
- package/dist/chunk-EUADDXAV.js +30 -0
- package/dist/chunk-F6CNPC4L.js +47 -0
- package/dist/chunk-FBAYZSFC.js +2806 -0
- package/dist/chunk-FBB4BWKN.js +30 -0
- package/dist/chunk-FF23FYQD.js +1269 -0
- package/dist/chunk-FG6EDGMI.js +53 -0
- package/dist/chunk-FHA3KMFC.js +43 -0
- package/dist/chunk-FIANWJXX.js +19 -0
- package/dist/chunk-FIWNDOMO.js +6 -0
- package/dist/chunk-FV3VF36K.js +2721 -0
- package/dist/chunk-G5FMTRG5.js +37 -0
- package/dist/chunk-GCBOHVDZ.js +229 -0
- package/dist/chunk-GDOW2KNP.js +19 -0
- package/dist/chunk-GTG3IGLF.js +2674 -0
- package/dist/chunk-GZTNTHSW.js +21 -0
- package/dist/chunk-H4H4O62O.js +46 -0
- package/dist/chunk-H5G7T35P.js +24 -0
- package/dist/chunk-H63XQ3OO.js +942 -0
- package/dist/chunk-H67RTX46.js +43 -0
- package/dist/chunk-HA4IPWMM.js +841 -0
- package/dist/chunk-HKYTOJLV.js +33 -0
- package/dist/chunk-HOAH5XBR.js +542 -0
- package/dist/chunk-HTYFQHRC.js +24 -0
- package/dist/chunk-HYY5V2KL.js +19 -0
- package/dist/chunk-HZI56ASJ.js +79 -0
- package/dist/chunk-I6VAWNNU.js +24 -0
- package/dist/chunk-IBXXZVG7.js +80 -0
- package/dist/chunk-IDDA5INB.js +60 -0
- package/dist/chunk-IK4BHOPZ.js +33 -0
- package/dist/chunk-IL5T7I2A.js +27 -0
- package/dist/chunk-ILSXT6KT.js +24 -0
- package/dist/chunk-IV2UXZXX.js +16 -0
- package/dist/chunk-IYEFEBRN.js +41 -0
- package/dist/chunk-IYMI7YI4.js +829 -0
- package/dist/chunk-J6I2YFJH.js +58 -0
- package/dist/chunk-JFBEAUJ6.js +24 -0
- package/dist/chunk-JR7Y5ONB.js +27 -0
- package/dist/chunk-JSEYUJUQ.js +836 -0
- package/dist/chunk-JYBT2JNY.js +61 -0
- package/dist/chunk-K3HSQPSM.js +24 -0
- package/dist/chunk-KAXJFL7N.js +43 -0
- package/dist/chunk-KDMKHR5A.js +32 -0
- package/dist/chunk-KKWZWP67.js +24 -0
- package/dist/chunk-KOJ5QETJ.js +8 -0
- package/dist/chunk-KPKXJYQH.js +19 -0
- package/dist/chunk-KSJVENRU.js +113 -0
- package/dist/chunk-KZJOV4QW.js +33 -0
- package/dist/chunk-KZS46KDY.js +58 -0
- package/dist/chunk-L3JWM7FR.js +50 -0
- package/dist/chunk-L4S6UFTL.js +26 -0
- package/dist/chunk-L6DJ4ZY5.js +2008 -0
- package/dist/chunk-L7RHB734.js +23 -0
- package/dist/chunk-LCWJS34U.js +38 -0
- package/dist/chunk-LFTAMH7I.js +24 -0
- package/dist/chunk-LFX7W4B7.js +113 -0
- package/dist/chunk-LINZPU5D.js +8 -0
- package/dist/chunk-LIWLBLCT.js +83 -0
- package/dist/chunk-LNKY5Z2X.js +23 -0
- package/dist/chunk-LS7HVBI7.js +24 -0
- package/dist/chunk-M4EUXOLU.js +170 -0
- package/dist/chunk-M4SPKUZE.js +7 -0
- package/dist/chunk-M4YLED7M.js +17 -0
- package/dist/chunk-MBKZYJRC.js +1424 -0
- package/dist/chunk-MCYM3RNF.js +227 -0
- package/dist/chunk-MF6IVSBJ.js +48 -0
- package/dist/chunk-MIAPBQCA.js +24 -0
- package/dist/chunk-MJZHFH5R.js +1075 -0
- package/dist/chunk-MQFCG4KS.js +1467 -0
- package/dist/chunk-MVV6RQMG.js +128 -0
- package/dist/chunk-MYMT5KJL.js +1182 -0
- package/dist/chunk-MZL6LGKO.js +587 -0
- package/dist/chunk-N23YFPPI.js +47 -0
- package/dist/chunk-N3G2FYDL.js +300 -0
- package/dist/chunk-N3TPMXS3.js +161 -0
- package/dist/chunk-N73IBH55.js +58 -0
- package/dist/chunk-N7J7CZS6.js +43 -0
- package/dist/chunk-NCB3YLHF.js +28 -0
- package/dist/chunk-NHQGRKEA.js +63 -0
- package/dist/chunk-NKIYLFXZ.js +2774 -0
- package/dist/chunk-NOSDEJ3K.js +25934 -0
- package/dist/chunk-NQDVMUHX.js +433 -0
- package/dist/chunk-NSSNYY6Y.js +58 -0
- package/dist/chunk-NY5NUFDZ.js +117 -0
- package/dist/chunk-O3S2KNIW.js +25 -0
- package/dist/chunk-O3VN6BTL.js +24 -0
- package/dist/chunk-ONZLC47B.js +88 -0
- package/dist/chunk-OQEBOVUO.js +30 -0
- package/dist/chunk-OUEGGWH7.js +24 -0
- package/dist/chunk-OURX73UJ.js +728 -0
- package/dist/chunk-P25VEGGX.js +24 -0
- package/dist/chunk-P26Z62UV.js +24 -0
- package/dist/chunk-P5RNWMZC.js +2984 -0
- package/dist/chunk-P6KZIZDV.js +987 -0
- package/dist/chunk-PEUSKIFV.js +168 -0
- package/dist/chunk-PFVTYFSL.js +24 -0
- package/dist/chunk-PWROWDZS.js +137 -0
- package/dist/chunk-Q3CV2JJ2.js +3650 -0
- package/dist/chunk-QBR6IKIX.js +50 -0
- package/dist/chunk-QGCEHR6S.js +13 -0
- package/dist/chunk-QHRE2M6V.js +26 -0
- package/dist/chunk-QKL7IY42.js +38 -0
- package/dist/chunk-QO6HEXIZ.js +272 -0
- package/dist/chunk-QOIVXZUF.js +24 -0
- package/dist/chunk-QPWRHDLZ.js +17 -0
- package/dist/chunk-QSXK6PJL.js +19 -0
- package/dist/chunk-QTZVVZ2A.js +54 -0
- package/dist/chunk-QWXWVPNE.js +18 -0
- package/dist/chunk-QY5ZKUWY.js +383 -0
- package/dist/chunk-QZAT46PP.js +95 -0
- package/dist/chunk-RA66JA3D.js +24 -0
- package/dist/chunk-REOPXBUR.js +600 -0
- package/dist/chunk-RGZGLKFB.js +648 -0
- package/dist/chunk-RL3NUWMY.js +3378 -0
- package/dist/chunk-RNOJSEES.js +16 -0
- package/dist/chunk-ROXO4R3J.js +16 -0
- package/dist/chunk-RPIW5T55.js +40 -0
- package/dist/chunk-RQ5DNYLG.js +10 -0
- package/dist/chunk-RZNYW7UP.js +133 -0
- package/dist/chunk-S32YYDIB.js +420 -0
- package/dist/chunk-S4QSJAGY.js +44 -0
- package/dist/chunk-S6UX7KB6.js +335 -0
- package/dist/chunk-SDSONLMZ.js +2546 -0
- package/dist/chunk-SGD3ZHID.js +250 -0
- package/dist/chunk-SKRSCTT5.js +28 -0
- package/dist/chunk-SMCDXUIO.js +24 -0
- package/dist/chunk-SPTPFY4S.js +528 -0
- package/dist/chunk-SREWFAAJ.js +90 -0
- package/dist/chunk-SS42FJVN.js +3875 -0
- package/dist/chunk-SVZDXFPX.js +891 -0
- package/dist/chunk-SZPTTNW7.js +16 -0
- package/dist/chunk-T3IGJARD.js +22 -0
- package/dist/chunk-TA3TFKYZ.js +86 -0
- package/dist/chunk-TBGUEF3M.js +939 -0
- package/dist/chunk-TGK6KUGN.js +331 -0
- package/dist/chunk-TJSND556.js +1783 -0
- package/dist/chunk-TKOJZQAJ.js +24 -0
- package/dist/chunk-TM4OC53S.js +97 -0
- package/dist/chunk-TNEHPP3H.js +18 -0
- package/dist/chunk-TWOREVKJ.js +1760 -0
- package/dist/chunk-TXS3U77A.js +60 -0
- package/dist/chunk-UB6ODJHO.js +134 -0
- package/dist/chunk-UBZXQIDR.js +24 -0
- package/dist/chunk-ULTSSIOU.js +38 -0
- package/dist/chunk-UMDEWWXT.js +33 -0
- package/dist/chunk-V6O6KVOA.js +347 -0
- package/dist/chunk-VABRPZVC.js +43 -0
- package/dist/chunk-VDAKTZQP.js +18 -0
- package/dist/chunk-VDAZPGR2.js +79 -0
- package/dist/chunk-VERLFNWR.js +25 -0
- package/dist/chunk-VH2UUU7K.js +24 -0
- package/dist/chunk-VJ3FCGQF.js +12 -0
- package/dist/chunk-VK5ZDV67.js +47 -0
- package/dist/chunk-VKQNDOAI.js +40 -0
- package/dist/chunk-VTEV3WVF.js +690 -0
- package/dist/chunk-VXZFQKBJ.js +21 -0
- package/dist/chunk-WI5ITCOH.js +22 -0
- package/dist/chunk-WLZ54FWG.js +120 -0
- package/dist/chunk-WYJEOMNY.js +31 -0
- package/dist/chunk-WZGJSQKN.js +29 -0
- package/dist/chunk-WZL4EEBS.js +11 -0
- package/dist/chunk-X4YNDLVA.js +54 -0
- package/dist/chunk-X6SUFTD7.js +17 -0
- package/dist/chunk-XB4KZ6WO.js +81 -0
- package/dist/chunk-XJI6SWFS.js +569 -0
- package/dist/chunk-XJP5DKIL.js +29 -0
- package/dist/chunk-XN4ARQ2W.js +47 -0
- package/dist/chunk-XN7MQO45.js +359 -0
- package/dist/chunk-XQCQZBGX.js +100 -0
- package/dist/chunk-XXOHXA3A.js +69 -0
- package/dist/chunk-XZOHR765.js +127 -0
- package/dist/chunk-YCNLQYTC.js +133 -0
- package/dist/chunk-YCRGWQBS.js +526 -0
- package/dist/chunk-YF2PYLC4.js +210 -0
- package/dist/chunk-YG5GUELW.js +935 -0
- package/dist/chunk-YS6KMYM4.js +91 -0
- package/dist/chunk-YWP7XFKD.js +12 -0
- package/dist/chunk-Z2MGTKDR.js +20 -0
- package/dist/chunk-Z6CL7AR6.js +24 -0
- package/dist/chunk-Z7X3RGGA.js +22 -0
- package/dist/chunk-ZF43WRG3.js +29 -0
- package/dist/chunk-ZMF7WEGG.js +60 -0
- package/dist/chunk-ZNHFLJSY.js +375 -0
- package/dist/chunk-ZQ4VFQID.js +76 -0
- package/dist/chunk-ZQF34VPS.js +72 -0
- package/dist/chunk-ZU425HNM.js +24 -0
- package/dist/chunk-ZZU5R5UU.js +24 -0
- package/dist/cli/index.js +9 -0
- package/dist/core-3VCCUFVX.js +32 -0
- package/dist/core-4BZQQSHS.js +33 -0
- package/dist/core-4VT4MHNB.js +38 -0
- package/dist/core-5535KXRD.js +40 -0
- package/dist/core-5HQBPCHL.js +35 -0
- package/dist/core-6RYHWUJO.js +35 -0
- package/dist/core-7BZJCIXN.js +35 -0
- package/dist/core-AJTVU6X7.js +37 -0
- package/dist/core-C6YUSTZI.js +57 -0
- package/dist/core-EEB7HTCL.js +33 -0
- package/dist/core-EFMVDWNH.js +38 -0
- package/dist/core-ETAGQBZO.js +34 -0
- package/dist/core-FVR3WZEC.js +36 -0
- package/dist/core-GCTFVYMH.js +29 -0
- package/dist/core-GES44OTS.js +33 -0
- package/dist/core-GGQREDSI.js +47 -0
- package/dist/core-HRYOV6QD.js +38 -0
- package/dist/core-IKD3EE3S.js +38 -0
- package/dist/core-JM4R426L.js +32 -0
- package/dist/core-KKQS3WI2.js +40 -0
- package/dist/core-LA6XDYG7.js +40 -0
- package/dist/core-MJ7JWQT5.js +37 -0
- package/dist/core-MLROKJ2M.js +53 -0
- package/dist/core-MR52YBRX.js +31 -0
- package/dist/core-NP4VHWXL.js +29 -0
- package/dist/core-NQLNZDX5.js +41 -0
- package/dist/core-NSIJEKLI.js +44 -0
- package/dist/core-OJUQLIQ5.js +35 -0
- package/dist/core-PB3VUQSS.js +32 -0
- package/dist/core-Q6VLFFYC.js +56 -0
- package/dist/core-QY7AVIKZ.js +51 -0
- package/dist/core-SBQMHWTA.js +52 -0
- package/dist/core-UHECQHJ2.js +38 -0
- package/dist/core-V5FV4NWL.js +56 -0
- package/dist/core-WGM4XUN3.js +58 -0
- package/dist/core-WUQVFARS.js +34 -0
- package/dist/core-Z2F3IGSR.js +42 -0
- package/dist/dataTable-3CPPIHB3.js +58 -0
- package/dist/engine-FXFBCWHB.js +961 -0
- package/dist/fixtures.d.ts +1 -0
- package/dist/fixtures.js +41 -0
- package/dist/fontTables-WYCZNRE7.js +18 -0
- package/dist/fonts.d.ts +1 -0
- package/dist/fonts.js +19 -0
- package/dist/geo/dach.d.ts +1 -0
- package/dist/geo/dach.js +14 -0
- package/dist/geo/de-states.d.ts +1 -0
- package/dist/geo/de-states.js +14 -0
- package/dist/geo/eu27.d.ts +1 -0
- package/dist/geo/eu27.js +14 -0
- package/dist/geo/europe.d.ts +1 -0
- package/dist/geo/europe.js +14 -0
- package/dist/geo/index.d.ts +1 -0
- package/dist/geo/index.js +41 -0
- package/dist/geo/us-states.d.ts +1 -0
- package/dist/geo/us-states.js +14 -0
- package/dist/geo/world.d.ts +1 -0
- package/dist/geo/world.js +14 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +364 -0
- package/dist/main-YLKBTHJP.js +569 -0
- package/dist/mcp/server.js +1025 -0
- package/dist/module-SVEW5ZUE.js +137233 -0
- package/dist/react/bar.d.ts +1 -0
- package/dist/react/bar.js +81 -0
- package/dist/react/bartable.d.ts +1 -0
- package/dist/react/bartable.js +70 -0
- package/dist/react/box.d.ts +1 -0
- package/dist/react/box.js +65 -0
- package/dist/react/bullet.d.ts +1 -0
- package/dist/react/bullet.js +72 -0
- package/dist/react/butterfly.d.ts +1 -0
- package/dist/react/butterfly.js +66 -0
- package/dist/react/choropleth.d.ts +1 -0
- package/dist/react/choropleth.js +67 -0
- package/dist/react/cohort.d.ts +1 -0
- package/dist/react/cohort.js +70 -0
- package/dist/react/column.d.ts +1 -0
- package/dist/react/column.js +86 -0
- package/dist/react/combo.d.ts +1 -0
- package/dist/react/combo.js +86 -0
- package/dist/react/creative.d.ts +1 -0
- package/dist/react/creative.js +61 -0
- package/dist/react/diagram.d.ts +1 -0
- package/dist/react/diagram.js +60 -0
- package/dist/react/dimswitch.d.ts +1 -0
- package/dist/react/dimswitch.js +72 -0
- package/dist/react/dot.d.ts +1 -0
- package/dist/react/dot.js +70 -0
- package/dist/react/export.d.ts +1 -0
- package/dist/react/export.js +658 -0
- package/dist/react/funnel.d.ts +1 -0
- package/dist/react/funnel.js +63 -0
- package/dist/react/gantt.d.ts +1 -0
- package/dist/react/gantt.js +62 -0
- package/dist/react/grid.d.ts +1 -0
- package/dist/react/grid.js +67 -0
- package/dist/react/heatmap.d.ts +1 -0
- package/dist/react/heatmap.js +68 -0
- package/dist/react/histogram.d.ts +1 -0
- package/dist/react/histogram.js +86 -0
- package/dist/react/index.d.ts +1 -0
- package/dist/react/index.js +504 -0
- package/dist/react/kpi.d.ts +1 -0
- package/dist/react/kpi.js +67 -0
- package/dist/react/likert.d.ts +1 -0
- package/dist/react/likert.js +83 -0
- package/dist/react/line.d.ts +1 -0
- package/dist/react/line.js +81 -0
- package/dist/react/mekko.d.ts +1 -0
- package/dist/react/mekko.js +71 -0
- package/dist/react/pareto.d.ts +1 -0
- package/dist/react/pareto.js +90 -0
- package/dist/react/pie.d.ts +1 -0
- package/dist/react/pie.js +64 -0
- package/dist/react/prepare.d.ts +1 -0
- package/dist/react/prepare.js +278 -0
- package/dist/react/pvm.d.ts +1 -0
- package/dist/react/pvm.js +68 -0
- package/dist/react/pyramid.d.ts +1 -0
- package/dist/react/pyramid.js +67 -0
- package/dist/react/sankey.d.ts +1 -0
- package/dist/react/sankey.js +59 -0
- package/dist/react/scatter.d.ts +1 -0
- package/dist/react/scatter.js +63 -0
- package/dist/react/slope.d.ts +1 -0
- package/dist/react/slope.js +64 -0
- package/dist/react/sparkline.d.ts +1 -0
- package/dist/react/sparkline.js +59 -0
- package/dist/react/spec.d.ts +1 -0
- package/dist/react/spec.js +379 -0
- package/dist/react/status.d.ts +1 -0
- package/dist/react/status.js +64 -0
- package/dist/react/story.d.ts +1 -0
- package/dist/react/story.js +140 -0
- package/dist/react/table.d.ts +1 -0
- package/dist/react/table.js +69 -0
- package/dist/react/theme.d.ts +1 -0
- package/dist/react/theme.js +53 -0
- package/dist/react/tilemap.d.ts +1 -0
- package/dist/react/tilemap.js +66 -0
- package/dist/react/treemap.d.ts +1 -0
- package/dist/react/treemap.js +61 -0
- package/dist/react/variance.d.ts +1 -0
- package/dist/react/variance.js +65 -0
- package/dist/react/waffle.d.ts +1 -0
- package/dist/react/waffle.js +62 -0
- package/dist/react/waterfall.d.ts +1 -0
- package/dist/react/waterfall.js +68 -0
- package/dist/resvg-ZOVDIZTV.js +23 -0
- package/dist/rows.d.ts +1 -0
- package/dist/rows.js +23 -0
- package/dist/rowsModule-YVLAROIP.js +27 -0
- package/dist/schema-2K6C3U24.js +23 -0
- package/dist/schema-2KIHLTYI.js +23 -0
- package/dist/schema-4HY2MWZC.js +30 -0
- package/dist/schema-4S5CXHAO.js +24 -0
- package/dist/schema-5BKQV56C.js +27 -0
- package/dist/schema-5HA5DSYN.js +24 -0
- package/dist/schema-5NKJPSBD.js +23 -0
- package/dist/schema-65FOKNHK.js +43 -0
- package/dist/schema-6OHZWHUI.js +23 -0
- package/dist/schema-6RYJS2GM.js +24 -0
- package/dist/schema-6W4M3WJ4.js +23 -0
- package/dist/schema-7TLSFG6M.js +24 -0
- package/dist/schema-AMFRKUFS.js +27 -0
- package/dist/schema-B7CZPPB4.js +28 -0
- package/dist/schema-BNRNHGHQ.js +26 -0
- package/dist/schema-E4MRCGPZ.js +24 -0
- package/dist/schema-F3WYTR65.js +26 -0
- package/dist/schema-FA6XIHTW.js +23 -0
- package/dist/schema-GZNOW4LX.js +23 -0
- package/dist/schema-HEIDGCSL.js +23 -0
- package/dist/schema-JB2H6KPA.js +23 -0
- package/dist/schema-MPXZNWV3.js +23 -0
- package/dist/schema-NHNQK6XO.js +23 -0
- package/dist/schema-NN6UPDPW.js +23 -0
- package/dist/schema-O4YNAGIY.js +23 -0
- package/dist/schema-O7AKK232.js +29 -0
- package/dist/schema-OJCML6LV.js +24 -0
- package/dist/schema-ORTRMYI6.js +24 -0
- package/dist/schema-PJ6P52BC.js +23 -0
- package/dist/schema-RTWES6NR.js +24 -0
- package/dist/schema-S36SRYGO.js +24 -0
- package/dist/schema-S3TCLTYD.js +23 -0
- package/dist/schema-SWWMOLOR.js +54 -0
- package/dist/schema-WOSEZNKG.js +26 -0
- package/dist/schema-Y6KBWUUR.js +23 -0
- package/dist/schema-YQYTLKSW.js +23 -0
- package/dist/schema-ZUUUY3QS.js +33 -0
- package/dist/specValidation-VNWIKLHH.js +49 -0
- package/dist/theme.d.ts +1 -0
- package/dist/theme.js +24 -0
- package/dist/themeShapeRules-2D3KWSPQ.js +11 -0
- package/dist/types/core/a11y/accessibility.d.ts +43 -0
- package/dist/types/core/a11y/recordsShared.d.ts +44 -0
- package/dist/types/core/a11y/structuralRecords.d.ts +6 -0
- package/dist/types/core/a11y/types.d.ts +116 -0
- package/dist/types/core/annotate.d.ts +300 -0
- package/dist/types/core/annotateArms.d.ts +37 -0
- package/dist/types/core/annotateFields.d.ts +30 -0
- package/dist/types/core/annotateGapBracket.d.ts +66 -0
- package/dist/types/core/annotateLinks.d.ts +47 -0
- package/dist/types/core/annotateTargets.d.ts +90 -0
- package/dist/types/core/axis.d.ts +179 -0
- package/dist/types/core/bandSelect.d.ts +10 -0
- package/dist/types/core/bands.d.ts +14 -0
- package/dist/types/core/calendarLabels.d.ts +101 -0
- package/dist/types/core/charts/band/stacks.d.ts +155 -0
- package/dist/types/core/charts/bar/fixtures.d.ts +9 -0
- package/dist/types/core/charts/bar/layout.d.ts +95 -0
- package/dist/types/core/charts/bartable/fixtures.d.ts +4 -0
- package/dist/types/core/charts/bartable/types.d.ts +192 -0
- package/dist/types/core/charts/box/fixtures.d.ts +12 -0
- package/dist/types/core/charts/box/types.d.ts +110 -0
- package/dist/types/core/charts/bullet/fixtures.d.ts +11 -0
- package/dist/types/core/charts/butterfly/fixtures.d.ts +9 -0
- package/dist/types/core/charts/choropleth/fixtures.d.ts +3 -0
- package/dist/types/core/charts/choropleth/overlayTypes.d.ts +68 -0
- package/dist/types/core/charts/choropleth/types.d.ts +117 -0
- package/dist/types/core/charts/cohort/fixtures.d.ts +12 -0
- package/dist/types/core/charts/cohort/types.d.ts +165 -0
- package/dist/types/core/charts/column/anomaly.d.ts +204 -0
- package/dist/types/core/charts/column/fixtures.d.ts +12 -0
- package/dist/types/core/charts/column/layout.d.ts +116 -0
- package/dist/types/core/charts/column/model.d.ts +295 -0
- package/dist/types/core/charts/column/types.d.ts +56 -0
- package/dist/types/core/charts/combo/endpoints.d.ts +165 -0
- package/dist/types/core/charts/combo/fixtures.d.ts +12 -0
- package/dist/types/core/charts/combo/layout.d.ts +48 -0
- package/dist/types/core/charts/creative/fixtures.d.ts +4 -0
- package/dist/types/core/charts/creative/types.d.ts +73 -0
- package/dist/types/core/charts/diagram/fixtures.d.ts +3 -0
- package/dist/types/core/charts/dimswitch/compile.d.ts +20 -0
- package/dist/types/core/charts/dimswitch/fixtures.d.ts +3 -0
- package/dist/types/core/charts/dimswitch/types.d.ts +152 -0
- package/dist/types/core/charts/dot/fixtures.d.ts +11 -0
- package/dist/types/core/charts/funnel/fixtures.d.ts +11 -0
- package/dist/types/core/charts/gantt/fixtures.d.ts +9 -0
- package/dist/types/core/charts/gantt/layout.d.ts +63 -0
- package/dist/types/core/charts/grid/fixtures.d.ts +3 -0
- package/dist/types/core/charts/grid/metricStack.d.ts +108 -0
- package/dist/types/core/charts/grid/metricStackSchema.d.ts +74 -0
- package/dist/types/core/charts/grid/normalize.d.ts +99 -0
- package/dist/types/core/charts/grid/schema.d.ts +168 -0
- package/dist/types/core/charts/heatmap/fixtures.d.ts +11 -0
- package/dist/types/core/charts/histogram/fixtures.d.ts +15 -0
- package/dist/types/core/charts/histogram/types.d.ts +98 -0
- package/dist/types/core/charts/kpi/fixtures.d.ts +9 -0
- package/dist/types/core/charts/likert/fixtures.d.ts +11 -0
- package/dist/types/core/charts/likert/layout.d.ts +111 -0
- package/dist/types/core/charts/line/fixtures.d.ts +16 -0
- package/dist/types/core/charts/line/types.d.ts +6 -0
- package/dist/types/core/charts/mekko/fixtures.d.ts +13 -0
- package/dist/types/core/charts/pareto/fixtures.d.ts +5 -0
- package/dist/types/core/charts/pareto/layout.d.ts +68 -0
- package/dist/types/core/charts/pie/fixtures.d.ts +14 -0
- package/dist/types/core/charts/pvm/fixtures.d.ts +13 -0
- package/dist/types/core/charts/pvm/types.d.ts +118 -0
- package/dist/types/core/charts/pyramid/fixtures.d.ts +4 -0
- package/dist/types/core/charts/pyramid/types.d.ts +92 -0
- package/dist/types/core/charts/sankey/fixtures.d.ts +4 -0
- package/dist/types/core/charts/sankey/types.d.ts +116 -0
- package/dist/types/core/charts/scatter/fixtures.d.ts +12 -0
- package/dist/types/core/charts/scatter/types.d.ts +58 -0
- package/dist/types/core/charts/slope/fixtures.d.ts +13 -0
- package/dist/types/core/charts/sparkline/fixtures.d.ts +9 -0
- package/dist/types/core/charts/status/fixtures.d.ts +8 -0
- package/dist/types/core/charts/status/layout.d.ts +71 -0
- package/dist/types/core/charts/table/fitFormats.d.ts +67 -0
- package/dist/types/core/charts/table/fixtures.d.ts +7 -0
- package/dist/types/core/charts/table/resolve.d.ts +72 -0
- package/dist/types/core/charts/table/view.d.ts +156 -0
- package/dist/types/core/charts/tilemap/fixtures.d.ts +3 -0
- package/dist/types/core/charts/tilemap/types.d.ts +94 -0
- package/dist/types/core/charts/treemap/fixtures.d.ts +4 -0
- package/dist/types/core/charts/treemap/types.d.ts +78 -0
- package/dist/types/core/charts/variance/fixtures.d.ts +12 -0
- package/dist/types/core/charts/waffle/fixtures.d.ts +5 -0
- package/dist/types/core/charts/waffle/types.d.ts +117 -0
- package/dist/types/core/charts/waterfall/fixtures.d.ts +9 -0
- package/dist/types/core/claims/browser.d.ts +49 -0
- package/dist/types/core/claims/manifest.d.ts +22 -0
- package/dist/types/core/dateFormat.d.ts +39 -0
- package/dist/types/core/deferred.d.ts +121 -0
- package/dist/types/core/diagnostics/describe.d.ts +149 -0
- package/dist/types/core/diagnostics/jsonPatch.d.ts +36 -0
- package/dist/types/core/doc/bareChart.d.ts +2 -0
- package/dist/types/core/doc/diagnostics.d.ts +124 -0
- package/dist/types/core/doc/docExpand.d.ts +39 -0
- package/dist/types/core/doc/document.d.ts +43 -0
- package/dist/types/core/doc/ownedDocumentCopy.d.ts +5 -0
- package/dist/types/core/doc/specError.d.ts +6 -0
- package/dist/types/core/emptyData.d.ts +27 -0
- package/dist/types/core/eventLane.d.ts +208 -0
- package/dist/types/core/fontMetrics/index.d.ts +47 -0
- package/dist/types/core/fontMetrics/injected.d.ts +40 -0
- package/dist/types/core/fontMetrics/tableDocument.d.ts +73 -0
- package/dist/types/core/fontMetrics/tables.generated.d.ts +17 -0
- package/dist/types/core/footer.d.ts +59 -0
- package/dist/types/core/format.d.ts +149 -0
- package/dist/types/core/formatPrecision.d.ts +136 -0
- package/dist/types/core/formatSpec.d.ts +304 -0
- package/dist/types/core/frame.d.ts +583 -0
- package/dist/types/core/geo/packs/all.d.ts +7 -0
- package/dist/types/core/geo/packs/dach.d.ts +16 -0
- package/dist/types/core/geo/packs/de-states.d.ts +16 -0
- package/dist/types/core/geo/packs/eu27.d.ts +16 -0
- package/dist/types/core/geo/packs/europe.d.ts +16 -0
- package/dist/types/core/geo/packs/index.d.ts +22 -0
- package/dist/types/core/geo/packs/registry.d.ts +37 -0
- package/dist/types/core/geo/packs/us-states.d.ts +16 -0
- package/dist/types/core/geo/packs/world.d.ts +16 -0
- package/dist/types/core/geo/tiles/eu27.generated.d.ts +412 -0
- package/dist/types/core/geo/tiles/europe.generated.d.ts +842 -0
- package/dist/types/core/geo/tiles/index.d.ts +8 -0
- package/dist/types/core/geo/tiles/types.d.ts +36 -0
- package/dist/types/core/geo/tiles/us-states.generated.d.ts +952 -0
- package/dist/types/core/geo/tiles/world.generated.d.ts +968 -0
- package/dist/types/core/geo/types.d.ts +146 -0
- package/dist/types/core/geometry.d.ts +102 -0
- package/dist/types/core/grid/sharedScale.d.ts +82 -0
- package/dist/types/core/icons.d.ts +227 -0
- package/dist/types/core/inputError.d.ts +14 -0
- package/dist/types/core/isoDate.d.ts +2 -0
- package/dist/types/core/isoTime.d.ts +7 -0
- package/dist/types/core/label/categoryRow.d.ts +332 -0
- package/dist/types/core/label/occupied.d.ts +41 -0
- package/dist/types/core/label/ownership.d.ts +83 -0
- package/dist/types/core/label/solver.d.ts +384 -0
- package/dist/types/core/label/tickRow.d.ts +78 -0
- package/dist/types/core/live/types.d.ts +50 -0
- package/dist/types/core/normalize/shared.d.ts +56 -0
- package/dist/types/core/notes.d.ts +174 -0
- package/dist/types/core/othersShade.d.ts +9 -0
- package/dist/types/core/periodYears.d.ts +9 -0
- package/dist/types/core/polyline.d.ts +11 -0
- package/dist/types/core/rangeRules.d.ts +19 -0
- package/dist/types/core/ratioTier.d.ts +120 -0
- package/dist/types/core/readerStrings.d.ts +13 -0
- package/dist/types/core/reading.d.ts +120 -0
- package/dist/types/core/registry.d.ts +178 -0
- package/dist/types/core/repaintGeometry.d.ts +19 -0
- package/dist/types/core/request.d.ts +124 -0
- package/dist/types/core/rows.d.ts +47 -0
- package/dist/types/core/scale.d.ts +106 -0
- package/dist/types/core/schema/capability.d.ts +229 -0
- package/dist/types/core/schema/namedColumns.d.ts +45 -0
- package/dist/types/core/schema/reference.d.ts +31 -0
- package/dist/types/core/schema/refusals.d.ts +45 -0
- package/dist/types/core/schema/unknownKeys.d.ts +45 -0
- package/dist/types/core/seriesIdentity.d.ts +120 -0
- package/dist/types/core/shareRounding.d.ts +49 -0
- package/dist/types/core/sizing.d.ts +330 -0
- package/dist/types/core/staticFooter.d.ts +6 -0
- package/dist/types/core/story.d.ts +41 -0
- package/dist/types/core/structureCounts.d.ts +10 -0
- package/dist/types/core/svg/renderSvg.d.ts +51 -0
- package/dist/types/core/target.d.ts +89 -0
- package/dist/types/core/text.d.ts +113 -0
- package/dist/types/core/theme.d.ts +478 -0
- package/dist/types/core/themeFields.d.ts +11 -0
- package/dist/types/core/themeRules.d.ts +111 -0
- package/dist/types/core/themeShape.d.ts +87 -0
- package/dist/types/core/themeValidate.d.ts +15 -0
- package/dist/types/core/timeAxis.d.ts +106 -0
- package/dist/types/core/types/annotations.d.ts +227 -0
- package/dist/types/core/types/cell.d.ts +82 -0
- package/dist/types/core/types/data.d.ts +314 -0
- package/dist/types/core/types/diagram.d.ts +234 -0
- package/dist/types/core/types/index.d.ts +8 -0
- package/dist/types/core/types/options.d.ts +1583 -0
- package/dist/types/core/types/scene.d.ts +990 -0
- package/dist/types/core/types/sizing.d.ts +51 -0
- package/dist/types/core/types/table.d.ts +873 -0
- package/dist/types/core/types/theme.d.ts +806 -0
- package/dist/types/core/zoom.d.ts +106 -0
- package/dist/types/fixtures/index.d.ts +40 -0
- package/dist/types/fixtures/registry.d.ts +15 -0
- package/dist/types/fonts.d.ts +10 -0
- package/dist/types/index.d.ts +70 -0
- package/dist/types/react/BoardplotTheme.d.ts +9 -0
- package/dist/types/react/DimSwitchChart.d.ts +36 -0
- package/dist/types/react/ScaleGroup.d.ts +31 -0
- package/dist/types/react/SceneRenderer.d.ts +23 -0
- package/dist/types/react/SizePlaceholder.d.ts +51 -0
- package/dist/types/react/StoryFrame.d.ts +42 -0
- package/dist/types/react/TableChart.d.ts +220 -0
- package/dist/types/react/a11ySurface.d.ts +20 -0
- package/dist/types/react/barrelCharts.d.ts +1023 -0
- package/dist/types/react/charts/bar.d.ts +28 -0
- package/dist/types/react/charts/bartable.d.ts +27 -0
- package/dist/types/react/charts/box.d.ts +27 -0
- package/dist/types/react/charts/bullet.d.ts +28 -0
- package/dist/types/react/charts/butterfly.d.ts +28 -0
- package/dist/types/react/charts/choropleth.d.ts +27 -0
- package/dist/types/react/charts/cohort.d.ts +52 -0
- package/dist/types/react/charts/column.d.ts +27 -0
- package/dist/types/react/charts/combo.d.ts +7 -0
- package/dist/types/react/charts/creative.d.ts +27 -0
- package/dist/types/react/charts/diagram.d.ts +162 -0
- package/dist/types/react/charts/dimswitch.d.ts +6 -0
- package/dist/types/react/charts/dot.d.ts +28 -0
- package/dist/types/react/charts/funnel.d.ts +28 -0
- package/dist/types/react/charts/gantt.d.ts +28 -0
- package/dist/types/react/charts/grid.d.ts +29 -0
- package/dist/types/react/charts/heatmap.d.ts +28 -0
- package/dist/types/react/charts/histogram.d.ts +27 -0
- package/dist/types/react/charts/kpi.d.ts +28 -0
- package/dist/types/react/charts/likert.d.ts +27 -0
- package/dist/types/react/charts/line.d.ts +28 -0
- package/dist/types/react/charts/mekko.d.ts +28 -0
- package/dist/types/react/charts/pareto.d.ts +28 -0
- package/dist/types/react/charts/pie.d.ts +28 -0
- package/dist/types/react/charts/pvm.d.ts +27 -0
- package/dist/types/react/charts/pyramid.d.ts +27 -0
- package/dist/types/react/charts/sankey.d.ts +27 -0
- package/dist/types/react/charts/scatter.d.ts +28 -0
- package/dist/types/react/charts/slope.d.ts +28 -0
- package/dist/types/react/charts/sparkline.d.ts +28 -0
- package/dist/types/react/charts/status.d.ts +27 -0
- package/dist/types/react/charts/table.d.ts +6 -0
- package/dist/types/react/charts/tilemap.d.ts +27 -0
- package/dist/types/react/charts/treemap.d.ts +27 -0
- package/dist/types/react/charts/variance.d.ts +28 -0
- package/dist/types/react/charts/waffle.d.ts +28 -0
- package/dist/types/react/charts/waterfall.d.ts +28 -0
- package/dist/types/react/createChartComponent.d.ts +135 -0
- package/dist/types/react/export/clipboard.d.ts +8 -0
- package/dist/types/react/export/csv.d.ts +2 -0
- package/dist/types/react/export/frame.d.ts +35 -0
- package/dist/types/react/export/index.d.ts +7 -0
- package/dist/types/react/export/png.d.ts +14 -0
- package/dist/types/react/export/svg.d.ts +5 -0
- package/dist/types/react/export/types.d.ts +69 -0
- package/dist/types/react/export/useExport.d.ts +17 -0
- package/dist/types/react/exportLink.d.ts +49 -0
- package/dist/types/react/footerFrame.d.ts +25 -0
- package/dist/types/react/hover/dataTable.d.ts +13 -0
- package/dist/types/react/hover/engine.d.ts +210 -0
- package/dist/types/react/hover/keyboard.d.ts +44 -0
- package/dist/types/react/hover/labelCard.d.ts +170 -0
- package/dist/types/react/hover/placement.d.ts +49 -0
- package/dist/types/react/index.d.ts +16 -0
- package/dist/types/react/parseChartSpec.d.ts +16 -0
- package/dist/types/react/prepare.d.ts +32 -0
- package/dist/types/react/prepared.d.ts +53 -0
- package/dist/types/react/preparedTable.d.ts +15 -0
- package/dist/types/react/rowsInput.d.ts +55 -0
- package/dist/types/react/rowsModule.d.ts +18 -0
- package/dist/types/react/rowsStore.d.ts +50 -0
- package/dist/types/react/scale-group.d.ts +2 -0
- package/dist/types/react/scaleGroupContext.d.ts +22 -0
- package/dist/types/react/scenePaint.d.ts +10 -0
- package/dist/types/react/scrollState.d.ts +26 -0
- package/dist/types/react/spec.d.ts +82 -0
- package/dist/types/react/specValidation.d.ts +45 -0
- package/dist/types/react/story.d.ts +15 -0
- package/dist/types/react/theme.d.ts +9 -0
- package/dist/types/react/themeContext.d.ts +44 -0
- package/dist/types/react/useChartLayout.d.ts +22 -0
- package/dist/types/react/useContainerSize.d.ts +57 -0
- package/dist/types/react/useHover.d.ts +100 -0
- package/dist/types/react/useZoom.d.ts +50 -0
- package/dist/types/rows.d.ts +63 -0
- package/dist/types/tableLooks.d.ts +6 -0
- package/dist/types/theme.d.ts +3 -0
- package/dist/types/validate.d.ts +3 -0
- package/dist/validate.d.ts +1 -0
- package/dist/validate.js +223 -0
- package/docs/FONTS.md +68 -0
- package/docs/TELEMETRY.md +94 -0
- package/docs/manual.md +850 -0
- package/docs/reference/bar.md +222 -0
- package/docs/reference/bartable.md +143 -0
- package/docs/reference/box.md +93 -0
- package/docs/reference/bullet.md +118 -0
- package/docs/reference/butterfly.md +117 -0
- package/docs/reference/choropleth.md +148 -0
- package/docs/reference/cohort.md +149 -0
- package/docs/reference/column.md +275 -0
- package/docs/reference/combo.md +219 -0
- package/docs/reference/creative.md +147 -0
- package/docs/reference/diagram.md +191 -0
- package/docs/reference/dimswitch.md +1395 -0
- package/docs/reference/dot.md +117 -0
- package/docs/reference/fixtures.md +1089 -0
- package/docs/reference/funnel.md +121 -0
- package/docs/reference/gantt.md +138 -0
- package/docs/reference/grid.md +302 -0
- package/docs/reference/heatmap.md +127 -0
- package/docs/reference/histogram.md +77 -0
- package/docs/reference/kpi.md +115 -0
- package/docs/reference/likert.md +113 -0
- package/docs/reference/line.md +436 -0
- package/docs/reference/mekko.md +114 -0
- package/docs/reference/options.md +313 -0
- package/docs/reference/pareto.md +102 -0
- package/docs/reference/pie.md +114 -0
- package/docs/reference/pvm.md +114 -0
- package/docs/reference/pyramid.md +99 -0
- package/docs/reference/react.md +706 -0
- package/docs/reference/reading.md +28 -0
- package/docs/reference/sankey.md +110 -0
- package/docs/reference/scatter.md +211 -0
- package/docs/reference/slope.md +126 -0
- package/docs/reference/sparkline.md +74 -0
- package/docs/reference/status.md +107 -0
- package/docs/reference/table.md +673 -0
- package/docs/reference/theme.md +361 -0
- package/docs/reference/tilemap.md +121 -0
- package/docs/reference/treemap.md +86 -0
- package/docs/reference/variance.md +126 -0
- package/docs/reference/waffle.md +106 -0
- package/docs/reference/waterfall.md +164 -0
- package/llms.txt +57 -0
- package/package.json +437 -4
|
@@ -0,0 +1,706 @@
|
|
|
1
|
+
# React
|
|
2
|
+
|
|
3
|
+
Contents: [BoardplotChart](#boardplotchart), [Spec settings](#spec-settings), [Per-type components](#per-type-components), [Rows from a query](#rows-from-a-query), [The table component](#the-table-component), [The dimswitch component](#the-dimswitch-component), [Container sizing](#container-sizing), [Series colours under a filter](#series-colours-under-a-filter), [Theme provider](#theme-provider), [Targets](#targets), [Refusals](#refusals), [Content security policy](#content-security-policy), [Server preparation](#server-preparation), [Bundlers and side effects](#bundlers-and-side-effects), [Maps](#maps), [Hover](#hover), [Zoom](#zoom), [Story](#story), [Shared value scale](#shared-value-scale), [Export](#export), [Package entry points](#package-entry-points), [Static SVG without React](#static-svg-without-react).
|
|
4
|
+
|
|
5
|
+
<!-- Generated by scripts/generate-reference.mjs from the boardplot describe, list and fixtures payloads. -->
|
|
6
|
+
|
|
7
|
+
Boardplot ships one spec-driven component, `BoardplotChart`, and one component per chart type. Both draw with the same layout engine as `boardplot_render`; the SVG in the browser matches the CLI output for the same spec, theme and size. `react` and `react-dom` 18 or 19 are peer dependencies.
|
|
8
|
+
|
|
9
|
+
## BoardplotChart
|
|
10
|
+
|
|
11
|
+
`BoardplotChart` from `boardplot/react/spec` takes the spec `boardplot_render` validates: a bare chart `{ name, type, data, options, annotations, theme }` or an envelope with one chart. An invalid spec or setting renders `SpecErrorCard`, which lists each error with its path, expected and received values, suggestion, JSON Patch `fix` and reference link.
|
|
12
|
+
|
|
13
|
+
```tsx
|
|
14
|
+
import { BoardplotChart } from 'boardplot/react/spec';
|
|
15
|
+
|
|
16
|
+
const spec = {
|
|
17
|
+
name: 'revenue-mix',
|
|
18
|
+
type: 'column',
|
|
19
|
+
data: { categories: ['2021', '2022', '2023', '2024', '2025'], series: [{ id: 'subscriptions', label: 'Subscriptions', values: [62, 74, 88, 103, 121] }, { id: 'services', label: 'Services', values: [38, 41, 43, 44, 46] }] },
|
|
20
|
+
annotations: [{ kind: 'cagr' }],
|
|
21
|
+
options: { variant: 'stacked', title: 'Subscriptions carry the growth', subtitle: { measure: 'Revenue by line' }, unit: '$m' },
|
|
22
|
+
};
|
|
23
|
+
|
|
24
|
+
export function RevenueMix() {
|
|
25
|
+
return <BoardplotChart spec={spec} size="container" fit="fill" fallbackSize={{ width: 960, height: 540 }} />;
|
|
26
|
+
}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
| Prop | Meaning |
|
|
30
|
+
|---|---|
|
|
31
|
+
| `spec` | The bare chart or an envelope with one chart. |
|
|
32
|
+
| `rows`, `columns`, `onRowsReading` | Query rows that fill a bare chart's data, as `rows` in `boardplot_render` fills it; see [Rows from a query](#rows-from-a-query). |
|
|
33
|
+
| `size`, `fit`, `fallbackSize` | Container sizing; see [Container sizing](#container-sizing). |
|
|
34
|
+
| `theme` | A preset name or theme object; it overrides the spec's `theme`. |
|
|
35
|
+
| `target` | The medium the chart is read in: `report` (the default), `dashboard`, `slide` or `print`. It overrides `spec.options.target` and the provider's `target`; see [Targets](#targets). |
|
|
36
|
+
| `onWarnings` | Called with the warnings of the layout and with a finding when the chart shows narrower than its safe minimum; see [Targets](#targets). |
|
|
37
|
+
| `hover` | Label card and series highlight on pointer hover; see [Hover](#hover). |
|
|
38
|
+
| `onSpecError` | Called after commit with the findings `SpecErrorCard` shows: an invalid spec or setting, or a chunk that did not load (code `chunk-load-failed`). It is called once per distinct set of findings, so a host may set state from it; a rerender with the same findings, or StrictMode's repeated effects, call it no second time. It is called once with `[]` when a later valid spec replaces the error card (its chart engine is ready, or its data is empty), without waiting for the chart to draw, because a valid spec can still wait for its container or refuse its size. A first spec that draws calls nothing, and a set the host had no `onSpecError` for is reported when the prop arrives. Empty data stays on `onEmpty`, and a layout refusal on `onRefused`. |
|
|
39
|
+
| `onSeriesClick` | Called with the series id when the reader clicks a series: its line or area, its name label or its legend entry. The name label and the legend label are keyboard buttons (Enter or Space); the line, area and swatches take the pointer only. SVG charts only. |
|
|
40
|
+
| `onRecordClick` | Called with `(record, event)` when the reader clicks a mark: the record the hover card names there, a bar, a point, a slice or a category band, with its category and series ids in `record.target.owner`, its source value in `record.value.raw` and its labels. Use it for a drill-down. A mark that prints everything it carries, such as a plain diagram node, opens no hover card but is still clicked and focused. An annotation (a value line, an event) is read but never calls it, from the pointer or the keyboard. It works with `hover` off. A click on a mark then fires no `onSeriesClick`; the name label and the legend entry keep their series click. Enter or Space on the record the keyboard has focused calls it too, with the keyboard event; see [Keyboard](#keyboard). SVG charts only. |
|
|
41
|
+
| `onRowSelect` | Called with `(rowId, { row, event, columnId })` when the reader picks a table row: a click in it outside a link or a button, or Enter or Space on its focused cell; see [The table component](#the-table-component). Table only (`table`, alias `tbl`); BoardplotChart passes it to no other type. A `dimswitch` spec draws as SVG here and takes no row pick; use `DimSwitchChart` for that. |
|
|
42
|
+
| `isRowSelectable` | Called with `(row, { collapsed })`; the rows it answers false for take no pick. Absent, every row but a section heading is selectable. Table only. |
|
|
43
|
+
| `zoom` | Line and area on a time, date or number x: `true` or `{ aggregate, grains, range, onZoom }`. Ctrl or Cmd with the wheel, or a trackpad pinch, zooms around the pointer; the plain wheel scrolls the page. See [Zoom](#zoom). SVG charts only. |
|
|
44
|
+
| `renderHoverContent` | Your own hover card content, for a link or a free layout: `(record, { records, defaultContent, source })` returns what the card shows. `record` is the record `onRecordClick` receives for the same mark. Return `defaultContent` to keep the default card, wrap it to add to it, return your own content to replace it, or `null` for no card on that record. Turns on `hover` when it is absent; see [Your own card content](#your-own-card-content). SVG charts only. |
|
|
45
|
+
| `prepared` | The server result of `prepareChart` for the same spec and settings; see [Server preparation](#server-preparation). |
|
|
46
|
+
| `onGeometry` | Called with the laid-out geometry of an accepted chart. SVG charts only. |
|
|
47
|
+
| `onRefused` | Called with the refusal result when the chart does not fit. |
|
|
48
|
+
| `onEmpty` | Called once when the chart has nothing to draw: a data collection (categories, series, rows, points) is empty. The chart shows `strings.emptyMessage`, default "No data to show.". A table with no data rows calls it too and draws its header plus one message row. |
|
|
49
|
+
| `renderRefused` | Returns the React content shown in place of a refused chart. |
|
|
50
|
+
| `fixedSize` | Renders at the intrinsic size instead of scaling to the parent width. SVG charts only. |
|
|
51
|
+
| `deferLayout` | On by default. A new container size or new data lays the chart out in a background React render, and the chart keeps its last drawing until the new one is ready, so a resize or a page of charts does not block the page. `false` lays the chart out in the render that brought the change, for a host that must show the chart and its own numbers in the same frame. SVG charts only. |
|
|
52
|
+
| `styleNonce` | CSP nonce for the style elements this component renders. |
|
|
53
|
+
| `idPrefix` | Prepended to every id the chart writes; see [Ids across React roots](#ids-across-react-roots). |
|
|
54
|
+
|
|
55
|
+
The entry names all 37 chart types and links neither their engines nor their schemas. When a spec arrives, `BoardplotChart` reads the type it names and fetches three chunks. Spec validation — the document parser, the diagnostics and zod — is the same for every type, so a page fetches it once however many charts it draws. The type's data and options schemas are their own chunk. Its engine is a third. A grid's engine links no panel engine: it fetches the engines its panels name, all at once, before it lays them out. The repository's package check (`npm run smoke:package`) prints the current sizes. Until the chunks arrive it draws the busy placeholder: the box the refusal placeholder uses, with the wording of `strings.loading`. In the browser nothing waits twice — validation, schemas and an engine the page already holds, from an earlier chart of that type or from an import of `boardplot/react/<type>`, are drawn in the same pass.
|
|
56
|
+
|
|
57
|
+
A server pass always draws the placeholder, whatever that server process loaded for an earlier request, and the pass that hydrates it reads the same: one server's output does not change as it warms up, and hydration never meets a chart where the server wrote a placeholder. `prepared` is no exception, because the chart request is resolved against the type's registration before the prepared scene is attached. Markup that has to be in the server response comes from the type's own component, `ColumnChart` from `boardplot/react/column` or `TableChart` from `boardplot/react/table`, which link their engines.
|
|
58
|
+
|
|
59
|
+
A chunk that does not arrive leaves `SpecErrorCard` in the chart's place, with the code `chunk-load-failed`, the loader's message and what to do about it. The failed load is not cached: the next render asks for it again.
|
|
60
|
+
|
|
61
|
+
`parseChartSpec(spec)` from `boardplot/react/prepare` validates a spec without layout and resolves to `{ name, request, warnings }`; it rejects with `BoardplotSpecError`, whose `errors` carry the same findings as the CLI. It loads the schemas of the types the spec names and no others. Both live on that entry only; the spec entry exports the component.
|
|
62
|
+
|
|
63
|
+
## Spec settings
|
|
64
|
+
|
|
65
|
+
The serializable settings `BoardplotChart` validates beside the spec.
|
|
66
|
+
|
|
67
|
+
| Prop | Type | Values | Default | Meaning |
|
|
68
|
+
|---|---|---|---|---|
|
|
69
|
+
| size | string \| object \| string | `'slide-16x9'`, `'slide-4x3'`, `'a4'`, `'dashboard'`, `'a4-landscape-content'`, `'a4-portrait-content'`, `'container'` | | Explicit frame or container. Container observes the parent after React attaches. |
|
|
70
|
+
| size.width | number | | | Canvas width in the stated unit; at least 100 layout px after conversion. |
|
|
71
|
+
| size.height | number | | | Canvas height in the stated unit; at least 24 layout px after conversion. Omitted, height stays automatic. |
|
|
72
|
+
| size.unit | string | `'px'`, `'pt'`, `'mm'` | | Dimension unit. Default px. One pt is 96/72 layout px; one mm is 96/25.4 layout px. |
|
|
73
|
+
| fit | string | `'fill'`, `'content'` | | Container fit. Default uses the registered sizing policy; content lays out the box width with the height left to the chart and prints the static footer, as `boardplot render` at that width draws it. |
|
|
74
|
+
| fallbackSize | string \| object | `'slide-16x9'`, `'slide-4x3'`, `'a4'`, `'dashboard'`, `'a4-landscape-content'`, `'a4-portrait-content'` | | Server and initial client frame for container sizing. Default 720 by 405. |
|
|
75
|
+
| fallbackSize.width | number | | | Canvas width in the stated unit; at least 100 layout px after conversion. |
|
|
76
|
+
| fallbackSize.height | number | | | Canvas height in the stated unit; at least 24 layout px after conversion. Omitted, height stays automatic. |
|
|
77
|
+
| fallbackSize.unit | string | `'px'`, `'pt'`, `'mm'` | | Dimension unit. Default px. One pt is 96/72 layout px; one mm is 96/25.4 layout px. |
|
|
78
|
+
| target | string | `'report'`, `'dashboard'`, `'slide'`, `'print'` | | Reading context. Default report. |
|
|
79
|
+
| theme | string \| object | | | Explicit host theme overriding the spec theme. |
|
|
80
|
+
| theme.preset | string | | | Registered base theme whose tokens are overridden. |
|
|
81
|
+
| theme.overrides | object | | | Partial theme token tree merged with the named preset. |
|
|
82
|
+
| hover | boolean \| object | | | Pointer hover: a label card and a highlight of the hovered series. Nothing else is interactive. The server render is the static chart. |
|
|
83
|
+
| hover.card | false \| string | `false`, `'label'`, `'sparkline'` | | Label card with the hovered record's own facts, placed beside the mark by the label solver and always inside the chart's own frame. Default 'label'. On a table, 'sparkline' draws the row across its column group instead and no card where the group holds fewer than three numbers. |
|
|
84
|
+
| hover.highlight | boolean | | | Dim the other series and outline the hovered marks; on a table, wash the row of the hovered cell instead. Default true. |
|
|
85
|
+
|
|
86
|
+
## Per-type components
|
|
87
|
+
|
|
88
|
+
Each chart type has its own entry with a smaller bundle. A per-type component takes `data`, `annotations` and the type's options as flat props, so `options.title` becomes `title` and `options.valueAxis` becomes `valueAxis`. It also takes the sizing props, `target`, `theme`, `hover`, `onSeriesClick`, `onRecordClick`, `renderHoverContent`, `zoom`, `prepared`, `onGeometry`, `onWarnings`, `onRefused`, `renderRefused`, `fixedSize`, `deferLayout`, `styleNonce` and `idPrefix` listed for `BoardplotChart`, and `rows`, `columns` and `onRowsReading` in place of `data` ([Rows from a query](#rows-from-a-query)). The option names and values are those of the type's reference page.
|
|
89
|
+
|
|
90
|
+
A prop the type does not take is refused as the CLI refuses it: an unknown key, top-level or inside an option object, draws the error card with `unknown-option` and the nearest key in place of the chart, and the layout does not run. The entry checks the keys against a tree generated from the type's options schema, so it links no zod and checks no option values; `BoardplotChart` validates the values. The sentence that names the nearest key is fetched the first time a chart is refused, so a refused chart shows the busy placeholder for that fetch. `GridChart` checks the grid's own options. A panel's options sit in the grid's data, and only `BoardplotChart` checks them.
|
|
91
|
+
|
|
92
|
+
```tsx
|
|
93
|
+
import { BarChart } from 'boardplot/react/bar';
|
|
94
|
+
|
|
95
|
+
const data = {
|
|
96
|
+
categories: [{ id: 'north', label: 'North' }, { id: 'south', label: 'South' }],
|
|
97
|
+
series: [{ id: 'revenue', label: 'Revenue', values: [42, 35] }],
|
|
98
|
+
};
|
|
99
|
+
|
|
100
|
+
export function RegionalRevenue() {
|
|
101
|
+
return <BarChart data={data} title="North leads South by 7" unit="USD m" size="container" fit="content" fallbackSize={{ width: 800, height: 450 }} />;
|
|
102
|
+
}
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
| Type | Component | Import |
|
|
106
|
+
|---|---|---|
|
|
107
|
+
| column | `ColumnChart` | `boardplot/react/column` |
|
|
108
|
+
| bar | `BarChart` | `boardplot/react/bar` |
|
|
109
|
+
| line | `LineChart` | `boardplot/react/line` |
|
|
110
|
+
| dimswitch | `DimSwitchChart` | `boardplot/react/dimswitch` |
|
|
111
|
+
| table | `TableChart` | `boardplot/react/table` |
|
|
112
|
+
| waterfall | `WaterfallChart` | `boardplot/react/waterfall` |
|
|
113
|
+
| kpi | `KpiChart` | `boardplot/react/kpi` |
|
|
114
|
+
| combo | `ComboChart` | `boardplot/react/combo` |
|
|
115
|
+
| variance | `VarianceChart` | `boardplot/react/variance` |
|
|
116
|
+
| bullet | `BulletChart` | `boardplot/react/bullet` |
|
|
117
|
+
| bartable | `BarTableChart` | `boardplot/react/bartable` |
|
|
118
|
+
| pvm | `PvmChart` | `boardplot/react/pvm` |
|
|
119
|
+
| pie | `PieChart` | `boardplot/react/pie` |
|
|
120
|
+
| status | `StatusChart` | `boardplot/react/status` |
|
|
121
|
+
| heatmap | `HeatmapChart` | `boardplot/react/heatmap` |
|
|
122
|
+
| gantt | `GanttChart` | `boardplot/react/gantt` |
|
|
123
|
+
| scatter | `ScatterChart` | `boardplot/react/scatter` |
|
|
124
|
+
| funnel | `FunnelChart` | `boardplot/react/funnel` |
|
|
125
|
+
| pareto | `ParetoChart` | `boardplot/react/pareto` |
|
|
126
|
+
| mekko | `MekkoChart` | `boardplot/react/mekko` |
|
|
127
|
+
| sparkline | `SparklineChart` | `boardplot/react/sparkline` |
|
|
128
|
+
| treemap | `TreemapChart` | `boardplot/react/treemap` |
|
|
129
|
+
| sankey | `SankeyChart` | `boardplot/react/sankey` |
|
|
130
|
+
| grid | `GridChart` | `boardplot/react/grid` |
|
|
131
|
+
| slope | `SlopeChart` | `boardplot/react/slope` |
|
|
132
|
+
| dot | `DotChart` | `boardplot/react/dot` |
|
|
133
|
+
| cohort | `CohortChart` | `boardplot/react/cohort` |
|
|
134
|
+
| choropleth | `ChoroplethChart` | `boardplot/react/choropleth` |
|
|
135
|
+
| butterfly | `ButterflyChart` | `boardplot/react/butterfly` |
|
|
136
|
+
| likert | `LikertChart` | `boardplot/react/likert` |
|
|
137
|
+
| histogram | `HistogramChart` | `boardplot/react/histogram` |
|
|
138
|
+
| box | `BoxChart` | `boardplot/react/box` |
|
|
139
|
+
| waffle | `WaffleChart` | `boardplot/react/waffle` |
|
|
140
|
+
| pyramid | `PyramidChart` | `boardplot/react/pyramid` |
|
|
141
|
+
| diagram | `DiagramChart` | `boardplot/react/diagram` |
|
|
142
|
+
| tilemap | `TilemapChart` | `boardplot/react/tilemap` |
|
|
143
|
+
| creative | `CreativeChart` | `boardplot/react/creative` |
|
|
144
|
+
|
|
145
|
+
The barrel `boardplot/react` exports the same components, `BoardplotTheme`, `ScaleGroup` and `useChartLayout`, and registers every chart core when it loads. `boardplot/react/theme` exports `BoardplotTheme`, `useBoardplotTheme`, `ScaleGroup`, `useScaleGroupPlan` and `SceneRenderer` without a chart core, so a page that imports it next to `boardplot/react/<type>` or `boardplot/react/spec` links only the cores it draws. Every component, `TableChart` included, also takes `styleNonce` for a host content security policy and `idPrefix`.
|
|
146
|
+
|
|
147
|
+
### Ids across React roots
|
|
148
|
+
|
|
149
|
+
The ids a chart writes, its description, its hatch patterns, the data-table toggle and the table summary, come from React's `useId`. React roots that render separately, islands or one `renderToString` per chart concatenated into one page, count `useId` from the same start, so their ids repeat and a chart's `aria-describedby` can name another chart's description. Give each such root its own `identifierPrefix`, the option of `createRoot`, `hydrateRoot`, `renderToString` and `renderToPipeableStream`, the same on the server and the client, or pass `idPrefix` to the component. `idPrefix` takes letters, digits, `_` and `-` and starts with a letter or a digit; the component throws on any other value. A single root needs neither.
|
|
150
|
+
|
|
151
|
+
A per-type entry links its own chart and the shared layout core, and fetches two core modules only when a chart turns out to need them. The annotation placement engine arrives when a chart carries an annotation, a value line, a target or a derived callout; a chart with none of them draws without it. The checks a PATCHED theme goes through arrive when a caller passes `theme={{ preset, overrides }}` — a preset name or a theme object alone needs nothing, and neither does the compact band, which tightens the spacing through an override the library builds itself. While such a chunk loads, the component draws the busy placeholder, the box the refusal placeholder uses with the wording of `strings.loading`, and then the chart, byte for byte the chart it drew before. A `prepared` snapshot built with a patched theme carries the theme the server resolved, and the component draws the snapshot in its first pass, hydration included, while the checks load behind it. Nothing waits twice on a page, and nothing waits in the browser in a graph that already holds the module: the CLI, the MCP server, `boardplot`, `boardplot/validate`, `boardplot/react/prepare`, the `boardplot/react` barrel and `useChartLayout` all link both. A server pass, and the client pass that hydrates it, count only the modules the chart's own entry links: both for a component from the `boardplot/react` barrel and for `useChartLayout`, and for a per-type entry only what it links (pareto and likert below). A server process holds every module any of its routes linked, and the page in the browser holds only its own, so a chart drawn with more would not match the hydrating frame (React error 418). `renderToStaticMarkup` of an annotated chart or a patched theme from a per-type entry (`boardplot/react/<type>`) therefore writes the placeholder unless the component gets `prepared`, and the chart follows once the page has hydrated. Two types link what they always need instead of fetching it, and their entries say so: every pareto derives the cumulative threshold as a value line whenever `cumulative` is on, which is the default, and every likert patches the theme for its statement labels. A chunk that never arrives turns the placeholder into a box that says `Loading failed`, with the loader's message as its title; the render after it asks once more.
|
|
152
|
+
|
|
153
|
+
## Rows from a query
|
|
154
|
+
|
|
155
|
+
Every chart component takes SQL-shaped rows instead of `data`: `rows` is an array of objects, one per row, and `columns` names the source column of each role. The mapping is the one `specFromRows` from `boardplot/rows` and `rows` in `boardplot_render` run, with the same roles, the same results and the same refusals. `data` then works as the template: a category or series it already names keeps its label and colour role, and a map takes its `pack` from it.
|
|
156
|
+
|
|
157
|
+
```tsx
|
|
158
|
+
import { ColumnChart } from 'boardplot/react/column';
|
|
159
|
+
|
|
160
|
+
const rows = [
|
|
161
|
+
{ month: '2026-01', channel: 'Search', revenue: 120 },
|
|
162
|
+
{ month: '2026-01', channel: 'Social', revenue: 80 },
|
|
163
|
+
{ month: '2026-02', channel: 'Search', revenue: 135 },
|
|
164
|
+
{ month: '2026-02', channel: 'Social', revenue: 95 },
|
|
165
|
+
];
|
|
166
|
+
|
|
167
|
+
export function MonthlyRevenue() {
|
|
168
|
+
return <ColumnChart rows={rows} columns={{ category: 'month', series: 'channel', value: 'revenue' }} title="Search leads both months" unit="$k"
|
|
169
|
+
size="container" fit="fill" fallbackSize={{ width: 960, height: 540 }} onRowsReading={(reading) => console.log(reading.ignoredColumns)} />;
|
|
170
|
+
}
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
`onRowsReading` is the one place the reading arrives: `{ rows, ignoredColumns, states }`, the row count, the source columns no role names, and the cells a `state` column marks `na`, `nm` or `suppressed`. The chart draws such a cell as an empty one, so only the reading tells them apart. It is called after the chart commits, once for each distinct reading, and again after a remount.
|
|
174
|
+
|
|
175
|
+
Rows that do not map draw the error card a refused option draws, with the CLI's code and the row: `invalid-value` at `rows.3.revenue`. `BoardplotChart` shows the same finding on `SpecErrorCard`, with the JSON Pointer `/rows/3/revenue`. A layout finding at a mapped value names the row it came from as well; a tilemap's unknown region is the exception, because the browser checks the regions when the chart draws, and that refusal names the data path. A zoomed view that draws coarser buckets keeps the bucket's own path, because a bucket comes from several rows. A type without a rows mapping, such as `table` or `dimswitch`, refuses with `rows-unsupported-type`, as `boardplot_render` does. `GridChart` takes no rows: its `rows` and `columns` are the options that lay out its panels.
|
|
176
|
+
|
|
177
|
+
The mapping is its own chunk, about 9 kB gzip. A chart fetches it the first time it gets rows and draws the busy placeholder until it lands; a page that passes no rows never fetches it. A server pass and the pass that hydrates it count the chunk as not loaded, so a server render with rows writes the placeholder, unless the component gets `prepared`. `prepareChart` takes the same `rows` and `columns` and throws the `InputError` that `specFromRows` throws. Its result carries the data it mapped, keyed to the type, template, rows and columns it mapped them from, so hydration draws the prepared SVG without the chunk. The chunk then loads in the background, and the same rows give the same chart without a second layout.
|
|
178
|
+
|
|
179
|
+
```tsx
|
|
180
|
+
import { prepareChart } from 'boardplot/react/prepare';
|
|
181
|
+
import { LineChart } from 'boardplot/react/line';
|
|
182
|
+
|
|
183
|
+
const rows = [{ week: '2026-W40', revenue: 120, plan: 'Base' }, { week: '2026-W41', revenue: 135, plan: 'Base' }];
|
|
184
|
+
const columns = { category: 'week', series: 'plan', value: 'revenue' } as const;
|
|
185
|
+
const size = { width: 800, height: 450 };
|
|
186
|
+
|
|
187
|
+
export async function WeeklyRevenue() {
|
|
188
|
+
const prepared = await prepareChart({ type: 'line', rows, columns, options: { title: 'Revenue', size } });
|
|
189
|
+
return <LineChart rows={rows} columns={columns} title="Revenue" size={size} prepared={prepared} />;
|
|
190
|
+
}
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
## The table component
|
|
194
|
+
|
|
195
|
+
`TableChart` draws a CSS grid of ARIA roles, not a `<table>`: `role="grid"` (or `role="treegrid"` for a hierarchy) on the scroll box's child, `role="row"` on every row, `role="rowheader"` on the row label and `role="gridcell"` on the rest. A row is a grid over one shared track list, so the layout can animate a column open and closed; the track list is computed from the resolved strings, a hidden column's track closes to zero and the column keeps its cells. By default, a closed parent keeps its rows in the document inside `div.bp-children`, which folds to zero height, so the fold runs the same path both ways. Set `mountCollapsed={false}` to leave closed subtrees out of the document; leaf rows then use browser paint deferral while off screen.
|
|
196
|
+
|
|
197
|
+
Its reader state is available as a controlled prop, each with a `default…` and an `on…Change` twin: `collapsed` (the ids of the folded parents; `collapsedForDepth(table, depth)` names the parents a depth control folds), `columnVisibility` (keyed by column-toggle id), `inlineVisibility` (keyed by `inlineGroup`, the switch a Changes control flips to hide the MoM or YoY line inside every cell at once), and `sort` (the column the reader sorted by). `toolbar={false}` draws no column-group control strip, `stickyLabels` pins the head and the row labels while the table scrolls, and `hover={{ card: 'sparkline' }}` opens the table's own card, which draws the row across its column group with the hovered point ringed instead of listing the cell's facts. Its change lines (MoM, YoY) print only where the hovered column has a value.
|
|
198
|
+
|
|
199
|
+
`sortable` turns the column headers into sort controls: `true` offers every value, computed, date and text column, a list of column ids offers those. A control is a button inside its header cell, the header cell carries `aria-sort`, and the chevron says which way the column is sorted — or, on a column nobody has sorted, which way the next click will sort it. A number opens descending, a name or a date ascending, and the third click returns the authored order. `sort` is `{ column, direction }` and `null` is the authored order; the authored sibling order (`options.sort`, with `categories`) still goes through the same prop and is resolved in the core as before. Sorting reorders the top-level rows and each sibling group on its own: children stay under their parent, an inline line travels inside its parent's cells, and a total or a section heading keeps its place, so a sort reorders within a section and never across one. Text sorts with the digits in it read as numbers, in the table's locale (`0.9.1` before `0.20.3`). `sortRows(table, sort, locale?)` is the same order without pixels, for a host that wants it elsewhere.
|
|
200
|
+
|
|
201
|
+
`rootsHidden` hides the level-0 data rows and everything under them while the totals and the section headings stay — the totals-only step of a depth control. `depthToExpansion(table, depth)` returns both halves of that state, `{ collapsed, rootsHidden }`, so a depth control passes one call's result to `collapsed` and `rootsHidden`; depth 0 is the Total alone.
|
|
202
|
+
|
|
203
|
+
A table under `size="container"` with `fit="fill"` fills the width it is given: the row-label column keeps its natural width and the value columns share what is left, in proportion to their own, each up to 2.5 times its natural width. `maxGrowth` names another cap, and `maxGrowth={false}` lets the columns share the whole frame. An authored `columns[].width` never grows or shrinks under the container's fill: the spec's widths win over the container's. On a value or computed column the width is a floor: it widens to the widest figure the column prints, so no number is cut, and the SVG layout reports `table-column-widened`. Every other column keeps exactly the width you set, and a cut text cell is reported as `table-column-clipped`. The room a cap leaves stays to the right of the table, or goes to an unauthored last track under `lastTrackFlex`; under `rowExtent: 'frame'` the value tracks grow to the frame edge by `frameFill` (default `'values'`), and `frameFill: 'none'` leaves the room to an empty track, so the rows still reach the frame edge. The grid element is exactly as wide as the tracks it draws. A table wider than its frame is never squeezed into it; it scrolls. Unlike a chart, a table takes the width alone and reads its height from its own rows, so a card with no height of its own still fills.
|
|
204
|
+
|
|
205
|
+
The scroller is the table's own, because the pinned columns are measured against it, and a host reaches it through props rather than the markup. `onScrollChange` receives `{ scrollLeft, scrollWidth, clientWidth, scrollTop, scrollHeight, clientHeight, gutterRight, gutterBottom }` on mount, on every scroll and when the container or the tracks change width, which is what a minimap of the column axis draws. `gutterRight` and `gutterBottom` are the px a vertical and a horizontal scrollbar take from the scroller's box (offset size minus client size, 0 for an overlay scrollbar), so an edge fade drawn by the host stays inside them. `handleRef` receives a `TableHandle`: `scrollState()` returns the same record, `scrollToColumn(columnId, behavior?)` scrolls so that column starts where the pinned columns end (jump chips for fiscal years or cohort years), and `scrollTo(left, behavior?)` scrolls to an offset. `onContentWidth` receives the width the figure needs to show every column without scrolling, its tracks, spacer tracks and margins, so a card that sizes itself to its table reads that number. `fillHeight` makes the figure a column as tall as its parent, with the scroller taking the height left and scrolling both ways; the host gives the parent a height, and `stickyLabels` keeps the head and the label column in place, which is what an expand dialog needs. `onRowSelect(rowId, { row, event, columnId })` is called when the reader picks a row: a click anywhere in it outside a link or a button, or Enter or Space on its focused cell. The keyboard reaches every cell: Tab enters the grid on one cell, the arrow keys, Home and End move between cells, and Enter or Space on a cell picks its row. `columnId` is the column of the clicked cell, or of the focused cell the key was pressed on, so a host can run one cell's action, a Remove in its own column, from that cell alone; it is undefined on the empty track `rowExtent: 'frame'` adds. A section heading takes none; a parent row the reader may fold folds on the same click when the host has not made it selectable; a selectable parent only selects on a click, and its fold mark folds it. `foldOn: 'row' | 'toggle'` overrides that default: `'row'` folds and selects on the row, by click and by Enter or Space alike, and `'toggle'` lets only the mark fold. `onFormatsFit(changes)` receives the formats `fitFormats` shortened, each as `{ row?, column?, from?, to }`. `isRowSelectable(row, { collapsed })` narrows the pick to the rows it answers true for; `collapsed` is true while the row is folded shut, so a host can tell an open parent from a folded one: the others take no click and no key for it, show no pointer and carry no `data-bp-selectable`, and a parent among them still folds. Absent, every row but a section heading is selectable, and each selectable body row shows a pointer. `rowLabelLead={{ width, render }}` draws a glyph before each row label, a channel mark for one: `render(row)` returns the glyph or nothing, and a measured label track grows by `width`. With `stickyLabels`, the hairline to the right of the last pinned column shows only while the grid is scrolled sideways. Every body row carries `data-row-id`, the row id from the data (in `dimswitch`, the id that `dimswitchRowId(structure, memberId, measureId)` builds; it names the structure, so the same line has a different id by KPI and by member). It is public API: it stays the same across data refreshes, re-sorts, folds and depth changes, so a host can anchor a comment, a test or an analytics event on it. `interactions={false}` stops clicks and keys from selecting, sorting and folding, for a host mode such as annotation where the host handles the click; the rows keep their fold state and draw their fold marks as marks, and hover stays.
|
|
206
|
+
|
|
207
|
+
The table's hover card is its one floating layer, and it renders through a portal at the end of `document.body`, positioned beside its cell in page coordinates, so a glass (`backdrop-filter`), `transform` or `overflow: hidden` ancestor of the table neither traps nor cuts it. `portalContainer` names another element, such as an open dialog's panel: the card then renders there and shares its stacking context, which is what a table inside a dialog needs, since the card's `z-index: 8` counts in the context it renders in. `portalContainer={false}` keeps the card inside the table's frame. Escape closes the card. A server pass draws no card, so server rendering and hydration are unchanged.
|
|
208
|
+
|
|
209
|
+
A controlled `collapsed` without `onCollapsedChange` is a read-only tree: no row folds on a click or a key. Its parent rows still draw the outline mark, minus open and plus closed, as a glyph with no button, as the SVG draws it; `outlineMarks={false}` draws no mark in a read-only grid or in the SVG. A parent row authored `foldable: false` draws neither toggle nor mark and stays open whatever `collapsed`, `expansion` or a depth control names; a section row's `badge` draws its status chip after the heading, in the status chip paints of both surfaces.
|
|
210
|
+
|
|
211
|
+
`measureWidths` says where the column widths come from. The default `'browser'` measures every string with the browser's own canvas in the resolved face and takes the wider of that and the shipped width tables, then measures again once `document.fonts.ready` resolves, so a late font swap cannot leave a stale track; where there is no canvas (server rendering, jsdom) it falls back to the tables plus a 4 % allowance on weight 600. `'tables'` keeps the tables in every case. The SVG path always measures from the tables and stays byte-identical.
|
|
212
|
+
|
|
213
|
+
A host that reads the drawn grid, a column's width or whether a label is cut, or takes a screenshot of it, first awaits `document.fonts.ready` and then the re-render that measurement starts, one animation frame later. Read before that, the tracks still come from the width tables, and a label can look cut in a font that has not loaded yet.
|
|
214
|
+
|
|
215
|
+
A table with `mountCollapsed: false` (the `dimswitch` default) paints a row that has no children only when it is near the viewport: the browser skips off-screen rows (`content-visibility: auto` on `[data-bp-defer-row]`). An element screenshot of a long table then shows blank rows below the fold. Before the capture, add this host CSS to paint every row: `.bp-table-grid [data-bp-defer-row]{content-visibility:visible!important}`. There is no prop for it.
|
|
216
|
+
|
|
217
|
+
The table stylesheet is a `<style data-bp-table-theme>` element, one per theme, shared by every table of that theme in the same document or shadow root. Server markup and the first client frame carry it inline, beside the table. After mount the component moves it to `document.head`, or to the shadow root the table renders in, and removes the inline copy; the last table of a theme to unmount removes it. A static capture of a mounted page, `outerHTML` of the table or of its container, therefore holds the grid without its styles and shows plain text. Collect the `style[data-bp-table-theme]` elements from `document.head` or the shadow root along with the markup. `styleNonce` sets the nonce on both copies. The vertical rule in a section heading row is `position: absolute` with `z-index: -1`, and its cell sets `isolation: isolate`. A stacking audit may flag the negative z-index; the pair is on purpose. `isolation` makes the cell its own stacking context, so the rule paints behind the heading text and above the cell's background, and never drops behind the table or the page.
|
|
218
|
+
|
|
219
|
+
## The dimswitch component
|
|
220
|
+
|
|
221
|
+
`DimSwitchChart` from `boardplot/react/dimswitch` takes the cube described in [Dimension switch table](dimswitch.md); its [React usage](dimswitch.md#react-usage) section has a complete host component. It compiles additive facts into `TableChart`. The host supplies calendar windows, sums and reference sums. Boardplot computes ratios of sums, changes, judgement and display formats.
|
|
222
|
+
|
|
223
|
+
`variant`, `depth`, `splits` and `collapsed` are controlled props. Each has a `default…` prop. One `onViewChange(next, reason)` callback returns `{ variant, depth, splits, collapsed }`. The reason is `variant`, `depth`, `splits` or `collapsed`. A variant or depth change resets manual folds to that depth. A splits change keeps manual folds. Set `inlineVisibility={{ change: false }}` to hide Changes without changing folds.
|
|
224
|
+
|
|
225
|
+
Depth d shows the measures of the Total and of d − 1 member levels, in both variants. Splits add no rung. DimSwitch leaves closed subtrees out of the document. The inherited table host props include `fillHeight`, `onScrollChange`, `handleRef`, `onRowSelect` and `measureWidths`. The default pins the label, Range and vs PP columns. The host supplies its toolbar.
|
|
226
|
+
|
|
227
|
+
## Container sizing
|
|
228
|
+
|
|
229
|
+
| Prop | Type | Values | Default | Meaning |
|
|
230
|
+
|---|---|---|---|---|
|
|
231
|
+
| size | string \| object \| string | `'slide-16x9'`, `'slide-4x3'`, `'a4'`, `'dashboard'`, `'a4-landscape-content'`, `'a4-portrait-content'`, `'container'` | | Explicit frame or container. Container observes the parent after React attaches. |
|
|
232
|
+
| size.width | number | | | Canvas width in the stated unit; at least 100 layout px after conversion. |
|
|
233
|
+
| size.height | number | | | Canvas height in the stated unit; at least 24 layout px after conversion. Omitted, height stays automatic. |
|
|
234
|
+
| size.unit | string | `'px'`, `'pt'`, `'mm'` | | Dimension unit. Default px. One pt is 96/72 layout px; one mm is 96/25.4 layout px. |
|
|
235
|
+
| fit | string | `'fill'`, `'content'` | | Container fit. Default uses the registered sizing policy; content lays out the box width with the height left to the chart and prints the static footer, as `boardplot render` at that width draws it. |
|
|
236
|
+
| fallbackSize | string \| object | `'slide-16x9'`, `'slide-4x3'`, `'a4'`, `'dashboard'`, `'a4-landscape-content'`, `'a4-portrait-content'` | | Server and initial client frame for container sizing. Default 720 by 405. |
|
|
237
|
+
| fallbackSize.width | number | | | Canvas width in the stated unit; at least 100 layout px after conversion. |
|
|
238
|
+
| fallbackSize.height | number | | | Canvas height in the stated unit; at least 24 layout px after conversion. Omitted, height stays automatic. |
|
|
239
|
+
| fallbackSize.unit | string | `'px'`, `'pt'`, `'mm'` | | Dimension unit. Default px. One pt is 96/72 layout px; one mm is 96/25.4 layout px. |
|
|
240
|
+
|
|
241
|
+
`size="container"` measures the room the host gives after React attaches and lays the chart out in it. It never measures what it draws, so a heading or the data-table toggle beside the chart does not make it grow. `fallbackSize` is the frame of the server output, of hydration and of the first client render; without it the fallback is 720 × 405 px. A chart mounted on the client without `fallbackSize` draws the busy placeholder until its container reports a width, and is laid out once, at that width; a container that reports none within 100 ms gets the fallback. A zero-width parent keeps the last usable size, and a chart that was refused in a small parent draws again once the parent is wide enough. While the container is still changing size, a size refusal waits: the busy placeholder stands in, and no warning goes to `onWarnings` or `onRefused`, until the size holds still for 120 ms.
|
|
242
|
+
|
|
243
|
+
A parent that takes its width from its content never grows the chart: it measures the chart's fallback width, and the chart lays out at the width the parent measured. This happens with a flex item that does not stretch: in a flex row without a width or `flex: 1`, in a flex column with `align-items: center` (a Next.js page that centres its content this way keeps the chart at its fallback width), with `margin: auto` and a `max-width` inside a flex parent, and with `display: inline-block` or `width: fit-content`. Give the parent its own width, for example `width: 100%` beside the `max-width`.
|
|
244
|
+
|
|
245
|
+
The measured size is the layout size of the chart, in CSS px. Boardplot does not read the host's font size: a 13 px dashboard body does not make the chart text smaller.
|
|
246
|
+
|
|
247
|
+
`fit="fill"` takes the parent's width and, when the parent has a height of its own (a `height`, a flex or grid track), that height less the data-table toggle or table drawn below the chart. A parent whose height is its content gets the height the type's aspect gives at that width, 16:9 for most types, 4:3 for scatter and 1:1 for pie, never less than the type's height floor; the chart then lays out again only when the width changes. `fit="content"` lays the chart out at the parent's width with the height left to the chart, as `boardplot render` and `boardplot measure` do with a width alone, and prints the footer of the static image under it: every note of the kinds `notes.show` lists, in full, with no line budget. Under `notes.placement: 'info'` a "Notes and sources (N)" button opens the notes the image does not print, in the space the image leaves free for it. The chart and its HTML footer are as tall as the image at that width. Omitted, `fit` follows the type's registered policy (`fit` in `boardplot_list`). An explicit `size` ignores `fit` and `fallbackSize`.
|
|
248
|
+
|
|
249
|
+
On the `report` and `dashboard` targets every type except `table` (100 px), `sparkline` (88 px), `waffle` (240 px) and `creative`, `slope` and `tilemap` (320 px) needs a box at least 280 layout px wide; column, line, combo, histogram, scatter and dot draw compact from their 480 px `minWidth` down to it, and slope from 320 px. With `density: 'compact'`, `bullet` needs 120 px. `boardplot_list` gives each type's floors at the default density. A 360 px phone with a 16 px page gutter and a 24 px card padding leaves 280 px: there a chart draws when its content fits, and a table wider than that scrolls. Keep the page gutter and the card padding at 40 px or less on each side together, or let the card scroll sideways.
|
|
250
|
+
|
|
251
|
+
### Print
|
|
252
|
+
|
|
253
|
+
A container chart lays itself out again for print. When the browser lays the page out for paper, each chart reads the box it has on the printed page and draws in it at once, also under `deferLayout`, so its text keeps the size the target sets. It keeps the height it has on that page: the browser has counted the pages by then, and a taller chart would push the end of the page out of the print. A printed box below the chart's floor, such as a narrow dashboard column on A4, lays the chart out in the smallest box of the same shape that it fits, and the drawing scales down into the box. A container table whose columns need more than its printed box draws at their width and scales down in the same way, so no figure drops out. After printing, each chart takes back its screen layout, with the hover card, focus and story step it had. A chart with an explicit `size` keeps it. Print CSS decides the printed box: give a dashboard one or two columns in `@media print`, and its charts print at full text size on A4. A chart in a tab that the print CSS shows is laid out at its printed width; one that print hides is not printed. This was measured in Chrome. A browser that does not report the printed layout to the page before it prints the page prints the screen layout, scaled to the paper.
|
|
254
|
+
|
|
255
|
+
## Series colours under a filter
|
|
256
|
+
|
|
257
|
+
Series take the theme's ramp colours in data order, so a filter that removes a series moves the colours of the series after it. To keep each series in its colour, give it a fixed ramp step with `colorRole: 'series-N'`, numbered from the full list of series, not the filtered one. The ramp itself comes from the theme, so the colours follow a theme change.
|
|
258
|
+
|
|
259
|
+
```tsx
|
|
260
|
+
import { LineChart } from 'boardplot/react/line';
|
|
261
|
+
|
|
262
|
+
// One ramp step per series, from the full list.
|
|
263
|
+
const all = [
|
|
264
|
+
{ id: 'apac', label: 'APAC', values: [3, 4, 5], colorRole: 'series-1' as const },
|
|
265
|
+
{ id: 'eu', label: 'EU', values: [5, 6, 6], colorRole: 'series-2' as const },
|
|
266
|
+
{ id: 'uk', label: 'UK', values: [2, 3, 2], colorRole: 'series-3' as const },
|
|
267
|
+
];
|
|
268
|
+
|
|
269
|
+
export function Orders({ shown = ['eu', 'uk'] }: { shown?: string[] }) {
|
|
270
|
+
const data = { categories: [{ id: 'Q1' }, { id: 'Q2' }, { id: 'Q3' }], series: all.filter((series) => shown.includes(series.id)) };
|
|
271
|
+
return <LineChart data={data} title="Orders" size={{ width: 640, height: 360 }} />;
|
|
272
|
+
}
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
## Theme provider
|
|
276
|
+
|
|
277
|
+
`BoardplotTheme` from `boardplot/react/theme` passes settings to every chart below it, `target` among them. Nested providers inherit omitted settings. A prop on the chart outranks the provider; a chart's own `theme` outranks the provider's. In `BoardplotChart` a spec's `options.theme` is the chart's own theme, so it outranks the provider's, and the component's `theme` prop outranks both. Remove `options.theme` from the spec to paint it with the provider's theme.
|
|
278
|
+
|
|
279
|
+
```tsx
|
|
280
|
+
import { BoardplotTheme } from 'boardplot/react/theme';
|
|
281
|
+
import { BoardplotChart } from 'boardplot/react/spec';
|
|
282
|
+
|
|
283
|
+
const spec = { type: 'bar', data: { categories: ['North', 'South'], series: [{ id: 'orders', label: 'Orders', values: [42, 35] }] } };
|
|
284
|
+
|
|
285
|
+
export function Dashboard() {
|
|
286
|
+
return (
|
|
287
|
+
<BoardplotTheme theme="notation" target="dashboard" locale={{ language: 'de-DE', decimal: ',', thousands: '.' }} strings={{ refusalMessage: 'This card is too narrow.' }}>
|
|
288
|
+
<BoardplotChart spec={spec} size="container" fit="content" />
|
|
289
|
+
</BoardplotTheme>
|
|
290
|
+
);
|
|
291
|
+
}
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
| Prop | Type | Values | Default | Meaning |
|
|
295
|
+
|---|---|---|---|---|
|
|
296
|
+
| target | string | `'report'`, `'dashboard'`, `'slide'`, `'print'` | | Reading context. Default report. |
|
|
297
|
+
| textScale | number | | | Inherited text scale: one factor on every text of every chart under the provider, 0.5 to 2.5. A chart option textScale or textSize wins. |
|
|
298
|
+
| textSize | number | | | Inherited primary label size in px, equal on every chart under the provider. A chart option wins. |
|
|
299
|
+
| diagnostics | string | `'auto'`, `'full'`, `'reader'` | | Default auto: full unless NODE_ENV is production, else reader. Reader cards keep diagnostics in console and data attributes. Full adds a collapsed Details disclosure. |
|
|
300
|
+
| direction | string | `'ltr'`, `'rtl'` | | Reading direction of HTML controls and cards; default ltr. Chart geometry, axes and data order are unchanged. |
|
|
301
|
+
| theme | string \| object | | | Inherited chart theme. Direct chart props take precedence. |
|
|
302
|
+
| theme.preset | string | | | Registered base theme whose tokens are overridden. |
|
|
303
|
+
| theme.overrides | object | | | Partial theme token tree merged with the named preset. |
|
|
304
|
+
| locale | string \| object | | | Inherited locale. Locale support follows each chart formatter. |
|
|
305
|
+
| locale.language | string | | | BCP 47 language tag. Changes words only, such as notes and month names. It never changes the decimal or grouping marks; they come only from locale.decimal and locale.thousands. E.g. "de"; "de_DE" is read as "de-DE"; "en-US" puts the month first (Sep 4). |
|
|
306
|
+
| locale.decimal | string | `'.'`, `','` | | Decimal mark of every number the chart prints. Default '.'. The language does not change it. |
|
|
307
|
+
| locale.thousands | string | `','`, `'.'`, `'’'`, `' '` | | Grouping mark of every number the chart prints. Default ',', or '.' with decimal ','. The language does not change it. A value equal to the decimal mark uses that fallback. |
|
|
308
|
+
| locale.minusGlyph | string | `'−'`, `'-'` | | Minus glyph for locale-derived table formats; default Unicode minus. |
|
|
309
|
+
| locale.weekStartsOn | number | `0`, `1` | | First weekday for week-granularity date ticks; default Monday. Line date ticks read this field, other layouts ignore it and report it. |
|
|
310
|
+
| motion | string | `'system'`, `'reduce'`, `'full'` | | Motion preference. Default system; charts remain static unless motion is enabled. |
|
|
311
|
+
| density | string | `'comfortable'`, `'compact'` | | Inherited density. Default comfortable preserves existing spacing. Compact scales pad and row-pitch tokens (labelPad, canvas margins, frame gaps, legendRowH) and maps to compact table density when the table has no explicit density. |
|
|
312
|
+
| strings | object | | | Inherited built-in wording. Authored labels remain unchanged. |
|
|
313
|
+
| strings.refusalMessage | string | | | Reader heading for a size refusal. Legacy width and height templates remain available only in full diagnostics. |
|
|
314
|
+
| strings.refusalHint | string | | | Reader hint for a size refusal; EN and DE defaults. |
|
|
315
|
+
| strings.emptyMessage | string | | | Reader heading for empty data; EN and DE defaults. |
|
|
316
|
+
| strings.emptyHint | string | | | Reader hint for empty data; EN and DE defaults. |
|
|
317
|
+
| strings.failureMessage | string | | | Reader heading when a chart cannot be shown; EN and DE defaults. |
|
|
318
|
+
| strings.failureHint | string | | | Reader hint when a chart cannot be shown; EN and DE defaults. |
|
|
319
|
+
| strings.diagnosticDetails | string | | | Label for the developer details disclosure; default Details. |
|
|
320
|
+
| strings.others | string | | | Host wording for the Others aggregate. |
|
|
321
|
+
| strings.total | string | | | Host wording for a computed total. |
|
|
322
|
+
| strings.source | string | | | Host wording for source furniture. |
|
|
323
|
+
| strings.notApplicable | string | | | Not applicable text; n/a, German k. A. |
|
|
324
|
+
| strings.legendCount | string | | | Host wording for a legend count; use {count} for the number. |
|
|
325
|
+
| strings.partial | string | | | Host wording after the labels of partial categories in their footnote, also the hatch key label. |
|
|
326
|
+
| strings.better | string | | | Meaning of a better sign-coloured value. |
|
|
327
|
+
| strings.worse | string | | | Meaning of a worse sign-coloured value. |
|
|
328
|
+
| strings.positiveTotal | string | | | Name of a mixed-sign stack positive boundary. |
|
|
329
|
+
| strings.rangeMidNote | string | | | Range method note. |
|
|
330
|
+
| strings.sensitivityNote | string | | | Tornado method note. |
|
|
331
|
+
| strings.hatchedBaseNote | string | | | Tornado base mismatch note. |
|
|
332
|
+
| strings.missingSwingNote | string | | | Tornado missing output note; {drivers} is replaced. |
|
|
333
|
+
| strings.rankOmitted | string | | | Focused bump note. |
|
|
334
|
+
| strings.noRank | string | | | A missing bump rank. |
|
|
335
|
+
| strings.rankMethod | string | | | Bump method note; {direction}, {format}, and {ring} are replaced. |
|
|
336
|
+
| strings.higherBetter | string | | | Direction of a bump rank. |
|
|
337
|
+
| strings.lowerBetter | string | | | Direction of a bump rank. |
|
|
338
|
+
| strings.rankFormat | string | | | Format clause in the bump method note. |
|
|
339
|
+
| strings.rankRing | string | | | Tie clause in the bump method note. |
|
|
340
|
+
| strings.nearZeroNote | string | | | Note for folded zero line ends. |
|
|
341
|
+
| strings.flagged | string | | | Anomaly marker key. |
|
|
342
|
+
| strings.corridor | string | | | Anomaly rule key. |
|
|
343
|
+
| strings.corridorBounds | string | | | Authored anomaly bounds key. |
|
|
344
|
+
| strings.median | string | | | Anomaly median rule label and key. |
|
|
345
|
+
| strings.anomalySmallSample | string | | | Small-sample anomaly sentence. |
|
|
346
|
+
| strings.anomalyZeroMad | string | | | Zero-MAD anomaly sentence. |
|
|
347
|
+
| strings.anomalyMadRule | string | | | MAD anomaly sentence; preserves the full calculation. |
|
|
348
|
+
| strings.anomalyCentreZero | string | | | Zero-centred anomaly rule clause. |
|
|
349
|
+
| strings.anomalyCentreMedian | string | | | Median-centred anomaly rule clause. |
|
|
350
|
+
| strings.anomalyThresholdRule | string | | | Threshold anomaly sentence. |
|
|
351
|
+
| strings.outsideBounds | string | | | Two-sided threshold clause. |
|
|
352
|
+
| strings.belowBound | string | | | Lower threshold clause. |
|
|
353
|
+
| strings.aboveBound | string | | | Upper threshold clause. |
|
|
354
|
+
| strings.lowerBound | string | | | Off-scale lower corridor bound. |
|
|
355
|
+
| strings.upperBound | string | | | Off-scale upper corridor bound. |
|
|
356
|
+
| strings.undrawnBounds | string | | | Off-scale corridor note. |
|
|
357
|
+
| strings.hiddenLabels | string | | | Heading of the note for hidden chart labels. |
|
|
358
|
+
| strings.noteOne | string | | | Pointer to one hidden note. |
|
|
359
|
+
| strings.noteMany | string | | | Pointer to hidden notes. |
|
|
360
|
+
| strings.notesAndSources | string | | | React notes panel label. |
|
|
361
|
+
| strings.close | string | | | React notes panel Close control. English Close; German Schließen. |
|
|
362
|
+
| strings.mapCredit | string | | | Word before a map credit in the React notes panel. |
|
|
363
|
+
| strings.gapBetween | string | | | Key for a gap between two lines. |
|
|
364
|
+
| strings.aboveSeries | string | | | Positive line gap key. |
|
|
365
|
+
| strings.belowSeries | string | | | Negative line gap key. |
|
|
366
|
+
| strings.average | string | | | Name before a computed mean; English Average, German Ø. |
|
|
367
|
+
| strings.toDate | string | | | Text after a running category name in its key or note. |
|
|
368
|
+
| strings.forecast | string | | | Key for the forecast pattern. |
|
|
369
|
+
| strings.plan | string | | | Key for the plan outline. |
|
|
370
|
+
| strings.forecastHeader | string | | | Header at the actual-to-forecast boundary. Keeps the scenario code by default. |
|
|
371
|
+
| strings.net | string | | | Name before a net total. |
|
|
372
|
+
| strings.incomplete | string | | | Marker on an incomplete stack total; prints under notes.show 'disclosure'. |
|
|
373
|
+
| strings.range | string | | | Key for a range whisker. |
|
|
374
|
+
| strings.valuesNotOnColumns | string | | | Note heading for omitted column values. |
|
|
375
|
+
| strings.valuesNotBesideMarks | string | | | Note heading for omitted combo values. |
|
|
376
|
+
| strings.partialTotals | string | | | Incomplete total note; {partial} is the marker. |
|
|
377
|
+
| strings.knownPartsTotals | string | | | Incomplete total note where the marker does not print. Column and combo only; a bar stack uses incompleteStacks. |
|
|
378
|
+
| strings.without | string | | | Word before missing stack parts. |
|
|
379
|
+
| strings.and | string | | | Word joining missing stack parts. |
|
|
380
|
+
| strings.aboveZero | string | | | Positive sign key; {series} and {meaning} are replaced. |
|
|
381
|
+
| strings.belowZero | string | | | Negative sign key; {series} and {meaning} are replaced. |
|
|
382
|
+
| strings.declaredBounds | string | | | Key for an authored uncertainty bound. |
|
|
383
|
+
| strings.tied | string | | | Label of a shared rank. |
|
|
384
|
+
| strings.tiedSymbol | string | | | Symbol before a displaced shared-rank label. |
|
|
385
|
+
| strings.currentValue | string | | | Football-field spine; {value} is replaced. |
|
|
386
|
+
| strings.baseCase | string | | | Tornado spine; {value} is replaced. |
|
|
387
|
+
| strings.swingOutsideBase | string | | | Tornado hatch key. |
|
|
388
|
+
| strings.fanGap | string | | | Missing uncertainty note; {categories} is replaced. |
|
|
389
|
+
| strings.mixedShares | string | | | Mixed-sign share note; {categories} is replaced. |
|
|
390
|
+
| strings.storyBack | string | | | Host wording for the story back button. |
|
|
391
|
+
| strings.storyNext | string | | | Host wording for the story next button. |
|
|
392
|
+
| strings.storyCounter | string | | | Host wording for the story counter; default {step} / {count}, without zero padding. |
|
|
393
|
+
| strings.storyStep | string | | | Host wording for the story live region position; {step} and {count} print without padding. Defaults to Step {step} of {count} (EN), Schritt {step} von {count} (DE). |
|
|
394
|
+
| strings.axisLow | string | | | Host wording for the low end of a scatter qualitative axis. |
|
|
395
|
+
| strings.axisHigh | string | | | Host wording for the high end of a scatter qualitative axis. |
|
|
396
|
+
| strings.nearZeroChange | string | | | Table n.m. change note. |
|
|
397
|
+
| strings.mixedCoverage | string | | | Table n.m. note for a change between totals of different rows. |
|
|
398
|
+
| strings.hiddenPeriods | string | | | Dimswitch note for periods left out; {periods} is replaced. |
|
|
399
|
+
| strings.missingStack | string | | | StackedArea source-null note; {categories} is replaced. |
|
|
400
|
+
| strings.incompleteStacks | string | | | Incomplete bar stack note (bar only; column and combo use knownPartsTotals); {categories} is replaced. |
|
|
401
|
+
| strings.knownPartsShares | string | | | Incomplete 100% stack note without total100; {categories} is replaced. |
|
|
402
|
+
| strings.rebaseZero | string | | | Line or stacked-area series left out by rebase100 for a zero base; {series} and {period} are replaced. |
|
|
403
|
+
| strings.rebaseMissing | string | | | Line or stacked-area series left out by rebase100 for a missing base; {series} and {period} are replaced. |
|
|
404
|
+
| strings.loading | string | | | Visible wording of the busy state; default Loading. |
|
|
405
|
+
|
|
406
|
+
A colour-only theme change repaints the existing geometry. A font, spacing, density or locale change runs layout again. `locale.decimal` and `locale.thousands` set the marks of every number the engine composes, and `locale.language` its words, such as notes and month names: `{ language: 'de-DE', decimal: ',', thousands: '.' }` prints `1.234,5`, while `locale="de-DE"` alone keeps `1,234.5`. A format example on the chart, series or cell stays as written, and authored text stays untranslated. `strings` replaces the wording of composed labels such as Others, Total and Source. `direction="rtl"` mirrors HTML controls and cards; chart geometry keeps its coordinates.
|
|
407
|
+
|
|
408
|
+
Dark mode is a theme. When the host turns dark, pass the dark preset to the provider: `standard-dark` for `standard`, `notation-dark` for `notation`; `glass` is dark already, and `boardroom` (the default), `capital` and `studio` have no dark preset. A chart paints its canvas in the theme's `color.background`, which `resolveTheme(name).color.background` from `boardplot/theme` returns (`#0E1A26` in `standard-dark`). Give the card that colour, or give the chart the card's colour: `theme={{ preset: 'standard-dark', overrides: { color: { background: '#111827' } } }}`.
|
|
409
|
+
|
|
410
|
+
## Targets
|
|
411
|
+
|
|
412
|
+
The target names the medium the chart is read in; [Sizing in the manual](../manual.md#sizing) gives the type sizes and the slot size for each. A chart takes its `target` prop, else `spec.options.target` (for `BoardplotChart`), else the provider's `target`, else `report`. A grid passes its target to every panel. The prepared result and the export carry the resolved target.
|
|
413
|
+
|
|
414
|
+
A dashboard selects `dashboard` once, at the provider, and keeps container sizing. A complete theme registered with its own `name` keeps its type sizes under every target; build its `type` with `typeForTarget(baseType, 'dashboard')` from `boardplot/theme` to take the dashboard sizes and keep its families, weights and line heights.
|
|
415
|
+
|
|
416
|
+
A chart that does not use `size="container"` does not grow past its natural width. It can shrink with its parent, and `onWarnings` reports a shrink below its safe minimum.
|
|
417
|
+
|
|
418
|
+
`onWarnings(warnings)` receives the warnings of the layout. In the browser it also watches the width the chart shows at; more than half a CSS pixel below `geometry.presentation.minDisplayWidth` it adds one display finding, `observed-display-too-small`. It repeats only when the warning state changes. The observation does not change the geometry, the prepared result or the exported SVG.
|
|
419
|
+
|
|
420
|
+
## Refusals
|
|
421
|
+
|
|
422
|
+
A chart below its size floor renders a status placeholder instead of marks. Its text is `strings.refusalMessage` of the provider, by default "This chart needs at least {width} × {height} px.", where `{width}` and `{height}` become the minimum the refusal names; wording without these tokens prints as written. The placeholder title carries the engine message. `onRefused` receives the refusal result, and `renderRefused` returns the content to show in its place. `onGeometry` runs only for an accepted layout.
|
|
423
|
+
|
|
424
|
+
## Content security policy
|
|
425
|
+
|
|
426
|
+
A strict content security policy needs two allowances for styles, and one setting keeps the console free of a reported violation.
|
|
427
|
+
|
|
428
|
+
- **Style elements.** Tables, the table hover card and story charts write `<style>` elements whose text depends on the spec and the theme, so a hash in the policy cannot allow them. Pass the nonce of the response as `styleNonce` on every component and list it in the policy, for example `style-src 'self' 'nonce-…'`. Without a nonce, allow inline style elements only: `style-src-elem 'self' 'unsafe-inline'`.
|
|
429
|
+
- **Style attributes.** Server markup carries `style` attributes, such as the frame size and the table's column tracks. A browser applies them only when `style-src-attr` (or `style-src`) allows `'unsafe-inline'`. A chart that renders only in the browser sets the same styles through the CSS object model, which a policy does not restrict.
|
|
430
|
+
- **zod probe.** Boardplot checks input with zod. Once per page, zod tries `new Function('')` to find out whether it can compile fast parsers. Rendering works when the policy refuses it, but a policy without `'unsafe-eval'` reports the attempt as a violation (a `securitypolicyviolation` event and a report to `report-to`). To skip the probe, set `(globalThis.__zod_globalConfig ??= {}).jitless = true` before Boardplot loads: in a module that the entry imports before any Boardplot entry, or in an inline script that carries the script nonce.
|
|
431
|
+
|
|
432
|
+
## Server preparation
|
|
433
|
+
|
|
434
|
+
Prepare on the server, pass the JSON result through your framework and render the component with the same props. The first client render attaches to the prepared scene without layout; a later change of data, options or measured size lays out again.
|
|
435
|
+
|
|
436
|
+
```tsx
|
|
437
|
+
import { parseChartSpec, prepareChart } from 'boardplot/react/prepare';
|
|
438
|
+
import { BoardplotChart } from 'boardplot/react/spec';
|
|
439
|
+
|
|
440
|
+
const spec = {
|
|
441
|
+
type: 'column',
|
|
442
|
+
data: { categories: ['2021', '2022', '2023', '2024', '2025'], series: [{ id: 'subscriptions', label: 'Subscriptions', values: [62, 74, 88, 103, 121] }, { id: 'services', label: 'Services', values: [38, 41, 43, 44, 46] }] },
|
|
443
|
+
options: { variant: 'stacked', title: 'Subscriptions carry the growth', unit: '$m' },
|
|
444
|
+
annotations: [{ kind: 'cagr' }],
|
|
445
|
+
};
|
|
446
|
+
const sizing = { size: 'container' as const, fit: 'fill' as const, fallbackSize: { width: 960, height: 540 } };
|
|
447
|
+
|
|
448
|
+
export async function RevenueMix() {
|
|
449
|
+
const prepared = await prepareChart({ ...(await parseChartSpec(spec)).request, ...sizing });
|
|
450
|
+
return <BoardplotChart spec={spec} {...sizing} prepared={prepared} />;
|
|
451
|
+
}
|
|
452
|
+
```
|
|
453
|
+
|
|
454
|
+
Prepare with the same theme, target and provider settings the client uses; a mismatch throws instead of showing a stale scene. A prepared result from an older engine revision is rejected. `serializePreparedChart(prepared)` returns JSON that is safe inside a `<script type="application/json">` element. The component entries carry `"use client"`; call `prepareChart` and `parseChartSpec` in server code. Both return a promise: `prepareChart` loads the engine of the chart's type and, for a grid, of its panels' types, and no other. `GridChart` fetches its panels' engines in the browser, so its server pass draws the busy placeholder unless it gets `prepared`. The data reaches the browser with the props, so remove private values before rendering.
|
|
455
|
+
|
|
456
|
+
A table brings its styles in its own markup: the server pass, `renderToString` and `renderToStaticMarkup` write a `<style data-bp-table-theme>` element beside the table, so the server response shows the styled grid before any script runs. The package ships no separate CSS file and no function that returns the table stylesheet. A capture of a page after mount has to collect that element from `document.head` or the shadow root; [The table component](#the-table-component) says how.
|
|
457
|
+
|
|
458
|
+
## Bundlers and side effects
|
|
459
|
+
|
|
460
|
+
`package.json` names `sideEffects`. A bundler drops a bare import of a file that is not on that list. The patterns for the chart catalogue (`**/core/charts/index.ts`) and the fixture modules (`**/core/charts/*/fixtures.ts`) match `.ts` source paths only. In the published `dist`, `dist/geo/*.js` matches, and so does each entry that calls a link function when it loads: `dist/index.js`, `dist/validate.js`, `dist/theme.js`, `dist/react/index.js`, `dist/react/export.js` and `dist/react/prepare.js`. Webpack and Vite skip the body of an entry that is not on the list when the host uses only names the entry re-exports, and then the link call never runs. The list does not keep the theme checks (`themeShapeRules`), the annotation publisher (`annotateEngine`) or the story layer (`storyLayer`).
|
|
461
|
+
|
|
462
|
+
A bare import is not enough for the theme checks, the annotation publisher or the story layer.
|
|
463
|
+
|
|
464
|
+
Import the chart component you draw, such as `ColumnChart` from `boardplot/react/column`. That import registers the type. A bare `import 'boardplot/react'` registers nothing.
|
|
465
|
+
|
|
466
|
+
Import the geo pack you draw, such as `import 'boardplot/geo/world'`. In the published package that file is `dist/geo/world.js`, and `dist/geo/*.js` is on the list, so the bare import stays. The Maps section names the packs. Without the import a choropleth throws `geo-pack-not-registered`.
|
|
467
|
+
|
|
468
|
+
Call the theme checks and the annotation publisher by value. `boardplot`, `boardplot/validate`, `boardplot/react`, `boardplot/react/prepare`, `boardplot/react/export` and `useChartLayout` call `linkThemeShapeRules()` and `linkAnnotateEngine()`. `boardplot/theme` calls `linkThemeShapeRules()`. An entry that makes such a call is on the `sideEffects` list. `withStory` from `boardplot/react/story` calls `linkStoryLayer()`. A per-type component loads the theme checks and the annotation publisher when the chart needs them. Do not add a bare import of those three modules. The bundler drops it.
|
|
469
|
+
|
|
470
|
+
The package is ES modules. Every entry names a `default` condition beside `import`, so CommonJS loads it with `require()` on Node 22.12 or later, the version `engines` asks for.
|
|
471
|
+
|
|
472
|
+
## Maps
|
|
473
|
+
|
|
474
|
+
`ChoroplethChart` ships the layout without the map geometry. Import the pack you draw once in your entry graph; `import 'boardplot/geo';` registers every pack, which costs more bundle than one pack.
|
|
475
|
+
|
|
476
|
+
```tsx
|
|
477
|
+
import 'boardplot/geo/de-states';
|
|
478
|
+
import { ChoroplethChart } from 'boardplot/react/choropleth';
|
|
479
|
+
|
|
480
|
+
export function StateMap() {
|
|
481
|
+
return <ChoroplethChart data={{ pack: 'de-states', regions: [{ id: 'DE-BY', value: 42.1 }, { id: 'DE-BE', value: 37.5 }] }} title="Bavaria leads Berlin by 4.6 points" />;
|
|
482
|
+
}
|
|
483
|
+
```
|
|
484
|
+
|
|
485
|
+
Without the import the chart throws `geo-pack-not-registered` at render time, with the pack and the import line in its message. The packs are `de-states`, `dach`, `eu27`, `europe`, `us-states` and `world`. `TilemapChart` carries its tile layouts and needs a pack only for an overlay placed by longitude and latitude. The CLI and the MCP server register every pack.
|
|
486
|
+
|
|
487
|
+
## Hover
|
|
488
|
+
|
|
489
|
+
| Prop | Type | Values | Default | Meaning |
|
|
490
|
+
|---|---|---|---|---|
|
|
491
|
+
| card | false \| string | `false`, `'label'`, `'sparkline'` | | Label card with the hovered record's own facts, placed beside the mark by the label solver and always inside the chart's own frame. Default 'label'. On a table, 'sparkline' draws the row across its column group instead and no card where the group holds fewer than three numbers. |
|
|
492
|
+
| highlight | boolean | | | Dim the other series and outline the hovered marks; on a table, wash the row of the hovered cell instead. Default true. |
|
|
493
|
+
|
|
494
|
+
The card lists the hovered record's own facts: the mark it names, its value as the chart prints it (the series or chart `format` decides the rounding, prefix and suffix; a unit that is a currency sign or a magnitude letter sits on the number as it would on a mark, "$213k"), the fields the record carries, each comparison, its share where the record has one, its rank where the chart ranks, and any annotation on it whose text the chart does not already print in full. A comparison prints its change through the same format as the value ("−$12"), and its percent at the precision the chart prints percentages with. A comparison that cannot be made, such as one against a series on the other axis, has no row. A category's date has no row when the heading names the category. An unlabelled date category of a line, column or combo chart is named as its period with its year ("Mar 2025", "4 Sep 2026"), where the axis prints "Mar" over a year row. A missing value inside a series has a card too: the pointer over the gap reads "No observation", and on a stacked area, which draws the missing part as zero, "No observation; drawn as 0 in the stack". On a card that lists several series, a date the heading does not name joins the heading once, after the category. The record keeps the source number and every comparison. Only the value row is a bare number and carries tabular figures; the composed lines read as captions.
|
|
495
|
+
|
|
496
|
+
Extra facts for the card come from the data, so a spec draws the same card in every host: a cell's `details` (`{ number: 96, details: { pipeline: 212, owner: 'Sales planning' } }`) print after the record's own fields, labelled, formatted and ordered by the chart option `detailFields` (`[{ key: 'pipeline', label: 'Pipeline', format: '1,234', unit: '$m' }]`). A key `detailFields` does not declare prints after the declared ones, labelled with its key. A text prints as plain text, never as markup or a link. The keyboard reading includes them; the static SVG and the accessible data table do not. An aggregate (topN Others, a computed Total) shows none, because folded facts cannot be summed. The record carries each one as a field with the key `detail:<key>`. Bar (not tornado), butterfly, column, combo, dot, funnel, heatmap, line, mekko, pie and slope read details; the other types refuse them.
|
|
497
|
+
|
|
498
|
+
An event in the event lane of a column, combo or line chart has its own card: its date or category and kind, then each item with its detail in full (the lane and the key may leave the detail out for space; the card does not). The card opens on a pointer over the event's marker, its lane block or its key entry, and on keyboard focus: with `hover` on, each event's marker or title line is one tab stop, and Escape or moving focus away closes the card.
|
|
499
|
+
|
|
500
|
+
A value line has its own card: its printed label, the value it draws at, and for a mean over one series or a span of categories what it measures ("Measure: Mean of Sales, Jan 2025 to Mar 2025"). The card opens on a pointer over the line or its label; a data mark beside the line keeps the pointer. Value lines and events stay as drawn while a mark is hovered, and neither has a row in the accessible data table.
|
|
501
|
+
|
|
502
|
+
A card a tap opened closes on a tap outside the chart, as on a table, or on a tap on the chart where no mark is.
|
|
503
|
+
|
|
504
|
+
On a grid, the pointed series keeps its full ink in every other panel, so small multiples still compare it; it has an outline and a card only in the panel under the pointer.
|
|
505
|
+
|
|
506
|
+
### Your own card content
|
|
507
|
+
|
|
508
|
+
`renderHoverContent` puts your own content into the card: a link to a detail page, a figure from your own data, a layout of your own. It is React code you write, so it never travels in a spec; a spec carries extra facts as cell `details` instead (see above).
|
|
509
|
+
|
|
510
|
+
```tsx
|
|
511
|
+
import { ColumnChart } from 'boardplot/react/column';
|
|
512
|
+
|
|
513
|
+
const data = { categories: [{ id: 'north', label: 'North' }, { id: 'south', label: 'South' }], series: [{ id: 'revenue', label: 'Revenue', values: [120, 90] }] };
|
|
514
|
+
|
|
515
|
+
export function RegionRevenue() {
|
|
516
|
+
return <ColumnChart data={data} title="North revenue exceeds South by $30k" unit="$k" renderHoverContent={(record, { defaultContent }) => <>
|
|
517
|
+
{defaultContent}
|
|
518
|
+
<div style={{ padding: '0 var(--bp-card-pad-x) var(--bp-card-pad-y)' }}>
|
|
519
|
+
<a href={`/regions/${record.target.owner.categoryId}`}>Open {record.categoryLabel}</a>
|
|
520
|
+
</div>
|
|
521
|
+
</>} />;
|
|
522
|
+
}
|
|
523
|
+
```
|
|
524
|
+
|
|
525
|
+
`records` lists every record the card covers, the pointed one first (a category band brings its other series). `source` is `'pointer'` or `'keyboard'`. The card keeps the theme's surface, radius, shadow, font and ink, with no padding of its own, because `defaultContent` brings its own; CSS custom properties give your content the theme values: `--bp-card-pad-x`, `--bp-card-pad-y`, `--bp-card-ink`, `--bp-card-muted` and `--bp-card-rule`. The card is measured after it renders and takes the seat the default card would take for a box of its size, inside the viewport; a taller card scrolls inside itself.
|
|
526
|
+
|
|
527
|
+
Unlike the default card, your card takes the pointer: moving the pointer from the mark to the card keeps it open while the pointer heads for it, even across other marks, and a pointer that rests on the way for 250 ms picks the mark under it. Leaving the chart closes the card after 150 ms unless the pointer reaches it, and a card that holds the focus stays open. A click or tap inside the card is yours: it fires no `onRecordClick` and does not move the card. A tap outside the chart and the card closes it.
|
|
528
|
+
|
|
529
|
+
Keyboard: focus on the chart's tab stop opens your card for the focused record, as for the default card. When the card holds a link, a button or another focusable element, Tab moves into it, Shift+Tab returns to the record, and Tab past its last element leaves the chart and closes the card. Escape in the card closes it and returns the focus to what opened it, the record stop or an event marker. Keys inside the card are yours. In a browser without popover support the card sits in the chart's own box, so the same Tab order holds; an `overflow: hidden` ancestor can clip it there.
|
|
530
|
+
|
|
531
|
+
Screen reader: the card is a non-modal dialog named by the record. The option the tab stop names keeps the record's reading and place and is described by your content, without the default facts it already read; where the card holds a focusable element, the description ends with "Press Tab to reach the card." (German: "Tab führt in die Karte.").
|
|
532
|
+
|
|
533
|
+
### Keyboard
|
|
534
|
+
|
|
535
|
+
A chart with `hover` on, or with `onRecordClick`, has one tab stop for its records. Tab enters the chart and Tab leaves it; the event markers and the series buttons keep their own stops. Home and End go to the first and the last record in the reading order. The focused record opens the card and the highlight the pointer opens on its mark, a ring marks the chart and the record's outline thickens. Enter or Space calls `onRecordClick` with the record and the keyboard event; on an annotation it only keeps the card open. Escape closes the card and keeps the focus; the next arrow opens it again. A record that draws no mark is still reached; its card opens inside the chart frame, where it covers the least drawn content, nearest the centre. The last input wins: a pointer move takes the card over, and the next key takes it back. After a data update the focus stays on the same record, or on the record now at its place.
|
|
536
|
+
|
|
537
|
+
The arrows follow the drawn chart: the record an arrow reaches lies in that direction, or the focus stays. On a bar, column, line, combo, dot, slope or butterfly, the arrows along the category axis (Left and Right on a column or line, Up and Down on a bar, dot or butterfly) move to the next drawn category, in the same series where it has a mark there. The other two arrows move between the records of one category at one position: the stacked segment, line, dot or wing drawn above, below or beside. On grouped bars Left and Right walk every bar. On a heatmap, cohort or status, arrows move to the nearest cell in the same drawn row or column and skip absent cells.
|
|
538
|
+
|
|
539
|
+
On a scatter, Left and Right move to the next drawn x, at the point nearest in height; Up and Down move to the next point at the same x, else to the nearest drawn point in that direction. Every point is reached. Records drawn at one position are read in turn before an arrow leaves it. Records without a drawn position keep list access. Other families and annotations keep list navigation: Right and Down go forward; Left and Up go back. An edge stops the focus without wrapping. From the first or last record of a panel, an outward arrow can reach the preceding or following panel or annotation.
|
|
540
|
+
|
|
541
|
+
The reading order, per panel of a grid in panel order: a category chart reads category by category in drawn order, each category's series in legend order (data order where there is no legend); a heatmap, cohort or status chart reads by drawn row, then column; a scatter reads by x, then by y; a treemap reads in tree order, group by group; every other chart reads its records in the order the data table lists them. Event and value-line records follow the data records. A table keeps its own keyboard grid (see [The table component](#the-table-component)): a focused cell opens the cell's card and row highlight, and Escape closes them.
|
|
542
|
+
|
|
543
|
+
A screen reader hears the focused record through the W3C APG listbox pattern with `aria-activedescendant`: the tab stop is a listbox named by the chart title, laid over the drawn chart and transparent to the pointer, and its one option carries the card's whole reading and the record's place ("3 of 16"). The SVG keeps `role="img"`, its label and its description for readers who do not enter the chart. The tab stop is drawn after the hover engine loads, so the server markup does not change. A generic audit may flag a `role="listbox"` in the page flow; it is there on purpose. The chart is one tab stop whose arrow keys move between records, and the listbox with `aria-activedescendant` is the APG pattern for exactly that: `role="img"` cannot take focus, `grid` needs a cell for every record, and `application` turns off the screen reader's reading mode for the rest of the chart.
|
|
544
|
+
|
|
545
|
+
The card sits beside the mark: right of it, else left, above or below, on the first side inside the frame that nothing occupies. Where every side is occupied it stays beside the mark and sits over the content on its own opaque background; it never moves off to a free corner of the frame. It never leaves that frame and never changes the drawn size, so a host element with a fixed height and `overflow: hidden` shows the whole card without reserving room for it. A row the frame is too narrow for wraps to two lines and then cuts with an ellipsis, carrying its full text as the text node's `<title>`; a card the frame is too short for drops rows from the bottom and ends on a row counting them, and the accessible description keeps every fact. The server output is the static chart.
|
|
546
|
+
|
|
547
|
+
## Zoom
|
|
548
|
+
|
|
549
|
+
`zoom` on a line or area chart whose x is a continuous axis (`data.x` with `xAxis`) or whose categories all carry an ISO `date` lets the reader zoom. Ctrl or Cmd with the wheel, or a trackpad pinch, zooms around the pointer; the plain wheel scrolls the page as before. With the chart focused, `+` (or `=`) zooms in, `-` zooms out, `0` returns to the range the chart opened at (its `viewDomain`, else the whole range), and Shift+Left and Shift+Right pan by half the visible range; Left and Right keep stepping records. A chart without `hover` or `onRecordClick` takes one tab stop for these keys.
|
|
550
|
+
|
|
551
|
+
Without `aggregate`, a zoom changes only the range: every reading in it is drawn. With `aggregate`, a range too wide for one point per 6 px draws coarser buckets, from minutes and hours through days, weeks and months to quarters and years, and zooming in goes back to the readings. A bucket is a `[start, end)` period on the zone clock (`xAxis.zone`, UTC on a date axis). `aggregate` is one rule, or one per series id that names every series (a series without a rule keeps the zoom to the range): `sum` for a flow such as orders, `last` for a stock such as a balance, `mean`, `min` or `max`. A sum with a missing reading stays empty, an empty bucket stays missing, and a note under the chart names the buckets ("Monthly sums"). Under `sum`, `min` or `max`, a first or last bucket the readings cover only in part is marked partial, on a date axis and on a continuous axis: its marker turns hollow, a note names it, and its hover card says which days it covers ("Covers 3 Jan 2025 to 31 Jan 2025 (29 of 31 days)"). Under `mean` or `last` it is not marked: a mean and a last value of fewer days stay on the scale of a full bucket. `grains` limits the grains, finest first. A bucketed view keeps events and, on a continuous axis, bands; anchors that name a reading (targets, value lines, callouts, phases) draw at the reading grain only. Cells with a scenario or a status are not combined: such a chart zooms its range only.
|
|
552
|
+
|
|
553
|
+
`onZoom(change)` is called after each zoom or pan, at most once per frame, with `range` (UTC ISO times, ISO dates or numbers), `grain` (the grain the range asks for, `{ unit, step }`, finer than the data when the host should send finer data), `drawn` (the grain on the chart, `null` for the readings), `zone` and `reason` (`wheel`, `keyboard`, `pan` or `reset`). With `onZoom` a time chart zooms in to five minutes, so a host can answer with finer `data`; the range stays when the data changes. `range` makes the zoom controlled: the chart draws that range and a gesture only calls `onZoom`.
|
|
554
|
+
|
|
555
|
+
## Story
|
|
556
|
+
|
|
557
|
+
A chart with `options.story` is a guided sequence of steps. The chart stays the same in every step: each step brings the marks its `highlight` names forward with a bold label and fades every other mark to the theme's dim token (`interaction.dim`, 25% by default). No mark moves between steps. A panel holds the step's title and body, Back and Next, and a counter ("2 / 6"); its words are `strings.storyBack`, `strings.storyNext` and `strings.storyCounter`. A step without `highlight` is an intro that shows every mark at full strength. The layout reserves a 240–320 px column right of the plot. At S widths, or if the chart would fall below its width floor, it puts the panel below the x axis at full plot width. Automatic height grows. Fixed height reduces the plot toward its measured minimum, then removes body lines down to zero, then clamps the panel title to one line. The button row stays. Cut text reports `story-text-truncated`; the live region keeps the full text. Only a frame that cannot fit the plot and this minimum panel refuses. The panel never covers the plot. Next is filled, Back has a hairline outline, and the panel has a 6 px radius. The counter sits left of the grouped buttons, or above them when the row is too narrow. Button labels wrap, with an 8 px gap and at least 44 px height. One step shows no buttons or counter. The counter has no zero padding and no progress bar. The type reference lists the chart types that take a story.
|
|
558
|
+
|
|
559
|
+
The story layer is opt-in, so a page that tells no story does not carry it. Wrap the component with `withStory` from `boardplot/react/story`: `const StoryScatter = withStory(ScatterChart)`, or `withStory(BoardplotChart)`. Without it the chart draws without the story and warns `story-layer-not-loaded`. The link holds for the whole page: once one chart calls `withStory`, a plain component with `options.story` on that page draws the static step (the panel without buttons) and no warning, so wrap every chart that tells a story. The CLI, the MCP server, `boardplot`, `boardplot/react/prepare` and `boardplot/react/export` always draw the story. The `react/story` entry is about 24 KB gzip on initial load; a chart entry carries only the hook that asks for it.
|
|
560
|
+
|
|
561
|
+
The wrapped component takes four props more. The step is a controlled prop with an uncontrolled twin. `defaultStep` names the first step (default `options.story.step`, else the first step). `step` makes it controlled: the chart shows that step, and `onStepChange(step, { index, reason })` reports each move with `reason` `back`, `next`, `key` or `mark`. Back stops at the first step and Next at the last; a story does not wrap, because a reader at the end should see that it ended. The buttons are HTML buttons over the drawn ones: they take Tab, and a disabled one stays focusable with `aria-disabled`. With the chart focused, the Left and Right arrow keys step. A click on a mark that a step brings forward moves to the first such step; `stepOnMarkClick={false}` turns that off. A polite live region reads each step's title and body. The fade is a CSS opacity transition with the theme's fade duration, and it is off under reduced motion.
|
|
562
|
+
|
|
563
|
+
A static output (SVG, PNG, the CLI and `export`) draws one step without buttons: the intro, or the step `options.story.step` names. Render once per step for a frame per step.
|
|
564
|
+
|
|
565
|
+
## Shared value scale
|
|
566
|
+
|
|
567
|
+
`ScaleGroup` from `boardplot/react/theme` gives separately mounted charts one value domain. Declare every member, then set `scaleGroup={{ y: <group>, id: <member id> }}` on each chart. The group resolves during render, so server markup carries the same domain as the browser. `useScaleGroupPlan(group)` returns the plan with the members it refused and why.
|
|
568
|
+
|
|
569
|
+
## Export
|
|
570
|
+
|
|
571
|
+
`boardplot/react/export` writes files from the canonical geometry, not from the live DOM. `useExport()` returns `svg()`, `png(scale)`, `csv()`, `copyImage()` and `copyData()`; the same functions exist standalone as `exportSvg`, `exportPng`, `exportCsv`, `copyImage` and `copyData`. Each resolves to `{ ok: true, artifact: { format, bytes, text, mediaType, filename }, document, receipt }` or `{ ok: false, code, message }`. The entry links no chart engine: each call loads the engine and schemas of the type it exports.
|
|
572
|
+
|
|
573
|
+
Pass the handle to the chart as `exporter`. Every chart component takes it, `BoardplotChart` and `TableChart` too, and the export then lays out what that chart drew, at its size on screen: a container chart at its measured width, and at its height where the host gives it one; a table or cohort that scrolls sideways at the width it scrolls at; a table at the height its rows need, with the rows, column groups and inline lines the reader sees, in its authored row order, since a column sort stays on screen; a `withStory` chart at the step the reader moved to. While the chart shows a refusal card or the busy placeholder, it hands the handle nothing. `csv()` and `copyData()` hold every record of the chart, folded rows and hidden columns included, as the CLI's records do: a fold hides rows from the drawing, not from the data. Give each chart its own handle; a handle that two charts hold answers `code: 'invalid'`.
|
|
574
|
+
|
|
575
|
+
```tsx
|
|
576
|
+
import { useExport } from 'boardplot/react/export';
|
|
577
|
+
import { ColumnChart } from 'boardplot/react/column';
|
|
578
|
+
|
|
579
|
+
const data = {
|
|
580
|
+
categories: ['2021', '2022', '2023', '2024', '2025'].map((year) => ({ id: year, label: year })),
|
|
581
|
+
series: [
|
|
582
|
+
{ id: 'subscriptions', label: 'Subscriptions', values: [62, 74, 88, 103, 121] },
|
|
583
|
+
{ id: 'services', label: 'Services', values: [38, 41, 43, 44, 46] },
|
|
584
|
+
],
|
|
585
|
+
};
|
|
586
|
+
|
|
587
|
+
export function RevenueMixCard() {
|
|
588
|
+
const exporter = useExport();
|
|
589
|
+
const download = async () => {
|
|
590
|
+
const result = await exporter.png(2);
|
|
591
|
+
if (!result.ok) return;
|
|
592
|
+
const url = URL.createObjectURL(new Blob([result.artifact.bytes], { type: result.artifact.mediaType }));
|
|
593
|
+
Object.assign(document.createElement('a'), { href: url, download: result.artifact.filename }).click();
|
|
594
|
+
URL.revokeObjectURL(url);
|
|
595
|
+
};
|
|
596
|
+
return <>
|
|
597
|
+
<ColumnChart data={data} variant="stacked" annotations={[{ kind: 'cagr' }]} title="Subscriptions carry the growth" unit="$m" size="container" fit="content" fallbackSize={{ width: 800, height: 450 }} exporter={exporter} />
|
|
598
|
+
<button onClick={download}>Download PNG</button>
|
|
599
|
+
</>;
|
|
600
|
+
}
|
|
601
|
+
```
|
|
602
|
+
|
|
603
|
+
Without a chart that holds it, the handle exports the spec or request it gets, `useExport({ spec })`.
|
|
604
|
+
|
|
605
|
+
- SVG and CSV are written in the browser.
|
|
606
|
+
- CSV and `copyData()` prefix cells that start with `=`, `+`, `-`, `@`, a tab or a carriage return with a single quote, unless the whole cell is a plain number (for example, `-12`); CSV punctuation quoting stays the same.
|
|
607
|
+
- SVG carries the page's web fonts that its text draws with, as `data:` font faces: only the families, weights, styles and `unicode-range` slices the text uses, so a file opened elsewhere keeps the face and its spacing. A loaded face whose file the page cannot read (a style sheet from another origin, a `FontFace` built in script) is named in a console warning and drawn in a fallback face. `embedFonts: false` writes the plain SVG. See [Export fonts](../manual.md#export-fonts).
|
|
608
|
+
- PNG rasterizes that SVG through the browser canvas, or through a `rasterizePng` function you pass, with the same font copies, since an SVG drawn as an image loads nothing from outside itself.
|
|
609
|
+
|
|
610
|
+
The nearest `BoardplotTheme` applies; `context` and `request` fields passed to the hook override it. The export keeps the resolved target and size; the file type does not select a target. To export at a size, set it in the spec: `options.size: { width }` lays the chart out at that width and its content height, `{ width, height }` at that frame. `request` takes a whole chart request, `type` and `data` included, such as a prepared chart's; the fields it names replace the spec's. A request or spec with `size: 'container'` and no chart that holds the handle exports at its `fallbackSize`, the frame the component draws before it measures, or 720 × 405 px without one. A chart whose notes print in the SVG needs more room than its notes button on screen: the export then grows taller at the same width, with the info lint `static-footer-grew`. An invalid request resolves to `code: 'invalid'` instead of rejecting. Clipboard permission is requested only by `copyImage` and `copyData`; `copyImage` starts the clipboard write before the PNG is painted, inside the click that called it, which Safari requires.
|
|
611
|
+
|
|
612
|
+
A complete download in TypeScript without the `exporter` link. The standalone exports take the provider settings from `useBoardplotTheme()`, and the card's width sets the file's width, so the file is laid out at the width the reader sees. `useExport({ spec })` does the same at the spec's own size, with the provider applied for you.
|
|
613
|
+
|
|
614
|
+
```tsx
|
|
615
|
+
import { useRef, useState } from 'react';
|
|
616
|
+
import { BoardplotChart } from 'boardplot/react/spec';
|
|
617
|
+
import { BoardplotTheme, useBoardplotTheme } from 'boardplot/react/theme';
|
|
618
|
+
import { exportPng, exportSvg, type ExportResult } from 'boardplot/react/export';
|
|
619
|
+
|
|
620
|
+
const spec = {
|
|
621
|
+
type: 'column',
|
|
622
|
+
data: {
|
|
623
|
+
categories: [{ id: 'Q1' }, { id: 'Q2' }, { id: 'Q3' }, { id: 'Q4' }],
|
|
624
|
+
series: [{ id: 'revenue', label: 'Revenue', values: [412, 448, 471, 503] }],
|
|
625
|
+
},
|
|
626
|
+
options: { title: 'Revenue grew every quarter', unit: '$k' },
|
|
627
|
+
};
|
|
628
|
+
|
|
629
|
+
function save(result: ExportResult): string {
|
|
630
|
+
if (!result.ok) return `${result.code}: ${result.message}`;
|
|
631
|
+
const { bytes, mediaType, filename } = result.artifact;
|
|
632
|
+
const url = URL.createObjectURL(new Blob([new Uint8Array(bytes)], { type: mediaType }));
|
|
633
|
+
const link = document.createElement('a');
|
|
634
|
+
link.href = url;
|
|
635
|
+
link.download = filename;
|
|
636
|
+
link.click();
|
|
637
|
+
setTimeout(() => URL.revokeObjectURL(url), 1000);
|
|
638
|
+
return `${filename}, ${bytes.byteLength} bytes`;
|
|
639
|
+
}
|
|
640
|
+
|
|
641
|
+
function RevenueCard() {
|
|
642
|
+
const card = useRef<HTMLDivElement>(null);
|
|
643
|
+
const context = useBoardplotTheme();
|
|
644
|
+
const [status, setStatus] = useState('');
|
|
645
|
+
|
|
646
|
+
async function download(format: 'svg' | 'png') {
|
|
647
|
+
// The width the reader sees; a width alone grows to the content height.
|
|
648
|
+
const width = Math.round(card.current?.getBoundingClientRect().width ?? 720);
|
|
649
|
+
const input = { spec: { ...spec, options: { ...spec.options, size: { width } } }, context };
|
|
650
|
+
setStatus(save(format === 'svg' ? await exportSvg(input) : await exportPng(input, 2)));
|
|
651
|
+
}
|
|
652
|
+
|
|
653
|
+
return (
|
|
654
|
+
<div ref={card} style={{ width: '100%' }}>
|
|
655
|
+
<BoardplotChart spec={spec} size="container" fit="content" fallbackSize={{ width: 720, height: 405 }} />
|
|
656
|
+
<button onClick={() => download('svg')}>Download SVG</button>
|
|
657
|
+
<button onClick={() => download('png')}>Download PNG</button>
|
|
658
|
+
<output aria-live="polite">{status}</output>
|
|
659
|
+
</div>
|
|
660
|
+
);
|
|
661
|
+
}
|
|
662
|
+
|
|
663
|
+
export function RevenueExport() {
|
|
664
|
+
return (
|
|
665
|
+
<BoardplotTheme theme="standard" target="dashboard">
|
|
666
|
+
<RevenueCard />
|
|
667
|
+
</BoardplotTheme>
|
|
668
|
+
);
|
|
669
|
+
}
|
|
670
|
+
```
|
|
671
|
+
|
|
672
|
+
## Package entry points
|
|
673
|
+
|
|
674
|
+
| Import | Holds |
|
|
675
|
+
|---|---|
|
|
676
|
+
| `boardplot` | The layout core: `resolveChartRequest`, `measure`, `renderSvg`, `resolveTheme`, `listCharts` and the types. |
|
|
677
|
+
| `boardplot/validate` | `getChartDefinition`, `listCharts`, `parseThemeJson` and `validateTheme`, without drawing. |
|
|
678
|
+
| `boardplot/rows` | `specFromRows` and `InputError`: query rows to a spec's data, without a chart engine. See the manual's [Rows in React](../manual.md#rows-in-react). |
|
|
679
|
+
| `boardplot/theme` | `registerTheme`, `resolveTheme`, `typeForTarget` and the `Theme` and `RenderTarget` types, without a chart engine. For a host that registers its own theme next to the per-type entries. |
|
|
680
|
+
| `boardplot/fonts` | `parseFontMetricTables`, `createMetricTablesMeasurer`, `measurableFamilies`, `metricTablesFamilies` and the table types, without a chart engine. For a host that builds a measurer from its own font tables. |
|
|
681
|
+
| `boardplot/fixtures` | `getFixtures(type)` and `allFixtures`: every fixture of every kind. |
|
|
682
|
+
| `boardplot/react` | Every per-type component, `BoardplotTheme`, `ScaleGroup`, `useChartLayout` and `SceneRenderer`. |
|
|
683
|
+
| `boardplot/react/spec` | `BoardplotChart`. It loads the engine of each type it draws on demand. |
|
|
684
|
+
| `boardplot/react/export` | `useExport` and the standalone SVG, PNG and CSV exports. |
|
|
685
|
+
| `boardplot/react/theme` | `BoardplotTheme`, `useBoardplotTheme`, `ScaleGroup`, `useScaleGroupPlan` and `SceneRenderer`, without a chart core. For a host that draws through `boardplot/react/<type>` or `boardplot/react/spec`. |
|
|
686
|
+
| `boardplot/react/prepare` | `prepareChart`, `parseChartSpec` and `serializePreparedChart` for server code. |
|
|
687
|
+
| `boardplot/geo` | Registers every map pack. |
|
|
688
|
+
| `boardplot/geo/dach` | Registers the `dach` map pack. |
|
|
689
|
+
| `boardplot/geo/de-states` | Registers the `de-states` map pack. |
|
|
690
|
+
| `boardplot/geo/eu27` | Registers the `eu27` map pack. |
|
|
691
|
+
| `boardplot/geo/europe` | Registers the `europe` map pack. |
|
|
692
|
+
| `boardplot/geo/us-states` | Registers the `us-states` map pack. |
|
|
693
|
+
| `boardplot/geo/world` | Registers the `world` map pack. |
|
|
694
|
+
| `boardplot/react/<type>` | One component per chart type; see [Per-type components](#per-type-components). |
|
|
695
|
+
|
|
696
|
+
## Static SVG without React
|
|
697
|
+
|
|
698
|
+
```ts
|
|
699
|
+
import { measureResolvedRequest, renderSvg, resolveChartRequest } from 'boardplot';
|
|
700
|
+
|
|
701
|
+
const request = resolveChartRequest({ type: 'bar', data: { categories: ['North', 'South'], series: [{ id: 'orders', label: 'Orders', values: [42, 35] }] }, size: { width: 800, height: 450 } });
|
|
702
|
+
const result = measureResolvedRequest(request);
|
|
703
|
+
const svg = result.geometry ? renderSvg(result.geometry, request.theme) : undefined;
|
|
704
|
+
```
|
|
705
|
+
|
|
706
|
+
A refused chart has `refused` and no `geometry`: a canvas below the floor, or an error lint of the layout, which the CLI and the components refuse too. A layout from `layoutResolvedRequest` sets `refused: true` for the first only; `isRefused(layout)` answers both.
|