boardplot 0.56.0 → 0.58.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 +408 -0
- package/README.md +49 -15
- package/dist/{DiagnosticDetails-JFBBXOT2.js → DiagnosticDetails-VGSL4NJK.js} +1 -1
- package/dist/{ReaderBox-GLCKYXBU.js → ReaderBox-MHMXIDAJ.js} +8 -7
- package/dist/{annotateEngine-QVNAE3EH.js → annotateEngine-753KQBNN.js} +2 -1
- package/dist/build-identity.json +3 -3
- package/dist/{chunk-HZUAEMN5.js → chunk-2CQBBN7M.js} +4 -4
- package/dist/{chunk-K3VZ5QJK.js → chunk-2ETK5TSA.js} +4 -4
- package/dist/{chunk-HHXIVFAU.js → chunk-2ETSI2EL.js} +11 -9
- package/dist/{chunk-ECBUFKCP.js → chunk-2GRXHWRH.js} +3 -3
- package/dist/{chunk-ZVM5TFGR.js → chunk-2HII2B6S.js} +6 -2
- package/dist/{chunk-WBETBGSC.js → chunk-2LC2H3ZM.js} +1003 -907
- package/dist/chunk-2NX7EO7H.js +23 -0
- package/dist/{chunk-52WNCUIN.js → chunk-2QI2PK2O.js} +1 -1
- package/dist/{chunk-QWCLWFKC.js → chunk-2VKQQLP7.js} +180 -58
- package/dist/chunk-3DOVXJ6K.js +602 -0
- package/dist/{chunk-CAJ54IEP.js → chunk-3E6NLODZ.js} +1 -1
- package/dist/{chunk-MOS6WFWM.js → chunk-3HA4IJTO.js} +9 -9
- package/dist/{chunk-JCIXYOND.js → chunk-3HPPTQEW.js} +4 -4
- package/dist/{chunk-7VVHTOE7.js → chunk-3KT2647F.js} +4 -2
- package/dist/{chunk-O6ZTIDWB.js → chunk-3MFVJMP6.js} +3 -2
- package/dist/{chunk-KQCKK3LD.js → chunk-3P3FKPFN.js} +170 -73
- package/dist/{chunk-WI5VOSQX.js → chunk-3XAJSMYD.js} +2 -2
- package/dist/{chunk-CPGASWNN.js → chunk-42QKUSHJ.js} +13 -3
- package/dist/{chunk-QB5HV4IY.js → chunk-44JU3VOT.js} +7 -8
- package/dist/{chunk-BYCJ6TKI.js → chunk-44K75CYE.js} +3 -3
- package/dist/{chunk-MS7O3KDJ.js → chunk-4FNM4D57.js} +6 -6
- package/dist/{chunk-BVYIKLQ5.js → chunk-4ROZ4TFL.js} +1 -1
- package/dist/{chunk-3V62N3Z7.js → chunk-4VV3KUFT.js} +7 -8
- package/dist/{chunk-MAFPVR4G.js → chunk-54YO56IK.js} +10 -5
- package/dist/{chunk-JMGB444D.js → chunk-5ACFYNA4.js} +8 -4
- package/dist/{chunk-6AMN7IKJ.js → chunk-5JEU6MWC.js} +49 -28
- package/dist/{chunk-NCLRZQR6.js → chunk-5JIB4VJA.js} +18 -10
- package/dist/{chunk-SXD3OYAR.js → chunk-5OP3E2ZD.js} +205 -96
- package/dist/{chunk-SS4YGK3E.js → chunk-5SLBD4BT.js} +72 -304
- package/dist/{chunk-XMP2DNLI.js → chunk-5SVGTQTW.js} +4 -4
- package/dist/chunk-5U567TYU.js +23 -0
- package/dist/chunk-5ZLF4S7X.js +40 -0
- package/dist/{chunk-T2YDWT54.js → chunk-5ZMTQATF.js} +261 -147
- package/dist/{chunk-WXJ5MHLH.js → chunk-62BDQTO6.js} +2 -2
- package/dist/chunk-64K3V4VN.js +25 -0
- package/dist/{chunk-BK6P6KMW.js → chunk-67YJJJIB.js} +1 -1
- package/dist/{chunk-32LLDRPI.js → chunk-6DJNFT2K.js} +42 -32
- package/dist/{chunk-JYAZPMSA.js → chunk-6IUK6PAH.js} +7 -6
- package/dist/{chunk-7STMIK2X.js → chunk-6JFQCVNN.js} +4 -4
- package/dist/chunk-6JXBLQJ2.js +32 -0
- package/dist/{chunk-5TWY3ZIC.js → chunk-6XPV6M3Q.js} +5 -5
- package/dist/{chunk-MPO5TVGF.js → chunk-6ZDSEITW.js} +3 -3
- package/dist/{chunk-75WIUG2W.js → chunk-72HVDLMT.js} +172 -78
- package/dist/chunk-75NU5RLX.js +24 -0
- package/dist/chunk-76GPN6AT.js +72 -0
- package/dist/chunk-7BQK2UDV.js +13 -0
- package/dist/{chunk-CF4NMRN7.js → chunk-7CAYRPJV.js} +45 -25
- package/dist/{chunk-U3A6FMSI.js → chunk-7GWWBHVQ.js} +7 -7
- package/dist/{chunk-CHAS5A5B.js → chunk-7NYUFMLJ.js} +149 -86
- package/dist/{chunk-D2B3KP35.js → chunk-7VWXXBTC.js} +4 -0
- package/dist/chunk-A65B23JK.js +113 -0
- package/dist/{chunk-4KMZAK6J.js → chunk-A7R6FUS6.js} +4 -4
- package/dist/{chunk-E2ZUBP4Q.js → chunk-AEVGUOPB.js} +7 -8
- package/dist/chunk-AHIK2N72.js +53 -0
- package/dist/{chunk-KLB2QC24.js → chunk-AICO24HJ.js} +5 -2
- package/dist/{chunk-7KSUMFBK.js → chunk-AJGSCVVW.js} +5 -1
- package/dist/{chunk-RSCRIWAH.js → chunk-AL62JJTB.js} +10 -3
- package/dist/{chunk-E7V3OHQQ.js → chunk-AN2V2LC4.js} +37 -22
- package/dist/{chunk-JIEVDGAF.js → chunk-AOFUA5XP.js} +1 -1
- package/dist/chunk-B5A7X2BA.js +44 -0
- package/dist/{chunk-2HTYGMMG.js → chunk-BCMEGJRX.js} +2 -2
- package/dist/{chunk-KD5GOR2K.js → chunk-BDIKWR45.js} +124 -69
- package/dist/{chunk-FNRPQIQE.js → chunk-BG6AIWAK.js} +4 -6
- package/dist/{chunk-ZMPH2OC4.js → chunk-BOT6W3VB.js} +7 -8
- package/dist/{chunk-DRHQG44U.js → chunk-BQBD6Q5J.js} +6 -2
- package/dist/{chunk-2DOEZ5QY.js → chunk-BZ67BJBH.js} +11 -10
- package/dist/{chunk-UBCVBBJJ.js → chunk-C47POAC5.js} +4 -3
- package/dist/{chunk-O7REHICC.js → chunk-C5OBPO4Z.js} +36 -28
- package/dist/{chunk-IGNBQT23.js → chunk-CCAAI56H.js} +121 -10
- package/dist/{chunk-RPIKNMZA.js → chunk-CDUR3KWV.js} +7 -2
- package/dist/{chunk-MZACASZY.js → chunk-CMPHT2LS.js} +14 -2
- package/dist/{chunk-FHA3KMFC.js → chunk-CQBPNE7Z.js} +5 -1
- package/dist/{chunk-IVRYF7QA.js → chunk-CR5FP5SF.js} +1 -1
- package/dist/{chunk-DD6RVD3S.js → chunk-D2TQX7UJ.js} +5 -1
- package/dist/{chunk-VVXKFU72.js → chunk-DEANHDXU.js} +62 -41
- package/dist/{chunk-GM3EGUYW.js → chunk-DHGE46UK.js} +1 -1
- package/dist/{chunk-UZTQUPTB.js → chunk-DIHX6NUB.js} +5 -5
- package/dist/{chunk-MD6DCQMA.js → chunk-DILQ34NW.js} +37 -37
- package/dist/{chunk-YMTXTQCN.js → chunk-DJKRYJP7.js} +6 -6
- package/dist/{chunk-JCAGVAB3.js → chunk-DKLC6QLF.js} +1200 -21
- package/dist/{chunk-SRAV6FPB.js → chunk-DNHTMCUP.js} +3 -3
- package/dist/{chunk-CKGSGRP7.js → chunk-DORE2RHL.js} +21 -5
- package/dist/{chunk-SMHZXHHD.js → chunk-DZYTXZNS.js} +15 -5
- package/dist/chunk-E262NRFP.js +39 -0
- package/dist/{chunk-V5JQQMFQ.js → chunk-E5YF236N.js} +4 -1
- package/dist/{chunk-IGJ2G5C6.js → chunk-EBUK7HJP.js} +6 -6
- package/dist/{chunk-ZL6IHMOW.js → chunk-ECBHC272.js} +198 -119
- package/dist/{chunk-SA46CNMS.js → chunk-ED7GLWTF.js} +4 -1
- package/dist/chunk-EFW43JQJ.js +24 -0
- package/dist/{chunk-5P2TTHBZ.js → chunk-EHRRHSPV.js} +2 -2
- package/dist/{chunk-JXBZIJCG.js → chunk-EILNJQMN.js} +32 -12
- package/dist/{chunk-GELSK76Y.js → chunk-ERDKMZ7O.js} +3 -3
- package/dist/{chunk-T2CYNDYU.js → chunk-ETRAPN5G.js} +366 -130
- package/dist/{chunk-JEUL777U.js → chunk-ETUKDEGL.js} +21 -12
- package/dist/chunk-F2ET5ZTT.js +49 -0
- package/dist/{chunk-2YO4WRJN.js → chunk-F3XOBFS4.js} +40 -29
- package/dist/{chunk-SPSGUFTI.js → chunk-FB6X7QHA.js} +1 -1
- package/dist/{chunk-5PPQIF4D.js → chunk-FGW54I23.js} +7 -8
- package/dist/{chunk-JTC5SEAQ.js → chunk-FP5B5XIL.js} +7 -3
- package/dist/{chunk-RJGCYGC3.js → chunk-FRHQGA5Q.js} +86 -250
- package/dist/{chunk-YZZLIYPA.js → chunk-FRR7BJ3B.js} +5 -1
- package/dist/{chunk-4DZFR52I.js → chunk-FVWHEM2N.js} +7 -5
- package/dist/{chunk-YPYD6OJ3.js → chunk-FWSMENKH.js} +2 -2
- package/dist/{chunk-YYJORENB.js → chunk-FWTUGNSF.js} +8 -8
- package/dist/{chunk-GIHH6VC2.js → chunk-FZKDZQ6U.js} +10 -6
- package/dist/{chunk-S7NRL66K.js → chunk-G4FF6G3I.js} +26 -17
- package/dist/{chunk-PQLAZEQV.js → chunk-GB6BZSTL.js} +248 -92
- package/dist/chunk-GCIHRRDJ.js +24 -0
- package/dist/{chunk-X3KCQEYZ.js → chunk-GHCU6OSE.js} +9 -1
- package/dist/chunk-GKDUIDU6.js +138 -0
- package/dist/chunk-GO66OCN7.js +24 -0
- package/dist/chunk-GOFS336W.js +24 -0
- package/dist/{chunk-AGDDH6XY.js → chunk-GQYT7G4F.js} +5 -1
- package/dist/{chunk-WN3HEU3P.js → chunk-GUTLXO7Q.js} +140 -89
- package/dist/chunk-H3VICNTN.js +47 -0
- package/dist/{chunk-GC4WOLV3.js → chunk-HAG3K6PQ.js} +14 -2
- package/dist/{chunk-CB4CERXZ.js → chunk-HBQHSZ6S.js} +11 -2
- package/dist/chunk-HTQGJQZN.js +124 -0
- package/dist/{chunk-F77TMAUY.js → chunk-HUQRO6VF.js} +39 -36
- package/dist/{chunk-4KQHKPB3.js → chunk-I5VDW2XZ.js} +543 -509
- package/dist/{chunk-43GGVT7W.js → chunk-I5VNHDPR.js} +11 -4
- package/dist/{chunk-4LTN7SND.js → chunk-IDXYHDQY.js} +1 -1
- package/dist/{chunk-Y54LU4CU.js → chunk-IIWZJ5ZM.js} +1 -1
- package/dist/{chunk-FMDNJ6PC.js → chunk-IPBOREIY.js} +2 -2
- package/dist/chunk-IU335UO7.js +27 -0
- package/dist/{chunk-JVZTKQFS.js → chunk-IVDTP6SV.js} +9 -5
- package/dist/{chunk-BDGLMWPO.js → chunk-IXOBDDMW.js} +11 -2
- package/dist/{chunk-EIL3KHAL.js → chunk-J4QRB6DQ.js} +5 -5
- package/dist/{chunk-3465633G.js → chunk-JCMGKQVS.js} +3 -3
- package/dist/{chunk-YK2KWNTU.js → chunk-JM7UTLF3.js} +28 -14
- package/dist/{chunk-CXETOLPX.js → chunk-JNDWRV34.js} +4 -4
- package/dist/{chunk-DLUNQHFO.js → chunk-JSRQTDZZ.js} +26 -24
- package/dist/{chunk-WTQAG2OT.js → chunk-JT3UTEWZ.js} +8 -3
- package/dist/{chunk-GQT2SY2S.js → chunk-JUYRDZSV.js} +291 -151
- package/dist/{chunk-LKMFMNQX.js → chunk-JVGL2SCN.js} +1 -1
- package/dist/{chunk-4JC3SE4G.js → chunk-JY4LTPOV.js} +1 -1
- package/dist/chunk-K7XPTQBJ.js +267 -0
- package/dist/{chunk-P4SMC4BY.js → chunk-KGBUXMFP.js} +120 -86
- package/dist/{chunk-XC5IRUEL.js → chunk-KIE5V3DA.js} +2 -2
- package/dist/{chunk-RT66UTLJ.js → chunk-KU4PCG4W.js} +2 -2
- package/dist/{chunk-VPL3JYC6.js → chunk-KVBLTAO7.js} +52 -10
- package/dist/{chunk-XCROSJ2Z.js → chunk-KW4JXWHO.js} +1 -1
- package/dist/{chunk-PJBEJR2U.js → chunk-KWIP5YRA.js} +24 -7
- package/dist/{chunk-JYBT2JNY.js → chunk-LE3LSEUL.js} +27 -2
- package/dist/{chunk-R2IKOLBK.js → chunk-LG6M2JTH.js} +3 -3
- package/dist/{chunk-DF3XEFQ7.js → chunk-LIE2WSB4.js} +21 -18
- package/dist/{chunk-Z55DXFWS.js → chunk-LJDATBPB.js} +26 -16
- package/dist/{chunk-KLIZXSBK.js → chunk-LMMS675D.js} +10 -9
- package/dist/{chunk-MRAP2UVV.js → chunk-LPKGZ664.js} +286 -35
- package/dist/{chunk-JFFREZGT.js → chunk-LPMSGO7L.js} +6 -2
- package/dist/chunk-LQWINE7K.js +211 -0
- package/dist/{chunk-6MJUW5R5.js → chunk-MKMMQDIY.js} +139 -71
- package/dist/{chunk-F5BYLT3M.js → chunk-MQ4IEDM5.js} +462 -138
- package/dist/{chunk-QGFKSDQO.js → chunk-MRM4KJ2O.js} +2 -2
- package/dist/{chunk-ETMHDCEH.js → chunk-MX2OZHIT.js} +102 -42
- package/dist/{chunk-6EYTD777.js → chunk-MXUPMGRY.js} +2 -2
- package/dist/{chunk-2FKEF2AC.js → chunk-NHU26HQ7.js} +58 -35
- package/dist/{chunk-KBJMLXNW.js → chunk-NQVJ4FPY.js} +161 -78
- package/dist/chunk-NZ7FX3AE.js +65 -0
- package/dist/chunk-OALBVELJ.js +23 -0
- package/dist/{chunk-5S3JQ5AT.js → chunk-OGZ4UPYK.js} +183 -137
- package/dist/{chunk-6WHWXCHJ.js → chunk-OMNB27GM.js} +7 -3
- package/dist/{chunk-EGGDPDYJ.js → chunk-OO63YP35.js} +1 -1
- package/dist/{chunk-ZYQYX66L.js → chunk-OPYDTW5Q.js} +6 -6
- package/dist/{chunk-A2GAWGVJ.js → chunk-OSJN7KDS.js} +68 -39
- package/dist/{chunk-RMC4OONA.js → chunk-OSJXIW6I.js} +1030 -1123
- package/dist/{chunk-X23SZHV5.js → chunk-OVVE42P4.js} +6 -6
- package/dist/{chunk-CCJP6QZO.js → chunk-OZA7HA6L.js} +1 -1
- package/dist/chunk-OZLKEBCD.js +54 -0
- package/dist/{chunk-TE4M52AA.js → chunk-P6DEFCMQ.js} +18 -2
- package/dist/{chunk-AMR4SUAN.js → chunk-PDTIQL3B.js} +6 -6
- package/dist/{chunk-BIVL764T.js → chunk-PJ5BYZPN.js} +2 -2
- package/dist/{chunk-BISJK67O.js → chunk-PK7Z7WRJ.js} +98 -46
- package/dist/{chunk-7VMEM3LN.js → chunk-PL6NWB5U.js} +178 -113
- package/dist/chunk-PMT75APP.js +94 -0
- package/dist/chunk-PP6A4X55.js +11 -0
- package/dist/{chunk-I7H5DU34.js → chunk-PPCH3PLO.js} +25 -13
- package/dist/{chunk-BIGQKCU7.js → chunk-PPE6S7WU.js} +42 -24
- package/dist/{chunk-2NSQIPAA.js → chunk-PT7KSIEO.js} +23 -36
- package/dist/{chunk-KZJ5VM6E.js → chunk-PZ3TQFSY.js} +15 -1
- package/dist/{chunk-ZJFJ2IKQ.js → chunk-QAUGRVRU.js} +122 -23
- package/dist/{chunk-BTDGWHGJ.js → chunk-QMFWZG2P.js} +39 -19
- package/dist/{chunk-L6YVK6VC.js → chunk-QZGGCE45.js} +2 -2
- package/dist/{chunk-67QSW5RW.js → chunk-R2RJQ3BM.js} +4 -4
- package/dist/{chunk-ZY72LSQK.js → chunk-R7HBIQ63.js} +102 -61
- package/dist/{chunk-4JHMCXOB.js → chunk-RBNDZLYS.js} +77 -36
- package/dist/chunk-RCSY4CT4.js +2170 -0
- package/dist/{chunk-NGA7ICG4.js → chunk-RDJ3ZU6O.js} +16 -13
- package/dist/{chunk-2NN676RI.js → chunk-RHQRPJHS.js} +7 -8
- package/dist/chunk-RI6XQKWJ.js +26 -0
- package/dist/{chunk-YOOHNQ3L.js → chunk-RJICOOB3.js} +18 -8
- package/dist/{chunk-5DTCOOLU.js → chunk-RLAVNCQJ.js} +2 -2
- package/dist/{chunk-CYKXROFG.js → chunk-ROPPWJQB.js} +23 -12
- package/dist/{chunk-54ROMBU7.js → chunk-SELOV32X.js} +105 -50
- package/dist/{chunk-TUW5IYGA.js → chunk-SQI4NWTQ.js} +9 -9
- package/dist/{chunk-ZEYBI47P.js → chunk-SRJ74CMG.js} +11 -3
- package/dist/{chunk-NHC2ADGI.js → chunk-STWOURLG.js} +253 -144
- package/dist/chunk-SWMFXSVW.js +23 -0
- package/dist/chunk-SXAZDIGM.js +84 -0
- package/dist/{chunk-EMFUZKYK.js → chunk-SZ5VGWDY.js} +3 -3
- package/dist/{chunk-R5MEBBAA.js → chunk-T26G23RS.js} +442 -119
- package/dist/{chunk-QHRE2M6V.js → chunk-T2L5H2WW.js} +4 -3
- package/dist/chunk-T7GPIJ4L.js +89 -0
- package/dist/{chunk-MJPXHCBW.js → chunk-TAEB3RU6.js} +5 -5
- package/dist/{chunk-V7F4F6JA.js → chunk-TBDIMTRD.js} +37 -16
- package/dist/{chunk-63Y3ROZ7.js → chunk-TFFPEWNP.js} +102 -64
- package/dist/{chunk-EZZ533MH.js → chunk-TMEUK2WS.js} +6 -2
- package/dist/{chunk-37PKNVLS.js → chunk-TVOMGNFQ.js} +1 -1
- package/dist/{chunk-HJRNBKIT.js → chunk-TX5FSNAU.js} +436 -30
- package/dist/{chunk-V634AXDM.js → chunk-U52PNFPX.js} +1 -1
- package/dist/{chunk-QLANK3VN.js → chunk-U74AWJ3X.js} +6 -6
- package/dist/chunk-UC7LBW7N.js +26 -0
- package/dist/{chunk-PZ46S2SY.js → chunk-UCKUAKYQ.js} +2 -2
- package/dist/{chunk-KF7HD3EH.js → chunk-UCYL3YA7.js} +77 -55
- package/dist/{chunk-HOU2MZHC.js → chunk-UD2GI3CS.js} +11 -4
- package/dist/{chunk-SNQ7D5R7.js → chunk-UIHGGWES.js} +51 -11
- package/dist/{chunk-LGNJCPFP.js → chunk-ULQIC76A.js} +10 -13
- package/dist/{chunk-KTHFHD6C.js → chunk-UY34DDUM.js} +11 -6
- package/dist/{chunk-6QDMRPXI.js → chunk-UYMFLWM6.js} +215 -258
- package/dist/{chunk-KDSYZLF6.js → chunk-V5IFI3FV.js} +8 -1
- package/dist/{chunk-JTFKRDDA.js → chunk-V7FV66KL.js} +1 -1
- package/dist/{chunk-27OIGDRK.js → chunk-V7NUJEJE.js} +1 -1
- package/dist/{chunk-CCDXK5NA.js → chunk-VESSIKBG.js} +8 -3
- package/dist/{chunk-QSMGZOT5.js → chunk-VRFJAF3R.js} +7 -8
- package/dist/chunk-VS2R3OGN.js +34 -0
- package/dist/{chunk-RLMC5CUP.js → chunk-VS5B4J2D.js} +7 -8
- package/dist/{chunk-7M2GK7XQ.js → chunk-W4R6SGU3.js} +252 -121
- package/dist/{chunk-JKOEHRGV.js → chunk-WDLWWEHZ.js} +1 -1
- package/dist/{chunk-7DAH2E4T.js → chunk-WFBN2HXR.js} +2 -2
- package/dist/{chunk-DLDDRXAI.js → chunk-WJS6SAWA.js} +296 -145
- package/dist/{chunk-WWGPTEQB.js → chunk-WQYNKF33.js} +73 -22
- package/dist/{chunk-64LJDGJH.js → chunk-WUP6C4ZD.js} +4 -2
- package/dist/{chunk-F2EVCJ4U.js → chunk-X24WAHHV.js} +87 -43
- package/dist/{chunk-OJ5CQV7H.js → chunk-X3UCQPVV.js} +209 -96
- package/dist/{chunk-7FKY6YWU.js → chunk-X46PSAJ7.js} +6 -6
- package/dist/{chunk-H3IBJQ5A.js → chunk-XD5XB22R.js} +2 -2
- package/dist/chunk-XDIAQEYK.js +28 -0
- package/dist/{chunk-7PPMT5EJ.js → chunk-XFPNYHX3.js} +372 -105
- package/dist/{chunk-FCECYJVA.js → chunk-XIBVAKCO.js} +1 -1
- package/dist/{chunk-OG2YUVBW.js → chunk-XMX4PCFL.js} +8 -3
- package/dist/{chunk-2NRHD2G7.js → chunk-XRRG4MBM.js} +12 -4
- package/dist/{chunk-FNMH5WEY.js → chunk-XTFO6D4L.js} +1 -1
- package/dist/chunk-XWRI3N5O.js +70 -0
- package/dist/{chunk-ZKJ5L35C.js → chunk-XXPLPSOE.js} +36 -25
- package/dist/{chunk-XQMYQ4TN.js → chunk-XZXZNI7A.js} +1 -1
- package/dist/{chunk-E555EDOQ.js → chunk-YEJZ2OYS.js} +490 -182
- package/dist/chunk-YGZEG3JV.js +123 -0
- package/dist/{chunk-F6OLHND5.js → chunk-Z3WQXVFV.js} +2 -2
- package/dist/{chunk-FFJGC2DX.js → chunk-Z6DUNKFU.js} +173 -40
- package/dist/{chunk-N5HN5QGH.js → chunk-Z6H5ED2I.js} +1 -1
- package/dist/{chunk-7Q37C6GZ.js → chunk-ZBOOMLHD.js} +1 -1
- package/dist/{chunk-MOK3ZS6P.js → chunk-ZDJ7C64T.js} +1 -1
- package/dist/{chunk-GLQ3KCTY.js → chunk-ZGZLEUKM.js} +7 -8
- package/dist/{chunk-YHD2FZFP.js → chunk-ZHRGX225.js} +6 -6
- package/dist/{chunk-76Q7E3TM.js → chunk-ZIVCPXXL.js} +510 -646
- package/dist/{chunk-BSATR6ZO.js → chunk-ZNRSYS76.js} +21 -3
- package/dist/{chunk-DMAMWUYY.js → chunk-ZSLTSCTI.js} +5 -5
- package/dist/{chunk-IGVAWAOK.js → chunk-ZSYFQSPF.js} +43 -9
- package/dist/cli/index.js +8 -3
- package/dist/{core-7Y5BZZON.js → core-43GLGBOY.js} +8 -1
- package/dist/{core-7S3XMW5O.js → core-5GI3ERXO.js} +4 -1
- package/dist/{core-K3JX5WPM.js → core-5L7TMK7I.js} +6 -1
- package/dist/{core-LB5M7XL4.js → core-7TO4OVY5.js} +6 -1
- package/dist/{core-ILPXXC2Z.js → core-BJVENHFQ.js} +7 -1
- package/dist/{core-JDFUZFRH.js → core-BX4MFWKC.js} +6 -1
- package/dist/{core-XW7UJFJZ.js → core-C3KXTOIZ.js} +7 -1
- package/dist/{core-WJNK7F2J.js → core-C5Y6BFLL.js} +7 -1
- package/dist/{core-WZ4CHVYL.js → core-CLUSJ2SK.js} +5 -1
- package/dist/{core-TCSW24N6.js → core-E3IN2VVH.js} +5 -1
- package/dist/{core-MU4ALRR7.js → core-FD67NQOV.js} +6 -1
- package/dist/{core-YMXYUGF5.js → core-FDKMLRAK.js} +5 -1
- package/dist/{core-VKZSQFRG.js → core-FL6Z3VVX.js} +5 -1
- package/dist/{core-5UF44NDI.js → core-JC7JUFPY.js} +8 -1
- package/dist/{core-RR2CAZC5.js → core-JF33TADA.js} +8 -1
- package/dist/{core-4RR6VSXM.js → core-JH32ZAKM.js} +4 -1
- package/dist/{core-G3LXHW73.js → core-JYYZPPQV.js} +7 -1
- package/dist/{core-4HFVG4CP.js → core-KJTKCV4U.js} +4 -1
- package/dist/{core-GSILPKUR.js → core-LCQPE5Y6.js} +8 -1
- package/dist/{core-GLOZY6Z7.js → core-LHVGWE54.js} +6 -1
- package/dist/{core-J2JD5ODO.js → core-OVSNBOCE.js} +9 -1
- package/dist/{core-BLHEJ5OK.js → core-PPEC236B.js} +5 -1
- package/dist/{core-ZLSQHZ3I.js → core-QTJZDK5H.js} +5 -1
- package/dist/{core-TKZZZ6UW.js → core-R3YZCOUZ.js} +7 -1
- package/dist/{core-HTD5RHE7.js → core-RIBW5XU4.js} +7 -1
- package/dist/{core-AR2T32Y3.js → core-RJFILBWL.js} +8 -1
- package/dist/{core-A5AKUB7H.js → core-RWSXEKTE.js} +4 -1
- package/dist/{core-DD62MWEW.js → core-SOPPZLEH.js} +5 -1
- package/dist/{core-HDNWVLJW.js → core-TBUZCXLX.js} +5 -1
- package/dist/{core-BOG33BFD.js → core-TZ5QLTAX.js} +5 -1
- package/dist/{core-H5HO2CED.js → core-U7E5W4MY.js} +3 -1
- package/dist/{core-QPSAYRFT.js → core-UBNVSL44.js} +7 -1
- package/dist/{core-E2XOSHPR.js → core-UDRD4WIU.js} +6 -1
- package/dist/{core-DFZMOO7E.js → core-UVJZ4HY2.js} +7 -1
- package/dist/{core-LGJZUP6H.js → core-X7WWYQH4.js} +8 -1
- package/dist/{core-BBNY2BX4.js → core-XP56X47I.js} +5 -1
- package/dist/{core-3KLQSYWB.js → core-XQG54CYG.js} +6 -1
- package/dist/{dataTable-CNDRVGA5.js → dataTable-U7W4I6IF.js} +15 -2
- package/dist/{engine-FVEIM3WV.js → engine-O5V26MGR.js} +32 -19
- package/dist/fixtures.js +4 -1
- package/dist/flags-BVLSAXT3.js +10 -0
- package/dist/{fontTables-ZPZQ6IR3.js → fontTables-JUW7ZTQY.js} +3 -1
- package/dist/fonts.js +1 -1
- package/dist/geo/dach.js +1 -1
- package/dist/geo/de-states.js +1 -1
- package/dist/geo/eu27.js +1 -1
- package/dist/geo/europe.js +1 -1
- package/dist/geo/index.js +2 -2
- package/dist/geo/us-states.js +1 -1
- package/dist/geo/world.js +1 -1
- package/dist/index.js +41 -22
- package/dist/{main-THU6VIVU.js → main-35GS47XC.js} +68 -123
- package/dist/mcp/server.js +131 -118
- package/dist/react/bar.js +10 -1
- package/dist/react/bartable.js +10 -1
- package/dist/react/box.js +8 -1
- package/dist/react/bullet.js +10 -1
- package/dist/react/butterfly.js +10 -1
- package/dist/react/choropleth.js +10 -1
- package/dist/react/cohort.js +11 -1
- package/dist/react/column.js +10 -1
- package/dist/react/combo.js +10 -1
- package/dist/react/creative.js +11 -1
- package/dist/react/diagram.js +10 -1
- package/dist/react/dimswitch.js +11 -1
- package/dist/react/dot.js +9 -1
- package/dist/react/export.js +36 -18
- package/dist/react/funnel.js +9 -1
- package/dist/react/gantt.js +9 -1
- package/dist/react/grid.js +10 -1
- package/dist/react/heatmap.js +9 -1
- package/dist/react/histogram.js +11 -1
- package/dist/react/index.js +101 -85
- package/dist/react/kpi.js +10 -1
- package/dist/react/likert.js +11 -1
- package/dist/react/line.js +9 -1
- package/dist/react/mekko.js +10 -1
- package/dist/react/pareto.js +11 -1
- package/dist/react/pie.js +9 -1
- package/dist/react/prepare.js +49 -21
- package/dist/react/pvm.js +12 -1
- package/dist/react/pyramid.js +10 -1
- package/dist/react/sankey.js +10 -1
- package/dist/react/scatter.js +8 -1
- package/dist/react/slope.js +10 -1
- package/dist/react/sparkline.js +10 -1
- package/dist/react/spec.js +24 -14
- package/dist/react/status.js +9 -1
- package/dist/react/story.js +5 -2
- package/dist/react/table.js +9 -1
- package/dist/react/theme.js +10 -3
- package/dist/react/tilemap.js +9 -1
- package/dist/react/treemap.js +9 -1
- package/dist/react/variance.js +10 -1
- package/dist/react/waffle.js +9 -1
- package/dist/react/waterfall.js +11 -1
- package/dist/{resvg-VB7S5HRF.js → resvg-ZYEZTSUO.js} +3 -1
- package/dist/rows.js +3 -2
- package/dist/{rowsModule-LI6KOS46.js → rowsModule-H2S6WW4D.js} +2 -1
- package/dist/{schema-CGQID64D.js → schema-2R32F6AW.js} +1 -1
- package/dist/{schema-H2EC4GAQ.js → schema-2TPGJGVR.js} +1 -1
- package/dist/{schema-THXXFY6I.js → schema-47BG2TZA.js} +1 -3
- package/dist/{schema-AMT7P7KB.js → schema-56MOEOVR.js} +1 -1
- package/dist/{schema-GNTKL5DN.js → schema-5MSR4LNN.js} +1 -1
- package/dist/{schema-5ZTGVQAJ.js → schema-5RIYEWE6.js} +1 -1
- package/dist/{schema-LOQ3AFC7.js → schema-A26ZNGTZ.js} +1 -3
- package/dist/{schema-MMVPMJEF.js → schema-ALBF6V7Y.js} +1 -3
- package/dist/{schema-BKUFZLLI.js → schema-BA6WP5YZ.js} +1 -1
- package/dist/{schema-PQZWO3BP.js → schema-CBL2SMVR.js} +1 -3
- package/dist/{schema-BBTXTWYI.js → schema-CWKGLDSR.js} +1 -3
- package/dist/{schema-5KDEQBBT.js → schema-DBIQFL56.js} +1 -1
- package/dist/{schema-KPEPBGAX.js → schema-DL7V6NN2.js} +1 -1
- package/dist/{schema-PL3EU6EQ.js → schema-DUVJMFKQ.js} +4 -2
- package/dist/{schema-L5U4OROI.js → schema-ECJERHKF.js} +2 -1
- package/dist/{schema-YLE4XXQQ.js → schema-EDSEKZDJ.js} +1 -1
- package/dist/{schema-HH5HOORE.js → schema-ESR6ZIK4.js} +1 -3
- package/dist/{schema-5DUTAVO7.js → schema-F7TWGLRZ.js} +1 -3
- package/dist/{schema-B2GCEYXD.js → schema-FGB6IGZM.js} +1 -3
- package/dist/{schema-7NSV542V.js → schema-FKGGTM4Z.js} +2 -1
- package/dist/{schema-72EEMYS3.js → schema-FU2AFIEE.js} +1 -1
- package/dist/{schema-QORUB6EK.js → schema-JNJFCYBM.js} +18 -1
- package/dist/{schema-JH57NFXJ.js → schema-JYZ4RF6S.js} +2 -1
- package/dist/{schema-25INXAMY.js → schema-K7F6TEDK.js} +1 -2
- package/dist/{schema-OU35XA3Z.js → schema-KAK6DZX4.js} +1 -1
- package/dist/{schema-R5Y6NVBH.js → schema-MOKWIGF7.js} +1 -1
- package/dist/{schema-ZQSIR5UC.js → schema-MQT6BMNK.js} +1 -3
- package/dist/{schema-FDFQKIO5.js → schema-MR3BPPQR.js} +1 -1
- package/dist/{schema-VYECMPON.js → schema-OPXZYIW7.js} +1 -3
- package/dist/{schema-ZEVJMFLV.js → schema-PV7JGX5H.js} +1 -1
- package/dist/{schema-QPOBZUAR.js → schema-PWPQF5RC.js} +1 -1
- package/dist/{schema-GN6GAIU5.js → schema-PYQEUC5P.js} +1 -3
- package/dist/{schema-M5JBHQIV.js → schema-QPIC5MAG.js} +9 -2
- package/dist/{schema-QCIE6M2P.js → schema-R42VXFIS.js} +1 -1
- package/dist/{schema-J7TNCZIP.js → schema-TVUJNEX7.js} +1 -1
- package/dist/{schema-AXRDF6ND.js → schema-Y4TI2T3T.js} +1 -1
- package/dist/{schema-ZG6ZKFRZ.js → schema-ZU2EU2VP.js} +1 -1
- package/dist/{specValidation-VHLGDEME.js → specValidation-2NHJT7TQ.js} +4 -1
- package/dist/theme.js +7 -2
- package/dist/{themeShapeRules-PW4BQHKL.js → themeShapeRules-G7UZX6GJ.js} +1 -1
- package/dist/types/core/annotate.d.ts +27 -2
- package/dist/types/core/annotateArms.d.ts +3 -1
- package/dist/types/core/annotateTargets.d.ts +4 -0
- package/dist/types/core/annotationOrigin.d.ts +13 -0
- package/dist/types/core/axis.d.ts +2 -2
- package/dist/types/core/charts/band/stacks.d.ts +7 -1
- package/dist/types/core/charts/bartable/types.d.ts +14 -1
- package/dist/types/core/charts/box/types.d.ts +3 -1
- package/dist/types/core/charts/choropleth/layout.d.ts +1 -5
- package/dist/types/core/charts/choropleth/types.d.ts +19 -0
- package/dist/types/core/charts/cohort/types.d.ts +16 -3
- package/dist/types/core/charts/column/model.d.ts +13 -0
- package/dist/types/core/charts/combo/layout.d.ts +7 -0
- package/dist/types/core/charts/creative/types.d.ts +21 -0
- package/dist/types/core/charts/dimswitch/compile.d.ts +15 -2
- package/dist/types/core/charts/dimswitch/types.d.ts +24 -1
- package/dist/types/core/charts/gantt/calendar.d.ts +24 -0
- package/dist/types/core/charts/gantt/columns.d.ts +56 -0
- package/dist/types/core/charts/gantt/layout.d.ts +8 -2
- package/dist/types/core/charts/gantt/model.d.ts +296 -0
- package/dist/types/core/charts/grid/metricStack.d.ts +9 -0
- package/dist/types/core/charts/grid/metricStackSchema.d.ts +13 -0
- package/dist/types/core/charts/grid/normalize.d.ts +5 -0
- package/dist/types/core/charts/grid/schema.d.ts +2 -2
- package/dist/types/core/charts/histogram/types.d.ts +8 -0
- package/dist/types/core/charts/likert/layout.d.ts +10 -8
- package/dist/types/core/charts/pareto/layout.d.ts +2 -0
- package/dist/types/core/charts/pvm/types.d.ts +10 -1
- package/dist/types/core/charts/pyramid/types.d.ts +3 -1
- package/dist/types/core/charts/sankey/types.d.ts +5 -1
- package/dist/types/core/charts/scatter/clamp.d.ts +2 -1
- package/dist/types/core/charts/scatter/model.d.ts +5 -0
- package/dist/types/core/charts/scatter/valueLines.d.ts +3 -1
- package/dist/types/core/charts/status/layout.d.ts +3 -0
- package/dist/types/core/charts/table/resolve.d.ts +22 -3
- package/dist/types/core/charts/table/view.d.ts +24 -1
- package/dist/types/core/claims/browser.d.ts +2 -0
- package/dist/types/core/claims/ids.d.ts +38 -0
- package/dist/types/core/deferred.d.ts +1 -0
- package/dist/types/core/doc/diagnostics.d.ts +3 -2
- package/dist/types/core/footer.d.ts +2 -0
- package/dist/types/core/formatSpec.d.ts +43 -14
- package/dist/types/core/frame.d.ts +26 -59
- package/dist/types/core/frameText.d.ts +203 -0
- package/dist/types/core/geo/types.d.ts +2 -0
- package/dist/types/core/geometry.d.ts +3 -1
- package/dist/types/core/label/categoryRow.d.ts +19 -2
- package/dist/types/core/label/solver.d.ts +23 -2
- package/dist/types/core/normalize/shared.d.ts +14 -2
- package/dist/types/core/notes.d.ts +15 -2
- package/dist/types/core/reading.d.ts +12 -1
- package/dist/types/core/registry.d.ts +4 -5
- package/dist/types/core/request.d.ts +7 -1
- package/dist/types/core/schema/capability.d.ts +32 -7
- package/dist/types/core/schema/generatedColumns.d.ts +168 -0
- package/dist/types/core/seriesIdentity.d.ts +4 -1
- package/dist/types/core/sizing.d.ts +32 -1
- package/dist/types/core/structureCounts.d.ts +3 -1
- package/dist/types/core/text.d.ts +16 -0
- package/dist/types/core/theme.d.ts +33 -4
- package/dist/types/core/themeGeometry.d.ts +9 -0
- package/dist/types/core/themeRules.d.ts +2 -0
- package/dist/types/core/timeAxis.d.ts +6 -1
- package/dist/types/core/types/annotations.d.ts +74 -4
- package/dist/types/core/types/diagram.d.ts +7 -0
- package/dist/types/core/types/options.d.ts +118 -15
- package/dist/types/core/types/scene.d.ts +30 -2
- package/dist/types/core/types/table.d.ts +27 -3
- package/dist/types/core/types/theme.d.ts +23 -0
- package/dist/types/index.d.ts +2 -0
- package/dist/types/react/TableChart.d.ts +5 -0
- package/dist/types/react/barrelCharts.d.ts +16 -5
- package/dist/types/react/charts/butterfly.d.ts +2 -2
- package/dist/types/react/charts/dot.d.ts +7 -1
- package/dist/types/react/charts/pareto.d.ts +4 -1
- package/dist/types/react/charts/variance.d.ts +3 -1
- package/dist/types/react/hover/labelCard.d.ts +11 -2
- package/dist/types/react/prepare.d.ts +7 -1
- package/dist/types/theme.d.ts +2 -0
- package/dist/validate.js +23 -6
- package/docs/TELEMETRY.md +2 -2
- package/docs/manual.md +283 -65
- package/docs/reference/bar.md +15 -4
- package/docs/reference/bartable.md +17 -2
- package/docs/reference/box.md +15 -4
- package/docs/reference/bullet.md +21 -6
- package/docs/reference/butterfly.md +17 -6
- package/docs/reference/choropleth.md +16 -5
- package/docs/reference/cohort.md +25 -5
- package/docs/reference/column.md +19 -4
- package/docs/reference/combo.md +11 -5
- package/docs/reference/creative.md +17 -8
- package/docs/reference/diagram.md +6 -1
- package/docs/reference/dimswitch.md +71 -118
- package/docs/reference/dot.md +16 -7
- package/docs/reference/fixtures.md +94 -1
- package/docs/reference/funnel.md +14 -5
- package/docs/reference/gantt.md +17 -16
- package/docs/reference/grid.md +13 -3
- package/docs/reference/heatmap.md +16 -6
- package/docs/reference/histogram.md +2 -2
- package/docs/reference/kpi.md +5 -1
- package/docs/reference/likert.md +17 -4
- package/docs/reference/line.md +18 -5
- package/docs/reference/mekko.md +10 -5
- package/docs/reference/options.md +20 -15
- package/docs/reference/pareto.md +9 -5
- package/docs/reference/pie.md +9 -5
- package/docs/reference/pvm.md +16 -6
- package/docs/reference/pyramid.md +14 -4
- package/docs/reference/react.md +6 -7
- package/docs/reference/sankey.md +7 -3
- package/docs/reference/scatter.md +8 -4
- package/docs/reference/slope.md +15 -5
- package/docs/reference/sparkline.md +1 -1
- package/docs/reference/status.md +7 -1
- package/docs/reference/table.md +41 -110
- package/docs/reference/theme.md +12 -4
- package/docs/reference/tilemap.md +2 -4
- package/docs/reference/treemap.md +1 -1
- package/docs/reference/variance.md +12 -6
- package/docs/reference/waffle.md +1 -1
- package/docs/reference/warnings.md +1077 -0
- package/docs/reference/waterfall.md +20 -5
- package/docs/use-cases.md +25 -13
- package/llms.txt +19 -6
- package/package.json +18 -3
- package/dist/chunk-6364WO5D.js +0 -47
- package/dist/chunk-DQ7YMQVX.js +0 -26
- package/dist/chunk-EBB4PYBN.js +0 -24
- package/dist/chunk-FG5L2LUK.js +0 -89
- package/dist/chunk-IFQN4GKK.js +0 -1852
- package/dist/chunk-IRXVV65V.js +0 -24
- package/dist/chunk-JGFHNAHS.js +0 -22
- package/dist/chunk-JHWYG7V5.js +0 -24
- package/dist/chunk-M4SPKUZE.js +0 -7
- package/dist/chunk-O36WX56O.js +0 -13
- package/dist/chunk-QJWLNP64.js +0 -24
- package/dist/chunk-QZIHKQRH.js +0 -26
- package/dist/chunk-SE7MJ2LQ.js +0 -24
- package/dist/chunk-TXBO2LWM.js +0 -25
- package/dist/chunk-UPTXFTKH.js +0 -25
- package/dist/chunk-UREXN6WG.js +0 -25
- package/dist/chunk-UZLR25BW.js +0 -24
- package/dist/chunk-WIVFIVFZ.js +0 -27
- package/dist/chunk-WZL4EEBS.js +0 -11
- package/dist/chunk-XHRUXZD7.js +0 -28
- package/dist/chunk-ZWNRLIFT.js +0 -24
package/docs/reference/bar.md
CHANGED
|
@@ -101,6 +101,8 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
101
101
|
| labelDensity | string | `'full'`, `'smart'`, `'minimal'` | | Value-label density. Default 'smart': every value stays eligible. A chart with more than 12 categories, or with most labels wider than the band, ranks the first, last, highest and lowest value (ties: the first) first. The other values then use only their natural seat beside the mark; with none free they are drawn nowhere and left out of the note. Those four may take one step, and the note names any that finds no seat. A smaller chart keeps every value on the bounded one-step rule and names any that finds no seat. 'full' treats all values alike and names every one that finds no seat. 'minimal' also applies the shared priority gate. Seats stay inside the plot band and one step from the natural seat. All values remain in reading records. When valueLabels is set, it wins: labelDensity is not read for the value labels. |
|
|
102
102
|
| legend | string \| object | `'top'`, `'bottom'`, `'right'`, `'left'`, `'none'`, `'auto'` (or another value of its type) | | Key position. Multiple series get a key by default unless visible direct labels name them all. 'none' hides the key and warns if names are missing. Subtitle and footnote mentions do not replace the key. |
|
|
103
103
|
| valueAxis.break | false \| object | `false` (or another value of its type) | | No break by default or with false. Set { from, to, style? } for a straight value-axis break; the omitted span collapses to a fixed 12px gap when valid. Automatic placement is supported only by waterfall and pvm. |
|
|
104
|
+
| columnOverrides | object | | | Settings per generated column. Ids: label. |
|
|
105
|
+
| columnOverrides.*.width | number | | | Track width in px. It beats the width the type would pick. |
|
|
104
106
|
| axisTitles | object | | | Title of the value axis when valueAxis.show draws it: in the tick-label row, ending at the right end of the axis past the last tick label or short of the first tick label, and in a row of its own under the ticks only when neither side has room. A theme with valueAxis.titles derives 'Measure, unit' from subtitle.measure and a unit the drawn subtitle does not print, when none is authored. |
|
|
105
107
|
| axisTitles.primary | string | | | 'Measure, unit' title of the value axis, e.g. 'Margin, %'. |
|
|
106
108
|
| valueLabels | string | `'none'`, `'last'`, `'ends'`, `'extremes'`, `'all'` | | Which values print, with line's choices: 'none', 'last', 'ends' (first and last), 'extremes' (first, last, highest and lowest; a tie takes the first) or 'all', chosen per series over the categories in their drawn order. Unset (default): every value is eligible and labelDensity decides. When set, valueLabels wins over labelDensity: each chosen value takes the one-step rule of 'full', and one with no seat is named in the note. A value not chosen is unlabelled by choice: the note does not name it, and the value axis is drawn so it stays readable (all modes but 'all'; valueAxis.show false turns it off). Authored cell labels print in every mode. Grouped only: a stack has no single value per category, so stacked, stacked100, football-field and tornado ignore every mode but 'all' with an option-ignored warning and keep their normal labels and value axis. Example: a ranking of 12 bars with 'extremes' prints the top, bottom, highest and lowest value. |
|
|
@@ -142,13 +144,17 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
142
144
|
|---|---|---|---|---|---|
|
|
143
145
|
| 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. 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. |
|
|
144
146
|
| 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. |
|
|
145
|
-
| 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.
|
|
147
|
+
| 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. |
|
|
146
148
|
| 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. |
|
|
147
|
-
| 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 |
|
|
149
|
+
| 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. | Drawn reference series accept anchors. |
|
|
148
150
|
| 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. |
|
|
149
|
-
| diff | Draws a level-difference arrow between two anchors and computes either percent change or their signed value difference. | from, to | from: AnchorRef; to: AnchorRef | mode: relative \| absolute \| reversed, default relative. relative prints the percent change from 'from' to 'to', reversed the change from 'to' to 'from', absolute the value difference. | Mode defaults to relative. Relative and reversed changes need a nonzero base; negative bases use its absolute magnitude and emit a warning. Absolute mode reports the raw value difference. A hidden label removes its arm. Drawn reference series accept anchors. |
|
|
151
|
+
| diff | Draws a level-difference arrow between two anchors and computes either percent change or their signed value difference. | from, to | from: AnchorRef; to: AnchorRef | mode: relative \| absolute \| reversed \| both, default relative. relative prints the percent change from 'from' to 'to', reversed the change from 'to' to 'from', absolute the value difference, both the value difference with the percent change beside it. | Mode defaults to relative. Relative and reversed changes need a nonzero base; negative bases use its absolute magnitude and emit a warning. Absolute mode reports the raw value difference. A hidden label removes its arm. Drawn reference series accept anchors. |
|
|
150
152
|
| band | Draws an inclusive category span as a shaded band or bracket, or a value-axis plan corridor, tolerance band or attainment fill, with a collision-managed label. | | from: categoryId (optional); to: categoryId (optional) | | Era shade/bracket needs inclusive category IDs. Corridor and tolerance use finite low/high on the value scale, with optional from/to as a category clip. Attainment needs a plan value and shades each resolved actual; missing cells are skipped. Divider applies only to bracket bands. Scenario AC/PY/PL/FC paints a plan corridor (default PL). |
|
|
151
|
-
| cagr | Draws a growth arrow between two anchored points and computes the compound annual growth rate from their values and ISO-date span. | | from: AnchorRef (optional); to: AnchorRef (optional) | suffix: string, default 'p.a.'. Text after the rate. period: boolean. Print the period before the rate from the anchors' category labels, '2014–2019: +5.8% p.a.'. Default true when the chart carries two or more CAGRs, so nested brackets are told apart by their text, false otherwise. An arrow's ends show its span, so an arrow prints the rate alone unless period is true. shape: bracket \| arrow, default bracket. arrow draws one straight arrow over the marks with the rate in an oval on it, lifted until it clears them. Where no straight line clears the chart, the span is too short for the oval, a stack's inner layer is the anchor or the chart lays comparisons out itself, it draws the bracket and warns cagr-arrow-no-room. | Omitted endpoints span the first to the last category, or the first to the last total on a waterfall. Resolved endpoints need a positive date interval from ISO dates or year-bearing labels and a positive start value; an end of zero reads -100%, and a start at or below zero or a negative end omits the rate and warns cagr-undefined. On a continuous time axis the years are the exact span between the two readings. An anchor on one series of several (seriesId, or a line
|
|
153
|
+
| cagr | Draws a growth arrow between two anchored points and computes the compound annual growth rate from their values and ISO-date span. | | from: AnchorRef (optional); to: AnchorRef (optional) | suffix: string, default 'p.a.'. Text after the rate. period: boolean. Print the period before the rate from the anchors' category labels, '2014–2019: +5.8% p.a.'. Default true when the chart carries two or more CAGRs, so nested brackets are told apart by their text, false otherwise. An arrow's ends show its span, so an arrow prints the rate alone unless period is true. shape: bracket \| arrow, default bracket. arrow draws one straight arrow over the marks with the rate in an oval on it, lifted until it clears them. Where no straight line clears the chart, the span is too short for the oval, a stack's inner layer is the anchor or the chart lays comparisons out itself, it draws the bracket and warns cagr-arrow-no-room. | Omitted endpoints span the first to the last category, or the first to the last total on a waterfall. Resolved endpoints need a positive date interval from ISO dates or year-bearing labels and a positive start value; an end of zero reads -100%, and a start at or below zero or a negative end omits the rate and warns cagr-undefined. On a continuous time axis the years are the exact span between the two readings. An anchor on one series of several (seriesId, or a category of an unstacked line, which reads the first drawn series; on a stack a category reads the stack total) names that series in the label, "Product B +10.1% p.a.", and the arm runs from that series' segment or point. In text, ${value} prints the rate with its suffix, so "CAGR 2014–2019: ${value}" keeps the computed number. Drawn reference series accept anchors. |
|
|
154
|
+
| 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. |
|
|
155
|
+
| 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. |
|
|
156
|
+
| 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. |
|
|
157
|
+
| box | Draws an unfilled box with two points as opposite corners, wrapping whole category bands, in the ink and rule width of a bracket; text inside the box stays free. | from, to | from: AnchorRef \| { categoryId, value }; to: AnchorRef \| { categoryId, value } | dashed: boolean, default false. Draws the edges 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. from and to are opposite corners, the box has no fill, and text inside it stays free. A { categoryId, value } corner spans that category's whole band, so the box wraps whole bars, values and markers; from and to on one category wrap that category. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
152
158
|
|
|
153
159
|
## Dense value labels
|
|
154
160
|
|
|
@@ -194,6 +200,8 @@ Below the floor a render is refused with `size-below-floor` and the pixels it ne
|
|
|
194
200
|
| option-dashed-connectors | example | Product mix across quarters |
|
|
195
201
|
| plan-corridor | example | Horizontal plan corridor on regional revenue |
|
|
196
202
|
| grouped-cloud-cagr | example | Grouped bars with a series CAGR arrow and last-year difference |
|
|
203
|
+
| diff-on-arrow | example | Difference between two regions on its arrow |
|
|
204
|
+
| diff-beside-arrow | example | Difference with placement 'label': the arrow off the rows |
|
|
197
205
|
| tolerance-band | example | Regional values against an authored tolerance band |
|
|
198
206
|
| bar-compact-380 | example | Bar in a 380px dashboard column |
|
|
199
207
|
| torture-long-labels | torture | Torture: long names at a generous size read whole, never cut |
|
|
@@ -223,3 +231,6 @@ Below the floor a render is refused with `size-below-floor` and the pixels it ne
|
|
|
223
231
|
| option-small-values-scientific | torture | Turku prints a power of ten (smallValues scientific) |
|
|
224
232
|
| option-small-values-p-value | torture | Every rate prints as an APA p-value (smallValues p-value) |
|
|
225
233
|
| key-left | example | Stacked bars with the key in a column left of the plot |
|
|
234
|
+
| column-overrides | example | columnOverrides sets the width of the name column |
|
|
235
|
+
| centered-values | example | Bar values at the center |
|
|
236
|
+
| drawing-on-value-axis | example | A line at the top level and an arrow over the gap, on a horizontal value axis |
|
|
@@ -101,7 +101,17 @@ Table rows with number columns and stacked bars. One panel when the rows compare
|
|
|
101
101
|
|
|
102
102
|
| Path | Type | Values | Default | Meaning |
|
|
103
103
|
|---|---|---|---|---|
|
|
104
|
+
| labels | object | | | Which printed values stay. |
|
|
105
|
+
| labels.point | false | `false` | | false stops the values in the segments and at the bar ends, in panels and in a cascade. Number columns, shares, growth and the Total row keep their numbers; hover and records keep the values. A missing row keeps its mark. |
|
|
104
106
|
| total | boolean | | `true` | Closing Total row, labelled with strings.total; default true. Summed number columns print their sum; a panel prints the summed ranges when a row has one (a row without counts its sum at both ends), else the sum of the bars, as text without a bar. |
|
|
107
|
+
| totalPosition | string | `'top'`, `'bottom'` | | Where the Total row stands, with its rule and ground; default 'bottom'. Works under cascade. With total false it warns option-ignored. |
|
|
108
|
+
| columnOverrides | object | | | Settings per generated column. Ids: label, each data.columns id and each data.panels id. |
|
|
109
|
+
| columnOverrides.*.width | number | | | Track width in px. It beats the width the type would pick. |
|
|
110
|
+
| columnOverrides.*.align | string | `'left'`, `'right'`, `'center'` | | Alignment of the column: its cell text and, unless headAlign is set, its head. Bars keep starting at the panel origin. |
|
|
111
|
+
| columnOverrides.*.headAlign | string | `'left'`, `'right'`, `'center'` | | Head alignment; defaults to align. |
|
|
112
|
+
| columnOverrides.*.label | string | | | Head text. |
|
|
113
|
+
| columnOrder | array | | | Order of whole blocks; blocks left out follow in default order. Ids: numbers, panels. |
|
|
114
|
+
| columnHeads | false | `false` | | false: no visible head row and no group heads, with their height and rule. Assistive technology still reads the head in React, and sortable warns there. |
|
|
105
115
|
| combinedShare | object | | | A note with the combined share of these rows in each summed panel: their sum over the panel's, at the low and the high end where rows carry ranges ('Core segments: 120 of 300 $bn at the low end, 40%; 210 of 500 at the high end, 42%'). A row id that names no row is refused. |
|
|
106
116
|
| combinedShare.rows | array | | | Row ids whose combined share prints; at least two, each once. |
|
|
107
117
|
| combinedShare.label | string | | | What the rows are called together in the note; default their labels joined with 'and'. |
|
|
@@ -112,12 +122,12 @@ Table rows with number columns and stacked bars. One panel when the rows compare
|
|
|
112
122
|
| cascade.share | boolean | | | Computed share column beside each panel; default true. rounding defaults to 'sum-consistent' here, so each adds up to 100%. |
|
|
113
123
|
| cascade.growth | object | | | Growth column after the last panel. |
|
|
114
124
|
| cascade.growth.measure | string | `'cagr'`, `'share-change'` | | 'cagr': each row's CAGR, first panel to last, in %. 'share-change': last share minus first, in pp. |
|
|
115
|
-
| cascade.growth.years | number | | | Years from first to last panel for 'cagr'; default read from the panel labels (2019, FY24). |
|
|
125
|
+
| cascade.growth.years | number | | | Years from first to last panel for 'cagr'; default read from the panel labels (2019, FY24). 'share-change' reads no years and warns option-ignored. |
|
|
116
126
|
| cascade.growth.label | string | | | Column head; default from the panel labels. |
|
|
117
127
|
| sharedScale | boolean | | | false: each panel its own scale. true: one scale, panel width follows its longest bar; weights refused. Default false, true under cascade. |
|
|
118
128
|
| heightFill | string | `'rows'`, `'none'` | `'rows'` | Spare canvas height. 'rows' (default): a pinned canvas stretches the rows up to 1.25 times their pitch and thickens the bars. 'none': natural pitch. |
|
|
119
129
|
|
|
120
|
-
Plus the [shared options](options.md). This type does not accept `detailFields`, `
|
|
130
|
+
Plus the [shared options](options.md). This type does not accept `detailFields`, `labelPosition`, `valueAxis`, `hatchStrength`, `annotations`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `sort`, `topN`, `bandFraction`, `valueAxis.show`, `valueAxis.gridlines`, `highlight` with an `option-ignored` warning.
|
|
121
131
|
|
|
122
132
|
## Annotations
|
|
123
133
|
|
|
@@ -141,6 +151,11 @@ Below the floor a render is refused with `size-below-floor` and the pixels it ne
|
|
|
141
151
|
| cascade-two-periods | example | Share cascade over two periods: rows coloured by a row group, two residual rows pinned last, share columns, a bracket and a CAGR column |
|
|
142
152
|
| cascade-two-periods-theme-total | example | Share cascade over two periods with the Total bar in the theme total colour, even where it equals a group colour |
|
|
143
153
|
| cascade-four-years | example | Share cascade over four years: product-category revenue share with the share change in pp |
|
|
154
|
+
| columns-reordered | example | Panels before the number columns |
|
|
155
|
+
| total-top | example | The Total row above the rows, with its rule and ground |
|
|
156
|
+
| no-values | example | No values at the bars: number columns and the Total keep theirs |
|
|
157
|
+
| column-widths | example | Authored widths, alignment and heads per column |
|
|
158
|
+
| no-column-heads | example | No head row: the first row starts at the top of the table |
|
|
144
159
|
|
|
145
160
|
## Not for
|
|
146
161
|
|
package/docs/reference/box.md
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# Box plot (distribution comparison)
|
|
2
2
|
|
|
3
|
+
Contents: [Use cases](#use-cases), [Chart IDs](#chart-ids), [Minimal spec](#minimal-spec), [Data](#data), [Options](#options), [Annotations](#annotations), [Sizing](#sizing), [Fixtures](#fixtures), [Not for](#not-for).
|
|
4
|
+
|
|
3
5
|
<!-- Generated by scripts/generate-reference.mjs from the boardplot describe, list and fixtures payloads. -->
|
|
4
6
|
|
|
5
7
|
Compares group distributions from raw observations — type-7 quartiles, a declared whisker rule, individually drawn outliers, and a mandatory per-group n. Type `box`. Aliases: `boxplot`, `box-and-whisker`.
|
|
@@ -48,6 +50,10 @@ One form; its chart ID is `box`.
|
|
|
48
50
|
| Path | Type | Values | Default | Meaning |
|
|
49
51
|
|---|---|---|---|---|
|
|
50
52
|
| valueAxis.break | false \| object | `false` (or another value of its type) | | No break by default or with false. Set { from, to, style? } for a straight value-axis break; the omitted span collapses to a fixed 12px gap when valid. Automatic placement is supported only by waterfall and pvm. |
|
|
53
|
+
| columnOverrides | object | | | Settings per generated column. Ids: label, n, median. |
|
|
54
|
+
| columnOverrides.*.width | number | | | Track width in px. It beats the width the type would pick. |
|
|
55
|
+
| columnOverrides.*.headAlign | string | `'left'`, `'right'`, `'center'` | | Head alignment; defaults to align. |
|
|
56
|
+
| columnOverrides.*.label | string | | | Head text. |
|
|
51
57
|
| axisTitles | object | | | Title of the value axis when it is drawn: under the tick row, ending at the right end of the axis. Drawn only when authored. |
|
|
52
58
|
| axisTitles.primary | string | | | 'Measure, unit' title of the value axis, e.g. 'Margin, %'. |
|
|
53
59
|
| whiskers | string | `'tukey'`, `'minmax'`, `'p10p90'` | `'tukey'` | Whisker rule. 'tukey' (default): most extreme observations within 1.5xIQR of the quartiles. 'minmax': whiskers reach every observation. 'p10p90': whiskers at the 10th/90th type-7 percentile. |
|
|
@@ -56,7 +62,7 @@ One form; its chart ID is `box`.
|
|
|
56
62
|
| methodNote | boolean | | `false` | Default false. true adds the footnote stating the quartile definition and the Tukey whisker rule. A 'minmax' or 'p10p90' whisker rule changes what whiskers and dots mean, so its note prints regardless, as do the small-n dot note and the note on withheld observations. |
|
|
57
63
|
| boxValues | string | `'median'`, `'all'` | `'median'` | Default 'median': each box prints its median. 'all' also prints Q1 and Q3 under the box edges and the whisker ends under the caps, so a quartile or percentile reads as a number. |
|
|
58
64
|
|
|
59
|
-
Plus the [shared options](options.md). This type does not accept `detailFields`, `valueAxis.log`, `hatchStrength`, `rounding`. This type ignores `animate`, `debug`, `categoryAxis`, `categoryLabels`, `topN`, `bandFraction`, `legend` with an `option-ignored` warning.
|
|
65
|
+
Plus the [shared options](options.md). This type does not accept `detailFields`, `labelPosition`, `valueAxis.tickStep`, `valueAxis.includeZero`, `valueAxis.percent`, `valueAxis.log`, `valueAxis.reverse`, `hatchStrength`, `rounding`. This type ignores `animate`, `debug`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `topN`, `bandFraction`, `legend` with an `option-ignored` warning.
|
|
60
66
|
|
|
61
67
|
## Annotations
|
|
62
68
|
|
|
@@ -64,9 +70,13 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
64
70
|
|
|
65
71
|
| Kind | Purpose | Required | Anchors | Optional fields | Notes |
|
|
66
72
|
|---|---|---|---|---|---|
|
|
67
|
-
| cagr | Draws a growth arrow between two anchored points and computes the compound annual growth rate from their values and ISO-date span. | | from: AnchorRef (optional); to: AnchorRef (optional) | suffix: string, default 'p.a.'. Text after the rate. period: boolean. Print the period before the rate from the anchors' category labels, '2014–2019: +5.8% p.a.'. Default true when the chart carries two or more CAGRs, so nested brackets are told apart by their text, false otherwise. An arrow's ends show its span, so an arrow prints the rate alone unless period is true. shape: bracket \| arrow, default bracket. arrow draws one straight arrow over the marks with the rate in an oval on it, lifted until it clears them. Where no straight line clears the chart, the span is too short for the oval, a stack's inner layer is the anchor or the chart lays comparisons out itself, it draws the bracket and warns cagr-arrow-no-room. | Omitted endpoints span the first to the last category, or the first to the last total on a waterfall. Resolved endpoints need a positive date interval from ISO dates or year-bearing labels and a positive start value; an end of zero reads -100%, and a start at or below zero or a negative end omits the rate and warns cagr-undefined. On a continuous time axis the years are the exact span between the two readings. An anchor on one series of several (seriesId, or a line
|
|
68
|
-
| diff | Draws a level-difference arrow between two anchors and computes either percent change or their signed value difference. | from, to | from: AnchorRef; to: AnchorRef | mode: relative \| absolute \| reversed, default relative. relative prints the percent change from 'from' to 'to', reversed the change from 'to' to 'from', absolute the value difference. | Mode defaults to relative. Relative and reversed changes need a nonzero base; negative bases use its absolute magnitude and emit a warning. Absolute mode reports the raw value difference. A hidden label removes its arm. |
|
|
69
|
-
| 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 |
|
|
73
|
+
| cagr | Draws a growth arrow between two anchored points and computes the compound annual growth rate from their values and ISO-date span. | | from: AnchorRef (optional); to: AnchorRef (optional) | suffix: string, default 'p.a.'. Text after the rate. period: boolean. Print the period before the rate from the anchors' category labels, '2014–2019: +5.8% p.a.'. Default true when the chart carries two or more CAGRs, so nested brackets are told apart by their text, false otherwise. An arrow's ends show its span, so an arrow prints the rate alone unless period is true. shape: bracket \| arrow, default bracket. arrow draws one straight arrow over the marks with the rate in an oval on it, lifted until it clears them. Where no straight line clears the chart, the span is too short for the oval, a stack's inner layer is the anchor or the chart lays comparisons out itself, it draws the bracket and warns cagr-arrow-no-room. | Omitted endpoints span the first to the last category, or the first to the last total on a waterfall. Resolved endpoints need a positive date interval from ISO dates or year-bearing labels and a positive start value; an end of zero reads -100%, and a start at or below zero or a negative end omits the rate and warns cagr-undefined. On a continuous time axis the years are the exact span between the two readings. An anchor on one series of several (seriesId, or a category of an unstacked line, which reads the first drawn series; on a stack a category reads the stack total) names that series in the label, "Product B +10.1% p.a.", and the arm runs from that series' segment or point. In text, ${value} prints the rate with its suffix, so "CAGR 2014–2019: ${value}" keeps the computed number. |
|
|
74
|
+
| diff | Draws a level-difference arrow between two anchors and computes either percent change or their signed value difference. | from, to | from: AnchorRef; to: AnchorRef | mode: relative \| absolute \| reversed \| both, default relative. relative prints the percent change from 'from' to 'to', reversed the change from 'to' to 'from', absolute the value difference, both the value difference with the percent change beside it. | Mode defaults to relative. Relative and reversed changes need a nonzero base; negative bases use its absolute magnitude and emit a warning. Absolute mode reports the raw value difference. A hidden label removes its arm. |
|
|
75
|
+
| 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. | |
|
|
76
|
+
| 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. |
|
|
77
|
+
| 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. |
|
|
78
|
+
| 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. |
|
|
79
|
+
| box | Draws an unfilled box with two points as opposite corners, wrapping whole category bands, in the ink and rule width of a bracket; text inside the box stays free. | from, to | from: AnchorRef \| { categoryId, value }; to: AnchorRef \| { categoryId, value } | dashed: boolean, default false. Draws the edges 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. from and to are opposite corners, the box has no fill, and text inside it stays free. A { categoryId, value } corner spans that category's whole band, so the box wraps whole bars, values and markers; from and to on one category wrap that category. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
70
80
|
|
|
71
81
|
## Sizing
|
|
72
82
|
|
|
@@ -90,6 +100,7 @@ Below the floor a render is refused with `size-below-floor` and the pixels it ne
|
|
|
90
100
|
| salary-bands-pinned-median | example | The IC5 median label pinned above its box through labelPlacements |
|
|
91
101
|
| twelve-teams-median-column | example | Twelve dense rows print their medians in one column beside n |
|
|
92
102
|
| outliers-axis-break | example | A value-axis break across the empty range keeps two far outliers visible |
|
|
103
|
+
| column-overrides | example | columnOverrides sets the name and n columns |
|
|
93
104
|
|
|
94
105
|
## Not for
|
|
95
106
|
|
package/docs/reference/bullet.md
CHANGED
|
@@ -52,8 +52,15 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
52
52
|
|
|
53
53
|
| Path | Type | Values | Default | Meaning |
|
|
54
54
|
|---|---|---|---|---|
|
|
55
|
-
| labels | false \| object | `false` (or another value of its type) | | False hides value, target-value and delta labels. Row names, band names and band-edge numbers remain. category: false hides row names. density: compact draws no labels. |
|
|
55
|
+
| labels | false \| object | `false` (or another value of its type) | | False hides value, target-value and delta labels. Row names, band names and band-edge numbers remain. category: false hides row names. position: false drops the line under each gap (below, above or on target) and direction: false the line under each name (higher or lower is better); annotation: false still drops all of them. strings.lowerBetter '' equals direction: false on lower-is-better rows. density: compact draws no labels. |
|
|
56
56
|
| sort | object \| string \| true | `'sheet'`, `'asc'`, `'desc'`, `'reverse'`, `true` (or another value of its type) | | Category ranking value: value divided by target when every row has a positive target, otherwise raw value. desc puts the highest ranking value first even on lower-is-better rows. Ties keep authored order and null values sort last. sheet keeps authored order and reverse reverses it. Dated rows keep authored order when a growth or difference annotation spans periods. |
|
|
57
|
+
| columnOverrides | object | | | Settings per generated column. Ids: label, actual, share, delta, target, gap. |
|
|
58
|
+
| columnOverrides.*.width | number | | | Track width in px. It beats the width the type would pick. |
|
|
59
|
+
| columnOverrides.*.align | string | `'left'`, `'right'`, `'center'` | | Alignment of the column: its cell text and, unless headAlign is set, its head. Bars keep starting at the panel origin. |
|
|
60
|
+
| columnOverrides.*.headAlign | string | `'left'`, `'right'`, `'center'` | | Head alignment; defaults to align. |
|
|
61
|
+
| columnOverrides.*.label | string | | | Head text. |
|
|
62
|
+
| columnVisibility | object | | | True shows a column and false leaves it out: the ids are data.columnToggles ids on table and column ids elsewhere. Ids: label, actual, share, delta, target, gap. |
|
|
63
|
+
| columnOrder | array | | | Order of whole blocks; blocks left out follow in default order. Ids: actual, share, delta, target, gap, plot. |
|
|
57
64
|
| axisTitles | object | | | Title of the value axis when it is drawn: under the tick row of the shared-scale axis valueAxis.show draws, ending at its right end. Drawn only when authored. |
|
|
58
65
|
| axisTitles.primary | string | | | 'Measure, unit' title of the value axis, e.g. 'Margin, %'. |
|
|
59
66
|
| sharedScale | boolean \| string | `'percentOfTarget'` (or another value of its type) | | true: one absolute scale across all rows (same-unit rows, comparable magnitudes; supports valueAxis). false: each row normalized to its own zero-based extent — band maximum extended by value/target overshoot; a bandless row uses its value/target extent (the bullet-graph percent-of-scale — mixed-unit KPI rows stay legible; valueAxis is ignored with a warning). 'percentOfTarget': every row in percent of its own target (actual ÷ target) on one 0–120% scale, three shared bands named once in a key (below 80%, 80–100%, at or above target), mirrored at 100% on a lower-is-better row (the key then reads more than 20% off, up to 20% off, on target or better), one target line at 100%, value, share of target and delta beside each row; the rows' bands, valueAxis and annotations are not drawn. Default: false when every row declares bands and the rows differ in unit or band thresholds (warns bullet-row-scales), true otherwise. |
|
|
@@ -61,7 +68,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
61
68
|
| targetColumns | boolean | | `true` | true: where the rows sit side by side and the plot keeps 45% of the width, a Target column and a Gap-to-target column print beside the rows, each under a head, with the gap's position (below, above or on target) under it and the row's direction (higher or lower is better) under its name. Where they do not fit, the target prints above its tick and the delta at the row end. false: always the second form. Default true. The percentOfTarget scale has its own columns. |
|
|
62
69
|
| density | string | `'compact'`, `'regular'` | `'regular'` | 'compact' is the 120 x 28 text-free mark: bar, bands and target tick, no labels, axis or key. The percentOfTarget scale needs a key and a value column, so compact refuses it. 'regular' uses labelled stacked rows when side columns take too much plot width. Height depends on row count and text. Default 'regular'. |
|
|
63
70
|
|
|
64
|
-
Plus the [shared options](options.md). This type does not accept `detailFields`, `valueAxis.log`, `valueAxis.reverse`, `valueAxis.break`, `hatchStrength`, `rounding`. This type ignores `animate`, `debug`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `topN` with an `option-ignored` warning.
|
|
71
|
+
Plus the [shared options](options.md). This type does not accept `detailFields`, `labelPosition`, `valueAxis.log`, `valueAxis.reverse`, `valueAxis.break`, `hatchStrength`, `rounding`. This type ignores `animate`, `debug`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `topN` with an `option-ignored` warning.
|
|
65
72
|
|
|
66
73
|
## Annotations
|
|
67
74
|
|
|
@@ -69,14 +76,18 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
69
76
|
|
|
70
77
|
| Kind | Purpose | Required | Anchors | Optional fields | Notes |
|
|
71
78
|
|---|---|---|---|---|---|
|
|
72
|
-
| 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.
|
|
79
|
+
| 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. | |
|
|
73
80
|
| note | Places authored text at an anchored data element through collision avoidance, with an optional icon or status chip. | at, text | at: AnchorRef | | |
|
|
74
|
-
| 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 |
|
|
81
|
+
| 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. | |
|
|
75
82
|
| abs | Reads the anchored data value and places its formatted absolute value in a collision-managed label. | at | at: AnchorRef | | |
|
|
76
|
-
| diff | Draws a level-difference arrow between two anchors and computes either percent change or their signed value difference. | from, to | from: AnchorRef; to: AnchorRef | mode: relative \| absolute \| reversed, default relative. relative prints the percent change from 'from' to 'to', reversed the change from 'to' to 'from', absolute the value difference. | Mode defaults to relative. Relative and reversed changes need a nonzero base; negative bases use its absolute magnitude and emit a warning. Absolute mode reports the raw value difference. A hidden label removes its arm. |
|
|
77
|
-
| cagr | Draws a growth arrow between two anchored points and computes the compound annual growth rate from their values and ISO-date span. | | from: AnchorRef (optional); to: AnchorRef (optional) | suffix: string, default 'p.a.'. Text after the rate. period: boolean. Print the period before the rate from the anchors' category labels, '2014–2019: +5.8% p.a.'. Default true when the chart carries two or more CAGRs, so nested brackets are told apart by their text, false otherwise. An arrow's ends show its span, so an arrow prints the rate alone unless period is true. shape: bracket \| arrow, default bracket. arrow draws one straight arrow over the marks with the rate in an oval on it, lifted until it clears them. Where no straight line clears the chart, the span is too short for the oval, a stack's inner layer is the anchor or the chart lays comparisons out itself, it draws the bracket and warns cagr-arrow-no-room. | Omitted endpoints span the first to the last category, or the first to the last total on a waterfall. Resolved endpoints need a positive date interval from ISO dates or year-bearing labels and a positive start value; an end of zero reads -100%, and a start at or below zero or a negative end omits the rate and warns cagr-undefined. On a continuous time axis the years are the exact span between the two readings. An anchor on one series of several (seriesId, or a line
|
|
83
|
+
| diff | Draws a level-difference arrow between two anchors and computes either percent change or their signed value difference. | from, to | from: AnchorRef; to: AnchorRef | mode: relative \| absolute \| reversed \| both, default relative. relative prints the percent change from 'from' to 'to', reversed the change from 'to' to 'from', absolute the value difference, both the value difference with the percent change beside it. | Mode defaults to relative. Relative and reversed changes need a nonzero base; negative bases use its absolute magnitude and emit a warning. Absolute mode reports the raw value difference. A hidden label removes its arm. |
|
|
84
|
+
| cagr | Draws a growth arrow between two anchored points and computes the compound annual growth rate from their values and ISO-date span. | | from: AnchorRef (optional); to: AnchorRef (optional) | suffix: string, default 'p.a.'. Text after the rate. period: boolean. Print the period before the rate from the anchors' category labels, '2014–2019: +5.8% p.a.'. Default true when the chart carries two or more CAGRs, so nested brackets are told apart by their text, false otherwise. An arrow's ends show its span, so an arrow prints the rate alone unless period is true. shape: bracket \| arrow, default bracket. arrow draws one straight arrow over the marks with the rate in an oval on it, lifted until it clears them. Where no straight line clears the chart, the span is too short for the oval, a stack's inner layer is the anchor or the chart lays comparisons out itself, it draws the bracket and warns cagr-arrow-no-room. | Omitted endpoints span the first to the last category, or the first to the last total on a waterfall. Resolved endpoints need a positive date interval from ISO dates or year-bearing labels and a positive start value; an end of zero reads -100%, and a start at or below zero or a negative end omits the rate and warns cagr-undefined. On a continuous time axis the years are the exact span between the two readings. An anchor on one series of several (seriesId, or a category of an unstacked line, which reads the first drawn series; on a stack a category reads the stack total) names that series in the label, "Product B +10.1% p.a.", and the arm runs from that series' segment or point. In text, ${value} prints the rate with its suffix, so "CAGR 2014–2019: ${value}" keeps the computed number. |
|
|
78
85
|
| 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. 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. |
|
|
79
86
|
| band | Draws an inclusive category span as a shaded band or bracket, or a value-axis plan corridor, tolerance band or attainment fill, with a collision-managed label. | | from: categoryId (optional); to: categoryId (optional) | | Era shade/bracket needs inclusive category IDs. Corridor and tolerance use finite low/high on the value scale, with optional from/to as a category clip. Attainment needs a plan value and shades each resolved actual; missing cells are skipped. Divider applies only to bracket bands. Scenario AC/PY/PL/FC paints a plan corridor (default PL). |
|
|
87
|
+
| 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. |
|
|
88
|
+
| 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. |
|
|
89
|
+
| 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. |
|
|
90
|
+
| box | Draws an unfilled box with two points as opposite corners, wrapping whole category bands, in the ink and rule width of a bracket; text inside the box stays free. | from, to | from: AnchorRef \| { categoryId, value }; to: AnchorRef \| { categoryId, value } | dashed: boolean, default false. Draws the edges 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. from and to are opposite corners, the box has no fill, and text inside it stays free. A { categoryId, value } corner spans that category's whole band, so the box wraps whole bars, values and markers; from and to on one category wrap that category. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
80
91
|
|
|
81
92
|
## Sizing
|
|
82
93
|
|
|
@@ -118,3 +129,7 @@ Below the floor a render is refused with `size-below-floor` and the pixels it ne
|
|
|
118
129
|
| target-columns-off | example | targetColumns false keeps the plot its full width |
|
|
119
130
|
| band-names-on-rows | example | bandKey 'row' names each band on its row, on a shared scale with a value axis |
|
|
120
131
|
| column-words-authored | example | strings set the target and gap column words |
|
|
132
|
+
| column-overrides | example | columnOverrides sets the widths, alignment and head words of the generated columns |
|
|
133
|
+
| columns-hidden | example | columnVisibility leaves the share column out of the percent-of-target rows |
|
|
134
|
+
| plot-first | example | columnOrder puts the marks first and reverses the columns behind them |
|
|
135
|
+
| no-direction-line | example | labels.direction and labels.position drop the second lines beside the target columns |
|
|
@@ -66,7 +66,12 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
66
66
|
|
|
67
67
|
| Path | Type | Values | Default | Meaning |
|
|
68
68
|
|---|---|---|---|---|
|
|
69
|
-
| sort | object \| string \| true | `'sheet'`, `'asc'`, `'desc'`, `'reverse'`, `true` (or another value of its type) | | Category ranking value: the sortBy measure (a, b, sum or diff), default sum. categories sets sheet, reverse, asc or desc with stable ties and missing values last. A rest row stays last. Dated rows keep authored order when a growth or difference annotation spans periods.
|
|
69
|
+
| sort | object \| string \| true | `'sheet'`, `'asc'`, `'desc'`, `'reverse'`, `true` (or another value of its type) | | Category ranking value: the sortBy measure (a, b, sum or diff), default sum. categories sets sheet, reverse, asc or desc with stable ties and missing values last. A rest row stays last. Dated rows keep authored order when a growth or difference annotation spans periods. |
|
|
70
|
+
| columnOverrides | object | | | Settings per generated column. Ids: label, diff. |
|
|
71
|
+
| columnOverrides.*.width | number | | | Track width in px. It beats the width the type would pick. |
|
|
72
|
+
| columnOverrides.*.align | string | `'left'`, `'right'`, `'center'` | | Alignment of the column: its cell text and, unless headAlign is set, its head. Bars keep starting at the panel origin. |
|
|
73
|
+
| columnOverrides.*.headAlign | string | `'left'`, `'right'`, `'center'` | | Head alignment; defaults to align. |
|
|
74
|
+
| columnOverrides.*.label | string | | | Head text. |
|
|
70
75
|
| a | string | | | Series id displayed in the left pane. |
|
|
71
76
|
| b | string | | | Series id displayed in the right pane. |
|
|
72
77
|
| centerColumnWidth | number | | | Width in pixels reserved between the panes for category labels; omission uses their measured width. |
|
|
@@ -75,7 +80,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
75
80
|
| sharedScale | boolean | | `true` | Use the same value scale on both sides by default. False gives independent scales and warns that lengths are not comparable. |
|
|
76
81
|
| negatives | string | `'direction'`, `'magnitude'` | `'direction'` | A negative value: direction (default) runs its bar from the pane's zero line toward the category names, and positive bars run outward; magnitude draws the bar length of the absolute value outward in a lighter tint. |
|
|
77
82
|
|
|
78
|
-
Plus the [shared options](options.md). This type does not accept `valueAxis`, `rounding`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `valueAxis.show`, `valueAxis.gridlines` with an `option-ignored` warning.
|
|
83
|
+
Plus the [shared options](options.md). This type does not accept `valueAxis`, `rounding`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `valueAxis.show`, `valueAxis.gridlines`, `topN.threshold` with an `option-ignored` warning.
|
|
79
84
|
|
|
80
85
|
## Annotations
|
|
81
86
|
|
|
@@ -83,12 +88,16 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
83
88
|
|
|
84
89
|
| Kind | Purpose | Required | Anchors | Optional fields | Notes |
|
|
85
90
|
|---|---|---|---|---|---|
|
|
86
|
-
| cagr | Draws a growth arrow between two anchored points and computes the compound annual growth rate from their values and ISO-date span. | | from: AnchorRef (optional); to: AnchorRef (optional) | suffix: string, default 'p.a.'. Text after the rate. period: boolean. Print the period before the rate from the anchors' category labels, '2014–2019: +5.8% p.a.'. Default true when the chart carries two or more CAGRs, so nested brackets are told apart by their text, false otherwise. An arrow's ends show its span, so an arrow prints the rate alone unless period is true. shape: bracket \| arrow, default bracket. arrow draws one straight arrow over the marks with the rate in an oval on it, lifted until it clears them. Where no straight line clears the chart, the span is too short for the oval, a stack's inner layer is the anchor or the chart lays comparisons out itself, it draws the bracket and warns cagr-arrow-no-room. | Omitted endpoints span the first to the last category, or the first to the last total on a waterfall. Resolved endpoints need a positive date interval from ISO dates or year-bearing labels and a positive start value; an end of zero reads -100%, and a start at or below zero or a negative end omits the rate and warns cagr-undefined. On a continuous time axis the years are the exact span between the two readings. An anchor on one series of several (seriesId, or a line
|
|
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 |
|
|
88
|
-
| diff | Draws a level-difference arrow between two anchors and computes either percent change or their signed value difference. | from, to | from: AnchorRef; to: AnchorRef | mode: relative \| absolute \| reversed, default relative. relative prints the percent change from 'from' to 'to', reversed the change from 'to' to 'from', absolute the value difference. | Mode defaults to relative. Relative and reversed changes need a nonzero base; negative bases use its absolute magnitude and emit a warning. Absolute mode reports the raw value difference. A hidden label removes its arm. |
|
|
91
|
+
| cagr | Draws a growth arrow between two anchored points and computes the compound annual growth rate from their values and ISO-date span. | | from: AnchorRef (optional); to: AnchorRef (optional) | suffix: string, default 'p.a.'. Text after the rate. period: boolean. Print the period before the rate from the anchors' category labels, '2014–2019: +5.8% p.a.'. Default true when the chart carries two or more CAGRs, so nested brackets are told apart by their text, false otherwise. An arrow's ends show its span, so an arrow prints the rate alone unless period is true. shape: bracket \| arrow, default bracket. arrow draws one straight arrow over the marks with the rate in an oval on it, lifted until it clears them. Where no straight line clears the chart, the span is too short for the oval, a stack's inner layer is the anchor or the chart lays comparisons out itself, it draws the bracket and warns cagr-arrow-no-room. | Omitted endpoints span the first to the last category, or the first to the last total on a waterfall. Resolved endpoints need a positive date interval from ISO dates or year-bearing labels and a positive start value; an end of zero reads -100%, and a start at or below zero or a negative end omits the rate and warns cagr-undefined. On a continuous time axis the years are the exact span between the two readings. An anchor on one series of several (seriesId, or a category of an unstacked line, which reads the first drawn series; on a stack a category reads the stack total) names that series in the label, "Product B +10.1% p.a.", and the arm runs from that series' segment or point. In text, ${value} prints the rate with its suffix, so "CAGR 2014–2019: ${value}" keeps the computed number. |
|
|
92
|
+
| 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. | |
|
|
93
|
+
| diff | Draws a level-difference arrow between two anchors and computes either percent change or their signed value difference. | from, to | from: AnchorRef; to: AnchorRef | mode: relative \| absolute \| reversed \| both, default relative. relative prints the percent change from 'from' to 'to', reversed the change from 'to' to 'from', absolute the value difference, both the value difference with the percent change beside it. | Mode defaults to relative. Relative and reversed changes need a nonzero base; negative bases use its absolute magnitude and emit a warning. Absolute mode reports the raw value difference. A hidden label removes its arm. |
|
|
89
94
|
| note | Places authored text at an anchored data element through collision avoidance, with an optional icon or status chip. | at, text | at: AnchorRef | | |
|
|
90
|
-
| 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.
|
|
95
|
+
| 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. | |
|
|
91
96
|
| abs | Reads the anchored data value and places its formatted absolute value in a collision-managed label. | at | at: AnchorRef | | |
|
|
97
|
+
| 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. |
|
|
98
|
+
| 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. |
|
|
99
|
+
| 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. |
|
|
100
|
+
| box | Draws an unfilled box with two points as opposite corners, wrapping whole category bands, in the ink and rule width of a bracket; text inside the box stays free. | from, to | from: AnchorRef \| { categoryId, value }; to: AnchorRef \| { categoryId, value } | dashed: boolean, default false. Draws the edges 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. from and to are opposite corners, the box has no fill, and text inside it stays free. A { categoryId, value } corner spans that category's whole band, so the box wraps whole bars, values and markers; from and to on one category wrap that category. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
92
101
|
|
|
93
102
|
## Sizing
|
|
94
103
|
|
|
@@ -118,6 +127,8 @@ Below the floor a render is refused with `size-below-floor` and the pixels it ne
|
|
|
118
127
|
| negatives-magnitude | torture | The lighter bar of \|value\| for negative values, from negatives: magnitude |
|
|
119
128
|
| blank-values | torture | A value the data lacks prints the not-applicable mark at the pane start |
|
|
120
129
|
| own-scales-mixed | torture | Panes of very different size on their own scales each draw a value axis |
|
|
130
|
+
| column-overrides | example | columnOverrides sets the name column and the difference column, beating centerColumnWidth |
|
|
131
|
+
| centered-values | example | Butterfly values at the center |
|
|
121
132
|
|
|
122
133
|
## Not for
|
|
123
134
|
|
|
@@ -57,15 +57,13 @@ One form; its chart ID is `choropleth`.
|
|
|
57
57
|
| overlays[].glyph.shares[].tone (overlays[].glyph branch 1) | string | | Semantic glyph tone resolved through the theme. One of `'good'`, `'bad'`, `'warn'`, `'neutral'`, `'info'`. |
|
|
58
58
|
| overlays[].glyph.kind (overlays[].glyph branch 2) | string | yes | Draw a fractionally filled Harvey ball. One of `'harvey'`. |
|
|
59
59
|
| overlays[].glyph.value (overlays[].glyph branch 2) | number | yes | Filled fraction from 0, empty, to 1, full. |
|
|
60
|
-
| overlays[].glyph.tone (overlays[].glyph branch 2) | string | | Semantic glyph tone resolved through the theme. One of `'good'`, `'bad'`, `'warn'`, `'neutral'`, `'info'`. |
|
|
60
|
+
| overlays[].glyph.tone (overlays[].glyph branch 2 \| overlays[].glyph branch 4 \| overlays[].glyph branch 5) | string | | Semantic glyph tone resolved through the theme. One of `'good'`, `'bad'`, `'warn'`, `'neutral'`, `'info'`. |
|
|
61
61
|
| overlays[].glyph.kind (overlays[].glyph branch 3) | string | yes | Draw a semantic status glyph. One of `'status'`. |
|
|
62
62
|
| overlays[].glyph.status (overlays[].glyph branch 3) | string | yes | Status judgment shown by the glyph. One of `'good'`, `'bad'`, `'warn'`, `'neutral'`. |
|
|
63
63
|
| overlays[].glyph.kind (overlays[].glyph branch 4) | string | yes | Draw a named built-in icon. One of `'icon'`. |
|
|
64
64
|
| overlays[].glyph.name (overlays[].glyph branch 4) | string | yes | Name from the built-in icon catalogue: alert calendar check conversation document flag gear lightbulb lock people star target workflow. |
|
|
65
|
-
| overlays[].glyph.tone (overlays[].glyph branch 4) | string | | Semantic glyph tone resolved through the theme. One of `'good'`, `'bad'`, `'warn'`, `'neutral'`, `'info'`. |
|
|
66
65
|
| overlays[].glyph.kind (overlays[].glyph branch 5) | string | yes | Draw a geometric location marker. One of `'marker'`. |
|
|
67
66
|
| overlays[].glyph.shape (overlays[].glyph branch 5) | string | | Marker outline; defaults to circle. One of `'circle'`, `'square'`, `'diamond'`. |
|
|
68
|
-
| overlays[].glyph.tone (overlays[].glyph branch 5) | string | | Semantic glyph tone resolved through the theme. One of `'good'`, `'bad'`, `'warn'`, `'neutral'`, `'info'`. |
|
|
69
67
|
| overlays[].label | string | yes | Readable name for this overlay or pie share. |
|
|
70
68
|
| overlays[].size | string | | Glyph size tier; defaults to md. One of `'sm'`, `'md'`, `'lg'`. |
|
|
71
69
|
| overlays[].a11y | string | | Authored accessible description for the overlay. |
|
|
@@ -97,10 +95,21 @@ One form; its chart ID is `choropleth`.
|
|
|
97
95
|
| overlayTones.info | string | | | What the info tone marks on this map. |
|
|
98
96
|
| overlayMeasure | string | | | The measure the overlay glyphs show, e.g. 'Activation progress, %'. The overlay key prints it as a heading without a category swatch, apart from the colour key; Harvey-ball overlays without it warn geo-overlay-measure-unnamed. |
|
|
99
97
|
| keyTitle | string | | | Title of the colour key, naming what the colours measure. Default 'Measure, unit' from subtitle.measure and unit, else the unit alone; set it when the subtitle is drawn elsewhere. |
|
|
100
|
-
| valueTable | string \| false | `'auto'`, `'side'`, `'below'`, `false` | | The table of every region with its class swatch, code and value; the top values print bold and the map then prints codes only. 'auto' (default): beside the map when the map keeps most of the row, else under it; off above 20 regions, without numeric values, or when a pinned canvas is too short for it. 'side' or 'below' forces the place; false leaves it off. |
|
|
98
|
+
| valueTable | string \| false | `'auto'`, `'side'`, `'below'`, `false` | | The table of every region with its class swatch, code and value; the top values print bold and the map then prints codes only. 'auto' (default): beside the map when the map keeps most of the row, else under it; off above 20 regions, without numeric values, or when a pinned canvas is too short for it; an authored 'auto' that the region count turns off warns option-ignored. 'side' or 'below' forces the place; false leaves it off. |
|
|
99
|
+
| valueTableEmphasis | string \| false | `'top'`, `false` | | 'top' (default) sets the top values bold in the value table and on the map, with a rule under them. The top group is ranked on all regions. false sets no row and no map label bold. |
|
|
100
|
+
| columnVisibility | object | | | True shows a column and false leaves it out: the ids are data.columnToggles ids on table and column ids elsewhere. Ids: swatch, code, value. |
|
|
101
|
+
| columnOverrides | object | | | Settings per generated column. Ids: swatch, code, value. Only value prints a head, so label and headAlign are refused on swatch and code. |
|
|
102
|
+
| columnOverrides.*.width | number | | | Track width in px. It beats the width the type would pick. |
|
|
103
|
+
| columnOverrides.*.align | string | `'left'`, `'right'`, `'center'` | | Alignment of the column: its cell text and, unless headAlign is set, its head. Bars keep starting at the panel origin. |
|
|
104
|
+
| columnOverrides.*.headAlign | string | `'left'`, `'right'`, `'center'` | | Head alignment; defaults to align. |
|
|
105
|
+
| columnOverrides.*.label | string | | | Head text. |
|
|
106
|
+
| rowVisibility | object | | | False leaves a generated row out. Ids: each region id, through the aliases of the map pack. |
|
|
107
|
+
| rowOrder | array | | | Order of the generated rows; rows left out follow in default order. Ids: each region id, through the aliases of the map pack. |
|
|
108
|
+
| rowOverrides | object | | | Settings per generated row. Ids: each region id, through the aliases of the map pack. |
|
|
109
|
+
| rowOverrides.*.label | string | | | Row name. |
|
|
101
110
|
| methodNote | boolean | | | Default false. true adds the method footnote on which regions the automatic label policy names. The world pack's endorsement disclaimer stays on the source line and prints once. The inset scale note is required for interpretation and prints regardless. |
|
|
102
111
|
|
|
103
|
-
Plus the [shared options](options.md). This type does not accept `detailFields`, `valueAxis`, `highlight`, `story`, `rounding`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `sort`, `bandFraction`, `valueAxis.show`, `valueAxis.gridlines` with an `option-ignored` warning.
|
|
112
|
+
Plus the [shared options](options.md). This type does not accept `detailFields`, `labelPosition`, `valueAxis`, `highlight`, `story`, `rounding`, `annotations`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `sort`, `bandFraction`, `valueAxis.show`, `valueAxis.gridlines` with an `option-ignored` warning.
|
|
104
113
|
|
|
105
114
|
## Annotations
|
|
106
115
|
|
|
@@ -148,3 +157,5 @@ Below the floor a render is refused with `size-below-floor` and the pixels it ne
|
|
|
148
157
|
| overlay-measure-heading | torture | The overlay measure has a heading |
|
|
149
158
|
| named-null-states | torture | Named map states differ from missing values |
|
|
150
159
|
| info-glyphs-with-status | torture | Info marker and icon tones appear beside status in the key |
|
|
160
|
+
| lookup-columns | example | The value table without swatches, with rows left out, moved and renamed |
|
|
161
|
+
| lookup-no-emphasis | example | The value table and the map set no top group in bold |
|
package/docs/reference/cohort.md
CHANGED
|
@@ -55,22 +55,32 @@ Cohorts by periods-since-start: counts in, every retention rate derived, weighte
|
|
|
55
55
|
|---|---|---|---|---|
|
|
56
56
|
| format | string | | | Rate format in percentage units, such as '1.0%' or '1.00' for two decimals without a sign on exhibit tables. Default: a decimal below 10%, whole percent otherwise on the heatmap. Exhibit tables share the needed decimal precision. The M0 anchor is neutral and the colour scale stays fixed at 0–100%. |
|
|
57
57
|
| basis | string | `'cohort'`, `'previous'` | `'cohort'` | 'cohort' = active / cohort base (comparable down a column); 'previous' = active / the previous period's active. |
|
|
58
|
-
| averages | false \| string | `false`, `'weighted'` | `false` | Weighted column average = total active / total base of the observed cohorts. |
|
|
58
|
+
| averages | false \| string | `false`, `'weighted'` | `false` | Heatmap only. Weighted column average = total active / total base of the observed cohorts. |
|
|
59
59
|
| methodNote | boolean | | | Default false. true adds the measure formula and explains the visible anchor column and blank cells. strings.cohortMeasure and strings.cohortFormula name another count-based measure, such as cumulative conversion. Required interpretation notes still print: the formula under basis 'previous', not-meaningful cells, weighted averages and rates too narrow to print. |
|
|
60
60
|
| variant | string | `'heatmap'`, `'pure'`, `'stepped'` | `'heatmap'` | Form. 'heatmap' (the default) draws the heatmap surface, which honours 'labels'. 'pure' and 'stepped' draw the exhibit. Stepped columns share the width the label and size columns leave, as pure columns do, and preserve weighted-average and missing-cell notes. The exhibit variants draw a fixed label set, so authoring 'labels' together with variant is refused (the legacy surface honours it). |
|
|
61
61
|
| formatScope | string | `'classic'`, `'column'` | | Stepped fills use absolute bins ('classic') or normalize within each period ('column'). |
|
|
62
62
|
| steps | array | | | Four ascending thresholds in percentage points that split the absolute ('classic') stepped fills into five classes the key names, such as [70, 80, 85, 90] for period-to-period retention. Default [30, 40, 50, 60]. |
|
|
63
|
-
| visiblePeriods | array | | | Original zero-based period indices displayed in chronological order
|
|
63
|
+
| visiblePeriods | array | | | Original zero-based period indices displayed in chronological order. A hidden period leaves no cell, head, note or record; rates and averages are still derived over all periods. |
|
|
64
64
|
| cohortSizeLabel | string | | | Header for the exhibit cohort-size column; defaults to Cohort size. |
|
|
65
65
|
| showPercentSign | boolean | | | Print a percent sign in every exhibit cell; defaults to false because the unit is stated once. |
|
|
66
66
|
| threshold | number \| false | `false` (or another value of its type) | | Pure-exhibit emphasis threshold in percentage points: cohort and total rates above it print bold; period 0 stays neutral. A note prints only when a visible cell uses that emphasis. Defaults to 60; false disables emphasis and its note. |
|
|
67
|
-
| designatedPeriod | integer |
|
|
68
|
-
| total | false \| string | `false`, `'weighted'` | |
|
|
67
|
+
| designatedPeriod | integer \| false | `false` (or another value of its type) | | Original zero-based period index receiving the pure-exhibit column tint; defaults to 3. false draws no tint and no head emphasis, on variant 'pure' only. |
|
|
68
|
+
| total | false \| string | `false`, `'weighted'` | | Summary row. Exhibit: weighted retention by default, or false to hide it. Heatmap: 'weighted' equals averages 'weighted', false hides the average row, and total wins over averages. Never averages cohort percentages equally. |
|
|
69
|
+
| totalPosition | string | `'top'`, `'bottom'` | | Exhibit variants: where the summary row stands, with its ground, rules and average bases; default 'bottom'. With total false it warns option-ignored. |
|
|
70
|
+
| columnVisibility | object | | | True shows a column and false leaves it out: the ids are data.columnToggles ids on table and column ids elsewhere. Ids: size. |
|
|
71
|
+
| columnOverrides | object | | | Settings per generated column. Ids: label, size, periods. A periods width is per period column and replaces the shared width, and the room it leaves stays empty on the right of the table. label on periods warns, because each period keeps its own head. label on the label track sets the corner head, and label on size beats cohortSizeLabel. |
|
|
72
|
+
| columnOverrides.*.width | number | | | Track width in px. It beats the width the type would pick. |
|
|
73
|
+
| columnOverrides.*.align | string | `'left'`, `'right'`, `'center'` | | Alignment of the column: its cell text and, unless headAlign is set, its head. Bars keep starting at the panel origin. |
|
|
74
|
+
| columnOverrides.*.headAlign | string | `'left'`, `'right'`, `'center'` | | Head alignment; defaults to align. |
|
|
75
|
+
| columnOverrides.*.label | string | | | Head text. |
|
|
76
|
+
| columnOrder | array | | | Order of whole blocks; blocks left out follow in default order. Ids: size, periods. |
|
|
77
|
+
| columnHeads | false | `false` | | false: no visible head row and no group heads, with their height and rule. Assistive technology still reads the head in React, and sortable warns there. |
|
|
78
|
+
| figures | false | `false` | | Variant 'stepped': false stops the numbers on filled cells. Period 0 and other cells with no fill keep their text. Hover, records and accessible values stay. |
|
|
69
79
|
| excludeCurrentPeriod | boolean | | | Remove the newest cohort and longest period before exhibit derivation. |
|
|
70
80
|
| exhibitLabel | string | | | Short exhibit heading above the assertion title. |
|
|
71
81
|
| heightFill | string | `'rows'`, `'none'` | `'rows'` | Exhibit variants. 'rows' (default): rows take the spare height of a pinned canvas, up to 1.8 times, and stepped columns share the free width. 'none': natural row height, stepped columns at measured width. |
|
|
72
82
|
|
|
73
|
-
Plus the [shared options](options.md). This type does not accept `detailFields`, `valueAxis`, `rounding`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `topN`, `bandFraction`, `valueAxis.show`, `valueAxis.gridlines` with an `option-ignored` warning.
|
|
83
|
+
Plus the [shared options](options.md). This type does not accept `detailFields`, `labelPosition`, `valueAxis`, `rounding`, `annotations`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `topN`, `bandFraction`, `valueAxis.show`, `valueAxis.gridlines` with an `option-ignored` warning.
|
|
74
84
|
|
|
75
85
|
## Annotations
|
|
76
86
|
|
|
@@ -144,6 +154,16 @@ Below the floor a render is refused with `size-below-floor` and the pixels it ne
|
|
|
144
154
|
| fractional-step-key | torture | Cohort classes keep fractional open upper bounds |
|
|
145
155
|
| cumulative-conversion-pure | example | Count-derived cumulative conversion with its own wording |
|
|
146
156
|
| cumulative-conversion-stepped | example | Count-derived cumulative conversion with its own wording |
|
|
157
|
+
| no-size-column | example | Pure exhibit without the size column, whose bases stay in the weighted total |
|
|
158
|
+
| column-tracks | example | Pure exhibit with authored track widths, alignment and heads |
|
|
159
|
+
| size-after-periods | example | Stepped exhibit with the size column after the periods |
|
|
160
|
+
| no-column-heads | example | Pure exhibit without its head row, with the periods named in the subtitle |
|
|
161
|
+
| no-column-heads-stepped | example | Stepped exhibit without heads or the range lines under them |
|
|
162
|
+
| total-top | example | Stepped exhibit with the weighted average above the cohorts |
|
|
163
|
+
| no-designated-period | example | Pure exhibit with no tinted column |
|
|
164
|
+
| stepped-no-figures | example | Stepped exhibit whose fills carry the rates without printed numbers |
|
|
165
|
+
| heatmap-weighted-total | example | Heatmap with the weighted average row set by total |
|
|
166
|
+
| heatmap-visible-periods | example | Heatmap showing the later periods only, with no trace of the hidden ones |
|
|
147
167
|
|
|
148
168
|
## Not for
|
|
149
169
|
|
package/docs/reference/column.md
CHANGED
|
@@ -71,6 +71,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
71
71
|
| labelDensity | string | `'full'`, `'smart'`, `'minimal'` | | Value-label density. Default 'smart': every value stays eligible. A chart with more than 12 categories, or with most labels wider than the band, ranks the first, last, highest and lowest value (ties: the first) first. The other values then use only their natural seat beside the mark; with none free they are drawn nowhere and left out of the note. Those four may take one step, and the note names any that finds no seat. A smaller chart keeps every value on the bounded one-step rule and names any that finds no seat. 'full' treats all values alike and names every one that finds no seat. 'minimal' also applies the shared priority gate. Seats stay inside the plot band and one step from the natural seat. All values remain in reading records. When valueLabels is set, it wins: labelDensity is not read for the value labels. |
|
|
72
72
|
| legend | string \| object | `'top'`, `'bottom'`, `'right'`, `'left'`, `'none'`, `'auto'` (or another value of its type) | | Key position. Multiple series get a key by default unless visible direct labels name them all. 'none' hides the key and warns if names are missing. Subtitle and footnote mentions do not replace the key. |
|
|
73
73
|
| valueAxis.break | false \| object | `false` (or another value of its type) | | No break by default or with false. Set { from, to, style? } for a straight value-axis break; the omitted span collapses to a fixed 12px gap when valid. Automatic placement is supported only by waterfall and pvm. |
|
|
74
|
+
| categoryAxis | object | | | Category-axis settings: dateTicks. |
|
|
74
75
|
| axisTitles | object | | | Title over the value axis when valueAxis.show draws it, in the top row left of the plot. A theme with valueAxis.titles derives 'Measure, unit' from subtitle.measure and a unit the drawn subtitle does not print, when none is authored. |
|
|
75
76
|
| axisTitles.primary | string | | | 'Measure, unit' title over the value axis, e.g. 'Revenue, €m'. |
|
|
76
77
|
| valueLabels | string | `'none'`, `'last'`, `'ends'`, `'extremes'`, `'all'` | | Which values print, with line's choices: 'none', 'last', 'ends' (first and last), 'extremes' (first, last, highest and lowest; a tie takes the first) or 'all', chosen per series over the categories in their drawn order. Unset (default): every value is eligible and labelDensity decides. When set, valueLabels wins over labelDensity: each chosen value takes the one-step rule of 'full', and one with no seat is named in the note. A value not chosen is unlabelled by choice: the note does not name it, and the value axis is drawn so it stays readable (all modes but 'all'; valueAxis.show false turns it off). Authored cell labels and flagged anomaly periods print in every mode. Grouped only: a stack has no single value per category, so stacked and stacked100 ignore every mode but 'all' with an option-ignored warning and keep their normal labels and value axis. Example: 24 monthly columns with 'extremes' print the first, peak, low and last value. |
|
|
@@ -78,6 +79,8 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
78
79
|
| grandTotalLabels | boolean | | | Show category stack-total labels in addition to segment labels; default on for the stacked variant and off for stacked100, where every bar would end on the same share. true keeps the absolute total on a 100% stack. |
|
|
79
80
|
| sharesOfOneWhole | boolean | | | true declares every stacked series a share of the same whole, such as channel shares of all orders: the stack then has a total, and percent series warn non-additive-stack only where a category adds to more than 100. Stacked and stacked100 only; refused on other variants. |
|
|
80
81
|
| referenceStyle | string | `'tick'`, `'line'`, `'marker'` | `'tick'` | Reference-series mark style; defaults to tick. |
|
|
82
|
+
| referenceTick | object | | | Where the reference tick draws, read under referenceStyle 'tick' only. A tick beside its column (the integrated PY tick of a stacked column) is unchanged. |
|
|
83
|
+
| referenceTick.position | string | `'behind'`, `'front'` | `'behind'` | Where a plan tick draws. 'behind' (default): behind its column, reaching up to 4 px past each side (2 px where a plan value beside it needs the room), so the column stays whole and the ends mark the plan; a column short of its plan prints its value inside its end. 'front': over the column on a page-colour band, 2 px past each side, the earlier look. |
|
|
81
84
|
| netLine | boolean \| object | | | Per-category ticks at a cumulative boundary of stacked columns, connected by default. |
|
|
82
85
|
| netLine.seriesId | string | | | Series whose cumulative boundary receives a tick; omitted uses the positive stack top, or the negative stack bottom when no value is positive. |
|
|
83
86
|
| netLine.connectors | boolean | | | Connect adjacent category ticks as a stepped line; defaults to true for columns. |
|
|
@@ -141,16 +144,20 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
141
144
|
|
|
142
145
|
| Kind | Purpose | Required | Anchors | Optional fields | Notes |
|
|
143
146
|
|---|---|---|---|---|---|
|
|
144
|
-
| cagr | Draws a growth arrow between two anchored points and computes the compound annual growth rate from their values and ISO-date span. | | from: AnchorRef (optional); to: AnchorRef (optional) | suffix: string, default 'p.a.'. Text after the rate. period: boolean. Print the period before the rate from the anchors' category labels, '2014–2019: +5.8% p.a.'. Default true when the chart carries two or more CAGRs, so nested brackets are told apart by their text, false otherwise. An arrow's ends show its span, so an arrow prints the rate alone unless period is true. shape: bracket \| arrow, default bracket. arrow draws one straight arrow over the marks with the rate in an oval on it, lifted until it clears them. Where no straight line clears the chart, the span is too short for the oval, a stack's inner layer is the anchor or the chart lays comparisons out itself, it draws the bracket and warns cagr-arrow-no-room. | Omitted endpoints span the first to the last category, or the first to the last total on a waterfall. Resolved endpoints need a positive date interval from ISO dates or year-bearing labels and a positive start value; an end of zero reads -100%, and a start at or below zero or a negative end omits the rate and warns cagr-undefined. On a continuous time axis the years are the exact span between the two readings. An anchor on one series of several (seriesId, or a line
|
|
145
|
-
| diff | Draws a level-difference arrow between two anchors and computes either percent change or their signed value difference. | from, to | from: AnchorRef; to: AnchorRef | mode: relative \| absolute \| reversed, default relative. relative prints the percent change from 'from' to 'to', reversed the change from 'to' to 'from', absolute the value difference. | Mode defaults to relative. Relative and reversed changes need a nonzero base; negative bases use its absolute magnitude and emit a warning. Absolute mode reports the raw value difference. A hidden label removes its arm. Drawn reference series accept anchors. |
|
|
146
|
-
| 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 |
|
|
147
|
+
| cagr | Draws a growth arrow between two anchored points and computes the compound annual growth rate from their values and ISO-date span. | | from: AnchorRef (optional); to: AnchorRef (optional) | suffix: string, default 'p.a.'. Text after the rate. period: boolean. Print the period before the rate from the anchors' category labels, '2014–2019: +5.8% p.a.'. Default true when the chart carries two or more CAGRs, so nested brackets are told apart by their text, false otherwise. An arrow's ends show its span, so an arrow prints the rate alone unless period is true. shape: bracket \| arrow, default bracket. arrow draws one straight arrow over the marks with the rate in an oval on it, lifted until it clears them. Where no straight line clears the chart, the span is too short for the oval, a stack's inner layer is the anchor or the chart lays comparisons out itself, it draws the bracket and warns cagr-arrow-no-room. | Omitted endpoints span the first to the last category, or the first to the last total on a waterfall. Resolved endpoints need a positive date interval from ISO dates or year-bearing labels and a positive start value; an end of zero reads -100%, and a start at or below zero or a negative end omits the rate and warns cagr-undefined. On a continuous time axis the years are the exact span between the two readings. An anchor on one series of several (seriesId, or a category of an unstacked line, which reads the first drawn series; on a stack a category reads the stack total) names that series in the label, "Product B +10.1% p.a.", and the arm runs from that series' segment or point. In text, ${value} prints the rate with its suffix, so "CAGR 2014–2019: ${value}" keeps the computed number. Drawn reference series accept anchors. |
|
|
148
|
+
| diff | Draws a level-difference arrow between two anchors and computes either percent change or their signed value difference. | from, to | from: AnchorRef; to: AnchorRef | mode: relative \| absolute \| reversed \| both, default relative. relative prints the percent change from 'from' to 'to', reversed the change from 'to' to 'from', absolute the value difference, both the value difference with the percent change beside it. | Mode defaults to relative. Relative and reversed changes need a nonzero base; negative bases use its absolute magnitude and emit a warning. Absolute mode reports the raw value difference. A hidden label removes its arm. Drawn reference series accept anchors. |
|
|
149
|
+
| 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. | Drawn reference series accept anchors. |
|
|
147
150
|
| 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. |
|
|
148
|
-
| 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.
|
|
151
|
+
| 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. |
|
|
149
152
|
| 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. 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. |
|
|
150
153
|
| 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. |
|
|
151
154
|
| 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. |
|
|
152
155
|
| 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. | 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. |
|
|
153
156
|
| band | Draws an inclusive category span as a shaded band or bracket, or a value-axis plan corridor, tolerance band or attainment fill, with a collision-managed label. | | from: categoryId (optional); to: categoryId (optional) | | Era shade/bracket needs inclusive category IDs. Corridor and tolerance use finite low/high on the value scale, with optional from/to as a category clip. Attainment needs a plan value and shades each resolved actual; missing cells are skipped. Divider applies only to bracket bands. Scenario AC/PY/PL/FC paints a plan corridor (default PL). |
|
|
157
|
+
| 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. |
|
|
158
|
+
| 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. |
|
|
159
|
+
| 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. |
|
|
160
|
+
| box | Draws an unfilled box with two points as opposite corners, wrapping whole category bands, in the ink and rule width of a bracket; text inside the box stays free. | from, to | from: AnchorRef \| { categoryId, value }; to: AnchorRef \| { categoryId, value } | dashed: boolean, default false. Draws the edges 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. from and to are opposite corners, the box has no fill, and text inside it stays free. A { categoryId, value } corner spans that category's whole band, so the box wraps whole bars, values and markers; from and to on one category wrap that category. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
154
161
|
|
|
155
162
|
## Dense value labels
|
|
156
163
|
|
|
@@ -191,6 +198,11 @@ Below the floor a render is refused with `size-below-floor` and the pixels it ne
|
|
|
191
198
|
| stacked100-shares-sum | torture | Torture: 100% stacked shares that add up to 100% in every column |
|
|
192
199
|
| stacked100-energy-mix | example | Stacked 100% column with absolute totals and 100% indicator |
|
|
193
200
|
| clustered-brand-gap | example | Clustered columns with value axis, gridlines, and diff arrow |
|
|
201
|
+
| plan-ticks-delta-callout | example | Actual columns with plan ticks, a delta and a callout stacked over the one year below plan |
|
|
202
|
+
| plan-ticks-front | example | Actual columns with plan ticks drawn over the columns |
|
|
203
|
+
| monthly-diff-bracket | example | Twelve monthly columns with a difference in value and percent from the first to the last month |
|
|
204
|
+
| monthly-diff-between | example | Twelve monthly columns with a difference whose arrow stands between the columns |
|
|
205
|
+
| monthly-delta-both | example | Highlighted first and last month with a delta in value and percent |
|
|
194
206
|
| ranked-dense-staggered | example | Ranked dense columns: staggered values, tick step, dotted grid, muted labels, highlight emphasis |
|
|
195
207
|
| ratio-tier-zero-denominator | torture | Torture: zero denominator stays visible as n/a in the ratio tier |
|
|
196
208
|
| negative-stacks | torture | Torture: negatives mixed into stacks, one all-negative column |
|
|
@@ -280,3 +292,6 @@ Below the floor a render is refused with `size-below-floor` and the pixels it ne
|
|
|
280
292
|
| option-value-labels-all | example | Every quarter prints its value (valueLabels all) |
|
|
281
293
|
| grouped-twelve-slide | torture | Two series over twelve units on a full slide print all 24 values |
|
|
282
294
|
| key-right-slide | example | Clustered columns on a slide with the key in a column right of the plot |
|
|
295
|
+
| inside-base-values | example | Column values inside the base |
|
|
296
|
+
| stacked-inside-base-values | example | Stacked column values inside each base |
|
|
297
|
+
| drawing-kinds | example | A box around the launch months, the old level and an arrow from a note |
|