boardplot 0.60.0 → 0.62.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/README.md +2 -2
- package/dist/{ReaderBox-JJX4J7GC.js → ReaderBox-5QFALZHR.js} +5 -5
- package/dist/{annotateEngine-KNRKDLY3.js → annotateEngine-ONWZYNEM.js} +1 -1
- package/dist/build-identity.json +3 -3
- package/dist/{chunk-D4SXBDA4.js → chunk-23YYVMWH.js} +1 -1
- package/dist/{chunk-OMUW75ZR.js → chunk-2MK5437T.js} +7 -7
- package/dist/{chunk-CDFZV6LR.js → chunk-2P5KBQLT.js} +4 -4
- package/dist/{chunk-EH23CIC5.js → chunk-2VUEIEUO.js} +2 -2
- package/dist/{chunk-TASEX7VA.js → chunk-2YXO645A.js} +1 -1
- package/dist/{chunk-YHIBABKS.js → chunk-35JGEMCK.js} +35 -28
- package/dist/{chunk-XWGAANY4.js → chunk-3DXOZRRW.js} +3 -3
- package/dist/{chunk-PP23D6QV.js → chunk-3H72EFNC.js} +4 -4
- package/dist/{chunk-RDJ3ZU6O.js → chunk-3KYSWAEH.js} +13 -8
- package/dist/{chunk-XMRLQDOR.js → chunk-3QJVBKRX.js} +37 -37
- package/dist/{chunk-XVFUJRRC.js → chunk-3YSLEJPV.js} +1 -1
- package/dist/{chunk-DBKMJWPO.js → chunk-3Z4I6LNK.js} +1 -1
- package/dist/{chunk-J5QVU7GS.js → chunk-476R7YF4.js} +24 -20
- package/dist/{chunk-MA57XWZA.js → chunk-47IEMR6C.js} +85 -79
- package/dist/{chunk-ZNA4JHHG.js → chunk-4HZKH4HS.js} +2 -2
- package/dist/{chunk-CQ6WHTRL.js → chunk-4NGKSJBX.js} +109 -23
- package/dist/{chunk-DEJKDFS3.js → chunk-4SK4IGMK.js} +3 -3
- package/dist/{chunk-OL6HVC6K.js → chunk-4TTNLFTJ.js} +1 -1
- package/dist/{chunk-L2VWHKTJ.js → chunk-4XDWZJUX.js} +3 -1
- package/dist/{chunk-66FOKRUF.js → chunk-5FG24HFB.js} +4 -4
- package/dist/{chunk-HLQ74GAX.js → chunk-5J2PQ5EZ.js} +4 -4
- package/dist/{chunk-7BQK2UDV.js → chunk-5LUHGXXE.js} +1 -1
- package/dist/{chunk-FYFXOLWI.js → chunk-5OUURZ2T.js} +70 -58
- package/dist/{chunk-UNO3WZR2.js → chunk-64D7CHCE.js} +4 -4
- package/dist/{chunk-SBYKLBDV.js → chunk-6LYMOF2S.js} +4 -4
- package/dist/{chunk-52YYGKXG.js → chunk-6MXRNA4Z.js} +17 -17
- package/dist/{chunk-IDVHLD2L.js → chunk-6OM5IYNK.js} +68 -11
- package/dist/{chunk-B7UWG6XJ.js → chunk-6PR23T2O.js} +1 -1
- package/dist/{chunk-VGOZOBNB.js → chunk-6QQPQ2TX.js} +1 -1
- package/dist/{chunk-BQBD6Q5J.js → chunk-6RRK3VFP.js} +1 -1
- package/dist/{chunk-YM7MO7WI.js → chunk-6WEJGZVQ.js} +1 -1
- package/dist/{chunk-OYLZRQTX.js → chunk-6XDX3MIU.js} +5 -5
- package/dist/{chunk-5XAU6JH5.js → chunk-75OLP5KB.js} +35 -35
- package/dist/{chunk-UIHGGWES.js → chunk-77LQEREO.js} +1 -1
- package/dist/{chunk-PRVX4PAO.js → chunk-7JSGG67J.js} +1 -1
- package/dist/{chunk-RTN422GQ.js → chunk-7NUNEVOU.js} +14 -9
- package/dist/{chunk-2ZDFX75P.js → chunk-7OT6CVQT.js} +1 -1
- package/dist/{chunk-QCDJGYFU.js → chunk-7R43Y35G.js} +1 -1
- package/dist/{chunk-XLX3TUFO.js → chunk-7RAF2HJA.js} +2 -2
- package/dist/{chunk-CROGQZFW.js → chunk-7S57SH2K.js} +9 -9
- package/dist/{chunk-LWRLVDFU.js → chunk-7ZYGEPY2.js} +52 -28
- package/dist/{chunk-N5DPRWQ6.js → chunk-ABUJPENV.js} +53 -42
- package/dist/{chunk-C63YFMCB.js → chunk-ADVFTNDL.js} +4 -4
- package/dist/{chunk-MOPY5REE.js → chunk-AFONROHX.js} +3 -3
- package/dist/{chunk-EGCELTRX.js → chunk-AO73FLJT.js} +4 -4
- package/dist/{chunk-U75MMLNQ.js → chunk-AU2TQN6F.js} +4 -4
- package/dist/{chunk-34XJCEPN.js → chunk-BFHAYXUU.js} +2 -2
- package/dist/{chunk-UKEI7JDA.js → chunk-BFJKH4AX.js} +3 -2
- package/dist/{chunk-3JG764MI.js → chunk-BHO5H4AF.js} +43 -15
- package/dist/{chunk-T73SF424.js → chunk-BKZF27CE.js} +2 -2
- package/dist/{chunk-BXZNLMMH.js → chunk-BR2ADMLU.js} +2 -2
- package/dist/{chunk-BIRB4FIZ.js → chunk-BZUHBKMK.js} +4 -4
- package/dist/{chunk-N7BPP6ZZ.js → chunk-C2X6NYMY.js} +1 -1
- package/dist/{chunk-NOC5PYN3.js → chunk-C3ULVZI7.js} +2 -2
- package/dist/{chunk-JUVSZGY7.js → chunk-CFT6W2QY.js} +3 -3
- package/dist/{chunk-7KIULDTU.js → chunk-CPBJII5T.js} +5 -5
- package/dist/{chunk-LUYV7PHY.js → chunk-CTRPRU4Y.js} +16 -13
- package/dist/{chunk-3HKY4LAR.js → chunk-CWBM7MXM.js} +4 -4
- package/dist/{chunk-ZQ6AEWKM.js → chunk-CZZXZFYL.js} +2 -2
- package/dist/{chunk-TDVNIVU4.js → chunk-D2I2BUR6.js} +1 -1
- package/dist/{chunk-VRG7GG7T.js → chunk-DCFK2BUL.js} +2 -2
- package/dist/{chunk-5OV7VOGV.js → chunk-DVQR5SFL.js} +2 -2
- package/dist/{chunk-GZYMHC44.js → chunk-DWEVPNNE.js} +2 -2
- package/dist/{chunk-RQT52BP4.js → chunk-DYG4XMCC.js} +5 -5
- package/dist/{chunk-PCITI5ED.js → chunk-E46KFVP5.js} +11 -11
- package/dist/{chunk-DITI57ZB.js → chunk-EKKRDPVW.js} +1 -1
- package/dist/{chunk-UGAZT73S.js → chunk-ELFF5YO7.js} +8 -8
- package/dist/{chunk-2KICOGFN.js → chunk-EPRJX5BI.js} +2 -2
- package/dist/{chunk-JOX252XQ.js → chunk-EPS7N5ZS.js} +8 -3
- package/dist/{chunk-AGR4VJ2Y.js → chunk-ERIMFXE3.js} +1 -1
- package/dist/{chunk-TSGSZAAN.js → chunk-ESS7GAO5.js} +15 -15
- package/dist/{chunk-VTUSC24F.js → chunk-EW77WN7V.js} +2 -2
- package/dist/{chunk-CLZPPLDA.js → chunk-F2IGRFYM.js} +57 -33
- package/dist/{chunk-WQ2TZNGR.js → chunk-F7LDXGWD.js} +11 -11
- package/dist/{chunk-SDAVHADX.js → chunk-FC6H5ATA.js} +2 -2
- package/dist/{chunk-ISNHKFCU.js → chunk-FI5VGWUQ.js} +2 -2
- package/dist/{chunk-Q53IWBTJ.js → chunk-FPF73SCJ.js} +18 -15
- package/dist/{chunk-4S3DTNEQ.js → chunk-FSRAPSO7.js} +28 -28
- package/dist/{chunk-ID65JMYY.js → chunk-FXKGNJYB.js} +17 -17
- package/dist/{chunk-25JXYOSX.js → chunk-FXQH2QJN.js} +1 -1
- package/dist/{chunk-GDS7LEGY.js → chunk-GA7CIH6N.js} +23 -18
- package/dist/{chunk-GYEBEF4S.js → chunk-GCOFMXFJ.js} +5 -5
- package/dist/{chunk-Q4SQGAEI.js → chunk-GGWYJNHH.js} +4 -4
- package/dist/{chunk-64M7YDMJ.js → chunk-GNSAYVND.js} +2 -2
- package/dist/{chunk-X725AGYP.js → chunk-H7K3RXBQ.js} +2 -2
- package/dist/{chunk-I5LFCHNQ.js → chunk-HCAPGTEA.js} +1 -1
- package/dist/{chunk-RF6ZHX5F.js → chunk-HUU76QHF.js} +1 -1
- package/dist/{chunk-TZOHCW4R.js → chunk-HV6OKHM6.js} +1 -1
- package/dist/{chunk-7OLE7R46.js → chunk-HYBGISXA.js} +3 -3
- package/dist/{chunk-E7GO4KFZ.js → chunk-I37SEVQ4.js} +127 -79
- package/dist/{chunk-ZCOGCNT7.js → chunk-I3UJHKCS.js} +3 -3
- package/dist/{chunk-VSAX2PYB.js → chunk-I56NIVFF.js} +4 -4
- package/dist/{chunk-2KDELDD4.js → chunk-IDMGFWB7.js} +134 -116
- package/dist/{chunk-YDYZWCUQ.js → chunk-IHZNRJEV.js} +1 -1
- package/dist/{chunk-EFU2RCCR.js → chunk-IMKHDTEQ.js} +1 -1
- package/dist/{chunk-PYJZ7CCP.js → chunk-ISNWAYX2.js} +3 -3
- package/dist/{chunk-6IRPZUWJ.js → chunk-ITPXKZXT.js} +83 -79
- package/dist/{chunk-PS45RNDC.js → chunk-J233F6JA.js} +3 -3
- package/dist/{chunk-PSUSHJFV.js → chunk-J6WWK4VC.js} +1 -1
- package/dist/{chunk-DXKMCMIH.js → chunk-J77EYTIA.js} +2 -2
- package/dist/{chunk-D7FFMBHF.js → chunk-JCZ64D4G.js} +4 -4
- package/dist/{chunk-LUIHWUZB.js → chunk-JEC6YG2C.js} +34 -20
- package/dist/{chunk-BNBCHZ6D.js → chunk-JV3S3OCN.js} +19 -18
- package/dist/{chunk-7KZN3TXQ.js → chunk-K2ZDFPYP.js} +5 -5
- package/dist/{chunk-WPHEUEO3.js → chunk-K3METEEY.js} +133 -30
- package/dist/{chunk-WWFUZXCW.js → chunk-K464WFSQ.js} +4 -4
- package/dist/{chunk-T52ZPSGL.js → chunk-KDRI3KHH.js} +7 -2
- package/dist/{chunk-K7CONTAT.js → chunk-KK7UXU2E.js} +3 -3
- package/dist/{chunk-5SPL5QEB.js → chunk-KNTNUQNS.js} +8 -8
- package/dist/{chunk-QZAT46PP.js → chunk-KRSI6U6L.js} +1 -0
- package/dist/{chunk-SC2363Q7.js → chunk-KU5WGRQJ.js} +72 -44
- package/dist/{chunk-C7SY7RYQ.js → chunk-KWBG3P7W.js} +4 -4
- package/dist/{chunk-ZXT3OS6U.js → chunk-KWKJYMXJ.js} +3 -3
- package/dist/{chunk-XKKII2K5.js → chunk-KWTVCTWS.js} +246 -83
- package/dist/{chunk-ZOQRX5V7.js → chunk-KZ7ECRPL.js} +4 -4
- package/dist/{chunk-VCENIUYM.js → chunk-L46NAICE.js} +5 -5
- package/dist/{chunk-2OKDNNCY.js → chunk-L4VGGSB3.js} +4 -4
- package/dist/{chunk-76IZNTNL.js → chunk-L6T7FXEM.js} +6 -6
- package/dist/{chunk-2E2MK4XM.js → chunk-LE6QYQRU.js} +2 -2
- package/dist/{chunk-WDLWWEHZ.js → chunk-LIMLKOX7.js} +1 -1
- package/dist/{chunk-2FSJFKUH.js → chunk-LK5V7U6C.js} +5 -5
- package/dist/{chunk-6RQCZA7X.js → chunk-LNBYRD5Q.js} +4 -4
- package/dist/{chunk-CVLTU3T4.js → chunk-LTEGXWSU.js} +4 -4
- package/dist/{chunk-MXC5QMPC.js → chunk-LUIHCUMB.js} +4 -4
- package/dist/{chunk-GOVRBONO.js → chunk-MAA5IGGT.js} +2 -2
- package/dist/{chunk-RLRVSX4I.js → chunk-MDGVRYXX.js} +20 -20
- package/dist/{chunk-7TGG57QF.js → chunk-MEIDC7ZF.js} +4 -4
- package/dist/{chunk-RWVM4EVE.js → chunk-MTJZT6F2.js} +5 -5
- package/dist/{chunk-AXKZLSON.js → chunk-MUYU6KTM.js} +1 -1
- package/dist/{chunk-RPS7G77V.js → chunk-MVA2JWM4.js} +2 -2
- package/dist/{chunk-LCTLW4ZW.js → chunk-MYDVNJAA.js} +1 -1
- package/dist/{chunk-3PFNYRBD.js → chunk-NFEVGJJ6.js} +13 -13
- package/dist/{chunk-HXAWJC32.js → chunk-NFSG2WBI.js} +4 -4
- package/dist/{chunk-K7NCVUIB.js → chunk-NFYF7P6H.js} +36 -28
- package/dist/{chunk-ZT7QX7UQ.js → chunk-NL2K3CZM.js} +5 -5
- package/dist/{chunk-A2RKEC66.js → chunk-NTONEZH5.js} +20 -20
- package/dist/{chunk-GGXAAOKT.js → chunk-NTSJ2RXB.js} +4 -4
- package/dist/{chunk-OJWJMG6B.js → chunk-NVPORMKX.js} +15 -15
- package/dist/{chunk-NJNMKQHG.js → chunk-NXA2CNVU.js} +125 -31
- package/dist/{chunk-R2RLERPT.js → chunk-NYROTVGH.js} +1 -1
- package/dist/{chunk-W74Y5AUG.js → chunk-NZHIXLKM.js} +19 -17
- package/dist/{chunk-UIOZDIUB.js → chunk-OCANU74G.js} +3 -3
- package/dist/{chunk-IF4PERIE.js → chunk-OF4VHET3.js} +4 -4
- package/dist/{chunk-UXJXA4NP.js → chunk-OJLXBFI3.js} +1 -1
- package/dist/{chunk-5HOIOQK3.js → chunk-OLXZXEKQ.js} +1 -1
- package/dist/{chunk-UNBUFCQT.js → chunk-OQGSYQLE.js} +1 -1
- package/dist/{chunk-MZCJ22O4.js → chunk-OQQGM2TM.js} +1 -1
- package/dist/{chunk-FPWADEL6.js → chunk-OQRTTGYP.js} +22 -1
- package/dist/{chunk-XUEX5WTR.js → chunk-OQTD4GN4.js} +1 -1
- package/dist/{chunk-HOQJIUTX.js → chunk-OXWIBDJP.js} +2 -2
- package/dist/{chunk-F7QCIJAY.js → chunk-OYDZO5BR.js} +1 -1
- package/dist/{chunk-5PC6VOEW.js → chunk-PDUF6EII.js} +9 -9
- package/dist/{chunk-GEFUIQUO.js → chunk-PHRQAWK4.js} +2 -2
- package/dist/{chunk-NF74JTTK.js → chunk-PM5D5KYQ.js} +67 -30
- package/dist/{chunk-QF6NFIBD.js → chunk-Q5BD6PMX.js} +22 -22
- package/dist/{chunk-UHFSDVW2.js → chunk-QEEE2WH5.js} +4 -4
- package/dist/{chunk-BG2RBCJP.js → chunk-QMGCL5FR.js} +4 -4
- package/dist/{chunk-DXSYY6XR.js → chunk-QMZPQU65.js} +2 -2
- package/dist/{chunk-7VWXXBTC.js → chunk-QSNEZ4UR.js} +1 -1
- package/dist/{chunk-BHYY6VMQ.js → chunk-QSWLPQCW.js} +27 -23
- package/dist/{chunk-LVC2YJGV.js → chunk-R55LS2W2.js} +28 -28
- package/dist/{chunk-BLTQ2L6U.js → chunk-RDXJAEZ4.js} +4 -4
- package/dist/{chunk-OVYQJDRW.js → chunk-RDZNRSAB.js} +2 -2
- package/dist/{chunk-VHZ4MXJO.js → chunk-RFUSBITY.js} +1 -1
- package/dist/{chunk-4VKYFELK.js → chunk-RIGQU57Y.js} +7 -7
- package/dist/{chunk-DEUOC3IL.js → chunk-RNA5GO3B.js} +2 -2
- package/dist/{chunk-IFRDI7EF.js → chunk-RODV3OHP.js} +294 -180
- package/dist/{chunk-CPKPQQV6.js → chunk-RPK657TE.js} +16 -2
- package/dist/{chunk-HMWN6FTW.js → chunk-SAVO62PW.js} +1 -1
- package/dist/{chunk-3ADWX4BM.js → chunk-SB2DHY53.js} +18 -18
- package/dist/{chunk-BIQ5LJEC.js → chunk-SBHPRHKB.js} +4 -4
- package/dist/{chunk-TMY4PWDQ.js → chunk-SBPFCQNK.js} +4 -4
- package/dist/{chunk-PZZAVTLQ.js → chunk-SFPHP3CC.js} +2 -2
- package/dist/{chunk-PLVYTK2H.js → chunk-SIZW5V4G.js} +18 -14
- package/dist/{chunk-Y4BJ7D5F.js → chunk-SJ5KVLTG.js} +1 -1
- package/dist/{chunk-PGZGBVTS.js → chunk-SJZLWRRY.js} +8 -8
- package/dist/{chunk-A3AKNPLZ.js → chunk-SOAB4G33.js} +4 -4
- package/dist/{chunk-LPLRXEOT.js → chunk-ST2IQX7U.js} +57 -17
- package/dist/{chunk-E4XQSRH6.js → chunk-T33R2CM3.js} +7 -7
- package/dist/{chunk-FWPPZB4G.js → chunk-T4ZE7AIX.js} +2 -2
- package/dist/{chunk-HTXICOSJ.js → chunk-TCQ733WC.js} +15 -15
- package/dist/{chunk-J3GYX5BJ.js → chunk-TGTKAIDU.js} +20 -15
- package/dist/{chunk-AE6X6RRH.js → chunk-U4PDXI67.js} +4 -4
- package/dist/{chunk-JXMOPQXC.js → chunk-UGTYYTPP.js} +2 -2
- package/dist/{chunk-Y5ROVCMQ.js → chunk-UL3RNOYB.js} +3 -3
- package/dist/{chunk-MYBBZNYN.js → chunk-UOTZH4TG.js} +2 -2
- package/dist/{chunk-ZH4DRVFN.js → chunk-UQSH52UJ.js} +4 -4
- package/dist/{chunk-PL43U5GM.js → chunk-UWT66OAR.js} +1 -1
- package/dist/{chunk-QTT4AJY5.js → chunk-V4NJTLJP.js} +14 -14
- package/dist/{chunk-SY7JC3PH.js → chunk-V4YJRZHE.js} +1 -1
- package/dist/{chunk-FP4INYSU.js → chunk-V5Y3CXSU.js} +4 -4
- package/dist/{chunk-TTY4CA7M.js → chunk-VZFPQMYN.js} +9 -9
- package/dist/{chunk-C26Z5AEW.js → chunk-W35C2SL3.js} +3 -3
- package/dist/{chunk-X5I3LGHD.js → chunk-W6ZCXWOK.js} +1 -1
- package/dist/{chunk-TUYKMVYV.js → chunk-WDP7IDGF.js} +13 -13
- package/dist/{chunk-L3B46VGP.js → chunk-WDQJ2DRZ.js} +14 -14
- package/dist/{chunk-3HKL6KJ6.js → chunk-WKBW4JFU.js} +1 -1
- package/dist/chunk-WM65Q3AL.js +69 -0
- package/dist/{chunk-HPNQ3GKK.js → chunk-WO6ZJCAO.js} +4 -4
- package/dist/chunk-WSRGEK5T.js +89 -0
- package/dist/{chunk-NGKZRGQL.js → chunk-WXGBSBHQ.js} +13 -12
- package/dist/{chunk-XDGAJVCG.js → chunk-WXOSGKMS.js} +8 -8
- package/dist/{chunk-6BAUUBP2.js → chunk-XBASXPUJ.js} +2 -2
- package/dist/{chunk-O6E2LWGK.js → chunk-XDDFM3BH.js} +6 -6
- package/dist/{chunk-ENVV7LI4.js → chunk-XJOCPL6R.js} +2 -2
- package/dist/{chunk-ETSWVJB6.js → chunk-XJSI7ZO2.js} +1 -1
- package/dist/chunk-XKGZWQF7.js +63 -0
- package/dist/{chunk-ZLH7XSHV.js → chunk-XLHURGH3.js} +5 -5
- package/dist/{chunk-LGNAFFIL.js → chunk-XWQDNJ36.js} +4 -4
- package/dist/{chunk-ZS24JHBP.js → chunk-YBQ4F27M.js} +4 -4
- package/dist/{chunk-ZIC22PSH.js → chunk-YDT6QZZK.js} +9 -9
- package/dist/{chunk-BJS6TLLE.js → chunk-YE6B7P6Q.js} +1 -1
- package/dist/{chunk-UF7OWARN.js → chunk-YERTQ576.js} +4 -4
- package/dist/{chunk-GNK7RTO4.js → chunk-YF4DIQJR.js} +4 -4
- package/dist/{chunk-7XO74NDR.js → chunk-YHLKL4R5.js} +3 -3
- package/dist/{chunk-E6KUWZ5W.js → chunk-YHSY6CVM.js} +4 -4
- package/dist/{chunk-RYH3JFCL.js → chunk-YJGZ3AOW.js} +2 -2
- package/dist/{chunk-5DTMIKDX.js → chunk-YKK25QM4.js} +4 -4
- package/dist/{chunk-3WC2TA6C.js → chunk-YMBJHKTY.js} +3 -3
- package/dist/{chunk-TLKRYDH3.js → chunk-YTFU2B5K.js} +2 -2
- package/dist/{chunk-AH2L44TR.js → chunk-YUIITZCO.js} +3 -3
- package/dist/{chunk-XHEG2BG6.js → chunk-Z3VCVPYX.js} +1 -1
- package/dist/{chunk-MF6XGFHB.js → chunk-ZB4WVG7Q.js} +7 -3
- package/dist/{chunk-YCTBPRV4.js → chunk-ZCB5MLPW.js} +3 -3
- package/dist/{chunk-DP5CXMZW.js → chunk-ZDQ2EWWH.js} +32 -28
- package/dist/{chunk-FG2VET62.js → chunk-ZG46HLGN.js} +108 -81
- package/dist/chunk-ZGL2P56Z.js +11 -0
- package/dist/{chunk-6USMWXB3.js → chunk-ZIAPNZ6R.js} +4 -4
- package/dist/{chunk-Q7GDGSTK.js → chunk-ZLIVUVIV.js} +28 -16
- package/dist/{chunk-IRCLNPLJ.js → chunk-ZMCTTTR2.js} +4 -4
- package/dist/{chunk-STRN4XOX.js → chunk-ZYJZ624V.js} +5 -5
- package/dist/cli/index.js +2 -2
- package/dist/{core-32KM4AJG.js → core-2DRDBSL7.js} +2 -1
- package/dist/{core-OZLK2EJW.js → core-2VAPYQDA.js} +2 -1
- package/dist/{core-STATMGC7.js → core-3JGHUUZZ.js} +2 -1
- package/dist/{core-6N5ONDKG.js → core-3KMBTZ32.js} +3 -1
- package/dist/{core-J5DSGZZR.js → core-4HEB3CRT.js} +2 -1
- package/dist/{core-2JHH5LLH.js → core-4WT74WGL.js} +3 -1
- package/dist/{core-JFORSZQS.js → core-4ZUNKYYC.js} +2 -1
- package/dist/{core-RYEENVFZ.js → core-5VCTJDQM.js} +2 -1
- package/dist/{core-FRVHGKYW.js → core-AJANHLTB.js} +2 -1
- package/dist/{core-7II27MGX.js → core-AL3TDBHQ.js} +5 -1
- package/dist/{core-AAC2ESXF.js → core-ATBNPTR5.js} +2 -1
- package/dist/{core-REYW2XB3.js → core-BIEUVBZK.js} +3 -1
- package/dist/{core-COGECGZY.js → core-C2CCLPE5.js} +2 -1
- package/dist/{core-XHSGRJDP.js → core-C3VC6YEV.js} +3 -1
- package/dist/{core-V2RMMBMO.js → core-DCWAUTD4.js} +2 -1
- package/dist/{core-X4SPCV6G.js → core-GYDBZC7Q.js} +3 -1
- package/dist/{core-255NAAUA.js → core-H3RRJPQK.js} +2 -1
- package/dist/{core-BTKBKGCU.js → core-HAMHEP3M.js} +3 -1
- package/dist/{core-CELQJZJB.js → core-HRBOWCHO.js} +2 -1
- package/dist/{core-WU6DBIAM.js → core-IHG5XK6Q.js} +2 -1
- package/dist/{core-L4EGZ73S.js → core-JNA7L23P.js} +3 -1
- package/dist/{core-QYAXEGWD.js → core-JTHVZEC4.js} +2 -1
- package/dist/{core-YTTTVHUH.js → core-JXCXTDYK.js} +3 -1
- package/dist/{core-TBQAFBDU.js → core-LL2O5PBD.js} +3 -1
- package/dist/{core-HRHUGQNB.js → core-NNHCWP3B.js} +2 -1
- package/dist/{core-FLCLKSGA.js → core-OM3DGO6B.js} +2 -1
- package/dist/{core-GCYDQRFM.js → core-QH3H6ZPI.js} +2 -1
- package/dist/{core-YVWLKGAN.js → core-QKDNA6KJ.js} +2 -1
- package/dist/{core-W4NG6WON.js → core-R6OE3ORL.js} +2 -1
- package/dist/{core-NARJSEGI.js → core-RZI7LRK3.js} +5 -1
- package/dist/{core-6GE3EMCB.js → core-SXBMOZ3W.js} +2 -1
- package/dist/{core-GETUMW6I.js → core-TXADFQ3I.js} +3 -1
- package/dist/{core-SUFLQLWC.js → core-UOB4JKCT.js} +2 -1
- package/dist/{core-56KTQ7DK.js → core-WIV43MFA.js} +2 -1
- package/dist/{core-W3XIUTU7.js → core-XDPELH2B.js} +4 -1
- package/dist/{core-F7ASDBXB.js → core-YKHQUOAW.js} +2 -1
- package/dist/{core-QLJQOZGJ.js → core-ZXGKAECT.js} +4 -1
- package/dist/{dataTable-OI4CVMFJ.js → dataTable-JBVSQNJX.js} +3 -2
- package/dist/{engine-3SQQ2S5U.js → engine-QUEIPS7M.js} +44 -18
- package/dist/fixtures.js +2 -1
- package/dist/fonts.js +4 -4
- package/dist/index.js +21 -20
- package/dist/{main-TWTT3Q2R.js → main-V264O3WR.js} +8 -7
- package/dist/mcp/server.js +14 -13
- package/dist/react/bar.js +5 -1
- package/dist/react/bartable.js +3 -1
- package/dist/react/box.js +3 -1
- package/dist/react/bullet.js +4 -1
- package/dist/react/butterfly.js +3 -1
- package/dist/react/choropleth.js +3 -1
- package/dist/react/cohort.js +3 -1
- package/dist/react/column.js +4 -1
- package/dist/react/combo.js +4 -1
- package/dist/react/creative.js +3 -1
- package/dist/react/diagram.js +3 -1
- package/dist/react/dimswitch.js +2 -1
- package/dist/react/dot.js +6 -1
- package/dist/react/export.js +19 -18
- package/dist/react/funnel.js +3 -1
- package/dist/react/gantt.js +3 -1
- package/dist/react/grid.js +5 -1
- package/dist/react/heatmap.js +3 -1
- package/dist/react/histogram.js +4 -1
- package/dist/react/index.js +86 -84
- package/dist/react/kpi.js +3 -1
- package/dist/react/likert.js +5 -1
- package/dist/react/line.js +3 -1
- package/dist/react/mekko.js +4 -1
- package/dist/react/pareto.js +3 -1
- package/dist/react/pie.js +3 -1
- package/dist/react/prepare.js +24 -22
- package/dist/react/pvm.js +4 -1
- package/dist/react/pyramid.js +3 -1
- package/dist/react/sankey.js +3 -1
- package/dist/react/scatter.js +3 -1
- package/dist/react/slope.js +4 -1
- package/dist/react/sparkline.js +3 -1
- package/dist/react/spec.js +12 -10
- package/dist/react/status.js +3 -1
- package/dist/react/story.js +4 -3
- package/dist/react/table.js +2 -1
- package/dist/react/theme.js +4 -3
- package/dist/react/tilemap.js +3 -1
- package/dist/react/treemap.js +3 -1
- package/dist/react/variance.js +4 -1
- package/dist/react/waffle.js +3 -1
- package/dist/react/waterfall.js +4 -1
- package/dist/{resvg-ZYEZTSUO.js → resvg-M5HJ3ME3.js} +1 -1
- package/dist/{rowsModule-BULW5KS2.js → rowsModule-6UL4SSUC.js} +1 -1
- package/dist/{schema-D3ELHESU.js → schema-3FSG2YXY.js} +1 -1
- package/dist/{schema-PBMYZKBK.js → schema-5PQPGEZQ.js} +1 -1
- package/dist/{schema-SUDJBIHX.js → schema-6LUORZNN.js} +1 -1
- package/dist/{schema-LGYHJPXU.js → schema-6MDHX2E7.js} +1 -1
- package/dist/{schema-4HGZZNUL.js → schema-7HXHGBUN.js} +1 -1
- package/dist/{schema-5SVPR3EU.js → schema-ACOD4XKI.js} +1 -1
- package/dist/{schema-AM2KS6ZC.js → schema-B3I7XBP3.js} +1 -1
- package/dist/{schema-4YIYGGOJ.js → schema-CCOTGURZ.js} +1 -1
- package/dist/{schema-GYVYJEL3.js → schema-E5O7M5KM.js} +1 -1
- package/dist/{schema-PAKZIYQF.js → schema-EWATAK6Z.js} +1 -1
- package/dist/{schema-NNNG7CWG.js → schema-FEBMLOZG.js} +1 -1
- package/dist/{schema-GYTWCCNA.js → schema-FL57LIU2.js} +1 -1
- package/dist/{schema-NI5B642U.js → schema-FTRAVEX3.js} +2 -1
- package/dist/{schema-FBIEOKO2.js → schema-GSKCG2WP.js} +1 -1
- package/dist/{schema-FPDLOIA6.js → schema-HVDY6QXK.js} +1 -1
- package/dist/{schema-XKPUXAVB.js → schema-I267TVQ4.js} +1 -1
- package/dist/{schema-IYLRZNFB.js → schema-IG2WGTQO.js} +1 -1
- package/dist/{schema-YCKUQ3FF.js → schema-ITZQDKSE.js} +1 -1
- package/dist/{schema-C25ECGJL.js → schema-LCOGZNQF.js} +1 -1
- package/dist/{schema-A4U4RDKJ.js → schema-MC3CQNPR.js} +1 -1
- package/dist/{schema-FQWENOJY.js → schema-MP2QNFCN.js} +1 -1
- package/dist/{schema-CBLNGK2F.js → schema-NYCMLGOW.js} +1 -1
- package/dist/{schema-GTLGAPCU.js → schema-OML7XS7J.js} +1 -1
- package/dist/{schema-IYBZPCM4.js → schema-QAAVXXYR.js} +1 -1
- package/dist/{schema-3LRC5TOZ.js → schema-QPYFXSEQ.js} +1 -1
- package/dist/{schema-WDKBCN3V.js → schema-RJBIXN5U.js} +1 -1
- package/dist/{schema-P2JYSV32.js → schema-RW47HWVO.js} +1 -1
- package/dist/{schema-TRPPZCIR.js → schema-S7Q4YR7R.js} +1 -1
- package/dist/{schema-YVBUY7NH.js → schema-SWVWMZY3.js} +1 -1
- package/dist/{schema-LX4EXDTI.js → schema-T3RSFE2V.js} +1 -1
- package/dist/{schema-KPZVLE6A.js → schema-T4CGWZLB.js} +4 -2
- package/dist/{schema-VH4AW62Z.js → schema-TXYKZ5NT.js} +1 -1
- package/dist/{schema-5OLQ54J5.js → schema-U6CZI6XG.js} +1 -1
- package/dist/{schema-SQ2GYLMI.js → schema-XE4WY64H.js} +1 -1
- package/dist/{schema-HAMPGUH3.js → schema-YDWVXQPK.js} +1 -1
- package/dist/{schema-KBV2JB2A.js → schema-YPGXVI22.js} +1 -1
- package/dist/{schema-2ACHQTR3.js → schema-ZMOIP2BK.js} +1 -1
- package/dist/{specValidation-5J6DDCHF.js → specValidation-6LVTTHZI.js} +2 -1
- package/dist/theme.js +3 -3
- package/dist/{themeShapeRules-MOUDTDUB.js → themeShapeRules-NDEXKFC7.js} +1 -1
- package/dist/types/core/annotate.d.ts +9 -0
- package/dist/types/core/annotateFields.d.ts +36 -1
- package/dist/types/core/annotateTargets.d.ts +2 -0
- package/dist/types/core/charts/bar/layout.d.ts +1 -1
- package/dist/types/core/charts/column/model.d.ts +3 -1
- package/dist/types/core/charts/grid/metricStack.d.ts +35 -3
- package/dist/types/core/charts/grid/metricStackSchema.d.ts +8 -0
- package/dist/types/core/charts/grid/schema.d.ts +5 -0
- package/dist/types/core/charts/scatter/layout.d.ts +18 -1
- package/dist/types/core/charts/scatter/marks.d.ts +94 -0
- package/dist/types/core/charts/scatter/zones.d.ts +52 -0
- package/dist/types/core/fontMetrics/index.d.ts +3 -1
- package/dist/types/core/fontMetrics/injected.d.ts +1 -0
- package/dist/types/core/frame.d.ts +7 -2
- package/dist/types/core/label/occupied.d.ts +1 -1
- package/dist/types/core/registry.d.ts +2 -0
- package/dist/types/core/request.d.ts +7 -0
- package/dist/types/core/sizing.d.ts +9 -0
- package/dist/types/core/themeGeometry.d.ts +184 -0
- package/dist/types/core/types/data.d.ts +2 -0
- package/dist/types/core/types/options.d.ts +10 -0
- package/dist/types/core/types/scene.d.ts +11 -0
- package/dist/types/core/types/theme.d.ts +26 -2
- package/dist/types/react/hover/engine.d.ts +5 -1
- package/dist/types/react/hover/labelCard.d.ts +33 -2
- package/dist/types/react/hover/placement.d.ts +11 -0
- package/dist/types/react/prepare.d.ts +2 -1
- package/dist/types/react/useHover.d.ts +1 -0
- package/dist/types/theme.d.ts +1 -1
- package/dist/validate.js +8 -6
- package/docs/manual.md +4 -2
- package/docs/reference/bar.md +2 -2
- package/docs/reference/bullet.md +1 -1
- package/docs/reference/butterfly.md +1 -1
- package/docs/reference/column.md +2 -2
- package/docs/reference/combo.md +2 -2
- package/docs/reference/dot.md +2 -2
- package/docs/reference/fixtures.md +3 -0
- package/docs/reference/grid.md +25 -12
- package/docs/reference/heatmap.md +1 -1
- package/docs/reference/line.md +2 -2
- package/docs/reference/mekko.md +2 -2
- package/docs/reference/options.md +6 -1
- package/docs/reference/pvm.md +1 -1
- package/docs/reference/react.md +4 -2
- package/docs/reference/scatter.md +1 -1
- package/docs/reference/slope.md +2 -2
- package/docs/reference/sparkline.md +1 -0
- package/docs/reference/table.md +1 -1
- package/docs/reference/theme.md +5 -1
- package/docs/reference/variance.md +1 -1
- package/docs/reference/waterfall.md +1 -1
- package/package.json +1 -1
- package/dist/chunk-6AIHN5S6.js +0 -89
- package/dist/chunk-CDZHNLO6.js +0 -42
- package/dist/chunk-QPWRHDLZ.js +0 -17
package/docs/reference/dot.md
CHANGED
|
@@ -46,7 +46,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
46
46
|
| series | array | yes | Values and optional ranges to compare across each category row. |
|
|
47
47
|
| series[].valueKind | string | | Multiply numbers by 100 into pct cells; explicit pct cells stay in percent units. One of `'fraction'`. |
|
|
48
48
|
| series[].id | string | yes | Series identity used by keyed options, annotations and legend entries. |
|
|
49
|
-
| series[].label | string | | Displayed series name; defaults to the series id. |
|
|
49
|
+
| series[].label | string | | Displayed series name; defaults to the series id. The hover card names each value with it ("North: 65.8"). |
|
|
50
50
|
| series[].values | (cell \| { categoryId, value: cell })[] | yes | Values in category order, or keyed entries pairing a categoryId with its value. |
|
|
51
51
|
| series[].scenario | string | | AC, PY, PL, FC (or ACT, BUD, FCST, LY for last year). Codes and aliases accept any case. |
|
|
52
52
|
| series[].direction | string | | Declared preference for higher or lower values in directional comparisons. One of `'higherIsBetter'`, `'lowerIsBetter'`. |
|
|
@@ -88,7 +88,7 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
88
88
|
|
|
89
89
|
| Kind | Purpose | Required | Anchors | Optional fields | Notes |
|
|
90
90
|
|---|---|---|---|---|---|
|
|
91
|
-
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
91
|
+
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. On column, bar and dot the key names the band with its bounds, "Target range: 95 to 105"; without a key the band prints its bounds itself. attainment: boolean \| { seriesId, direction }. Shades each category between its actual and the line. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
92
92
|
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false. An arrow from the text to the anchored point, in the arrow standard of theme marks.arrow: the text stands far enough out for a 24 px shaft, level with the point right or left of it, or over or under it, where there is room. With no such seat it draws without the arrow and warns callout-arrow-no-room. Not with icon or status. Example: "arrow": true. | |
|
|
93
93
|
| note | Places authored text at an anchored data element through collision avoidance, with an optional icon or status chip. | at, text | at: AnchorRef | | |
|
|
94
94
|
| delta | Computes the signed difference between an anchored value and another anchor or literal, then places a collision-managed label at the first anchor. | at, vs | at: AnchorRef; vs: AnchorRef \| number | mode: absolute \| relative \| both, default absolute. absolute prints at minus vs, relative the percent change from vs to at, both the two as '+149 (+36%)'. relative and both need a nonzero vs. | |
|
|
@@ -947,6 +947,9 @@ The CLI prints every match in one response through `boardplot fixtures --type <t
|
|
|
947
947
|
| metric-stack-steps | grid.metric-stack | example | Metric stack: volume-weighted funnel steps and remaining-per-100 chain |
|
|
948
948
|
| stack-readout-parts | grid.metric-stack | example | Metric stack: readout gutter without the unit and the span |
|
|
949
949
|
| stack-gutter-right | grid.metric-stack | example | Metric stack: readout gutter right of the plots, with a set width and alignment |
|
|
950
|
+
| metric-stack-per-unit | grid.metric-stack | example | Metric stack: cost per order computed from spend and orders |
|
|
951
|
+
| metric-stack-focus | grid.metric-stack | example | Metric stack: the focus look, with the latest week against the first |
|
|
952
|
+
| metric-stack-focus-shares | grid.metric-stack | example | Metric stack: the focus look by month, with segment shares |
|
|
950
953
|
|
|
951
954
|
## slope
|
|
952
955
|
|
package/docs/reference/grid.md
CHANGED
|
@@ -94,24 +94,28 @@ Facets, variance tiers and metric stacks with shared categories and computed rea
|
|
|
94
94
|
| categories[].id ( branch 3) | string | yes | Unique category id in display order. |
|
|
95
95
|
| categories[].label ( branch 3) | string | yes | Category label drawn once below the last panel. |
|
|
96
96
|
| categories[].partial ( branch 3) | boolean | | Period still running. Draw count so far provisionally; scoped outcomes are n/a. |
|
|
97
|
-
| measures ( branch 3) | array | yes | Raw source
|
|
97
|
+
| measures ( branch 3) | array | yes | Raw source values stored once. Rates, amounts per unit and readouts are computed from these values. |
|
|
98
98
|
| measures[].id ( branch 3) | string | yes | Unique source measure id. |
|
|
99
99
|
| measures[].label ( branch 3) | string | yes | Source measure label; also the stacked-column legend label. |
|
|
100
|
-
| measures[].values ( branch 3) | array | yes | Source
|
|
100
|
+
| measures[].values ( branch 3) | array | yes | Source values, one per category: counts, or amounts such as spend. Null means unavailable. |
|
|
101
101
|
| panels ( branch 3) | array | yes | Two to five panels in top-down reading order. |
|
|
102
102
|
| panels[].id ( branch 3) | string | yes | Unique panel id; state scopes use this id. |
|
|
103
103
|
| panels[].type ( branch 3) | string | yes | Columns, stacked columns for a multi-measure sum, or a line with points. One of `'column'`, `'line'`. |
|
|
104
|
-
| panels[].title ( branch 3) | string | yes | Measure name in the shared readout gutter. |
|
|
105
|
-
| panels[].unit ( branch 3) | string | yes | Measure unit in the readout gutter. |
|
|
106
|
-
| panels[].measure ( branch 3) | object | yes | Engine-computed panel measure. |
|
|
104
|
+
| panels[].title ( branch 3) | string | yes | Measure name in the shared readout gutter. The hover card names each value with it when the unit is a sign or code. |
|
|
105
|
+
| panels[].unit ( branch 3) | string | yes | Measure unit in the readout gutter. A unit in words names each value on the hover card ('Cases per month: 800'); a sign or code such as '$' or 'EUR k' stays on the number. |
|
|
106
|
+
| panels[].measure ( branch 3) | object | yes | Engine-computed panel measure: a sum, a rate in percent, or an amount per unit. |
|
|
107
107
|
| panels[].measure.sum ( branch 3; panels[].measure branch 1) | array | yes | Measures added for each category. Columns stack the inputs in order. |
|
|
108
108
|
| panels[].measure.numerator ( branch 3; panels[].measure branch 2) | array | yes | Measures summed for the rate numerator. |
|
|
109
|
-
| panels[].measure.denominator ( branch 3; panels[].measure branch 2) | string | yes | Source measure for the rate denominator; the result is a percentage
|
|
110
|
-
| panels[].
|
|
109
|
+
| panels[].measure.denominator ( branch 3; panels[].measure branch 2) | string | yes | Source measure for the rate denominator; the result is a percentage, a share of a count. For an amount per unit, such as cost per order, use ratio and per. |
|
|
110
|
+
| panels[].measure.ratio ( branch 3; panels[].measure branch 3) | array | yes | Measures added for the amount, such as spend. |
|
|
111
|
+
| panels[].measure.per ( branch 3; panels[].measure branch 3) | string | yes | Source measure of the units, such as orders. Each category's value is the sum of ratio divided by per, with no factor 100; it is n/a when an input is null or per is 0. A window divides the sum of ratio over its categories by the sum of per, never the mean of the category values: spend 100 and 300 on 10 and 20 orders is 13.33 per order. The change readout is the percent change of the two window values. One mark per category. |
|
|
112
|
+
| panels[].readout ( branch 3) | string \| object | yes | change compares grid windows; base computes a volume-weighted mature rate and remaining-per-100 span, for rate panels only. One of `'change'` (or another value of its type). |
|
|
111
113
|
| panels[].readout.base ( branch 3) | string | yes | Base measure for the remaining-per-100 chain. |
|
|
112
114
|
| panels[].emphasis ( branch 3) | boolean | | Use the theme accent. At most one panel may be emphasised. |
|
|
113
|
-
| panels[].divisor ( branch 3) | number | | Display divisor for sum marks and their change span, for example 1000. The headline percent is unitless. |
|
|
114
|
-
| panels[].decimals ( branch 3) | integer | | Decimal places of the marks and the change span. A panel with divisor and without decimals prints 0 for
|
|
115
|
+
| panels[].divisor ( branch 3) | number | | Display divisor for sum or per-unit marks and their change span, for example 1000. The headline percent is unitless. |
|
|
116
|
+
| panels[].decimals ( branch 3) | integer | | Decimal places of the marks and the change span. A panel with divisor and without decimals prints 0 for sums and amounts per unit and 1 for rates; a panel with neither prints by the default number rule. |
|
|
117
|
+
| panels[].keyTitle ( branch 3) | string | | Caption over the key of a stacked panel, such as 'By plan', in muted small text. A panel without a key prints none. |
|
|
118
|
+
| panels[].segmentShares ( branch 3) | boolean | | true prints each segment's share of its column, in whole percent that add up to 100, inside the segment of the base and the focus columns of a stacked panel. It applies under options.stack.variant 'focus'; the focus column prints the shares of the key. A share that has no room in its segment is left out; the key still carries it. Without the focus look, or on a panel that stacks no measures, it does nothing and warns option-ignored. Absent: no segment labels. |
|
|
115
119
|
| states ( branch 3) | object | | Category states declared once, with explicit panel scopes. |
|
|
116
120
|
| states.maturing ( branch 3) | object | | Right-censored categories and their panel scope. One continuous band. |
|
|
117
121
|
| states.maturing.from ( branch 3) | string | yes | First maturing category, inclusive. |
|
|
@@ -142,6 +146,7 @@ Facets, variance tiers and metric stacks with shared categories and computed rea
|
|
|
142
146
|
| Path | Type | Values | Default | Meaning |
|
|
143
147
|
|---|---|---|---|---|
|
|
144
148
|
| stack | object | | | Select metric-stack mode of sharedAxis category. Top-down panels, independent zero scales, one axis, one gutter and shared states. |
|
|
149
|
+
| stack.variant | string | `'focus'` | | 'focus': the value-first look. The compare window is the focus: each panel prints its focus value first, in the theme role type.display, then the change and the base value ('+86% from $272'), and a stacked panel keys each measure with its share of the focus value. The focus categories take the accent, the base window a dark neutral and the other categories a light neutral; a dashed line marks the base level in each panel. In React, hover and keyboard focus move the focus to one category. Needs data.windows and readout 'change' in every panel; a stack with readout { base } panels ignores it and warns option-ignored. Absent: today's look. |
|
|
145
150
|
| stack.heights | array | | | Plot heights in layout pixels, one per panel in top-down order. Use rows for proportional heights instead. |
|
|
146
151
|
| stack.columnVisibility | object | | | False leaves a seat of the one gutter track out, with its height: unit, headline or span. The panel name stays. Hiding headline and span also drops the method line. The values stay in the marks. |
|
|
147
152
|
| stack.columnOverrides | object | | | Settings per generated column. Ids: gutter. |
|
|
@@ -190,18 +195,19 @@ Common combinations are recipes, not chart types. Stacked revenue over a ΔPY% v
|
|
|
190
195
|
|
|
191
196
|
Set `stack: {}` to draw two to five panels in top-down order. Shared source counts produce both the marks and the left readouts. The optional period row, partial states, maturing scope and comparison windows belong to the grid. Each panel starts at zero on an independent scale.
|
|
192
197
|
|
|
193
|
-
A sum uses one or more source measures; a multi-measure column is stacked. A rate divides the summed numerator by its denominator and multiplies by 100. `readout: "change"` gives the percent change of averages per category, or the percentage-point difference of two weighted rates. `readout: { base: "source-id" }` gives a weighted mature step rate and a remaining-per-100 chain. The first table gives the formulas. The second table gives how a panel prints them: a panel that sets neither `divisor` nor `decimals` prints by the default number rule, and a panel that sets one of them prints as the table says.
|
|
198
|
+
A sum uses one or more source measures; a multi-measure column is stacked. A rate divides the summed numerator by its denominator and multiplies by 100. An amount per unit, `{ ratio: ["spend"], per: "orders" }`, divides the summed `ratio` measures by the `per` measure, with no factor 100, and draws one mark per category. `readout: "change"` gives the percent change of averages per category, the percent change of the two window values of an amount per unit, or the percentage-point difference of two weighted rates. A window value of an amount per unit divides the window sums: `sum(ratio) / sum(per)`, never the mean of the category values. `readout: { base: "source-id" }` gives a weighted mature step rate and a remaining-per-100 chain. The first table gives the formulas. The second table gives how a panel prints them: a panel that sets neither `divisor` nor `decimals` prints by the default number rule, and a panel that sets one of them prints as the table says.
|
|
194
199
|
|
|
195
200
|
| Readout | Headline | Span |
|
|
196
201
|
|---|---|---|
|
|
197
202
|
| `change`, sum measure | `(compare mean per category / base mean per category - 1) × 100` | Base mean → compare mean, divided by the panel `divisor` |
|
|
203
|
+
| `change`, amount per unit | `(compare window value / base window value - 1) × 100`, each window value `sum(ratio) / sum(per)` | Base window value → compare window value, divided by the panel `divisor` |
|
|
198
204
|
| `change`, rate measure | Compare rate minus base rate, in percentage points | Base rate → compare rate |
|
|
199
205
|
| `{ "base": "measure-id" }`, rate measure | `100 × sum(numerator) / sum(denominator)` over mature categories | `100 × sum(denominator) / sum(base)` → `100 × sum(numerator) / sum(base)` over the same categories |
|
|
200
206
|
|
|
201
207
|
| Readout | Panel without `divisor` and `decimals` | Panel with `divisor` or `decimals` |
|
|
202
208
|
|---|---|---|
|
|
203
209
|
| `change`, sum measure | The headline is a change in percent with two digits (`−2.7%`). The span prints the two means as a set of their own, with scale words where the column labels print them (`34.51k → 33.59k`). | The headline is rounded to a whole percent (`−3%`). The span is rounded to the panel `decimals`, whole counts by default, as the column labels print (`35 → 34` under `divisor: 1000`). |
|
|
204
|
-
| `change`, rate measure | The headline is the difference of the unrounded weighted rates, in percentage points with two digits (`+1.4pp`). The span prints the two unrounded rates by the default number rule (`2.27% → 3.62%`). |
|
|
210
|
+
| `change`, rate measure | The headline is the difference of the unrounded weighted rates, in percentage points with two digits (`+1.4pp`). The span prints the two unrounded rates by the default number rule (`2.27% → 3.62%`). | The headline is the difference of the unrounded weighted rates, rounded once to the panel `decimals`, one by default, so it prints the digits of the span (`0.85% → 0.74%` reads `−0.1pp`). The span rounds each unrounded rate once to the panel `decimals`, one by default (`2.3% → 3.6%`). |
|
|
205
211
|
| `{ "base": "measure-id" }`, rate measure | The headline rates and the chain ends of every such panel in the stack form one percent set and print the unrounded rates (`4.75%`, `100 → 4.75`, `4.75 → 0.23`). | The headline and the chain ends are rounded to one decimal, whatever the panel `decimals` (`4.7%`, `100 → 4.7`, `4.7 → 0.2`). |
|
|
206
212
|
|
|
207
213
|
All sums use the source counts that draw the marks. Rates are weighted by volume, never the mean of the displayed category rates. The chain starts at 100, and 100 prints as `100`. A zero denominator or a missing input gives `n/a`, not zero.
|
|
@@ -214,7 +220,11 @@ Use one readout method in each stack: every panel uses `change`, or every panel
|
|
|
214
220
|
|
|
215
221
|
Default plot heights are 200 px for a single-measure column, 150 px for a stacked column, and 130 px for a line. These are minimum defaults: the engine increases them when names, units or readouts need more room. An authored fixed canvas with spare height expands the plots proportionally. `stack.heights` sets explicit plot heights; `rows` sets proportional weights based on the space the labels need.
|
|
216
222
|
|
|
217
|
-
Use `stack.heights` for plot heights or `rows` for proportional heights. The engine reserves label space and shares one readout gutter and one panel gap. Side margins stay at most 24 px; an authored `margin` still wins. Where the gutter leaves too little room for the values, each readout moves above its panel and the plot takes the full width. Where even the full width is too little, values and category names thin to every second category, counted back from the latest, and the latest value always shows; a hidden name keeps its tick. A stacked panel keys its measures inside its readout; when its segment values do not all fit, none show and the key says that the labels show totals. Provisional columns are hatched in their own paint inside a dashed outline. It refuses dimensions that cause collisions. The maturing band covers all gaps between its scoped panels and ends at their last baseline. `reading.metricStack.readouts[]` exposes the inputs, `method` and `grain`. Count changes use `average-change`; rate changes use `rounded-rate-change`; step rates use `weighted-rate`. Every readout uses the explicit or inferred grain described above, with category as the fallback. Fixtures `metric-stack-volume` and `metric-stack-steps` show both full exhibits.
|
|
223
|
+
Use `stack.heights` for plot heights or `rows` for proportional heights. The engine reserves label space and shares one readout gutter and one panel gap. Side margins stay at most 24 px; an authored `margin` still wins. Where the gutter leaves too little room for the values, each readout moves above its panel and the plot takes the full width. Where even the full width is too little, values and category names thin to every second category, counted back from the latest, and the latest value always shows; a hidden name keeps its tick. A stacked panel keys its measures inside its readout; when its segment values do not all fit, none show and the key says that the labels show totals. Provisional columns are hatched in their own paint inside a dashed outline. It refuses dimensions that cause collisions. The maturing band covers all gaps between its scoped panels and ends at their last baseline. `reading.metricStack.readouts[]` exposes the inputs, `method` and `grain`. Count changes use `average-change`; changes of an amount per unit use `ratio-change`; rate changes use `rounded-rate-change`; step rates use `weighted-rate`. Every readout uses the explicit or inferred grain described above, with category as the fallback. Fixtures `metric-stack-volume` and `metric-stack-steps` show both full exhibits.
|
|
224
|
+
|
|
225
|
+
A stacked panel takes an optional `keyTitle`, such as `By plan`, printed over its key in muted small text.
|
|
226
|
+
|
|
227
|
+
`stack.variant: 'focus'` turns on the value-first look. It needs `data.windows` and `readout: "change"` in every panel; a stack of `{ base }` readouts ignores it and warns `option-ignored`. The compare window is the focus. Each panel's readout prints its name and unit on one line where they fit, then the value of the focus, then the change and the base value: `+86% from $272`. The value is the number that the right end of today's span prints, with a currency sign or `%` on it as the hover card prints it; a unit in words stays beside the name. Every panel prints its value in `type.display` (36 px on a 1.11 line by default), in the family and weight of `type.figure`, also above the panel and on a canvas too short for the readout. The short canvas puts the change beside the value. A stacked panel keys each measure with its share of the focus value, in whole percent that add up to 100; over a window of several categories a share divides the window sums. With `segmentShares: true` on a stacked panel, each segment of the base and the focus columns prints its share of the column inside the segment, in the ink that reads on its fill. These shares add up to 100 per column, and the focus column prints the shares of the key. A share without room in its segment is left out, and the key still carries it. Without the look the option does nothing and warns `option-ignored`. Fixture `metric-stack-focus-shares` shows it. The header line names the focus, the word `against`, a dashed key of the base line and the base window; where a window holds more than one category a second sentence names the averages. `strings.stackFrom`, `strings.stackAgainst` and `strings.stackAverages` replace the words. `columnVisibility` leaves out the unit, the change (`headline`) or the base value (`span`); the value always prints. The gutter and the panels are sized for the widest text of any focus, so they hold still when the focus moves. The baseline of each panel runs under the readout and the plot. The marks take three states: the focus categories take the accent, the base window a dark neutral, every other category a light neutral, and the focus wins where the windows overlap. A stacked column steps each state through a ramp of its own, and its key swatches show the focus ramp. A line takes one paint, the accent on the emphasis panel and the dark neutral elsewhere, with an open ring on each base category and an accent dot on each focus category; other categories print no point. A provisional mark keeps its hatch, dashed outline and hollow point. A dashed line marks the base value across the plot, over columns and under a line, and the base value prints muted 8 px left of the plot, centred on the line; a panel without a base value draws no line. The frame legend keeps only the provisional key. Only the focus categories print their values: bold ink, above the mark, on a plate in the page colour that may cover the marks of other categories; `labelDensity` still applies. A category needs 14 px for its mark, and the width of its name where names print, so about 30 weekly columns fit beside the readout at 1,184 px. With `data.periods` the period row is the axis: no category prints its name, and each period label starts at its first category, muted and small, after a short tick from the last baseline, with no rule. Without periods the category names print as in the default look. Where the focus is one category, a hairline runs through every panel at its centre, behind the marks. In React, hover and keyboard focus move the focus to the category under the pointer; see the React reference. Fixture `metric-stack-focus` shows the look.
|
|
218
228
|
|
|
219
229
|
```json
|
|
220
230
|
{
|
|
@@ -316,3 +326,6 @@ Below the floor a render is refused with `size-below-floor` and the pixels it ne
|
|
|
316
326
|
| metric-stack-steps | example | Metric stack: volume-weighted funnel steps and remaining-per-100 chain |
|
|
317
327
|
| stack-readout-parts | example | Metric stack: readout gutter without the unit and the span |
|
|
318
328
|
| stack-gutter-right | example | Metric stack: readout gutter right of the plots, with a set width and alignment |
|
|
329
|
+
| metric-stack-per-unit | example | Metric stack: cost per order computed from spend and orders |
|
|
330
|
+
| metric-stack-focus | example | Metric stack: the focus look, with the latest week against the first |
|
|
331
|
+
| metric-stack-focus-shares | example | Metric stack: the focus look by month, with segment shares |
|
|
@@ -53,7 +53,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
53
53
|
| series | array | yes | Matrix rows, each supplying one cell value per category. |
|
|
54
54
|
| series[].valueKind | string | | Multiply numbers by 100 into pct cells; explicit pct cells stay in percent units. One of `'fraction'`. |
|
|
55
55
|
| series[].id | string | yes | Series identity used by keyed options, annotations and legend entries. |
|
|
56
|
-
| series[].label | string | | Displayed series name; defaults to the series id. |
|
|
56
|
+
| series[].label | string | | Displayed series name; defaults to the series id. The hover card names each value with it ("North: 65.8"). |
|
|
57
57
|
| series[].values | (cell \| { categoryId, value: cell })[] | yes | Values in category order, or keyed entries pairing a categoryId with its value. |
|
|
58
58
|
| series[].scenario | string | | AC, PY, PL, FC (or ACT, BUD, FCST, LY for last year). Codes and aliases accept any case. Controls scenario labels and paint conventions. |
|
|
59
59
|
| series[].direction | string | | Declares this row's judgment for the continuous scale and PINS the whole matrix on the good/bad valence ramp (like table heat's signed flag) — declaring 'higherIsBetter' is therefore not a paint no-op on an all-positive matrix. 'lowerIsBetter' inverts the row's poles. Breaks bins go bad to good; under a breaks key every row needs the same direction (else refused). Ignored by the plain discrete ladder and harvey glyphs (warned). One of `'higherIsBetter'`, `'lowerIsBetter'`. |
|
package/docs/reference/line.md
CHANGED
|
@@ -96,7 +96,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
96
96
|
| series[].axis | string | | Accepted for combo-shaped data. Ignored here. A kind that differs from the chart type is refused. One of `'primary'`, `'secondary'`. |
|
|
97
97
|
| series[].valueKind | string | | Multiply numbers by 100 into pct cells; explicit pct cells stay in percent units. One of `'fraction'`. |
|
|
98
98
|
| series[].id | string | yes | Series identity used by keyed options, annotations and legend entries. |
|
|
99
|
-
| series[].label | string | | Displayed series name; defaults to the series id. |
|
|
99
|
+
| series[].label | string | | Displayed series name; defaults to the series id. The hover card names each value with it ("North: 65.8"). |
|
|
100
100
|
| series[].shortLabel | string | | Short end-label name. End labels get 18% of the effective width: Boardplot tries the full label on one line, then on two, then shortLabel with a full-name legend key, then a legend with value-only end labels. legend 'none' removes the shortLabel and legend steps, a labelPlacements pin the legend step. Boardplot adds no abbreviation or ellipsis. |
|
|
101
101
|
| series[].values | (cell \| { categoryId, value: cell })[] | yes | Values in category order, or keyed entries pairing a categoryId with its value. |
|
|
102
102
|
| series[].scenario | string | | AC, PY, PL, FC (or ACT, BUD, FCST, LY for last year). Codes and aliases accept any case. Controls scenario labels and paint conventions. |
|
|
@@ -237,7 +237,7 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
237
237
|
| delta | Computes the signed difference between an anchored value and another anchor or literal, then places a collision-managed label at the first anchor. | at, vs | at: AnchorRef; vs: AnchorRef \| number | mode: absolute \| relative \| both, default absolute. absolute prints at minus vs, relative the percent change from vs to at, both the two as '+149 (+36%)'. relative and both need a nonzero vs. placement: auto \| label \| bracket, default auto. With both ends on two different series at the last category, bracket draws the gap bracket in the right margin: an open ring on each end point, a dashed guide from each ring to the margin, a bracket with an arrowhead toward the measured end, and the gap as a large number beside it; the end values sit just over and under their guides. auto draws the bracket where gapFill washes the same two series and the label elsewhere. label keeps the label at the anchor. On a bar chart a diff between two categories of one series rides in the shorter bar's row under auto: an arrow from the longer bar's end to the to end, with the number in a break of the shaft; label keeps the arrow off the rows with the number beside it. bracket on other anchors, or on stacked variants (stacked-area, stacked100-area), warns gap-bracket-unavailable and keeps the label. caption: string. A short line under the bracket number that says what it measures, right-aligned in muted ink. Only a gap bracket prints it; elsewhere it warns gap-caption-ignored. | Drawn reference series accept anchors. Bad anchors report the cause and valid ids. |
|
|
238
238
|
| note | Places authored text at an anchored data element through collision avoidance, with an optional icon or status chip. | at, text | at: AnchorRef | | Drawn reference series accept anchors. Bad anchors report the cause and valid ids. |
|
|
239
239
|
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false. An arrow from the text to the anchored point, in the arrow standard of theme marks.arrow: the text stands far enough out for a 24 px shaft, level with the point right or left of it, or over or under it, where there is room. With no such seat it draws without the arrow and warns callout-arrow-no-room. Not with icon or status. Example: "arrow": true. | Drawn reference series accept anchors. Bad anchors report the cause and valid ids. |
|
|
240
|
-
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. seriesId: string. Series whose mean is measured. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. side: left \| right, default right. Side of the plot the label sits on. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. attainment: boolean \| { seriesId, direction }. Shades each category between its actual and the line. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
240
|
+
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. seriesId: string. Series whose mean is measured. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. side: left \| right, default right. Side of the plot the label sits on. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. On column, bar and dot the key names the band with its bounds, "Target range: 95 to 105"; without a key the band prints its bounds itself. attainment: boolean \| { seriesId, direction }. Shades each category between its actual and the line. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
241
241
|
| indicator100 | Maps 100 through the chart's value scale and draws a side tick with a 100% label. | | | side: left \| right, default left. Side of the plot the 100% mark sits on. | No anchor is required. The chart needs a value scale that can represent 100. |
|
|
242
242
|
| abs | Reads the anchored data value and places its formatted absolute value in a collision-managed label. | at | at: AnchorRef | | Drawn reference series accept anchors. Bad anchors report the cause and valid ids. |
|
|
243
243
|
| event | Places a dated event in the lane above the plot as a block with a pole to the data, or, when it does not fit, as a numbered marker with an entry in the event key below the plot; periods draw a thin bar. | label | at: categoryId (optional) | date: ISO date yyyy-mm-dd, in place of at: the event sits at the last category whose date is on or before it, and the block header and the key print it as d MMM. Every category needs an ISO date; a date outside the categories warns event-out-of-range. end: ISO date, with date: the event is a period, drawn as a thin bar to the end of that day. to: Category id, with at: the event is a period to the end of that category. group: Id of a group in options.events.groups, which gives the kind label, tone and glyph. detail: string \| string[]. Authored lines under the title, at most three in the lane; nothing is cut, a longer block moves to the key. items: { label, detail? }[]. More changes on the same date, after this event's own label and detail. The lane and the key draw a compact +N after the title; the hover card, the SVG title and description, and the interaction records list every item in full. placement: auto \| key, default options.events.placement. key numbers this event into the key below the plot. tone: neutral \| bad \| good, default the group tone, else neutral. Column, combo and line paint the glyph, the marker ring and the period bar in it; gantt paints a bad rule. labelPlacement: top \| inline \| badge, default top. inline (line) sets the block beside its rule inside the plot. badge (gantt) draws the label, at most 3 characters, in a filled circle at the top of its rule; badge events never go to the numbered key. | Exactly one of at (a category id) and date (an ISO date) places the event; end or to makes it a period. The event lane above the plot sets a block of group and date, title and detail with a thin pole to the data; an event that does not fit, a second event on one category and every event under options.events.placement 'key' get a numbered marker and an entry in the key below the plot, numbered in time order; under footnotes: false they are left off and listed in the footnotes-off lint. The full date, title and detail of every event stay in the SVG title and description, the interaction records and the hover card, whether or not the lane or the key prints the detail. In compact mode the lane is one row of numbered markers and the key packs "n date title" into as few lines as the width allows; where the plot would still fall under 80px the key keeps "n title" and the info lint event-lane-compact says so. options.events.rows sets the lane rows (default by canvas width: 1 under 1080px, 2 from 1080px); a row gives way while the plot band left under the lane would keep less than 40% of the canvas height. |
|
package/docs/reference/mekko.md
CHANGED
|
@@ -54,7 +54,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
54
54
|
| series | array | yes | Stack components and optional reference series supplying widths. |
|
|
55
55
|
| series[].valueKind | string | | Multiply numbers by 100 into pct cells; explicit pct cells stay in percent units. One of `'fraction'`. |
|
|
56
56
|
| series[].id | string | yes | Series identity used by keyed options, annotations and legend entries. |
|
|
57
|
-
| series[].label | string | | Displayed series name; defaults to the series id. |
|
|
57
|
+
| series[].label | string | | Displayed series name; defaults to the series id. The hover card names each value with it ("North: 65.8"). |
|
|
58
58
|
| series[].values | (cell \| { categoryId, value: cell })[] | yes | Values in category order, or keyed entries pairing a categoryId with its value. |
|
|
59
59
|
| series[].scenario | string | | AC, PY, PL, FC (or ACT, BUD, FCST, LY for last year). Codes and aliases accept any case. |
|
|
60
60
|
| series[].direction | string | | Declared preference for higher or lower values in directional comparisons. One of `'higherIsBetter'`, `'lowerIsBetter'`. |
|
|
@@ -87,7 +87,7 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
87
87
|
| delta | Computes the signed difference between an anchored value and another anchor or literal, then places a collision-managed label at the first anchor. | at, vs | at: AnchorRef; vs: AnchorRef \| number | mode: absolute \| relative \| both, default absolute. absolute prints at minus vs, relative the percent change from vs to at, both the two as '+149 (+36%)'. relative and both need a nonzero vs. | |
|
|
88
88
|
| note | Places authored text at an anchored data element through collision avoidance, with an optional icon or status chip. | at, text | at: AnchorRef | | |
|
|
89
89
|
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false. An arrow from the text to the anchored point, in the arrow standard of theme marks.arrow: the text stands far enough out for a 24 px shaft, level with the point right or left of it, or over or under it, where there is room. With no such seat it draws without the arrow and warns callout-arrow-no-room. Not with icon or status. Example: "arrow": true. | |
|
|
90
|
-
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. side: left \| right, default right. Side of the plot the label sits on. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
90
|
+
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. side: left \| right, default right. Side of the plot the label sits on. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. On column, bar and dot the key names the band with its bounds, "Target range: 95 to 105"; without a key the band prints its bounds itself. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
91
91
|
| indicator100 | Maps 100 through the chart's value scale and draws a side tick with a 100% label. | | | side: left \| right, default left. Side of the plot the 100% mark sits on. | No anchor is required. The chart needs a value scale that can represent 100. |
|
|
92
92
|
| abs | Reads the anchored data value and places its formatted absolute value in a collision-managed label. | at | at: AnchorRef | | |
|
|
93
93
|
| text | Places authored text at a point through the label solver: on the point, or above, below, right or left of it. The text prints as written. | at, text | at: AnchorRef \| { categoryId, value } | | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. The text prints as written, ${value} included. It takes id and priority, and no other field. |
|
|
@@ -42,7 +42,7 @@ These options are shared across chart types. Each type page names its exceptions
|
|
|
42
42
|
| subtitle.measure | string | | | Measure named by the subtitle; options.unit supplies its unit. |
|
|
43
43
|
| subtitle.period | string | | | Reporting period text after the measure. |
|
|
44
44
|
| subtitle.scenarios | array | | | Scenario captions in authored order, printed as their own segment joined with "vs": "… · 6 Jul to 4 Oct · AC vs PL". |
|
|
45
|
-
| unit | string | | | Chart unit, composed into the subtitle where supported; individual series may declare their own units. A unit prints as text after the number, so unit 'USD' reads 2,456 USD. For a currency sign, set format instead, such as '$1,234'; a unit the format already prints warns unit-in-format, and a unit that names another currency than the format's sign warns unit-format-conflict. |
|
|
45
|
+
| unit | string | | | Chart unit, composed into the subtitle where supported; individual series may declare their own units. A unit prints as text after the number, so unit 'USD' reads 2,456 USD. For a currency sign, set format instead, such as '$1,234'; a unit the format already prints warns unit-in-format, and a unit that names another currency than the format's sign warns unit-format-conflict. A unit in words, such as 'orders', names the number on the hover card ('Orders: 76'); a sign, code or scale such as '%', 'kg' or 'k orders' stays on the number. |
|
|
46
46
|
| unitShown | boolean | | | True when the host prints the unit beside the chart: no unit line, no unit beside a kpi value; line end labels, a table head and the legend check treat the unit as shown. Number formatting does not change. Default false. |
|
|
47
47
|
| source | string \| array | | | Source credit rendered in the chart frame. An array of strings joins with '; ' in one source line. An empty array prints no source. `**text**` draws bold and a single `*` stays literal. |
|
|
48
48
|
| footnotes | array \| false \| string | `false` (or another value of its type) | | A string is one footnote. Footnotes in authored order. `**text**` draws bold and a single `*` stays literal. The frame prints them within notes.maxLines and the rest go to the notes list. false leaves notes and the pointer off the frame; disclosures that notes.show prints, the source line and a required map credit stay. |
|
|
@@ -113,6 +113,8 @@ These options are shared across chart types. Each type page names its exceptions
|
|
|
113
113
|
| strings.belowSeries | string | | | Negative line gap key. |
|
|
114
114
|
| strings.average | string | | | Name before a computed mean; English Average, German Ø. |
|
|
115
115
|
| strings.valueLineRange | string | | | Tolerance-band bounds; {v1} and {v2} are the formatted bounds. |
|
|
116
|
+
| strings.valueLineRangeKey | string | | | Key of a tolerance band on a column, bar or dot chart; {name} is the line's name and {range} the bounds. |
|
|
117
|
+
| strings.valueLineRangeKeyPlain | string | | | Key of a tolerance band whose line has no name; {range} is the bounds. |
|
|
116
118
|
| strings.toDate | string | | | Text after a running category name in its key or note. |
|
|
117
119
|
| strings.forecast | string | | | Key for the forecast pattern. |
|
|
118
120
|
| strings.plan | string | | | Key for the plan outline. |
|
|
@@ -174,6 +176,9 @@ These options are shared across chart types. Each type page names its exceptions
|
|
|
174
176
|
| strings.knownPartsShares | string | | | Incomplete 100% stack note without total100; {categories} is replaced. |
|
|
175
177
|
| strings.rebaseZero | string | | | Line or stacked-area series left out by rebase100 for a zero or negative base; {series} and {period} are replaced. |
|
|
176
178
|
| strings.rebaseMissing | string | | | Line or stacked-area series left out by rebase100 for a missing base; {series} and {period} are replaced. |
|
|
179
|
+
| strings.stackFrom | string | | | Metric stack focus look: the base value after the change; {v1} is the base value. English from {v1}. |
|
|
180
|
+
| strings.stackAgainst | string | | | Metric stack focus look: the word between the focus and the base window in the header line. English against. |
|
|
181
|
+
| strings.stackAverages | string | | | Metric stack focus look: the header sentence when a window holds more than one category; {v1} is the grain. |
|
|
177
182
|
| format | string | | | Chart-level format-by-example, such as 1,234.5 or 1.2pp. A currency sign comes from here: '$1,234' prints $2,456. Its decimals are preserved; series and cell formats can override it. Without a format, every number prints by the default rule: scale words from 10,000 (cells from 100,000), three digits of the largest value, no more decimals than the data carry. A magnitude after the number divides the raw value: k, thousand, Tsd., Tausend (10³); m, M, mn, mm, million(s), Mio., Million(en) (10⁶); b, B, bn, billion(s), Mrd., Milliarde(n), milliard(s) (10⁹); tn, trillion(s), Bio., Billionen (10¹²). The letters k, m, M, mm, b, B and T scale when glued to the number or spaced beside a currency ('$1.2 k'); '12 m/s' and '50 B' keep their unit. A scale inside a currency affix ('USDm 1.2', '1.2 €m') holds that divisor. The example's scale word and decimals hold for every value, totals included: '$1.2M' prints 4 as $0.0M and warns format-hides-values with a finer example. A German or French chart prints the scale in its own words (Mrd., Bio.; Md, Bn). Axis ticks take their digits from their spacing, and a statistic such as a mean takes up to one decimal more. A unit alone ('$M', '€bn', '%', 'x') states the prefix, the suffix and any scale word: the default number rule fills the decimals, and the scale words where the unit names none ('$M' prints 15,060,000 and 14,800,000 as $15.06M and $14.80M). A table column moves the unit into its head and picks the cell precision from the data. Spreadsheet number codes translate to examples with warning format-spreadsheet-code; percent values stay percent points. Direction glyphs (▲/▼, ↑/↓) at the start or end of the example carry a sign. A glyph inside the prefix or unit stays literal text. ± carries a sign. A trailing minus marks negatives, '1st' prints English ordinals, and '1.2E+06' prints scientific notation. With no digit, one run of 1–15 @ fixes significant figures: '$@@@M' prints 4,270,000 as $4.27M. A % example expects values in percent units: 3.53 prints 3.53%, a fraction 0.0353 prints 0.04%. A separator followed by exactly three digits after a nonzero integer part is a thousands mark: 1.000 groups thousands with a dot and prints decimals with a comma; write 0.000 for three decimals. |
|
|
178
183
|
| detailFields | array | | | Label, format, unit and order of the cell details keys, the extra facts a value's hover card lists after it: [{ key: 'deals', label: 'Deals', format: '1,234' }]. Declared keys print first, in this order; a details key it does not declare prints after them, labelled with its key. Default: every key, labelled with itself. |
|
|
179
184
|
| detailFields[].key | string | | | The details key in the cells. |
|
package/docs/reference/pvm.md
CHANGED
|
@@ -91,7 +91,7 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
91
91
|
| delta | Computes the signed difference between an anchored value and another anchor or literal, then places a collision-managed label at the first anchor. | at, vs | at: AnchorRef; vs: AnchorRef \| number | mode: absolute \| relative \| both, default absolute. absolute prints at minus vs, relative the percent change from vs to at, both the two as '+149 (+36%)'. relative and both need a nonzero vs. | |
|
|
92
92
|
| note | Places authored text at an anchored data element through collision avoidance, with an optional icon or status chip. | at, text | at: AnchorRef | | |
|
|
93
93
|
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false. An arrow from the text to the anchored point, in the arrow standard of theme marks.arrow: the text stands far enough out for a 24 px shaft, level with the point right or left of it, or over or under it, where there is room. With no such seat it draws without the arrow and warns callout-arrow-no-room. Not with icon or status. Example: "arrow": true. | |
|
|
94
|
-
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. side: left \| right, default right. Side of the plot the label sits on. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
94
|
+
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. side: left \| right, default right. Side of the plot the label sits on. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. On column, bar and dot the key names the band with its bounds, "Target range: 95 to 105"; without a key the band prints its bounds itself. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
95
95
|
| abs | Reads the anchored data value and places its formatted absolute value in a collision-managed label. | at | at: AnchorRef | | |
|
|
96
96
|
| text | Places authored text at a point through the label solver: on the point, or above, below, right or left of it. The text prints as written. | at, text | at: AnchorRef \| { categoryId, value } | | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. The text prints as written, ${value} included. It takes id and priority, and no other field. |
|
|
97
97
|
| line | Draws a straight line between two points or from a text annotation, in the ink and rule width of a bracket; a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the line in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the line starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
package/docs/reference/react.md
CHANGED
|
@@ -515,6 +515,8 @@ A card a tap opened closes on a tap outside the chart, as on a table, or on a ta
|
|
|
515
515
|
|
|
516
516
|
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.
|
|
517
517
|
|
|
518
|
+
A metric stack with `stack.variant: 'focus'` moves its focus instead. With `hover` on, the pointer anywhere in a category's column, from the top of the first plot to the last baseline, makes that category the focus: the stack draws as it draws with that one category as its compare window and the base window unchanged, so the readout values, the changes, the shares, the header label, the accent colours, the focus dot, the value labels and the hairline move to it, and the plots stay where they are. A category without a value in a panel prints `n/a` there and no change line. Keyboard focus on a record moves the focus to its category in the same way. When the pointer leaves the plots, or the chart loses the keyboard focus, the authored compare window returns. Under the look no series dims and no card shows, unless the host sets `hover.card` or `renderHoverContent`; `onRecordClick` names the record of the panel nearest the pointer. The SVG, the PNG and the server render draw the authored compare window.
|
|
519
|
+
|
|
518
520
|
### Your own card content
|
|
519
521
|
|
|
520
522
|
`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).
|
|
@@ -534,9 +536,9 @@ export function RegionRevenue() {
|
|
|
534
536
|
}
|
|
535
537
|
```
|
|
536
538
|
|
|
537
|
-
`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
|
|
539
|
+
`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. On a line, area, combo or sparkline chart it always keeps off the area between the points, so it never stands in the way of a pointer that moves from point to point. A taller card scrolls inside itself.
|
|
538
540
|
|
|
539
|
-
|
|
541
|
+
Your card always takes the pointer, also where the default card lets it through to the points under it: 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.
|
|
540
542
|
|
|
541
543
|
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.
|
|
542
544
|
|
|
@@ -157,7 +157,7 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
157
157
|
| abs | Reads the anchored data value and places its formatted absolute value in a collision-managed label. | at | at: AnchorRef | | |
|
|
158
158
|
| note | Places authored text at an anchored data element through collision avoidance, with an optional icon or status chip. | at, text | at: AnchorRef | | |
|
|
159
159
|
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false. An arrow from the text to the anchored point, in the arrow standard of theme marks.arrow: the text stands far enough out for a 24 px shaft, level with the point right or left of it, or over or under it, where there is room. With no such seat it draws without the arrow and warns callout-arrow-no-room. Not with icon or status. Example: "arrow": true. | |
|
|
160
|
-
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. side: left \| right, default right. Side of the plot the label sits on. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
160
|
+
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. side: left \| right, default right. Side of the plot the label sits on. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. On column, bar and dot the key names the band with its bounds, "Target range: 95 to 105"; without a key the band prints its bounds itself. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
161
161
|
| text | Places authored text at a point through the label solver: on the point, or above, below, right or left of it. The text prints as written. | at, text | at: AnchorRef \| { categoryId, value } | | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. The text prints as written, ${value} included. It takes id and priority, and no other field. |
|
|
162
162
|
| line | Draws a straight line between two points or from a text annotation, in the ink and rule width of a bracket; a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the line in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the line starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
163
163
|
| arrow | Draws a straight arrow between two points or from a text annotation to a point, in the theme arrow look (`marks.arrow`); a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the shaft in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the arrow starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
package/docs/reference/slope.md
CHANGED
|
@@ -49,7 +49,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
49
49
|
| series | array | yes | Series whose first and last category values are joined by a slope. |
|
|
50
50
|
| series[].valueKind | string | | Multiply numbers by 100 into pct cells; explicit pct cells stay in percent units. One of `'fraction'`. |
|
|
51
51
|
| series[].id | string | yes | Series identity used by keyed options, annotations and legend entries. |
|
|
52
|
-
| series[].label | string | | Displayed series name; defaults to the series id. |
|
|
52
|
+
| series[].label | string | | Displayed series name; defaults to the series id. The hover card names each value with it ("North: 65.8"). |
|
|
53
53
|
| series[].values | (cell \| { categoryId, value: cell })[] | yes | Values in category order, or keyed entries pairing a categoryId with its value. |
|
|
54
54
|
| series[].scenario | string | | AC, PY, PL, FC (or ACT, BUD, FCST, LY for last year). Codes and aliases accept any case. |
|
|
55
55
|
| series[].role | string | | Declares a plotted data series or a comparison reference series. One of `'data'`, `'reference'`. |
|
|
@@ -97,7 +97,7 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
97
97
|
| abs | Reads the anchored data value and places its formatted absolute value in a collision-managed label. | at | at: AnchorRef | | |
|
|
98
98
|
| note | Places authored text at an anchored data element through collision avoidance, with an optional icon or status chip. | at, text | at: AnchorRef | | |
|
|
99
99
|
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false. An arrow from the text to the anchored point, in the arrow standard of theme marks.arrow: the text stands far enough out for a 24 px shaft, level with the point right or left of it, or over or under it, where there is room. With no such seat it draws without the arrow and warns callout-arrow-no-room. Not with icon or status. Example: "arrow": true. | |
|
|
100
|
-
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
100
|
+
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. On column, bar and dot the key names the band with its bounds, "Target range: 95 to 105"; without a key the band prints its bounds itself. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
101
101
|
| text | Places authored text at a point through the label solver: on the point, or above, below, right or left of it. The text prints as written. | at, text | at: AnchorRef \| { categoryId, value } | | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. The text prints as written, ${value} included. It takes id and priority, and no other field. |
|
|
102
102
|
| line | Draws a straight line between two points or from a text annotation, in the ink and rule width of a bracket; a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the line in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the line starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
103
103
|
| arrow | Draws a straight arrow between two points or from a text annotation to a point, in the theme arrow look (`marks.arrow`); a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the shaft in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the arrow starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
@@ -33,6 +33,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
33
33
|
| valueKind | string | | Multiply numbers by 100 into pct cells; explicit pct cells stay in percent units. One of `'fraction'`. |
|
|
34
34
|
| values | cell[] | yes | The series in order, at least two points. A null is bridged by a dotted segment with a ring on the missing point. |
|
|
35
35
|
| labels | array | | One name per value, in the same order. The end labels and the hover records read them; without them a point is named by its position. |
|
|
36
|
+
| label | string | | Name of the metric the line shows, such as "Orders", as `label` names a KPI. The hover card names each value with it ("Orders: 18"); nothing on the chart prints it. |
|
|
36
37
|
|
|
37
38
|
## Options
|
|
38
39
|
|
package/docs/reference/table.md
CHANGED
|
@@ -217,7 +217,7 @@ Consulting-grade table: hierarchy with honest totals (derive/validate/source), t
|
|
|
217
217
|
| encodings.*.tolerance.abs (encodings.* branch 6) | number | | | Column units. 2 reads 63 to 67 as warn around 65. |
|
|
218
218
|
| encodings.*.columns (encodings.* branch 6) | array | | | Further columns this rule paints. A sixty-column cohort grid names its lane once instead of sixty times, and a column that carries its own entry keeps it. Leave a column out to keep it unshaded. |
|
|
219
219
|
| totalPosition | string | `'top'`, `'bottom'` | | Total-row position; variant supplies the default. |
|
|
220
|
-
| density | string | `'compact'`, `'regular'`, `'relaxed'`, `'cohort'`, `'cohort-small'` | `'regular'` | Cell spacing. Before a size refusal, the static table retries with compact spacing, tight margins and automatic height unless belowMinimum is 'refuse'. Where a fixed width or height still misses, cell air, column gaps and margins shrink to 2 px air and 4 px gaps, and row air to 1 px where the height misses; a 'table-tight-spacing' warning names the size for compact spacing. 'cohort' and 'cohort-small' are the fixed matrix grids of a cohort table: rows of 26 px (20 px) whatever the level, cells one (two) steps under the label, heads on the axis step, and value columns centred unless the column names its own alignment. |
|
|
220
|
+
| density | string | `'compact'`, `'regular'`, `'relaxed'`, `'cohort'`, `'cohort-small'` | `'regular'` | Cell spacing. 'compact' keeps half of each row's regular air, rounded down (theme table.compactStep sets a fixed step instead), and 'relaxed' adds 2 px above and below; type, heads and cell air keep their size. Before a size refusal, the static table retries with compact spacing, tight margins and automatic height unless belowMinimum is 'refuse'. Where a fixed width or height still misses, cell air, column gaps and margins shrink to 2 px air and 4 px gaps, and row air to 1 px where the height misses; a 'table-tight-spacing' warning names the size for compact spacing. 'cohort' and 'cohort-small' are the fixed matrix grids of a cohort table: rows of 26 px (20 px) whatever the level, cells one (two) steps under the label, heads on the axis step, and value columns centred unless the column names its own alignment. |
|
|
221
221
|
| nulls | string | `'blank'`, `'dash'` | | What a MISSING cell prints. 'dash' (the default) keeps the em dash; 'blank' leaves it empty, which is what a cohort staircase needs — a cohort acquired in May has not been observed at M8, and a triangle of dashes is noise. The explicit states na, nm and suppressed keep their glyphs. |
|
|
222
222
|
| figures | boolean | | | Print the cell figures; default true. false draws the heat grounds alone in 22 px cells, over any width authored for the figures, on 14 px rows or the line box of the text a row still prints where that is taller, so a sixty-column triangle fits one screen. The heads keep their labels and the numbers stay in the markup for a reader who cannot see the grounds. Refused on a table without a heat lane in encodings. |
|
|
223
223
|
| expansion | object | | | Expansion order: depth, collapsed, expanded. |
|
package/docs/reference/theme.md
CHANGED
|
@@ -87,7 +87,7 @@ Defaults are the `bridge` preset.
|
|
|
87
87
|
| pattern.hatchGap | number | yes | | `6` | Distance between hatch lines in px. Lower values read denser and start to moiré in print. |
|
|
88
88
|
| pattern.hatchStrokeWidth | number | yes | | `0.75` | Hatch line stroke width in px. |
|
|
89
89
|
| pattern.outlineStrokeWidth | number | yes | | `1.5` | Outline stroke width in px for PL/FC notation and outlined marks. |
|
|
90
|
-
| type | object | yes | | `{"family":"'Helvetica Neue', Helvetica, Arial, Roboto, sans-serif","title":{"size":18,"weight":600,"lineHeight":1.25},"subtitle":{"size":12,"weight":400,"lineHeight":1.3},"label":{"size":11.5,"weight":400,"lineHeight":1.2},"axis":{"size":10.5,"weight":400,"lineHeight":1.2},"footnote":{"size":9,"weight":400,"lineHeight":1.3},"micro":{"size":9,"weight":400,"lineHeight":1.2},"scale":{"S":{"title":15,"subtitle":10.5,"label":10,"axis":9.5,"footnote":8.5,"micro":9},"L":{"title":22,"subtitle":14,"label":13,"axis":12,"footnote":10.5,"micro":9.5}},"numeric":"tabular","emphasis":{"weight":600},"figure":{"weight":600},"eyebrow":{"weight":500,"ink":"inkMuted"}}` | Typography: the font stack every role inherits plus one type step per role. |
|
|
90
|
+
| type | object | yes | | `{"family":"'Helvetica Neue', Helvetica, Arial, Roboto, sans-serif","title":{"size":18,"weight":600,"lineHeight":1.25},"subtitle":{"size":12,"weight":400,"lineHeight":1.3},"label":{"size":11.5,"weight":400,"lineHeight":1.2},"axis":{"size":10.5,"weight":400,"lineHeight":1.2},"footnote":{"size":9,"weight":400,"lineHeight":1.3},"micro":{"size":9,"weight":400,"lineHeight":1.2},"scale":{"S":{"title":15,"subtitle":10.5,"label":10,"axis":9.5,"footnote":8.5,"micro":9},"L":{"title":22,"subtitle":14,"label":13,"axis":12,"footnote":10.5,"micro":9.5}},"display":{"size":36,"lineHeight":1.11},"numeric":"tabular","emphasis":{"weight":600},"figure":{"weight":600},"eyebrow":{"weight":500,"ink":"inkMuted"}}` | Typography: the font stack every role inherits plus one type step per role. |
|
|
91
91
|
| type.family | string | yes | | `'\\'Helvetica Neue\\', Helvetica, Arial, Roboto, sans-serif'` | CSS font stack for every type role. The label solver measures with this stack, so keep it to the calibrated class. |
|
|
92
92
|
| type.title | object | yes | | `{"size":18,"weight":600,"lineHeight":1.25}` | One typographic role. Sizes step per width class through type.scale. |
|
|
93
93
|
| type.title.family | string | | | | CSS font stack for this role alone, in the type.family grammar. Absent falls back to type.family. |
|
|
@@ -145,6 +145,9 @@ Defaults are the `bridge` preset.
|
|
|
145
145
|
| type.figure | object | | | `{"weight":600}` | The big value of a KPI card. Set its family and weight here. The preferred size is max(heroMinimum, round(title x 1.5)) in target units. type.scale does not step it. Absent means type.family at the emphasis weight (700 by default). |
|
|
146
146
|
| type.figure.family | string | | | | CSS font stack for the KPI value alone, in the type.family grammar. Absent falls back to type.family. Measured from the width tables when one of its names is tabled, else by the character-class model. |
|
|
147
147
|
| type.figure.weight | number | | | `600` | Font weight (100 to 1000) of the KPI value. Absent means the emphasis weight (700 by default). |
|
|
148
|
+
| type.display | object | | | `{"size":36,"lineHeight":1.11}` | The value of every panel in the metric stack focus look (options.stack.variant 'focus'), in every readout layout. It prints in the family and weight of type.figure. type.scale does not step it; textScale does. Absent means 36 px on a 1.11 line. |
|
|
149
|
+
| type.display.size | number | | | `36` | Font size in px of the stack values (8 to 160). Absent means 36. |
|
|
150
|
+
| type.display.lineHeight | number | | | `1.11` | Line height of the stack values as a ratio of their size (0.9 to 2). Absent means 1.11. |
|
|
148
151
|
| type.eyebrow | object | | | `{"weight":500,"ink":"inkMuted"}` | The eyebrow of a KPI card, the label over the figure when the card has no title. Each absent key keeps today's eyebrow: the label role at 13 px or more, as authored, in color.inkMuted. type.scale does not step it. |
|
|
149
152
|
| type.eyebrow.size | number | | | | Font size in px of the KPI eyebrow (6 to 24). Absent keeps the label role at 13 px or more. |
|
|
150
153
|
| type.eyebrow.weight | number | | | `500` | Font weight (100 to 1000) of the KPI eyebrow. Absent keeps the label weight. |
|
|
@@ -278,6 +281,7 @@ Defaults are the `bridge` preset.
|
|
|
278
281
|
| table.section.spaceBefore | number | | | | Air in px above the label of a section row that follows other rows, inside the row, on the SVG and in the grid, so a new block reads at once. Default one body line box; 0 for none. A section that is the first row under the head takes a quarter line box, never more than this value. The label sits at the bottom of its row. |
|
|
279
282
|
| table.section.rule | string | | `'heavy'`, `'hair'` | | The line under a section heading, across the full table width, on the SVG and in the grid: 'heavy' (default) twice the rule stroke in the text ink; 'hair' the row rule (table.ruleInk at table.ruleWidths.row), or the text ink under table.headRule 'ink'. |
|
|
280
283
|
| table.fixedType | boolean | | | `true` | True makes a density change row height and cell padding only: compact heads, body and total keep their size, and the label of a cohort grid's closing row keeps the total face while the matrix cells keep their own step. Absent or false steps compact type 0.5 px down as before. |
|
|
284
|
+
| table.compactStep | number | | | | Px of air the compact density takes off each side of a body row and of the total row (0 to 8). Absent means compact keeps half of each row's regular air, rounded down: 3 px above and below a top-level or group row instead of 7, 2 px for a sub row instead of 4, and 4 px for the total instead of 8. 1 brings back the compact rows of 0.60 and earlier. |
|
|
281
285
|
| table.noPrevious | string | | `'na'`, `'missing'` | `'missing'` | What a change against the previous column prints where its group has no previous column, such as the first month's month-on-month: 'na' (default) prints n/a, 'missing' prints the missing glyph under the row's missing and the table's nulls policy. |
|
|
282
286
|
| table.ofWhich | string | | `'muted'`, `'ink'` | `'ink'` | 'muted' (default) draws ofWhich rows in the muted ink. 'ink' draws their labels and values in the text colour: the relation stays arithmetic only, and a muted column or an inline share line stays muted. |
|
|
283
287
|
| table.groupGround | string | | `'expanded'`, `'always'`, `'none'` | `'none'` | Which group rows carry the group ground when options.groupGround is absent. 'expanded': only the header row of an open group. 'always': folded or open, as before 0.28. 'none': none. Every preset sets 'none'; absent in a custom theme, 'expanded'. The Total keeps its own ground (table.grounds.total). |
|
|
@@ -95,7 +95,7 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
95
95
|
| abs | Reads the anchored data value and places its formatted absolute value in a collision-managed label. | at | at: AnchorRef | | |
|
|
96
96
|
| note | Places authored text at an anchored data element through collision avoidance, with an optional icon or status chip. | at, text | at: AnchorRef | | |
|
|
97
97
|
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false. An arrow from the text to the anchored point, in the arrow standard of theme marks.arrow: the text stands far enough out for a 24 px shaft, level with the point right or left of it, or over or under it, where there is room. With no such seat it draws without the arrow and warns callout-arrow-no-room. Not with icon or status. Example: "arrow": true. | |
|
|
98
|
-
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. side: left \| right, default right. Side of the plot the label sits on. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
98
|
+
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. side: left \| right, default right. Side of the plot the label sits on. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. On column, bar and dot the key names the band with its bounds, "Target range: 95 to 105"; without a key the band prints its bounds itself. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
99
99
|
| text | Places authored text at a point through the label solver: on the point, or above, below, right or left of it. The text prints as written. | at, text | at: AnchorRef \| { categoryId, value } | | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. The text prints as written, ${value} included. It takes id and priority, and no other field. |
|
|
100
100
|
| line | Draws a straight line between two points or from a text annotation, in the ink and rule width of a bracket; a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the line in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the line starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
101
101
|
| arrow | Draws a straight arrow between two points or from a text annotation to a point, in the theme arrow look (`marks.arrow`); a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the shaft in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the arrow starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
@@ -129,7 +129,7 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
129
129
|
| delta | Computes the signed difference between an anchored value and another anchor or literal, then places a collision-managed label at the first anchor. | at, vs | at: AnchorRef; vs: AnchorRef \| number | mode: absolute \| relative \| both, default absolute. absolute prints at minus vs, relative the percent change from vs to at, both the two as '+149 (+36%)'. relative and both need a nonzero vs. | |
|
|
130
130
|
| note | Places authored text at an anchored data element through collision avoidance, with an optional icon or status chip. | at, text | at: AnchorRef | | |
|
|
131
131
|
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false. An arrow from the text to the anchored point, in the arrow standard of theme marks.arrow: the text stands far enough out for a 24 px shaft, level with the point right or left of it, or over or under it, where there is room. With no such seat it draws without the arrow and warns callout-arrow-no-room. Not with icon or status. Example: "arrow": true. | |
|
|
132
|
-
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. side: left \| right, default right. Side of the plot the label sits on. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
132
|
+
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. side: left \| right, default right. Side of the plot the label sits on. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. On column, bar and dot the key names the band with its bounds, "Target range: 95 to 105"; without a key the band prints its bounds itself. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
133
133
|
| abs | Reads the anchored data value and places its formatted absolute value in a collision-managed label. | at | at: AnchorRef | | |
|
|
134
134
|
| bracket | Draws a bracket over an inclusive span of steps and prints the sum of their values, after an optional label. | from, to | from: categoryId; to: categoryId | label: string. Name printed before the sum, "Commercial +81". Without it the bracket prints the sum alone. | from and to are step ids, inclusive. The engine adds the steps up and prints the signed sum; every step in the span must be a delta, so a span that holds a total is refused with bracket-span-total. A step the bridge cannot add (an open start) refuses it with bracket-span-no-value. Brackets stand in one row above the steps. Vertical bridges only. |
|
|
135
135
|
| text | Places authored text at a point through the label solver: on the point, or above, below, right or left of it. The text prints as written. | at, text | at: AnchorRef \| { categoryId, value } | | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. The text prints as written, ${value} included. It takes id and priority, and no other field. |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "boardplot",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.62.0",
|
|
4
4
|
"description": "Consulting-grade waterfall, Mekko (Marimekko) and variance charts and management tables for slides, reports and dashboards. Use it through Claude Code, Codex or other MCP agents, or as responsive React components with tooltips. Open source, Apache-2.0.",
|
|
5
5
|
"mcpName": "io.github.boardplot/boardplot",
|
|
6
6
|
"type": "module",
|
package/dist/chunk-6AIHN5S6.js
DELETED
|
@@ -1,89 +0,0 @@
|
|
|
1
|
-
import {
|
|
2
|
-
chartTypeAliases,
|
|
3
|
-
schemaLoaders
|
|
4
|
-
} from "./chunk-XMRLQDOR.js";
|
|
5
|
-
import {
|
|
6
|
-
registeredType
|
|
7
|
-
} from "./chunk-TDVNIVU4.js";
|
|
8
|
-
import {
|
|
9
|
-
caseInsensitiveValue,
|
|
10
|
-
getChart,
|
|
11
|
-
getChartSchemas,
|
|
12
|
-
registerChartSchemas
|
|
13
|
-
} from "./chunk-NF74JTTK.js";
|
|
14
|
-
import {
|
|
15
|
-
registerChartCoreLoader
|
|
16
|
-
} from "./chunk-BQBD6Q5J.js";
|
|
17
|
-
|
|
18
|
-
// src/react/coreLoaders.ts
|
|
19
|
-
var coreLoaders = {
|
|
20
|
-
bar: () => import("./core-W3XIUTU7.js").then((module) => module.barCore),
|
|
21
|
-
bartable: () => import("./core-JFORSZQS.js").then((module) => module.bartableCore),
|
|
22
|
-
box: () => import("./core-YVWLKGAN.js").then((module) => module.boxCore),
|
|
23
|
-
bullet: () => import("./core-XHSGRJDP.js").then((module) => module.bulletCore),
|
|
24
|
-
butterfly: () => import("./core-HRHUGQNB.js").then((module) => module.butterflyCore),
|
|
25
|
-
choropleth: () => import("./core-32KM4AJG.js").then((module) => module.choroplethCore),
|
|
26
|
-
cohort: () => import("./core-STATMGC7.js").then((module) => module.cohortCore),
|
|
27
|
-
column: () => import("./core-TBQAFBDU.js").then((module) => module.columnCore),
|
|
28
|
-
combo: () => import("./core-REYW2XB3.js").then((module) => module.comboCore),
|
|
29
|
-
creative: () => import("./core-FLCLKSGA.js").then((module) => module.creativeCore),
|
|
30
|
-
diagram: () => import("./core-255NAAUA.js").then((module) => module.diagramCore),
|
|
31
|
-
dimswitch: () => import("./core-56KTQ7DK.js").then((module) => module.dimswitchCore),
|
|
32
|
-
dot: () => import("./core-NARJSEGI.js").then((module) => module.dotCore),
|
|
33
|
-
funnel: () => import("./core-WU6DBIAM.js").then((module) => module.funnelCore),
|
|
34
|
-
gantt: () => import("./core-RYEENVFZ.js").then((module) => module.ganttCore),
|
|
35
|
-
grid: () => import("./core-7II27MGX.js").then((module) => module.gridCore),
|
|
36
|
-
heatmap: () => import("./core-J5DSGZZR.js").then((module) => module.heatmapCore),
|
|
37
|
-
histogram: () => import("./core-YTTTVHUH.js").then((module) => module.histogramCore),
|
|
38
|
-
kpi: () => import("./core-OZLK2EJW.js").then((module) => module.kpiCore),
|
|
39
|
-
likert: () => import("./core-QLJQOZGJ.js").then((module) => module.likertCore),
|
|
40
|
-
line: () => import("./core-V2RMMBMO.js").then((module) => module.lineCore),
|
|
41
|
-
mekko: () => import("./core-6N5ONDKG.js").then((module) => module.mekkoCore),
|
|
42
|
-
pareto: () => import("./core-GETUMW6I.js").then((module) => module.paretoCore),
|
|
43
|
-
pie: () => import("./core-CELQJZJB.js").then((module) => module.pieCore),
|
|
44
|
-
pvm: () => import("./core-BTKBKGCU.js").then((module) => module.pvmCore),
|
|
45
|
-
pyramid: () => import("./core-FRVHGKYW.js").then((module) => module.pyramidCore),
|
|
46
|
-
sankey: () => import("./core-QYAXEGWD.js").then((module) => module.sankeyCore),
|
|
47
|
-
scatter: () => import("./core-GCYDQRFM.js").then((module) => module.scatterCore),
|
|
48
|
-
slope: () => import("./core-L4EGZ73S.js").then((module) => module.slopeCore),
|
|
49
|
-
sparkline: () => import("./core-COGECGZY.js").then((module) => module.sparklineCore),
|
|
50
|
-
status: () => import("./core-6GE3EMCB.js").then((module) => module.statusCore),
|
|
51
|
-
table: () => import("./core-AAC2ESXF.js").then((module) => module.tableCore),
|
|
52
|
-
tilemap: () => import("./core-W4NG6WON.js").then((module) => module.tilemapCore),
|
|
53
|
-
treemap: () => import("./core-SUFLQLWC.js").then((module) => module.treemapCore),
|
|
54
|
-
variance: () => import("./core-X4SPCV6G.js").then((module) => module.varianceCore),
|
|
55
|
-
waffle: () => import("./core-F7ASDBXB.js").then((module) => module.waffleCore),
|
|
56
|
-
waterfall: () => import("./core-2JHH5LLH.js").then((module) => module.waterfallCore)
|
|
57
|
-
};
|
|
58
|
-
|
|
59
|
-
// src/react/loadChartTypes.ts
|
|
60
|
-
var aliasOwners = /* @__PURE__ */ new Map();
|
|
61
|
-
for (let [type, aliases] of Object.entries(chartTypeAliases))
|
|
62
|
-
for (let alias of aliases) aliasOwners.set(alias, type);
|
|
63
|
-
function knownChartType(name) {
|
|
64
|
-
return name = caseInsensitiveValue(name, [...Object.keys(coreLoaders), ...aliasOwners.keys()]) ?? name, Object.hasOwn(coreLoaders, name) ? name : aliasOwners.get(name);
|
|
65
|
-
}
|
|
66
|
-
async function loadChartTypes(names, parts) {
|
|
67
|
-
let types = [...new Set(names.map(knownChartType).filter((type) => type !== void 0))];
|
|
68
|
-
await Promise.all(types.flatMap((type) => [
|
|
69
|
-
parts.schemas && getChartSchemas(type) === void 0 ? schemaLoaders[type]().then((schemas) => {
|
|
70
|
-
registerChartSchemas(schemas, chartTypeAliases[type]);
|
|
71
|
-
}) : void 0,
|
|
72
|
-
parts.cores && getChart(type) === void 0 ? coreLoaders[type]().then((core) => {
|
|
73
|
-
registeredType(core);
|
|
74
|
-
}) : void 0
|
|
75
|
-
]));
|
|
76
|
-
}
|
|
77
|
-
registerChartCoreLoader({
|
|
78
|
-
knows: (type) => knownChartType(type) !== void 0,
|
|
79
|
-
load: (type) => loadChartTypes([type], { schemas: !1, cores: !0 })
|
|
80
|
-
});
|
|
81
|
-
function registeredTypeWithPanelCores(core) {
|
|
82
|
-
return registeredType(core);
|
|
83
|
-
}
|
|
84
|
-
|
|
85
|
-
export {
|
|
86
|
-
knownChartType,
|
|
87
|
-
loadChartTypes,
|
|
88
|
-
registeredTypeWithPanelCores
|
|
89
|
-
};
|