boardplot 0.54.0 → 0.56.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 +491 -0
- package/README.md +4 -4
- package/dist/{ReaderBox-YXC5XK7D.js → ReaderBox-GLCKYXBU.js} +14 -10
- package/dist/{annotateEngine-5O3IRSQL.js → annotateEngine-QVNAE3EH.js} +3 -1
- package/dist/build-identity.json +3 -3
- package/dist/{chunk-MT4MP3UZ.js → chunk-27OIGDRK.js} +1 -1
- package/dist/{chunk-OD3IH6FG.js → chunk-2DOEZ5QY.js} +39 -21
- package/dist/{chunk-WUKSZNHL.js → chunk-2FKEF2AC.js} +32 -21
- package/dist/{chunk-GYNZ72GO.js → chunk-2HTYGMMG.js} +2 -2
- package/dist/chunk-2NN676RI.js +25 -0
- package/dist/{chunk-4MREJWRM.js → chunk-2NRHD2G7.js} +5 -4
- package/dist/{chunk-3UBTO342.js → chunk-2NSQIPAA.js} +77 -38
- package/dist/{chunk-T7ZCYYQZ.js → chunk-2YO4WRJN.js} +25 -7
- package/dist/{chunk-SHH2AHIU.js → chunk-32LLDRPI.js} +64 -42
- package/dist/{chunk-WEPAE4KG.js → chunk-3465633G.js} +4 -4
- package/dist/{chunk-WGIO6AHP.js → chunk-37PKNVLS.js} +3 -3
- package/dist/chunk-3V62N3Z7.js +24 -0
- package/dist/{chunk-S6CRZKPO.js → chunk-43GGVT7W.js} +5 -5
- package/dist/{chunk-VDAZPGR2.js → chunk-4DZFR52I.js} +2 -2
- package/dist/{chunk-WDONXBQE.js → chunk-4JC3SE4G.js} +1 -1
- package/dist/{chunk-EHVESNLV.js → chunk-4JGBCBDZ.js} +1 -1
- package/dist/{chunk-G6XCUX3I.js → chunk-4JHMCXOB.js} +60 -13
- package/dist/{chunk-GGO43PHB.js → chunk-4KMZAK6J.js} +6 -5
- package/dist/{chunk-GVKFFJ23.js → chunk-4KQHKPB3.js} +462 -149
- package/dist/{chunk-AHQ4L3BE.js → chunk-4LTN7SND.js} +2 -2
- package/dist/{chunk-MZJBPDIL.js → chunk-52WNCUIN.js} +1 -1
- package/dist/{chunk-JAKRPSWP.js → chunk-54ROMBU7.js} +164 -51
- package/dist/{chunk-OZUTYDV4.js → chunk-5DTCOOLU.js} +2 -2
- package/dist/{chunk-DDI2W4TR.js → chunk-5P2TTHBZ.js} +3 -3
- package/dist/{chunk-U2HQELXL.js → chunk-5PPQIF4D.js} +2 -2
- package/dist/{chunk-K4K6KGEF.js → chunk-5S3JQ5AT.js} +241 -195
- package/dist/chunk-5TWY3ZIC.js +19 -0
- package/dist/{chunk-BXEM2CVW.js → chunk-6364WO5D.js} +3 -3
- package/dist/{chunk-ZNHF2XCP.js → chunk-63Y3ROZ7.js} +50 -36
- package/dist/{chunk-VAEC53B3.js → chunk-64LJDGJH.js} +3 -3
- package/dist/{chunk-WZBMTZBM.js → chunk-67QSW5RW.js} +4 -4
- package/dist/{chunk-HGGLJYPZ.js → chunk-6AMN7IKJ.js} +89 -57
- package/dist/{chunk-24BHMKDD.js → chunk-6EYTD777.js} +25 -2
- package/dist/{chunk-HZG5NB7Q.js → chunk-6MJUW5R5.js} +159 -86
- package/dist/{chunk-NGRIT3CY.js → chunk-6QDMRPXI.js} +113 -128
- package/dist/{chunk-HZZH3MQI.js → chunk-6WHWXCHJ.js} +7 -3
- package/dist/{chunk-T3PNYRDM.js → chunk-75WIUG2W.js} +394 -141
- package/dist/{chunk-ZTH6YSVA.js → chunk-76Q7E3TM.js} +117 -102
- package/dist/chunk-7ADUVRG5.js +14 -0
- package/dist/{chunk-U4P6TQRW.js → chunk-7DAH2E4T.js} +2 -2
- package/dist/{chunk-43OQ26TL.js → chunk-7FKY6YWU.js} +8 -8
- package/dist/{chunk-CPKHL7FK.js → chunk-7KSUMFBK.js} +1 -1
- package/dist/{chunk-KL2XJQAA.js → chunk-7M2GK7XQ.js} +1729 -196
- package/dist/{chunk-RZB4RPPD.js → chunk-7PPMT5EJ.js} +155 -151
- package/dist/{chunk-JFBEAUJ6.js → chunk-7Q37C6GZ.js} +1 -1
- package/dist/chunk-7STMIK2X.js +94 -0
- package/dist/{chunk-KFWEO4UA.js → chunk-7VMEM3LN.js} +254 -142
- package/dist/{chunk-GSMWHKOW.js → chunk-7VVHTOE7.js} +7 -7
- package/dist/{chunk-KBFPMESI.js → chunk-A2GAWGVJ.js} +246 -79
- package/dist/{chunk-23RWLBZF.js → chunk-AGDDH6XY.js} +3 -3
- package/dist/chunk-AMR4SUAN.js +25 -0
- package/dist/{chunk-6I7YZTY7.js → chunk-BDGLMWPO.js} +12 -4
- package/dist/{chunk-JJJ2KAHR.js → chunk-BIGQKCU7.js} +20 -9
- package/dist/{chunk-LTMF75MR.js → chunk-BISJK67O.js} +208 -62
- package/dist/{chunk-FILDYFT4.js → chunk-BIVL764T.js} +2 -2
- package/dist/{chunk-RNOJSEES.js → chunk-BK6P6KMW.js} +1 -1
- package/dist/{chunk-XB4KZ6WO.js → chunk-BSATR6ZO.js} +40 -13
- package/dist/{chunk-MYCLO35J.js → chunk-BTDGWHGJ.js} +50 -12
- package/dist/{chunk-PDG4IM3L.js → chunk-BVYIKLQ5.js} +1 -1
- package/dist/{chunk-TNHD4UTC.js → chunk-BYCJ6TKI.js} +13 -3
- package/dist/{chunk-NQSDIDRO.js → chunk-CAJ54IEP.js} +5 -5
- package/dist/{chunk-E42JZ2DA.js → chunk-CB4CERXZ.js} +4 -5
- package/dist/{chunk-ENOCOA3F.js → chunk-CCDXK5NA.js} +5 -5
- package/dist/{chunk-7X3UZM7F.js → chunk-CCJP6QZO.js} +1 -1
- package/dist/{chunk-ELPQZIGR.js → chunk-CF4NMRN7.js} +37 -13
- package/dist/{chunk-32X7JGH3.js → chunk-CHAS5A5B.js} +89 -69
- package/dist/{chunk-AVMKRVNP.js → chunk-CKGSGRP7.js} +14 -24
- package/dist/{chunk-3EZRM4YM.js → chunk-CPGASWNN.js} +25 -1
- package/dist/{chunk-BWTX7LUG.js → chunk-CXETOLPX.js} +9 -4
- package/dist/{chunk-D3D7XHBI.js → chunk-CYKXROFG.js} +6 -6
- package/dist/{chunk-DRTA6JG5.js → chunk-D2B3KP35.js} +26 -15
- package/dist/{chunk-TSPWXAAI.js → chunk-DD6RVD3S.js} +6 -7
- package/dist/{chunk-A5TY7H5T.js → chunk-DF3XEFQ7.js} +159 -53
- package/dist/{chunk-P52JHUUM.js → chunk-DLDDRXAI.js} +198 -88
- package/dist/{chunk-XNA6DATU.js → chunk-DLUNQHFO.js} +99 -56
- package/dist/{chunk-2THWIKRB.js → chunk-DMAMWUYY.js} +33 -16
- package/dist/chunk-DQ7YMQVX.js +26 -0
- package/dist/{chunk-4WK3CNW5.js → chunk-DRHQG44U.js} +11 -0
- package/dist/{chunk-WZGJSQKN.js → chunk-DZ3S4RPI.js} +15 -1
- package/dist/chunk-E2ZUBP4Q.js +24 -0
- package/dist/{chunk-G63ROSY5.js → chunk-E555EDOQ.js} +139 -72
- package/dist/{chunk-A7IEVBYI.js → chunk-E76U5H52.js} +1 -5
- package/dist/{chunk-J2ROMB7J.js → chunk-E7V3OHQQ.js} +64 -26
- package/dist/chunk-EBB4PYBN.js +24 -0
- package/dist/{chunk-FPPN5NAR.js → chunk-ECBUFKCP.js} +3 -3
- package/dist/{chunk-5PCCSSII.js → chunk-EGGDPDYJ.js} +1 -1
- package/dist/{chunk-F7X53SZM.js → chunk-EIL3KHAL.js} +12 -7
- package/dist/{chunk-MBVXROCI.js → chunk-EMFUZKYK.js} +20 -3
- package/dist/{chunk-TNNK4IIY.js → chunk-ETMHDCEH.js} +13 -12
- package/dist/{chunk-WMZCOGD6.js → chunk-EZZ533MH.js} +1 -1
- package/dist/{chunk-GEBGBJBD.js → chunk-F2EVCJ4U.js} +41 -34
- package/dist/{chunk-2IXDYW6O.js → chunk-F5BYLT3M.js} +195 -57
- package/dist/{chunk-NRHTC2SQ.js → chunk-F6OLHND5.js} +2 -2
- package/dist/{chunk-3FNY7ZCG.js → chunk-F77TMAUY.js} +141 -79
- package/dist/{chunk-QQNPU27R.js → chunk-FCECYJVA.js} +1 -1
- package/dist/{chunk-RGZGLKFB.js → chunk-FFJGC2DX.js} +418 -62
- package/dist/chunk-FG5L2LUK.js +89 -0
- package/dist/chunk-FMDNJ6PC.js +47 -0
- package/dist/{chunk-4WQ2MBE7.js → chunk-FNMH5WEY.js} +1 -1
- package/dist/{chunk-F35DA442.js → chunk-FNRPQIQE.js} +46 -27
- package/dist/{chunk-7EVIIADO.js → chunk-GC4WOLV3.js} +3 -1
- package/dist/{chunk-JB4YPOMT.js → chunk-GELSK76Y.js} +6 -7
- package/dist/{chunk-5SJQOPL7.js → chunk-GIHH6VC2.js} +4 -4
- package/dist/chunk-GLQ3KCTY.js +24 -0
- package/dist/{chunk-HHS6333D.js → chunk-GM3EGUYW.js} +2 -2
- package/dist/{chunk-PBYUJSEY.js → chunk-GQT2SY2S.js} +66 -43
- package/dist/{chunk-BUPLB3EX.js → chunk-H3IBJQ5A.js} +6 -2
- package/dist/{chunk-K4RCWNLC.js → chunk-HHXIVFAU.js} +11 -8
- package/dist/{chunk-B3F4TS3V.js → chunk-HJRNBKIT.js} +768 -69
- package/dist/chunk-HOU2MZHC.js +61 -0
- package/dist/{chunk-S4QSJAGY.js → chunk-HZUAEMN5.js} +1 -1
- package/dist/chunk-I7H5DU34.js +132 -0
- package/dist/{chunk-YS56RSTZ.js → chunk-IFQN4GKK.js} +161 -69
- package/dist/chunk-IGJ2G5C6.js +24 -0
- package/dist/{chunk-4ZGN4ZUN.js → chunk-IGNBQT23.js} +87 -3
- package/dist/{chunk-B6LHZLLK.js → chunk-IGVAWAOK.js} +31 -101
- package/dist/chunk-INHDHZNP.js +8 -0
- package/dist/chunk-IRXVV65V.js +24 -0
- package/dist/{chunk-IDDA5INB.js → chunk-IVRYF7QA.js} +7 -4
- package/dist/{chunk-3RMTPAEJ.js → chunk-JCAGVAB3.js} +810 -73
- package/dist/{chunk-OMVYFSOM.js → chunk-JCIXYOND.js} +2 -2
- package/dist/{chunk-6TJDWMZV.js → chunk-JEUL777U.js} +83 -9
- package/dist/{chunk-J33RA3YO.js → chunk-JFFREZGT.js} +5 -5
- package/dist/{chunk-AJHYXD5U.js → chunk-JGFHNAHS.js} +2 -2
- package/dist/chunk-JHWYG7V5.js +24 -0
- package/dist/{chunk-EP54VZI5.js → chunk-JIEVDGAF.js} +1 -1
- package/dist/{chunk-IDT7DJ7F.js → chunk-JKOEHRGV.js} +1 -1
- package/dist/chunk-JMGB444D.js +26 -0
- package/dist/{chunk-DSZUV3TM.js → chunk-JTC5SEAQ.js} +3 -3
- package/dist/chunk-JTFKRDDA.js +53 -0
- package/dist/{chunk-RKITD2UJ.js → chunk-JVZTKQFS.js} +6 -3
- package/dist/{chunk-BBL3R5YZ.js → chunk-JXBZIJCG.js} +1 -1
- package/dist/{chunk-WLZ54FWG.js → chunk-JYAZPMSA.js} +70 -1
- package/dist/chunk-K3VZ5QJK.js +19 -0
- package/dist/{chunk-EYLWVI26.js → chunk-KBJMLXNW.js} +165 -124
- package/dist/{chunk-KAQH75T6.js → chunk-KD5GOR2K.js} +82 -48
- package/dist/{chunk-LNKY5Z2X.js → chunk-KDSYZLF6.js} +2 -3
- package/dist/{chunk-7NWFKHSG.js → chunk-KF7HD3EH.js} +116 -42
- package/dist/{chunk-V7RAPZHX.js → chunk-KLB2QC24.js} +3 -3
- package/dist/chunk-KLIZXSBK.js +24 -0
- package/dist/{chunk-HDZGZJKR.js → chunk-KQCKK3LD.js} +100 -36
- package/dist/{chunk-4TPHMIE5.js → chunk-KTHFHD6C.js} +4 -2
- package/dist/{chunk-IYEFEBRN.js → chunk-KZJ5VM6E.js} +14 -3
- package/dist/{chunk-MEG4NMSI.js → chunk-L6YVK6VC.js} +2 -2
- package/dist/chunk-LGNJCPFP.js +28 -0
- package/dist/{chunk-7JQAUJOL.js → chunk-LKMFMNQX.js} +1 -1
- package/dist/{chunk-QY5ZKUWY.js → chunk-MAFPVR4G.js} +9 -3
- package/dist/{chunk-QR35TD2B.js → chunk-MD6DCQMA.js} +37 -37
- package/dist/{chunk-AA4U62G6.js → chunk-MJPXHCBW.js} +4 -4
- package/dist/{chunk-LYVOL4TQ.js → chunk-MOK3ZS6P.js} +2 -1
- package/dist/{chunk-MKVV7GVJ.js → chunk-MOS6WFWM.js} +13 -7
- package/dist/{chunk-2DR5MMDY.js → chunk-MPO5TVGF.js} +12 -6
- package/dist/{chunk-OU5K2JPF.js → chunk-MRAP2UVV.js} +102 -32
- package/dist/chunk-MS7O3KDJ.js +24 -0
- package/dist/{chunk-53OYF4ZT.js → chunk-MSYTF3DZ.js} +26 -11
- package/dist/{chunk-5A6MO4AR.js → chunk-MZACASZY.js} +7 -4
- package/dist/{chunk-H4H4O62O.js → chunk-N5HN5QGH.js} +1 -1
- package/dist/chunk-NCLRZQR6.js +211 -0
- package/dist/{chunk-C54QLNE4.js → chunk-NGA7ICG4.js} +1 -1
- package/dist/{chunk-SFQ5ADIG.js → chunk-NHC2ADGI.js} +315 -151
- package/dist/chunk-NMTWUYUF.js +30 -0
- package/dist/chunk-O36WX56O.js +13 -0
- package/dist/{chunk-FV32N6AF.js → chunk-O6ZTIDWB.js} +6 -4
- package/dist/{chunk-6BJQULXR.js → chunk-O7REHICC.js} +85 -39
- package/dist/{chunk-4FFCIQDG.js → chunk-OG2YUVBW.js} +4 -1
- package/dist/{chunk-CICWSCLC.js → chunk-OJ5CQV7H.js} +146 -69
- package/dist/{chunk-ULTSSIOU.js → chunk-OQQMDSCC.js} +1 -1
- package/dist/{chunk-PJWLKCFX.js → chunk-P4SMC4BY.js} +98 -90
- package/dist/{chunk-JEYJRJ7M.js → chunk-PJBEJR2U.js} +5 -4
- package/dist/{chunk-AZIRTSVP.js → chunk-PQLAZEQV.js} +122 -52
- package/dist/chunk-PZ46S2SY.js +69 -0
- package/dist/chunk-QB5HV4IY.js +24 -0
- package/dist/{chunk-IM4WUIR7.js → chunk-QGFKSDQO.js} +2 -2
- package/dist/chunk-QJWLNP64.js +24 -0
- package/dist/chunk-QLANK3VN.js +24 -0
- package/dist/chunk-QSMGZOT5.js +24 -0
- package/dist/{chunk-UYNAL3Y3.js → chunk-QWCLWFKC.js} +142 -68
- package/dist/chunk-QZIHKQRH.js +26 -0
- package/dist/{chunk-SZCPKGYG.js → chunk-R2IKOLBK.js} +3 -3
- package/dist/{chunk-BRPOSOK5.js → chunk-R5MEBBAA.js} +144 -71
- package/dist/{chunk-47BO6MYI.js → chunk-RJGCYGC3.js} +137 -70
- package/dist/chunk-RLMC5CUP.js +24 -0
- package/dist/{chunk-6NLH6TEP.js → chunk-RMC4OONA.js} +331 -143
- package/dist/{chunk-26P4WRQC.js → chunk-RPIKNMZA.js} +6 -3
- package/dist/{chunk-YF2PYLC4.js → chunk-RSCRIWAH.js} +1 -1
- package/dist/{chunk-DHWCFQNO.js → chunk-RT66UTLJ.js} +4 -18
- package/dist/{chunk-DAVHGK27.js → chunk-S7NRL66K.js} +46 -23
- package/dist/{chunk-VABRPZVC.js → chunk-SA46CNMS.js} +5 -1
- package/dist/chunk-SE7MJ2LQ.js +24 -0
- package/dist/{chunk-L7RHB734.js → chunk-SGDWLXUC.js} +1 -1
- package/dist/{chunk-E64MTTBC.js → chunk-SMHZXHHD.js} +45 -14
- package/dist/{chunk-AG2CJ4JY.js → chunk-SNQ7D5R7.js} +18 -1
- package/dist/{chunk-3V7AA3IZ.js → chunk-SPSGUFTI.js} +11 -3
- package/dist/{chunk-I2E3YDNZ.js → chunk-SRAV6FPB.js} +33 -9
- package/dist/chunk-SRUV7AT6.js +51 -0
- package/dist/{chunk-KJEZFOO6.js → chunk-SS4YGK3E.js} +91 -48
- package/dist/{chunk-WQ55QPEB.js → chunk-SXD3OYAR.js} +241 -118
- package/dist/{chunk-U7LLQ7XM.js → chunk-T2CYNDYU.js} +473 -109
- package/dist/{chunk-FMFCGYCE.js → chunk-T2YDWT54.js} +289 -300
- package/dist/{chunk-KORHKDJW.js → chunk-TE4M52AA.js} +2 -1
- package/dist/chunk-TUW5IYGA.js +24 -0
- package/dist/chunk-TXBO2LWM.js +25 -0
- package/dist/chunk-U3A6FMSI.js +28 -0
- package/dist/{chunk-EHDWWFNV.js → chunk-UBCVBBJJ.js} +3 -3
- package/dist/chunk-UPTXFTKH.js +25 -0
- package/dist/chunk-UREXN6WG.js +25 -0
- package/dist/chunk-UZLR25BW.js +24 -0
- package/dist/{chunk-JEL6665C.js → chunk-UZTQUPTB.js} +6 -6
- package/dist/{chunk-ISWU5YB3.js → chunk-V5JQQMFQ.js} +11 -5
- package/dist/chunk-V634AXDM.js +31 -0
- package/dist/{chunk-57ZGVAU3.js → chunk-V7F4F6JA.js} +39 -6
- package/dist/chunk-VJ7VBB6S.js +58 -0
- package/dist/{chunk-LVXOY5WL.js → chunk-VPL3JYC6.js} +6 -5
- package/dist/{chunk-VWYUUBBP.js → chunk-VVXKFU72.js} +83 -32
- package/dist/{chunk-XTGWCYAR.js → chunk-WBETBGSC.js} +430 -256
- package/dist/chunk-WI5VOSQX.js +125 -0
- package/dist/chunk-WIVFIVFZ.js +27 -0
- package/dist/{chunk-OURX73UJ.js → chunk-WN3HEU3P.js} +13 -11
- package/dist/{chunk-7EOLHBI6.js → chunk-WTQAG2OT.js} +81 -21
- package/dist/{chunk-G57ZO7DB.js → chunk-WWGPTEQB.js} +66 -26
- package/dist/{chunk-33PLBIMA.js → chunk-WXJ5MHLH.js} +3 -2
- package/dist/chunk-X23SZHV5.js +25 -0
- package/dist/{chunk-TKQKXBGC.js → chunk-X3KCQEYZ.js} +10 -8
- package/dist/chunk-X3YP4DUV.js +76 -0
- package/dist/chunk-XC5IRUEL.js +48 -0
- package/dist/{chunk-LFX7W4B7.js → chunk-XCROSJ2Z.js} +1 -1
- package/dist/{chunk-RK4S3VPS.js → chunk-XHRUXZD7.js} +3 -3
- package/dist/{chunk-S32YYDIB.js → chunk-XMP2DNLI.js} +4 -3
- package/dist/{chunk-C3O45JWU.js → chunk-XQMYQ4TN.js} +4 -4
- package/dist/{chunk-QKL7IY42.js → chunk-Y54LU4CU.js} +1 -1
- package/dist/chunk-YHD2FZFP.js +24 -0
- package/dist/{chunk-OMNQXHFF.js → chunk-YK2KWNTU.js} +31 -20
- package/dist/chunk-YMTXTQCN.js +24 -0
- package/dist/{chunk-SGD3ZHID.js → chunk-YOOHNQ3L.js} +15 -4
- package/dist/{chunk-JTJNQKPM.js → chunk-YPYD6OJ3.js} +2 -2
- package/dist/{chunk-3P4PJJND.js → chunk-YYJORENB.js} +6 -6
- package/dist/{chunk-NRF223FR.js → chunk-YZZLIYPA.js} +1 -1
- package/dist/{chunk-WJKVNRCR.js → chunk-Z55DXFWS.js} +18 -17
- package/dist/{chunk-UTQGZF37.js → chunk-ZEYBI47P.js} +1 -1
- package/dist/{chunk-WKWMOZNE.js → chunk-ZJFJ2IKQ.js} +226 -61
- package/dist/{chunk-QJ4WGAC6.js → chunk-ZKJ5L35C.js} +94 -21
- package/dist/{chunk-ZXOD37BE.js → chunk-ZL6IHMOW.js} +73 -39
- package/dist/chunk-ZMPH2OC4.js +24 -0
- package/dist/{chunk-EYZ6SLF3.js → chunk-ZVM5TFGR.js} +7 -7
- package/dist/chunk-ZWNRLIFT.js +24 -0
- package/dist/{chunk-VNLSTZES.js → chunk-ZY72LSQK.js} +314 -92
- package/dist/chunk-ZYQYX66L.js +24 -0
- package/dist/cli/index.js +3 -3
- package/dist/{core-MN45UFF4.js → core-3KLQSYWB.js} +3 -1
- package/dist/{core-DAFZ7YJW.js → core-4HFVG4CP.js} +2 -1
- package/dist/{core-34KIMTK6.js → core-4RR6VSXM.js} +2 -1
- package/dist/{core-7R3ARYNI.js → core-5UF44NDI.js} +5 -1
- package/dist/{core-3CWPIFAL.js → core-7S3XMW5O.js} +3 -1
- package/dist/{core-ONNGSKWQ.js → core-7Y5BZZON.js} +5 -1
- package/dist/{core-AEYGGH7X.js → core-A5AKUB7H.js} +4 -1
- package/dist/{core-YPH723Z7.js → core-AR2T32Y3.js} +8 -1
- package/dist/{core-CJZXX2V3.js → core-BBNY2BX4.js} +2 -1
- package/dist/{core-CJ7FFPDU.js → core-BLHEJ5OK.js} +5 -1
- package/dist/{core-KII4CH3W.js → core-BOG33BFD.js} +3 -1
- package/dist/{core-O2K4BDYH.js → core-DD62MWEW.js} +4 -1
- package/dist/{core-WJSKT5XM.js → core-DFZMOO7E.js} +5 -1
- package/dist/{core-QXIAQFHM.js → core-E2XOSHPR.js} +3 -1
- package/dist/{core-R27R6J5M.js → core-G3LXHW73.js} +3 -1
- package/dist/{core-V7I4F6JW.js → core-GLOZY6Z7.js} +5 -1
- package/dist/{core-KZK3WCUG.js → core-GSILPKUR.js} +3 -1
- package/dist/{core-GEUPUZUY.js → core-H5HO2CED.js} +3 -1
- package/dist/{core-W7AZNHOX.js → core-HDNWVLJW.js} +3 -1
- package/dist/{core-L7Y7YXWR.js → core-HTD5RHE7.js} +1 -1
- package/dist/{core-WHI4ABF2.js → core-ILPXXC2Z.js} +1 -1
- package/dist/{core-RGLOYY73.js → core-J2JD5ODO.js} +6 -1
- package/dist/{core-ASBJZZTP.js → core-JDFUZFRH.js} +2 -1
- package/dist/{core-XKV7GMPG.js → core-K3JX5WPM.js} +2 -1
- package/dist/{core-L5KTPXHC.js → core-LB5M7XL4.js} +3 -1
- package/dist/{core-KCORN7F7.js → core-LGJZUP6H.js} +3 -1
- package/dist/{core-DJPGSTXB.js → core-MU4ALRR7.js} +8 -1
- package/dist/{core-MNUVP5IJ.js → core-QPSAYRFT.js} +5 -1
- package/dist/{core-YVNOHIQ4.js → core-RR2CAZC5.js} +3 -1
- package/dist/{core-KF6GJOGW.js → core-TCSW24N6.js} +7 -1
- package/dist/{core-JLXFDYHX.js → core-TKZZZ6UW.js} +4 -1
- package/dist/{core-7YKLT7KY.js → core-VKZSQFRG.js} +4 -1
- package/dist/{core-EAIFSTDE.js → core-WJNK7F2J.js} +3 -1
- package/dist/{core-JLJTP7P6.js → core-WZ4CHVYL.js} +3 -1
- package/dist/{core-PFXIBWLD.js → core-XW7UJFJZ.js} +4 -1
- package/dist/{core-RCFFJANI.js → core-YMXYUGF5.js} +5 -1
- package/dist/{core-DKJUX7Q4.js → core-ZLSQHZ3I.js} +3 -1
- package/dist/{dataTable-VKEHFLJM.js → dataTable-CNDRVGA5.js} +4 -2
- package/dist/{engine-PPXKJJFI.js → engine-FVEIM3WV.js} +59 -32
- package/dist/fixtures.js +6 -1
- package/dist/{fontTables-WYCZNRE7.js → fontTables-ZPZQ6IR3.js} +1 -1
- package/dist/fonts.js +2 -1
- package/dist/geo/dach.js +3 -1
- package/dist/geo/de-states.js +3 -1
- package/dist/geo/eu27.js +3 -1
- package/dist/geo/europe.js +3 -1
- package/dist/geo/index.js +4 -2
- package/dist/geo/us-states.js +3 -1
- package/dist/geo/world.js +3 -1
- package/dist/index.js +31 -26
- package/dist/{main-53MXACOU.js → main-THU6VIVU.js} +55 -24
- package/dist/mcp/server.js +50 -22
- package/dist/{module-SVEW5ZUE.js → module-ZSR7KTAS.js} +1 -1
- package/dist/react/bar.js +6 -1
- package/dist/react/bartable.js +6 -1
- package/dist/react/box.js +6 -1
- package/dist/react/bullet.js +4 -1
- package/dist/react/butterfly.js +5 -1
- package/dist/react/choropleth.js +4 -1
- package/dist/react/cohort.js +4 -1
- package/dist/react/column.js +9 -1
- package/dist/react/combo.js +3 -1
- package/dist/react/creative.js +2 -1
- package/dist/react/diagram.js +3 -1
- package/dist/react/dimswitch.js +4 -1
- package/dist/react/dot.js +9 -1
- package/dist/react/export.js +33 -30
- package/dist/react/funnel.js +4 -1
- package/dist/react/gantt.js +4 -1
- package/dist/react/grid.js +4 -1
- package/dist/react/heatmap.js +4 -1
- package/dist/react/histogram.js +6 -1
- package/dist/react/index.js +95 -90
- package/dist/react/kpi.js +2 -1
- package/dist/react/likert.js +7 -1
- package/dist/react/line.js +4 -1
- package/dist/react/mekko.js +5 -1
- package/dist/react/pareto.js +3 -1
- package/dist/react/pie.js +5 -1
- package/dist/react/prepare.js +33 -27
- package/dist/react/pvm.js +4 -1
- package/dist/react/pyramid.js +5 -1
- package/dist/react/sankey.js +4 -1
- package/dist/react/scatter.js +4 -1
- package/dist/react/slope.js +6 -1
- package/dist/react/sparkline.js +4 -1
- package/dist/react/spec.js +25 -32
- package/dist/react/status.js +8 -1
- package/dist/react/story.js +6 -4
- package/dist/react/table.js +4 -1
- package/dist/react/theme.js +6 -3
- package/dist/react/tilemap.js +4 -1
- package/dist/react/treemap.js +3 -1
- package/dist/react/variance.js +5 -1
- package/dist/react/waffle.js +3 -1
- package/dist/react/waterfall.js +4 -1
- package/dist/{resvg-ZOVDIZTV.js → resvg-VB7S5HRF.js} +1 -1
- package/dist/rows.js +2 -3
- package/dist/{rowsModule-L3MBGPBH.js → rowsModule-LI6KOS46.js} +2 -1
- package/dist/{schema-GVHM2HEF.js → schema-25INXAMY.js} +1 -1
- package/dist/{schema-ZCZCY34J.js → schema-5DUTAVO7.js} +1 -1
- package/dist/{schema-26YUL3MG.js → schema-5KDEQBBT.js} +1 -1
- package/dist/{schema-FT37ZEYY.js → schema-5ZTGVQAJ.js} +1 -3
- package/dist/{schema-CMXL5F5L.js → schema-72EEMYS3.js} +1 -1
- package/dist/{schema-6ZV532RM.js → schema-7NSV542V.js} +1 -1
- package/dist/{schema-HWU55RJL.js → schema-AMT7P7KB.js} +1 -1
- package/dist/{schema-AQD3H5VV.js → schema-AXRDF6ND.js} +1 -1
- package/dist/{schema-SY3MKF5S.js → schema-B2GCEYXD.js} +1 -1
- package/dist/{schema-QLH2DZFI.js → schema-BBTXTWYI.js} +1 -1
- package/dist/{schema-SLQPM32G.js → schema-BKUFZLLI.js} +1 -1
- package/dist/{schema-LYBOPAGQ.js → schema-CGQID64D.js} +1 -1
- package/dist/{schema-QNI6MNQ2.js → schema-FDFQKIO5.js} +1 -1
- package/dist/{schema-KH62LDYK.js → schema-GN6GAIU5.js} +1 -1
- package/dist/{schema-733PO52K.js → schema-GNTKL5DN.js} +1 -1
- package/dist/{schema-ZSYX76MO.js → schema-H2EC4GAQ.js} +1 -1
- package/dist/{schema-H7RKVTVO.js → schema-HH5HOORE.js} +1 -1
- package/dist/{schema-NOPOI5G2.js → schema-J7TNCZIP.js} +1 -1
- package/dist/{schema-WAKLKLBB.js → schema-JH57NFXJ.js} +1 -1
- package/dist/{schema-KFXLS67Q.js → schema-KPEPBGAX.js} +1 -1
- package/dist/{schema-GK6MD4EG.js → schema-L5U4OROI.js} +1 -1
- package/dist/{schema-IOWE3RQO.js → schema-LOQ3AFC7.js} +1 -1
- package/dist/{schema-GSE3QXUK.js → schema-M5JBHQIV.js} +5 -3
- package/dist/{schema-IOKAZVL7.js → schema-MMVPMJEF.js} +1 -1
- package/dist/{schema-B4GFRYIP.js → schema-OU35XA3Z.js} +1 -1
- package/dist/{schema-HRHNGOFC.js → schema-PL3EU6EQ.js} +2 -2
- package/dist/{schema-MNG24WU2.js → schema-PQZWO3BP.js} +1 -1
- package/dist/{schema-5E5J43CF.js → schema-QCIE6M2P.js} +2 -1
- package/dist/{schema-Q4IPIR6W.js → schema-QORUB6EK.js} +1 -1
- package/dist/{schema-33ZF6WKL.js → schema-QPOBZUAR.js} +1 -1
- package/dist/{schema-3W7IFXVN.js → schema-R5Y6NVBH.js} +1 -1
- package/dist/{schema-KHCLVE2V.js → schema-THXXFY6I.js} +1 -1
- package/dist/{schema-HGUBNXUY.js → schema-VYECMPON.js} +1 -1
- package/dist/{schema-PNUC54GC.js → schema-YLE4XXQQ.js} +1 -1
- package/dist/{schema-KORNUIC6.js → schema-ZEVJMFLV.js} +1 -1
- package/dist/{schema-4ZXJCRZR.js → schema-ZG6ZKFRZ.js} +1 -1
- package/dist/{schema-WCDYWS4K.js → schema-ZQSIR5UC.js} +1 -1
- package/dist/{specValidation-H5B4MQST.js → specValidation-VHLGDEME.js} +3 -1
- package/dist/theme.js +4 -2
- package/dist/{themeShapeRules-54U5EIZR.js → themeShapeRules-PW4BQHKL.js} +1 -1
- package/dist/types/core/a11y/recordsShared.d.ts +4 -0
- package/dist/types/core/annotate.d.ts +39 -0
- package/dist/types/core/annotateArms.d.ts +1 -1
- package/dist/types/core/axis.d.ts +2 -0
- package/dist/types/core/calendarLabels.d.ts +15 -0
- package/dist/types/core/charts/band/stacks.d.ts +71 -2
- package/dist/types/core/charts/bartable/types.d.ts +10 -0
- package/dist/types/core/charts/box/types.d.ts +2 -0
- package/dist/types/core/charts/choropleth/index.d.ts +7 -0
- package/dist/types/core/charts/choropleth/layout.d.ts +7 -0
- package/dist/types/core/charts/choropleth/schema.d.ts +36 -0
- package/dist/types/core/charts/cohort/types.d.ts +8 -1
- package/dist/types/core/charts/column/layout.d.ts +1 -1
- package/dist/types/core/charts/column/model.d.ts +4 -0
- package/dist/types/core/charts/combo/endpoints.d.ts +1 -1
- package/dist/types/core/charts/creative/types.d.ts +1 -1
- package/dist/types/core/charts/dimswitch/compile.d.ts +2 -0
- package/dist/types/core/charts/dimswitch/types.d.ts +8 -0
- package/dist/types/core/charts/grid/normalize.d.ts +18 -1
- package/dist/types/core/charts/heatmap/fixtures.d.ts +2 -2
- package/dist/types/core/charts/histogram/types.d.ts +14 -2
- package/dist/types/core/charts/likert/layout.d.ts +14 -9
- package/dist/types/core/charts/logAxis.d.ts +55 -0
- package/dist/types/core/charts/pvm/types.d.ts +6 -0
- package/dist/types/core/charts/pyramid/types.d.ts +7 -4
- package/dist/types/core/charts/sankey/types.d.ts +3 -1
- package/dist/types/core/charts/scatter/clamp.d.ts +155 -0
- package/dist/types/core/charts/scatter/frontier.d.ts +21 -0
- package/dist/types/core/charts/scatter/index.d.ts +9 -0
- package/dist/types/core/charts/scatter/layout.d.ts +26 -0
- package/dist/types/core/charts/scatter/logAxis.d.ts +14 -0
- package/dist/types/core/charts/scatter/model.d.ts +258 -0
- package/dist/types/core/charts/scatter/schema.d.ts +57 -0
- package/dist/types/core/charts/scatter/trend.d.ts +54 -0
- package/dist/types/core/charts/scatter/valueLines.d.ts +47 -0
- package/dist/types/core/charts/sparkline/fixtures.d.ts +1 -1
- package/dist/types/core/charts/status/layout.d.ts +5 -3
- package/dist/types/core/charts/table/resolve.d.ts +0 -7
- package/dist/types/core/charts/tilemap/index.d.ts +6 -0
- package/dist/types/core/charts/tilemap/layout.d.ts +5 -0
- package/dist/types/core/charts/tilemap/schema.d.ts +4 -0
- package/dist/types/core/charts/treemap/types.d.ts +2 -2
- package/dist/types/core/charts/variance/fixtures.d.ts +2 -1
- package/dist/types/core/charts/waffle/types.d.ts +2 -0
- package/dist/types/core/dateFormat.d.ts +1 -1
- package/dist/types/core/doc/diagnostics.d.ts +8 -0
- package/dist/types/core/doc/document.d.ts +9 -1
- package/dist/types/core/doc/ownedDocumentCopy.d.ts +2 -1
- package/dist/types/core/fontMetrics/index.d.ts +1 -1
- package/dist/types/core/footer.d.ts +9 -1
- package/dist/types/core/format.d.ts +8 -1
- package/dist/types/core/formatSpec.d.ts +84 -6
- package/dist/types/core/frame.d.ts +41 -8
- package/dist/types/core/geo/packs/registry.d.ts +3 -2
- package/dist/types/core/geometry.d.ts +19 -0
- package/dist/types/core/icons.d.ts +11 -0
- package/dist/types/core/inputError.d.ts +3 -0
- package/dist/types/core/isoDate.d.ts +2 -0
- package/dist/types/core/label/categoryRow.d.ts +9 -1
- package/dist/types/core/label/occupied.d.ts +5 -0
- package/dist/types/core/label/solver.d.ts +31 -2
- package/dist/types/core/notes.d.ts +13 -1
- package/dist/types/core/ols.d.ts +38 -0
- package/dist/types/core/periodYears.d.ts +5 -1
- package/dist/types/core/registry.d.ts +12 -0
- package/dist/types/core/request.d.ts +3 -2
- package/dist/types/core/scale.d.ts +7 -0
- package/dist/types/core/schema/capability.d.ts +17 -20
- package/dist/types/core/schema/namedColumns.d.ts +6 -0
- package/dist/types/core/schema/refusals.d.ts +1 -4
- package/dist/types/core/shareRounding.d.ts +8 -0
- package/dist/types/core/sizing.d.ts +17 -12
- package/dist/types/core/story.d.ts +3 -0
- package/dist/types/core/target.d.ts +6 -0
- package/dist/types/core/text.d.ts +8 -0
- package/dist/types/core/theme.d.ts +52 -1
- package/dist/types/core/types/annotations.d.ts +15 -3
- package/dist/types/core/types/data.d.ts +4 -1
- package/dist/types/core/types/diagram.d.ts +81 -2
- package/dist/types/core/types/optionInput.d.ts +13 -0
- package/dist/types/core/types/options.d.ts +65 -24
- package/dist/types/core/types/scene.d.ts +79 -2
- package/dist/types/core/types/table.d.ts +11 -0
- package/dist/types/core/types/theme.d.ts +48 -3
- package/dist/types/index.d.ts +28 -27
- package/dist/types/optionTypes.d.ts +44 -0
- package/dist/types/react/DimSwitchChart.d.ts +2 -1
- package/dist/types/react/RefusalBoundary.d.ts +25 -0
- package/dist/types/react/SceneRenderer.d.ts +3 -1
- package/dist/types/react/SizePlaceholder.d.ts +2 -1
- package/dist/types/react/TableChart.d.ts +8 -4
- package/dist/types/react/barrelCharts.d.ts +1521 -1012
- package/dist/types/react/charts/bar.d.ts +36 -25
- package/dist/types/react/charts/bartable.d.ts +36 -25
- package/dist/types/react/charts/box.d.ts +36 -25
- package/dist/types/react/charts/bullet.d.ts +36 -25
- package/dist/types/react/charts/butterfly.d.ts +36 -25
- package/dist/types/react/charts/choropleth.d.ts +36 -25
- package/dist/types/react/charts/cohort.d.ts +76 -50
- package/dist/types/react/charts/column.d.ts +36 -25
- package/dist/types/react/charts/combo.d.ts +2 -1
- package/dist/types/react/charts/creative.d.ts +31 -25
- package/dist/types/react/charts/diagram.d.ts +302 -160
- package/dist/types/react/charts/dot.d.ts +36 -25
- package/dist/types/react/charts/funnel.d.ts +36 -25
- package/dist/types/react/charts/gantt.d.ts +36 -25
- package/dist/types/react/charts/grid.d.ts +38 -27
- package/dist/types/react/charts/heatmap.d.ts +36 -25
- package/dist/types/react/charts/histogram.d.ts +36 -25
- package/dist/types/react/charts/kpi.d.ts +36 -25
- package/dist/types/react/charts/likert.d.ts +36 -25
- package/dist/types/react/charts/line.d.ts +36 -25
- package/dist/types/react/charts/mekko.d.ts +36 -25
- package/dist/types/react/charts/pareto.d.ts +33 -25
- package/dist/types/react/charts/pie.d.ts +36 -25
- package/dist/types/react/charts/pvm.d.ts +36 -25
- package/dist/types/react/charts/pyramid.d.ts +33 -25
- package/dist/types/react/charts/sankey.d.ts +36 -25
- package/dist/types/react/charts/scatter.d.ts +36 -25
- package/dist/types/react/charts/slope.d.ts +36 -25
- package/dist/types/react/charts/sparkline.d.ts +36 -25
- package/dist/types/react/charts/status.d.ts +36 -25
- package/dist/types/react/charts/tilemap.d.ts +36 -25
- package/dist/types/react/charts/treemap.d.ts +36 -25
- package/dist/types/react/charts/variance.d.ts +36 -25
- package/dist/types/react/charts/waffle.d.ts +36 -25
- package/dist/types/react/charts/waterfall.d.ts +36 -25
- package/dist/types/react/createChartComponent.d.ts +11 -9
- package/dist/types/react/footerFrame.d.ts +1 -1
- package/dist/types/react/hover/engine.d.ts +2 -1
- package/dist/types/react/hover/labelCard.d.ts +20 -2
- package/dist/types/react/prepare.d.ts +2 -2
- package/dist/types/react/prepared.d.ts +5 -1
- package/dist/types/react/useContainerSize.d.ts +2 -0
- package/dist/types/rows.d.ts +1 -1
- package/dist/validate.js +13 -8
- package/docs/manual.md +139 -35
- package/docs/reference/bar.md +10 -7
- package/docs/reference/bartable.md +7 -3
- package/docs/reference/box.md +5 -2
- package/docs/reference/bullet.md +7 -5
- package/docs/reference/butterfly.md +12 -5
- package/docs/reference/choropleth.md +10 -8
- package/docs/reference/cohort.md +3 -2
- package/docs/reference/column.md +14 -7
- package/docs/reference/combo.md +8 -6
- package/docs/reference/creative.md +1 -1
- package/docs/reference/diagram.md +94 -18
- package/docs/reference/dimswitch.md +16 -13
- package/docs/reference/dot.md +7 -4
- package/docs/reference/fixtures.md +49 -5
- package/docs/reference/funnel.md +4 -3
- package/docs/reference/gantt.md +1 -1
- package/docs/reference/grid.md +1 -1
- package/docs/reference/heatmap.md +6 -4
- package/docs/reference/histogram.md +7 -4
- package/docs/reference/kpi.md +11 -8
- package/docs/reference/likert.md +7 -3
- package/docs/reference/line.md +9 -8
- package/docs/reference/mekko.md +4 -4
- package/docs/reference/options.md +34 -32
- package/docs/reference/pareto.md +4 -4
- package/docs/reference/pie.md +8 -7
- package/docs/reference/pvm.md +4 -2
- package/docs/reference/pyramid.md +4 -4
- package/docs/reference/react.md +20 -11
- package/docs/reference/sankey.md +5 -3
- package/docs/reference/scatter.md +3 -3
- package/docs/reference/slope.md +7 -6
- package/docs/reference/sparkline.md +6 -5
- package/docs/reference/status.md +6 -4
- package/docs/reference/table.md +28 -26
- package/docs/reference/theme.md +93 -85
- package/docs/reference/tilemap.md +8 -7
- package/docs/reference/treemap.md +6 -5
- package/docs/reference/variance.md +8 -5
- package/docs/reference/waffle.md +2 -1
- package/docs/reference/waterfall.md +12 -9
- package/docs/use-cases.md +25 -2
- package/llms.txt +1 -1
- package/package.json +1 -1
- package/dist/chunk-2HXKW6U6.js +0 -24
- package/dist/chunk-35ZTANEK.js +0 -24
- package/dist/chunk-3CLLHMFF.js +0 -24
- package/dist/chunk-46ZPFJAM.js +0 -24
- package/dist/chunk-6BWSF5PS.js +0 -24
- package/dist/chunk-6K2TMVPF.js +0 -42
- package/dist/chunk-6KWIQ5KF.js +0 -18
- package/dist/chunk-6ZXMA4TY.js +0 -24
- package/dist/chunk-7HFUG25L.js +0 -24
- package/dist/chunk-7R5EV5MS.js +0 -24
- package/dist/chunk-7X65ZQN4.js +0 -38
- package/dist/chunk-ATUZTGZI.js +0 -25
- package/dist/chunk-BW5VLBSZ.js +0 -15
- package/dist/chunk-BYD7VLAI.js +0 -24
- package/dist/chunk-CEY646NZ.js +0 -28
- package/dist/chunk-D7GZPMHW.js +0 -24
- package/dist/chunk-FIANWJXX.js +0 -19
- package/dist/chunk-H4SYN3QA.js +0 -24
- package/dist/chunk-HC4NDND6.js +0 -24
- package/dist/chunk-HNVW3YDS.js +0 -25
- package/dist/chunk-HW7BPJNQ.js +0 -24
- package/dist/chunk-I5L3QTKQ.js +0 -24
- package/dist/chunk-IK4BHOPZ.js +0 -33
- package/dist/chunk-IMJXJHFW.js +0 -88
- package/dist/chunk-JDEVGTSX.js +0 -24
- package/dist/chunk-K2KU4HHT.js +0 -25
- package/dist/chunk-KDMKHR5A.js +0 -32
- package/dist/chunk-KNZD53L4.js +0 -24
- package/dist/chunk-KOJ5QETJ.js +0 -8
- package/dist/chunk-KSQEG6DX.js +0 -24
- package/dist/chunk-KVSJ2O4Q.js +0 -24
- package/dist/chunk-L3JWM7FR.js +0 -50
- package/dist/chunk-L7FSCT4M.js +0 -28
- package/dist/chunk-LMPZKCDM.js +0 -24
- package/dist/chunk-MONVTUHR.js +0 -24
- package/dist/chunk-NWQTSZYC.js +0 -24
- package/dist/chunk-OM67S6S4.js +0 -19
- package/dist/chunk-OTW5SEFS.js +0 -21
- package/dist/chunk-PGV25HTX.js +0 -25
- package/dist/chunk-QGCEHR6S.js +0 -13
- package/dist/chunk-T3IGJARD.js +0 -22
- package/dist/chunk-U2ES66IN.js +0 -26
- package/dist/chunk-U6CJPTOB.js +0 -19
- package/dist/chunk-VDVXGAIP.js +0 -24
- package/dist/chunk-VGWWUCAB.js +0 -24
- package/dist/chunk-X4U6PT3Z.js +0 -33
- package/dist/chunk-XXNLNZ7E.js +0 -24
- package/dist/chunk-ZBJNEJSL.js +0 -24
- package/dist/chunk-ZWJTHFWB.js +0 -27
- /package/dist/{DiagnosticDetails-UNYNYCAH.js → DiagnosticDetails-JFBBXOT2.js} +0 -0
package/docs/reference/combo.md
CHANGED
|
@@ -69,7 +69,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
69
69
|
| series[].id | string | yes | Series identity used by keyed options, annotations and legend entries. |
|
|
70
70
|
| series[].label | string | | Displayed series name; defaults to the series id. |
|
|
71
71
|
| series[].values | (cell \| { categoryId, value: cell })[] | yes | Values in category order, or keyed entries pairing a categoryId with its value. |
|
|
72
|
-
| series[].scenario | string | | AC, PY, PL, FC (or ACT, BUD, FCST). Controls scenario labels and paint conventions. |
|
|
72
|
+
| series[].scenario | string | | AC, PY, PL, FC (or ACT, BUD, FCST, LY for last year). Codes and aliases accept any case. Controls scenario labels and paint conventions. |
|
|
73
73
|
| series[].role | string | | Data series or comparison-only reference series; references are excluded from the main plotted data. One of `'data'`, `'reference'`. |
|
|
74
74
|
| series[].colorRole | string | | Theme color role used for this series when no explicit fill takes precedence. One of good, bad, warn, neutral, neutralLight, highlight, total, others; series-N for step N of the theme ramp, 1-based (series-2 is color.series[1]); or status-<key> for a theme status colour. A hex colour goes in fill. |
|
|
75
75
|
| series[].fill | string | | Explicit CSS fill color for this series; remains authored across theme changes. |
|
|
@@ -88,7 +88,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
88
88
|
|---|---|---|---|---|
|
|
89
89
|
| labelDensity | string | `'full'`, `'smart'`, `'minimal'` | | Default 'smart': every column total stays eligible. A chart with more than 12 categories, or with most totals wider than the band, ranks the first, last, highest and lowest (ties: the first) first. The other totals then use only their natural seat above the column; 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 total on the bounded one-step rule and names any that finds no seat. 'full' treats all totals alike and names every one that finds no seat. Seats stay inside the plot band and one step from the natural seat. Reading records keep every value. |
|
|
90
90
|
| labels | false \| object | `false` (or another value of its type) | | Line end labels default to the value alone at both ends; point: ['series', 'absolute'] adds the series name. Authored point content applies to both ends. On stacked columns, segment: ['absolute', 'percent'] prints value and share in each segment, and a value its segment cannot hold is named in the note line; grandTotal: false hides stack totals. A single column series prints its values as grandTotal labels, so grandTotal: false hides them and keeps the line values; point governs line values only. Combo has no labels.growth: the growth statements of the dual-axis anatomy are dualAxis.growth. |
|
|
91
|
-
| legend | string \| object | `'top'`, `'bottom'`, `'none'`, `'auto'` (or another value of its type) | | Key position. Multiple series get a key unless direct labels name them. 'none' hides the key; render warns when names are missing. A series key also explains its scenario styling. |
|
|
91
|
+
| legend | string \| object | `'top'`, `'bottom'`, `'right'`, `'left'`, `'none'`, `'auto'` (or another value of its type) | | Key position. Multiple series get a key unless direct labels name them. 'none' hides the key; render warns when names are missing. A series key also explains its scenario styling. |
|
|
92
92
|
| secondaryAxis | object | | | Independent acknowledged secondary scale, or a percentage relabeling of the primary scale. An independent secondary scale returns the warning dual-axis. |
|
|
93
93
|
| secondaryAxis.acknowledge (secondaryAxis branch 1) | true | `true` | | Explicit acknowledgement that the right axis uses an independent scale. |
|
|
94
94
|
| secondaryAxis.domain (secondaryAxis branch 1) | array | | | Pin the secondary domain (data may only widen it, never be clipped). |
|
|
@@ -115,13 +115,14 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
115
115
|
| axisTitles.primary | string | | | Visible title above the primary value axis. |
|
|
116
116
|
| axisTitles.secondary | string | | | Visible title above the active secondary value axis. |
|
|
117
117
|
| interpolate | string | `'linear'`, `'step-after'`, `'step-before'`, `'monotone'` | | Interpolation for line/area series; per-series smooth overrides it. |
|
|
118
|
-
| dualAxis | object | | | Dual-axis anatomy: both scales from zero with one interval count and shared gridlines, maxima chosen so the line runs above the columns (the
|
|
118
|
+
| dualAxis | object | | | Dual-axis anatomy: both scales from zero with one interval count and shared gridlines, maxima chosen so the line runs above the columns (the columns shrink to a quarter of the plot when that is the only way; when no pair keeps the line above, the columns keep the lower 55% of the plot with the left ticks stopping at the column top, and the line floats in the band above on its own scale from its low to its high, with no right ticks and its ends, low and high printed, every point up to 8 categories, and the unit title over the top left tick; info lint dual-axis-line-floated), axis titles with a swatch of their series, column values inside the column top, the line's values above their points on a halo (every point up to 8 categories, else the first and last). Column values the line still covers are dropped; when one value is wider than its column, every column value sits above its column instead (labels.grandTotal: false hides them). With valueLabels 'all' (the anatomy's default up to 8 categories) every value is labelled, so neither tick column is drawn and the axis titles key both series in one row from the left; valueAxis.show or secondaryAxis.show brings the ticks back, and so does a value that finds no seat. Authored valueAxis.min or max, or a negative value, keep the plain dual axis and report the info lint dual-axis-anatomy-off. |
|
|
119
119
|
| dualAxis.anatomy | boolean | | | true draws the dual-axis anatomy on an acknowledged secondary scale the author did not pin. Default: the theme's valueAxis.dualAxis, else false. |
|
|
120
120
|
| dualAxis.growth | boolean | | `false` | With the anatomy, states each series' growth from its first to its last complete value beyond the right ticks, bold in the series' text ink, on one line with the series name up to its first comma ('+128% Units sold'); the name goes under the figure when one line would take more than a fifth of the canvas width. A partial category is no end, and the name then says the span. On a canvas narrower than 600 px the statements move to one note line ('Units sold +128%, Revenue +33%, 2019–2024.') and the plot keeps the width. Default false. |
|
|
121
|
-
| valueLabels | string | `'none'`, `'last'`, `'ends'`, `'extremes'`, `'all'` | | Which line values print, each at its point; the key row names the series. 'none', 'last' (default; the dual-axis anatomy defaults to 'all' up to 8 categories, else 'ends'), 'ends' (first and last), 'extremes' (ends plus low and high) or 'all'. Interior values sit on the side away from other lines, never nearer another line, or on the column with a backing; authored cell labels always print. |
|
|
121
|
+
| valueLabels | string | `'none'`, `'last'`, `'ends'`, `'extremes'`, `'all'` | | Which line values print, each at its point; the key row names the series. 'none', 'last' (default; the dual-axis anatomy defaults to 'all' up to 8 categories, else 'ends', and a line floated over the columns to 'all' up to 8 categories, else 'extremes'), 'ends' (first and last), 'extremes' (ends plus low and high) or 'all'. Interior values sit on the side away from other lines, never nearer another line, or on the column with a backing; authored cell labels always print. |
|
|
122
122
|
| latestPoint | string | `'ring'`, `'none'` | | Ring the last observed point of the lead line in the highlight colour, r 4.5 with a dot inside it, as on the line chart. 'ring' picks the first line series that is not a prior year, plan or forecast, and a forecast or plan point is never the one ringed. 'none' rings nothing, including the ring a theme with an ink lead line draws by default; omitted, the theme decides. |
|
|
123
123
|
| averageMarker | boolean \| object | | | Computed dashed average rule with a solver-placed Ø label on the primary axis, as on column: the mean over every category of the column stack, the columns in scope summed ('all' by default). A line named in the scope is left out with the warning average-marker-scope. |
|
|
124
124
|
| averageMarker.scope | string \| array | `'all'` (or another value of its type) | | Series included in the computed average; defaults to 'all'. |
|
|
125
|
+
| averageMarker.includePartial | boolean | | | true averages the categories marked partial too. By default they are left out, and the label names the periods the average covers. Column, bar and combo. |
|
|
125
126
|
| referenceStyle | string | `'tick'`, `'line'`, `'marker'` | `'tick'` | How reference series draw, as on bar and column: 'tick' (default) a solid plan tick across the column, 'line' the same span dashed at 1.25px, 'marker' a dot at the column centre. |
|
|
126
127
|
| referenceTick | object | | | Weight and ink of the reference tick, as on bar, read under referenceStyle 'tick' only: the dashed 'line' keeps its 1.25px and the 'marker' its dot. |
|
|
127
128
|
| referenceTick.width | number | | `2.2` | Stroke width of the tick in px; default 2.2. |
|
|
@@ -136,7 +137,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
136
137
|
| events.groups[].glyph | string | `'dot'`, `'triangle'`, `'diamond'`, `'square'` | | Shape that marks the kind without colour; default by group order: dot, triangle, diamond, square. |
|
|
137
138
|
| events.keyTitle | string | | | Heading printed over the event key. |
|
|
138
139
|
|
|
139
|
-
Plus the [shared options](options.md). This type does not accept `valueAxis.
|
|
140
|
+
Plus the [shared options](options.md). This type does not accept `valueAxis.log`, `valueAxis.reverse`, `valueAxis.break`. This type ignores `animate`, `debug`, `rowLabels`, `sort`, `topN` with an `option-ignored` warning.
|
|
140
141
|
|
|
141
142
|
## Annotations
|
|
142
143
|
|
|
@@ -144,7 +145,7 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
144
145
|
|
|
145
146
|
| Kind | Purpose | Required | Anchors | Optional fields | Notes |
|
|
146
147
|
|---|---|---|---|---|---|
|
|
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. | 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 category, which reads the first drawn series) 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
|
+
| 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 category, which reads the first drawn series) 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
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. |
|
|
149
150
|
| 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 | | Drawn reference series accept anchors. |
|
|
150
151
|
| 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. |
|
|
@@ -187,6 +188,7 @@ Below the floor a render is refused with `size-below-floor` and the pixels it ne
|
|
|
187
188
|
| theme-dual-axis-anatomy | example | A theme draws every acknowledged dual axis with its anatomy |
|
|
188
189
|
| revenue-units-dual-axis-anatomy | example | Dual-axis anatomy: shared gridlines, the line above the columns, both growth rates stated |
|
|
189
190
|
| daily-columns-rate-reference | torture | Daily columns, rate endpoints and a named reference on a flat dashboard |
|
|
191
|
+
| dual-axis-line-floated | example | A margin line floats over the revenue columns on its own scale |
|
|
190
192
|
| option-step-after | example | Output and available capacity |
|
|
191
193
|
| option-step-before | example | Output and available capacity |
|
|
192
194
|
| combo-end-label-collision | torture | Line end value and last column total placed as a pair |
|
|
@@ -125,7 +125,7 @@ One form; its chart ID is `creative`.
|
|
|
125
125
|
|---|---|---|---|---|
|
|
126
126
|
| footnotes | false | `false` | | false leaves the source line and the method lines (the account-median basis and the fatigue rule) off the card, for a host that shows them in its own frame; the texts stay in frame.source and frame.notes, and the fatigue status line stays on the card. No list of notes is taken. |
|
|
127
127
|
|
|
128
|
-
Plus the [shared options](options.md). This type does not accept `a11y`, `belowMinimum`, `margin`, `canvas`, `unit`, `unitShown`, `strings`, `format`, `detailFields`, `smallValues`, `labelDensity`, `labels`, `
|
|
128
|
+
Plus the [shared options](options.md). This type does not accept `a11y`, `belowMinimum`, `margin`, `canvas`, `unit`, `unitShown`, `strings`, `format`, `detailFields`, `smallValues`, `labelDensity`, `labels`, `labelPlacements`, `legend`, `valueAxis`, `scaleGroup`, `highlight`, `story`, `focus`, `hatchStrength`, `rounding`, `annotations`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `sort`, `topN`, `bandFraction`, `valueAxis.show`, `valueAxis.gridlines` with an `option-ignored` warning.
|
|
129
129
|
|
|
130
130
|
## Annotations
|
|
131
131
|
|
|
@@ -1,16 +1,50 @@
|
|
|
1
1
|
# Diagram
|
|
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).
|
|
3
|
+
Contents: [Use cases](#use-cases), [Design](#design), [Chart IDs](#chart-ids), [Minimal spec](#minimal-spec), [Data](#data), [Options](#options), [Annotations](#annotations), [Sizing](#sizing), [Fixtures](#fixtures), [Not for](#not-for).
|
|
4
4
|
|
|
5
5
|
<!-- Generated by scripts/generate-reference.mjs from the boardplot describe, list and fixtures payloads. -->
|
|
6
6
|
|
|
7
|
-
Deterministic node-edge diagrams with
|
|
7
|
+
Deterministic node-edge diagrams with eight consulting presets, obstacle-aware routing, and structural descriptions. Type `diagram`.
|
|
8
8
|
|
|
9
9
|
## Use cases
|
|
10
10
|
|
|
11
11
|
- Process or organisation flow
|
|
12
12
|
- Driver tree or value chain
|
|
13
13
|
- Organisation chart
|
|
14
|
+
- System architecture and data flow
|
|
15
|
+
- Trust boundaries and protected zones
|
|
16
|
+
|
|
17
|
+
## Design
|
|
18
|
+
|
|
19
|
+
**Message:** How parts connect: a structure, a process, or a system and its data flows.
|
|
20
|
+
|
|
21
|
+
**Use when:** The links between the parts are the message, such as an organisation, a driver tree, a process or a system architecture with `variant: architecture`.
|
|
22
|
+
|
|
23
|
+
**Not when:** The message is a number or a change (a chart); the items only rank (bar or table); dated work over time (gantt or the roadmap variant).
|
|
24
|
+
|
|
25
|
+
### design-diagram-variant
|
|
26
|
+
|
|
27
|
+
Pick the variant that matches the links: architecture for systems, data flow and trust boundaries; linear-process for steps; hierarchy for reporting lines. This rule needs the author's judgment; render does not check it.
|
|
28
|
+
|
|
29
|
+
### design-diagram-title
|
|
30
|
+
|
|
31
|
+
Write the finding in the title, such as "Only the protected runtime reads the keys", not the name of the system. This rule needs the author's judgment; render does not check it.
|
|
32
|
+
|
|
33
|
+
### design-diagram-one-focus
|
|
34
|
+
|
|
35
|
+
Mark one node or path with options.highlight, so the reader sees the message first and the structure second. This rule needs the author's judgment; render does not check it.
|
|
36
|
+
|
|
37
|
+
### design-diagram-size
|
|
38
|
+
|
|
39
|
+
Keep an exhibit to about 20 nodes; split a larger system into one overview and detail exhibits. This rule needs the author's judgment; render does not check it.
|
|
40
|
+
|
|
41
|
+
### design-diagram-return
|
|
42
|
+
|
|
43
|
+
Set flow: return on a feedback edge, so it stays out of the node order and on the outer corridors. This rule needs the author's judgment; render does not check it.
|
|
44
|
+
|
|
45
|
+
### design-diagram-protected
|
|
46
|
+
|
|
47
|
+
Set protected only where the claim is true: the lock states that the zone is protected, and the engine cannot check it. This rule needs the author's judgment; render does not check it.
|
|
14
48
|
|
|
15
49
|
## Chart IDs
|
|
16
50
|
|
|
@@ -21,6 +55,7 @@ Deterministic node-edge diagrams with seven consulting presets, obstacle-aware r
|
|
|
21
55
|
- `diagram.circular-process`: fixture `operating-cycle`
|
|
22
56
|
- `diagram.strategy-house`: fixture `strategy-house`
|
|
23
57
|
- `diagram.roadmap`: fixture `growth-roadmap`
|
|
58
|
+
- `diagram.architecture`: fixture `protected-request`
|
|
24
59
|
|
|
25
60
|
## Minimal spec
|
|
26
61
|
|
|
@@ -51,7 +86,7 @@ Deterministic node-edge diagrams with seven consulting presets, obstacle-aware r
|
|
|
51
86
|
|---|---|---|---|
|
|
52
87
|
| nodes | array | yes | One to 80 uniquely identified diagram nodes. |
|
|
53
88
|
| nodes[].id | string | yes | Trimmed identifier of at most 80 Unicode code points; control characters and the auto: prefix are reserved. |
|
|
54
|
-
| nodes[].kind | string | yes | Semantic node kind
|
|
89
|
+
| nodes[].kind | string | yes | Semantic node kind. Each variant reads: hierarchy 'entity'; issue-tree 'issue' or 'driver'; linear-process and circular-process 'step'; customer-journey 'painPoint'; roadmap 'milestone'. Another kind is refused with invalid-diagram-kind. strategy-house and architecture do not check the kind. One of `'entity'`, `'issue'`, `'driver'`, `'step'`, `'painPoint'`, `'vision'`, `'objective'`, `'initiative'`, `'enabler'`, `'foundation'`, `'milestone'`, `'callout'`. |
|
|
55
90
|
| nodes[].shape | object | yes | Node outline or icon-only shape. |
|
|
56
91
|
| nodes[].shape.kind (nodes[].shape branch 1) | string | yes | Select the rectangle node shape. One of `'rectangle'`. |
|
|
57
92
|
| nodes[].shape.kind (nodes[].shape branch 2) | string | yes | Select the roundedRect node shape. One of `'roundedRect'`. |
|
|
@@ -61,11 +96,12 @@ Deterministic node-edge diagrams with seven consulting presets, obstacle-aware r
|
|
|
61
96
|
| nodes[].shape.kind (nodes[].shape branch 5) | string | yes | Select the chevron node shape. One of `'chevron'`. |
|
|
62
97
|
| nodes[].shape.tip (nodes[].shape branch 5) | number | | Chevron tip depth as a fraction of width; defaults to 0.16 and is capped by shape height. |
|
|
63
98
|
| nodes[].shape.kind (nodes[].shape branch 6) | string | yes | Select the text node shape. One of `'text'`. |
|
|
64
|
-
| nodes[].shape.kind (nodes[].shape branch 7) | string | yes | Select the
|
|
65
|
-
| nodes[].shape.
|
|
66
|
-
| nodes[].shape.
|
|
67
|
-
| nodes[].shape.
|
|
68
|
-
| nodes[].shape.
|
|
99
|
+
| nodes[].shape.kind (nodes[].shape branch 7) | string | yes | Select the store node shape. One of `'store'`. |
|
|
100
|
+
| nodes[].shape.kind (nodes[].shape branch 8) | string | yes | Select the icon node shape. One of `'icon'`. |
|
|
101
|
+
| nodes[].shape.name (nodes[].shape branch 8) | string | yes | Name from the built-in icon catalogue. |
|
|
102
|
+
| nodes[].shape.kind (nodes[].shape branch 9) | string | yes | Select the roof node shape. One of `'roof'`. |
|
|
103
|
+
| nodes[].shape.apex (nodes[].shape branch 9) | number | | Horizontal roof apex as a fraction of width; defaults to 0.5. |
|
|
104
|
+
| nodes[].shape.eaveInset (nodes[].shape branch 9) | number | | Inset of each roof eave as a fraction of width; defaults to 0. |
|
|
69
105
|
| nodes[].label | string | yes | Primary visible node label, at most 200 Unicode code points. |
|
|
70
106
|
| nodes[].secondaryLabel | string | | Secondary line inside the node, at most 400 Unicode code points. |
|
|
71
107
|
| nodes[].caption | string | | Supporting caption placed near the node, at most 400 Unicode code points. |
|
|
@@ -94,16 +130,22 @@ Deterministic node-edge diagrams with seven consulting presets, obstacle-aware r
|
|
|
94
130
|
| nodes[].ports[].intent | string | | Allowed edge direction: incoming, outgoing or both. One of `'in'`, `'out'`, `'bidi'`. |
|
|
95
131
|
| nodes[].ports[].capacity | integer | | Maximum number of edge endpoints assigned to this port. |
|
|
96
132
|
| nodes[].groupId | string | | Id of an existing group containing this node. |
|
|
97
|
-
| nodes[].laneId | string | | Id of an existing lane containing this node. |
|
|
133
|
+
| nodes[].laneId | string | | Id of an existing lane containing this node. Architecture with flow 'lanes' requires it except on policy-strip nodes, which must omit it. |
|
|
98
134
|
| nodes[].order | integer | | Ordering key: nodes sort by order, a node without one by its 0-based position in nodes, ties by id. Automatic step numbers follow this order. |
|
|
135
|
+
| nodes[].track | string | | Architecture only: named cross-axis track. Nodes in one track line up across zones or lanes. |
|
|
136
|
+
| nodes[].span | string | | Architecture only: a wide band across its lane, or a full-height rail in its zone. One of `'full'`. |
|
|
137
|
+
| nodes[].repeat | integer | | Architecture only: draws 2 to 5 stacked copies, for repeated workers. |
|
|
138
|
+
| nodes[].protected | boolean | | Architecture only: a lock and a double border. This is an authored claim. |
|
|
99
139
|
| edges | array | | Up to 160 uniquely identified links between distinct existing nodes. |
|
|
100
140
|
| edges[].id | string | yes | Trimmed identifier of at most 80 Unicode code points; control characters and the auto: prefix are reserved. |
|
|
101
|
-
| edges[].source | object | yes | Edge origin
|
|
102
|
-
| edges[].source.nodeId | string | yes | Id of the existing node at this edge endpoint. |
|
|
103
|
-
| edges[].source.portId | string | | Named port on the endpoint node; omission allows automatic port selection. |
|
|
104
|
-
| edges[].
|
|
105
|
-
| edges[].target
|
|
106
|
-
| edges[].target.
|
|
141
|
+
| edges[].source | object | yes | Edge origin: a node with an optional named output port, or a zone in variant architecture. |
|
|
142
|
+
| edges[].source.nodeId (edges[].source branch 1) | string | yes | Id of the existing node at this edge endpoint. |
|
|
143
|
+
| edges[].source.portId (edges[].source branch 1) | string | | Named port on the endpoint node; omission allows automatic port selection. |
|
|
144
|
+
| edges[].source.groupId (edges[].source branch 2) | string | yes | Id of the existing zone whose frame this edge ends on. |
|
|
145
|
+
| edges[].target | object | yes | Edge destination: a node with an optional named input port, or a zone in variant architecture. |
|
|
146
|
+
| edges[].target.nodeId (edges[].target branch 1) | string | yes | Id of the existing node at this edge endpoint. |
|
|
147
|
+
| edges[].target.portId (edges[].target branch 1) | string | | Named port on the endpoint node; omission allows automatic port selection. |
|
|
148
|
+
| edges[].target.groupId (edges[].target branch 2) | string | yes | Id of the existing zone whose frame this edge ends on. |
|
|
107
149
|
| edges[].routing | string | | Requested edge path style. curved draws only in circular-process; other variants draw it orthogonal with diagram-route-degraded. One of `'straight'`, `'elbow'`, `'orthogonal'`, `'curved'`. |
|
|
108
150
|
| edges[].arrowStart | boolean | | Whether to draw an arrowhead at the source endpoint. |
|
|
109
151
|
| edges[].arrowEnd | boolean | | Whether to draw an arrowhead at the target endpoint. |
|
|
@@ -115,6 +157,7 @@ Deterministic node-edge diagrams with seven consulting presets, obstacle-aware r
|
|
|
115
157
|
| edges[].waypoints | array | | Up to 12 authored route waypoints in normalized plot coordinates. |
|
|
116
158
|
| edges[].waypoints[].x | number | yes | Horizontal position as a fraction of the diagram plot width. |
|
|
117
159
|
| edges[].waypoints[].y | number | yes | Vertical position as a fraction of the diagram plot height. |
|
|
160
|
+
| edges[].flow | string | | Architecture only: a return edge does not set the node order and may close a loop. Default forward. One of `'forward'`, `'return'`. |
|
|
118
161
|
| groups | array | | Up to 32 named visual groups referenced by node.groupId. |
|
|
119
162
|
| groups[].id | string | yes | Trimmed identifier of at most 80 Unicode code points; control characters and the auto: prefix are reserved. |
|
|
120
163
|
| groups[].title | string | yes | Visible group title, at most 200 Unicode code points. |
|
|
@@ -122,6 +165,9 @@ Deterministic node-edge diagrams with seven consulting presets, obstacle-aware r
|
|
|
122
165
|
| groups[].order | integer | | Authored ordering key used by the selected diagram variant. |
|
|
123
166
|
| groups[].role | string | | Visual emphasis or semantic tone for this element. One of `'primary'`, `'accent'`, `'secondary'`, `'muted'`, `'good'`, `'bad'`, `'warn'`, `'category'`. |
|
|
124
167
|
| groups[].paletteKey | string | | Stable categorical color key; required only when role is category. |
|
|
168
|
+
| groups[].kind | string | | Architecture only: a policy group is a strip across the exhibit, and its nodes take no edges. Default zone. One of `'zone'`, `'policy'`. |
|
|
169
|
+
| groups[].parentId | string | | Architecture only: the zone this zone sits in, up to three levels. |
|
|
170
|
+
| groups[].protected | boolean | | Architecture only: a lock and a double frame. This is an authored claim. |
|
|
125
171
|
| lanes | array | | Up to 32 named partitions referenced by node.laneId. |
|
|
126
172
|
| lanes[].id | string | yes | Trimmed identifier of at most 80 Unicode code points; control characters and the auto: prefix are reserved. |
|
|
127
173
|
| lanes[].label | string | | Optional visible label, at most 200 Unicode code points. |
|
|
@@ -135,15 +181,37 @@ Deterministic node-edge diagrams with seven consulting presets, obstacle-aware r
|
|
|
135
181
|
| key[].label (key[] branch 1) | string | yes | What the fill means, at most 80 Unicode code points. |
|
|
136
182
|
| key[].line (key[] branch 2) | string | yes | The edge style this entry names, drawn as the edges draw it. One of `'solid'`, `'dashed'`, `'dotted'`. |
|
|
137
183
|
| key[].label (key[] branch 2) | string | yes | What the line style means, at most 80 Unicode code points. |
|
|
184
|
+
| channels | array | | Architecture only: up to 16 shared labels, each for edges that cross one gutter. |
|
|
185
|
+
| channels[].id | string | yes | Trimmed identifier of at most 80 Unicode code points; control characters and the auto: prefix are reserved. |
|
|
186
|
+
| channels[].edgeIds | array | yes | Ids of the edges this label names; they must cross one common gutter. |
|
|
187
|
+
| channels[].label | string | yes | The shared label, at most 80 Unicode code points. |
|
|
188
|
+
| callouts | array | | Architecture only: up to 16 numbered discs, numbered in this order. |
|
|
189
|
+
| callouts[].id | string | yes | Trimmed identifier of at most 80 Unicode code points; control characters and the auto: prefix are reserved. |
|
|
190
|
+
| callouts[].target | object | yes | The node, edge or zone that carries the number. Each target takes one callout. In flow 'lanes', a zone must contain a node. |
|
|
191
|
+
| callouts[].target.nodeId (callouts[].target branch 1) | string | yes | Id of the node this callout marks. |
|
|
192
|
+
| callouts[].target.edgeId (callouts[].target branch 2) | string | yes | Id of the edge this callout marks. |
|
|
193
|
+
| callouts[].target.groupId (callouts[].target branch 3) | string | yes | Id of the zone this callout marks. |
|
|
194
|
+
| callouts[].title | string | | Short name in the key row, at most 80 Unicode code points. |
|
|
195
|
+
| callouts[].text | string | | Explanation in the key row, at most 200 Unicode code points. |
|
|
196
|
+
| inset | object | | Architecture only: a detail panel after a rule, beside the exhibit from 800 px and under it below that. |
|
|
197
|
+
| inset.title | string | yes | Panel title, at most 80 Unicode code points. |
|
|
198
|
+
| inset.kpis | array | | Up to 4 large numbers. |
|
|
199
|
+
| inset.kpis[].value | string | yes | The large number as text, at most 16 Unicode code points. |
|
|
200
|
+
| inset.kpis[].label | string | yes | What the number means, at most 60 Unicode code points. |
|
|
201
|
+
| inset.rows | array | | Up to 12 short rows. |
|
|
202
|
+
| inset.rows[].label | string | yes | Row name, at most 60 Unicode code points. |
|
|
203
|
+
| inset.rows[].value | string | yes | Row value as text, at most 24 Unicode code points. |
|
|
138
204
|
|
|
139
205
|
## Options
|
|
140
206
|
|
|
141
207
|
| Path | Type | Values | Default | Meaning |
|
|
142
208
|
|---|---|---|---|---|
|
|
143
|
-
| variant | string | `'hierarchy'`, `'issue-tree'`, `'linear-process'`, `'customer-journey'`, `'circular-process'`, `'strategy-house'`, `'roadmap'` | | Required structural layout variant for the diagram. |
|
|
144
|
-
| flow | string | `'columns'`, `'serpentine'` | |
|
|
209
|
+
| variant | string | `'hierarchy'`, `'issue-tree'`, `'linear-process'`, `'customer-journey'`, `'circular-process'`, `'strategy-house'`, `'roadmap'`, `'architecture'` | | Required structural layout variant for the diagram. |
|
|
210
|
+
| flow | string | `'columns'`, `'serpentine'`, `'lanes'` | | Layout flow: columns or serpentine for customer-journey, columns or lanes for architecture. |
|
|
211
|
+
| heightFill | string | `'rows'`, `'none'` | `'rows'` | Spare canvas height, read by hierarchy (org chart) and customer-journey. 'rows' (default): a canvas with a set height grows the gaps between the levels up to 2.6 times. 'none': natural gaps, the block centred. |
|
|
212
|
+
| highlight | string \| array | | | Architecture only: the node and edge ids that carry the message. They take the accent, and everything else recedes. |
|
|
145
213
|
|
|
146
|
-
Plus the [shared options](options.md). This type does not accept `belowMinimum`, `unit`, `unitShown`, `strings`, `format`, `detailFields`, `smallValues`, `labelDensity`, `labels`, `
|
|
214
|
+
Plus the [shared options](options.md). This type does not accept `belowMinimum`, `unit`, `unitShown`, `strings`, `format`, `detailFields`, `smallValues`, `labelDensity`, `labels`, `labelPlacements`, `legend`, `valueAxis`, `scaleGroup`, `story`, `focus`, `hatchStrength`, `rounding`, `annotations`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `sort`, `topN`, `bandFraction`, `valueAxis.show`, `valueAxis.gridlines` with an `option-ignored` warning.
|
|
147
215
|
|
|
148
216
|
## Annotations
|
|
149
217
|
|
|
@@ -185,6 +253,14 @@ Below the floor a render is refused with `size-below-floor` and the pixels it ne
|
|
|
185
253
|
| four-child-start-arrow | torture | A start arrow clears a neighbouring group frame |
|
|
186
254
|
| stacked-leaf-captions | torture | Every stacked leaf keeps its caption |
|
|
187
255
|
| long-border-badges | torture | Long badge phrases keep clear of node labels |
|
|
256
|
+
| protected-request | example | A request stays protected on its way to private processing and back |
|
|
257
|
+
| marketing-pipeline | example | Rejected records return to the source for repair |
|
|
258
|
+
| journey-attribution | example | Multi-touch attribution from customer journey to budget |
|
|
259
|
+
| nested-service | example | A service nested three levels deep, with one protected runtime |
|
|
260
|
+
| agent-approval | example | An agent reaches its tools through an approval gate |
|
|
261
|
+
| pipeline-health | example | A data pipeline with its service levels beside it |
|
|
262
|
+
| long-names | torture | Long names keep every word at every width |
|
|
263
|
+
| twenty-node-platform | torture | Twenty nodes and thirty edges across four zones |
|
|
188
264
|
|
|
189
265
|
## Not for
|
|
190
266
|
|
|
@@ -192,7 +192,7 @@ A KPI table: measures by one hierarchical dimension by period, switchable betwee
|
|
|
192
192
|
| measures[].value.a (measures[].value branch 5) | object \| number | yes | Expression over additive sums, other measures and constants. A Total operand evaluates its whole expression against dimension.total.id in the same current, prior, displayed-period ref or plan window. Nested Total keeps this scope. |
|
|
193
193
|
| measures[].value.b (measures[].value branch 5) | object \| number | yes | Expression over additive sums, other measures and constants. A Total operand evaluates its whole expression against dimension.total.id in the same current, prior, displayed-period ref or plan window. Nested Total keeps this scope. |
|
|
194
194
|
| measures[].value.factor (measures[].value branch 5) | number | | Multiplier of the result: 100 for a percent level, 1000 for CPM. |
|
|
195
|
-
| measures[].scale | string | | Precision rule from the largest absolute Range or period value; changes do not count. Money and count take it over every member row of the measure, so the measure prints in one magnitude: a member at 210k under a 1.2M total prints 0.21M, not 210.0k. Per unit and percent take it per row. Money: k, M or B with one decimal at 1000 or more, else whole units; every member row prints at the precision of the measure: a nonzero figure below it prints the bound (<0.01M), an exact zero prints 0, and a count never gains decimals. Per unit: fractional values keep authored precision. Without a format, start whole at 10 or more, else one decimal, then raise precision for rounding error above 1%, up to 20 decimals. Integer-only rows keep those defaults. Money and per unit drop format affixes; put the currency in unit. Count and percent keep the format; defaults 1,234 and 1.2%. Scaled money and automatic count rows add decimals for rounding error above 1% of the largest value of the measure, up to 20; held whole thousands stay whole. Nonzero values never print as zero. Absent keeps the format. One of `'money'`, `'perUnit'`, `'count'`, `'percent'`. |
|
|
195
|
+
| measures[].scale | string | | Precision rule from the largest absolute Range or period value; changes do not count. Money and count take it over every member row of the measure, so the measure prints in one magnitude: a member at 210k under a 1.2M total prints 0.21M, not 210.0k. Per unit and percent take it per row. Money: k, M or B with one decimal at 1000 or more, else whole units; every member row prints at the precision of the measure: a nonzero figure below it prints the bound (<0.01M), an exact zero prints 0, and a count never gains decimals. Per unit: fractional values keep authored precision. Without a format, start whole at 10 or more, else one decimal, then raise precision for rounding error above 1%, up to 20 decimals. Integer-only rows keep those defaults. Money and per unit drop format affixes; put the currency in unit. Count and percent keep the format; defaults 1,234 and 1.2%. Scaled money and automatic count rows add decimals for rounding error above 1% of the largest value of the measure in that column, up to 20, so a period column can print more decimals than the Range column; held whole thousands stay whole. Nonzero values never print as zero. Absent keeps the format. One of `'money'`, `'perUnit'`, `'count'`, `'percent'`. |
|
|
196
196
|
| measures[].bands | array | | Range and period value bands in original units; percent levels use percentage points. Select the first value <= to, or the last band above all bounds. Missing tone means neutral. Bands replace level change colours; judge still colours comparisons. Partial windows and failed sample floors stay neutral. |
|
|
197
197
|
| measures[].bands[].tone | string | | Semantic band tone. One of `'good'`, `'warn'`, `'bad'`, `'neutral'`. |
|
|
198
198
|
| measures[].bands[].to | number | yes | Upper endpoint of this band in the value units. |
|
|
@@ -231,7 +231,7 @@ A KPI table: measures by one hierarchical dimension by period, switchable betwee
|
|
|
231
231
|
| facts | array | yes | Additive sums per member and period, one entry each. |
|
|
232
232
|
| facts[].memberId | string | yes | Stable id or display label. |
|
|
233
233
|
| facts[].periodId | string | yes | Stable id or display label. |
|
|
234
|
-
| facts[].sums | object | yes | Sums by field: an absent field drops its measures, null is missing, 0 is data.
|
|
234
|
+
| facts[].sums | object | yes | Sums by field: an absent field drops its measures, null is missing, 0 is data. A field absent or null in every fact of a member does not apply to it, null in some facts is missing, and a host that means zero sends 0. With dimension.sums true, a member owes a field it reports in any period in every period, and a gap makes the parent sum missing. |
|
|
235
235
|
| facts[].ref | object | | Sums of the period before (partial: the same days one period earlier). Only displayed periods take ref; Range compares with prior and optional plan. |
|
|
236
236
|
|
|
237
237
|
## Options
|
|
@@ -243,7 +243,7 @@ A KPI table: measures by one hierarchical dimension by period, switchable betwee
|
|
|
243
243
|
| driverTones | string | `'grouped'`, `'always'`, `'never'` | | Driver tones. 'grouped' (default): drivers with a parentId whose parent is not a section heading do, as statement lines do. 'always': every driver. 'never': driver ink only, as before 0.28. Neutral figures and labels keep the driver ink. |
|
|
244
244
|
| judgements | string | `'all'`, `'exceptions'` | | Which tones show. exceptions: strong good and bad only. |
|
|
245
245
|
| variant | string | `'by-measure'`, `'by-member'` | `'by-measure'` | by-measure: KPI rows over members (by-member: members over KPIs, Total first). In by-member the Total block is always open. |
|
|
246
|
-
| encodings | object | | | Per-column opt-in visual encodings. |
|
|
246
|
+
| encodings | object | | | Per-column opt-in visual encodings. A key is a column id: range, pp (the vs prior column), pl (the vs plan column, with a plan) or the id of a displayed period. Any other key draws nothing and warns dimswitch-encoding-column. |
|
|
247
247
|
| encodings.*.type (encodings.* branch 5) | string | `'arrow'` | | Select the arrow lane. |
|
|
248
248
|
| encodings.*.scale (encodings.* branch 5) | string | `'absolute'`, `'relative'` | | 'absolute' cuts the change itself at 10 and 2 (points on a percent column); 'relative' cuts its share of the column's largest change at 10% and 2%. Default 'absolute' on a percent column, 'relative' elsewhere. |
|
|
249
249
|
| encodings.*.type (encodings.* branch 6) | string | `'heat'` | | Select the heat lane. |
|
|
@@ -280,11 +280,12 @@ A KPI table: measures by one hierarchical dimension by period, switchable betwee
|
|
|
280
280
|
| stickyLabels.top | number | | | Offset in px. Clears a host toolbar. Default 0; above 0 needs head: 'page'. |
|
|
281
281
|
| stickyLabels.sections | boolean | | | Section label. Default false. true keeps the active section label under the head until the next section starts. |
|
|
282
282
|
| frameFill | string | `'values'`, `'none'` | `'values'` | Under rowExtent 'frame'. 'values' (default): automatic value tracks grow in whole pixels, up to maxGrowth (default 2.5). An unauthored label track takes the rest. 'none': columns keep their widths; an empty track carries the row ground and rules to the edge. |
|
|
283
|
-
|
|
|
284
|
-
|
|
|
283
|
+
| heightFill | string | `'rows'`, `'none'` | `'rows'` | Spare canvas height. 'rows' (default) spreads it over leaf rows as air, up to 16 px a side. 'none' leaves it empty. |
|
|
284
|
+
| rowLabelLines | number | `1`, `2` | `2` | Lines a row label may take before a cut (default 2). A label breaks at a space or after _ - / or a dot, so a long campaign name wraps instead of ending in '…'. 1 keeps every label on one line. The hover card always prints the full name. |
|
|
285
|
+
| lastTrackFlex | boolean | | | Last unauthored track takes the spare frame width when rowExtent is tracks. Default false. |
|
|
285
286
|
| rowExtent | string | `'tracks'`, `'frame'` | `'frame'` | Where rows end. 'frame' (default) fills the width inside the frame margins. An explicit 'frame' also carries row grounds and rules through authored side margins. frameFill controls track growth. 'tracks' stops rows at the last column. Column bands stop at their columns. Tables use horizontal rules and explicit column separators; there is no single vertical end rule. |
|
|
286
|
-
| sortIndicator | string | `'all'`, `'sorted'` | |
|
|
287
|
-
| levelOffset | integer | | | Shift
|
|
287
|
+
| sortIndicator | string | `'all'`, `'sorted'` | | Sortable headers with a chevron. 'all' (the default) draws one on every sortable header; 'sorted' draws it on the sorted one alone and keeps the others' reserve, so no track moves. |
|
|
288
|
+
| levelOffset | integer | | | Shift body rows down the ladder. Default 0. A board whose top rows are groups rather than KPI lines reads one rung too heavy: 1 steps them down in size, weight, air, ground, indent and label ink, -1 steps them up. The rungs stay floored at the top and at the deepest step. |
|
|
288
289
|
| cellPadX | number | | | Horizontal cell padding in px. Default 12; only when it cannot fit, use 5 for 20–24 columns or 3 for 25 or more. |
|
|
289
290
|
| groupRule | string | `'label'`, `'span'` | `'span'` | Heading rule. 'span' (default) rules every column of the group, so it shows which columns the heading covers; 'label' underlines the heading text alone. |
|
|
290
291
|
| groupAlign | string | `'left'`, `'center'`, `'right'` | `'center'` | Heading position. 'center' (default) centres the heading over its columns; in the React grid a group wider than the visible scroll area starts its heading at the first column, and the heading stays in view while the group scrolls. 'left' always starts it at the first column, 'right' ends it at the last. A heading wider than its columns starts at the first column. |
|
|
@@ -327,7 +328,7 @@ A KPI table: measures by one hierarchical dimension by period, switchable betwee
|
|
|
327
328
|
| widths.period | number | | | Track of each period in px; default 94. |
|
|
328
329
|
| minimumSample | object | | | Minimum judge base per sum field in BOTH windows (below it: neutral). Default none. |
|
|
329
330
|
|
|
330
|
-
Plus the [shared options](options.md). This type does not accept `detailFields`, `labels`, `
|
|
331
|
+
Plus the [shared options](options.md). This type does not accept `detailFields`, `labels`, `valueAxis`, `story`, `hatchStrength`, `rounding`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `topN`, `bandFraction`, `valueAxis.show`, `valueAxis.gridlines` with an `option-ignored` warning.
|
|
331
332
|
|
|
332
333
|
## Annotations
|
|
333
334
|
|
|
@@ -414,6 +415,8 @@ Email no spend: no Paid media group
|
|
|
414
415
|
|
|
415
416
|
`depth` opens the row tree level by level, like the outline buttons 1, 2 and 3 of a spreadsheet. Every row that can fold has an outline level, and depth d shows the rows of level d or less. Without a statement, the levels are the member levels, with the same meaning in both variants. Depth 1 shows the measures of the Total only; by-member also shows the top-level members as folded rows. Depth 2 also shows every measure of the top-level members. Depth 3 also shows every measure of their children. In general, depth d shows the measures of the Total and of d − 1 member levels; by-member also shows the next member level as folded rows. The maximum depth is the number of member levels plus one, so 3 for a dimension with two levels. A statement adds levels: see [Depth with a statement](#statements-subtotals-results-and-drivers). Section rows, group label rows, split rows and change lines take no level.
|
|
416
417
|
|
|
418
|
+
On a fixed height, such as a slide or a print canvas, a table that misses the height at its `depth` draws one fold shallower, down to depth 1. By-member then also folds the Total. The table keeps the deepest fold that fits and warns with `dimswitch-depth-folded`, whose fix sets `options.depth` and, where the Total folded, adds its row to `expansion.collapsed`. An open height grows to its rows and never folds. A folded table sets the decimals of each change column from the rows it draws, so a hidden row with a small change does not keep a decimal on the figures of the rows that show. Where depth 1 still misses, the size refusal names the least height the folded table needs.
|
|
419
|
+
|
|
417
420
|
These are the row counts of the worked example. They include section rows and group label rows, not change lines.
|
|
418
421
|
|
|
419
422
|
| variant | splits | depth 1 | depth 2 | depth 3 |
|
|
@@ -427,7 +430,7 @@ These are the row counts of the worked example. They include section rows and gr
|
|
|
427
430
|
|
|
428
431
|
`group` collects measures. In by-measure each group starts a section row. `groupHeadings` sets the text of that row, and `dimension.total.heading` names the section over the measures before the first group. by-measure has section rows only when at least one measure has a group. In by-member each member block shows a group label row with the measures of the group under it. A member for which no measure of the group applies shows no group label row. `divider: true` draws a rule above the rows of a measure, to start a family of KPIs without a section row.
|
|
429
432
|
|
|
430
|
-
In by-member the Total block is
|
|
433
|
+
In by-member the Total block is open unless `expansion.collapsed` names its row. A folded Total shows its headline like a folded member row, and a table on a fixed height folds it after depth 1 (see the fixed height above). `inTotalBlock: false` leaves a measure out of the Total block, for example a platform KPI that has no meaning for the total; by-measure keeps the Total row of that measure. A folded member row shows its headline: the first measure in `dimension.headline` that applies to the member. The measure label and unit follow the member label, for example `Paid search Marketing spend, USD`. An open member row shows no figures.
|
|
431
434
|
|
|
432
435
|
## Host data: what to supply and how to compute it
|
|
433
436
|
|
|
@@ -459,7 +462,7 @@ GROUP BY w.period_id, r.member_id;
|
|
|
459
462
|
|
|
460
463
|
Map each result row to one fact: `{ "memberId": member_id, "periodId": period_id, "sums": { "orders": orders, "nc": nc, "spend": spend }, "ref": { "orders": ref_orders, "nc": ref_nc, "spend": ref_spend } }`. A SQL `SUM` over no rows gives NULL. Change that NULL to 0 for a field that applies to the member, and remove the key for a field that does not apply. The [React usage](#react-usage) example does this mapping.
|
|
461
464
|
|
|
462
|
-
A measure applies to a member when every local field that its `value` reads has a number in at least one fact of that member. Otherwise Boardplot leaves the row of that measure out for that member. If the Total lacks a field, the measure is left out everywhere. The three states of a field mean different things:
|
|
465
|
+
A measure applies to a member when every local field that its `value` reads has a number in at least one fact of that member. Otherwise Boardplot leaves the row of that measure out for that member. If the Total lacks a field, the measure is left out everywhere, with the warning `dimswitch-measure-omitted` and an entry in `reading.omissions`. With `dimension.sums: true` the Total has a field when at least one member has a number for it. The three states of a field mean different things:
|
|
463
466
|
|
|
464
467
|
- Absent or `null` in every fact of the member: the measure does not apply. Use this for a structural absence, such as spend for Email. A SQL export that gives `null` works as it is.
|
|
465
468
|
- `null` in some facts only: the measure applies, and those values are missing. Their cells print the missing glyph (—).
|
|
@@ -467,7 +470,7 @@ A measure applies to a member when every local field that its `value` reads has
|
|
|
467
470
|
|
|
468
471
|
To keep a row when the selected windows hold only `null` for a field, declare the field on the member: `{ "id": "email", "label": "Email", "fields": ["spend"] }` (and `dimension.total.fields` for the Total). The row then stays and prints the missing glyph. A statement line never leaves by applicability: see [Statements](#statements-subtotals-results-and-drivers). Decide applicability on the whole source data, not on the selected range, so rows do not appear and disappear when the reader changes the range. Source tables often fill spend with 0 for channels that never have spend. Remove that field or set it to `null` for those members; a 0 draws Marketing spend 0 and CAC 0.0 rows.
|
|
469
472
|
|
|
470
|
-
By default Boardplot uses the sums that you supply for every member and for the Total. Members do not have to add up to their parent: a channel list can leave out small channels, and members can overlap. Set `dimension.sums: true` only for a true partition. Boardplot then derives the sums of each parent, and of the Total, from its children, so supply no fact for the Total or for a parent member; for both `sums` and `ref`, and records the difference to any supplied parent sum as a reconciliation record. A field
|
|
473
|
+
By default Boardplot uses the sums that you supply for every member and for the Total. Members do not have to add up to their parent: a channel list can leave out small channels, and members can overlap. Set `dimension.sums: true` only for a true partition. Boardplot then derives the sums of each parent, and of the Total, from its children, so supply no fact for the Total or for a parent member; for both `sums` and `ref`, and records the difference to any supplied parent sum as a reconciliation record. A field that a child reports in no fact adds up over the other children. A child that reports a field in any period owes it in every period: a `null` value, a missing field or a missing fact makes the parent value `null`, and the Total prints the missing glyph. A missing fact or field also gives the warning `dimswitch-fact-missing`, which names the member and the periods. Send `null` for an unknown value and `0` for none.
|
|
471
474
|
|
|
472
475
|
## Measures: values, formats, changes and judgement
|
|
473
476
|
|
|
@@ -494,7 +497,7 @@ Scaled `money` and automatic `count` rows add decimals when rounding error excee
|
|
|
494
497
|
|
|
495
498
|
`money` drops the prefix, suffix and decimals of `format`. `perUnit` drops the prefix and suffix, but keeps authored precision for fractional values. Put the currency in `unit`. The unit prints after the KPI label, such as `Net revenue USD`, and not in the cells. Member rows and split rows repeat no unit. A `%` or `pp` unit next to a percent format is left out, because the cells already show it. A nonzero value never prints as zero: the row takes more decimals (0.004).
|
|
496
499
|
|
|
497
|
-
Each period value has a change line under it, and Range has the vs prior column. `change: "relative"` (the default) prints the percent change against the reference: whole percent from 5% and at 0% (+7%), and one decimal below 5% (+4.2%). With `relative`, a change of 1,000% or more, or a reference of 0 or less, prints n.m. A missing reference prints n/a. 0 against 0 prints nothing. `change: "pp"` prints the difference of the two percent levels with one decimal (+0.9pp). Use `pp` for shares and rates. `change: "absolute"` prints the current value minus the reference value, in the measure format with a sign (+0.4). Use it on statement lines, where the changes add up down the statement.
|
|
500
|
+
Each period value has a change line under it, and Range has the vs prior column. `change: "relative"` (the default) prints the percent change against the reference: whole percent from 5% and at 0% (+7%), and one decimal below 5% (+4.2%). With `relative`, a change of 1,000% or more, or a reference of 0 or less, prints n.m. A missing reference prints n/a. 0 against 0 prints nothing. A displayed period whose facts carry no `ref` has no change line at all, and a period where only some facts lack `ref` prints n/a for those members. `change: "pp"` prints the difference of the two percent levels with one decimal (+0.9pp). Use `pp` for shares and rates. `change: "absolute"` prints the current value minus the reference value, in the measure format with a sign (+0.4). Use it on statement lines, where the changes add up down the statement.
|
|
498
501
|
|
|
499
502
|
`judge` colours a measure. `family` sets the direction and the default thresholds: `volume` (higher is better, [2, 10]), `cost` (lower is better, [5, 15]) and `rate` (higher is better, [3, 10]). The thresholds are relative percent changes. A favourable change of at least the first threshold is good, and of at least the second threshold strong good. An adverse change of at least the first threshold is warn, and of at least the second threshold bad. A smaller change is neutral. A `pp` measure is also judged on the relative change of its level: a share that goes from 40% to 41.2% is +3% relative, which is good for a `rate`, while the cell prints +1.2pp. There is no lower-is-better rate family in 0.24.0: for a rate where lower is better (a return rate or a bounce rate), use `cost`, which shares `thresholds.cost` with CAC. A statement line can use the family `effect` instead: see [Statements](#statements-subtotals-results-and-drivers).
|
|
500
503
|
|
|
@@ -1346,7 +1349,7 @@ Each item names the mistake, the symptom and the fix.
|
|
|
1346
1349
|
|
|
1347
1350
|
- **Averaging daily ratios.** Symptom: CAC, AOV or a rate differs from a check on the totals, and the members do not match the Total. Fix: supply the additive parts (spend and new customers) and let `value` divide them.
|
|
1348
1351
|
- **A ratio in `sums`.** Symptom: under `dimension.sums: true` a parent shows the sum of the rates of its children, and without it a Total rate does not match the weighted rate of its members. Fix: put the numerator and the denominator in `sums`, and write the ratio as `{ "op": "div", ... }`.
|
|
1349
|
-
- **Missing ref sums.** Symptom:
|
|
1352
|
+
- **Missing ref sums.** Symptom: a period has no change line and no coloured cell, or some members print n/a under it; only the vs prior column works. Fix: add `ref` to each fact of a displayed period.
|
|
1350
1353
|
- **A full week as the reference of a partial week.** Symptom: on a Wednesday the running week shows a change near −55% (three days against seven); without `partial: true` it is also judged bad. Fix: compare the partial period with the same days of the period before, and set `partial: true`.
|
|
1351
1354
|
- **Zero-filled spend.** Symptom: Email shows Marketing spend 0 and CAC 0.0 rows. Fix: leave the `spend` key out, or set it to `null`, in every fact of a member that never has spend.
|
|
1352
1355
|
- **Depth 4.** Symptom: the error `dimswitch depth must be between 1 and 3 (member levels + 1); got 4`. Fix: the maximum depth is the number of member levels plus one; offer depth controls up to that number.
|
package/docs/reference/dot.md
CHANGED
|
@@ -48,7 +48,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
48
48
|
| series[].id | string | yes | Series identity used by keyed options, annotations and legend entries. |
|
|
49
49
|
| series[].label | string | | Displayed series name; defaults to the series id. |
|
|
50
50
|
| series[].values | (cell \| { categoryId, value: cell })[] | yes | Values in category order, or keyed entries pairing a categoryId with its value. |
|
|
51
|
-
| series[].scenario | string | | AC, PY, PL, FC (or ACT, BUD, FCST). |
|
|
51
|
+
| series[].scenario | string | | AC, PY, PL, FC (or ACT, BUD, FCST, LY for last year). Codes and aliases accept any case. |
|
|
52
52
|
| series[].direction | string | | Declared preference for higher or lower values in directional comparisons. One of `'higherIsBetter'`, `'lowerIsBetter'`. |
|
|
53
53
|
| series[].role | string | | Declares a plotted data series or a comparison reference series. One of `'data'`, `'reference'`. |
|
|
54
54
|
| series[].colorRole | string | | Theme color role used for this series when no explicit fill takes precedence. One of good, bad, warn, neutral, neutralLight, highlight, total, others; series-N for step N of the theme ramp, 1-based (series-2 is color.series[1]); or status-<key> for a theme status colour. A hex colour goes in fill. |
|
|
@@ -60,20 +60,23 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
60
60
|
|
|
61
61
|
| Path | Type | Values | Default | Meaning |
|
|
62
62
|
|---|---|---|---|---|
|
|
63
|
-
| legend | string \| object | `'top'`, `'bottom'`, `'none'`, `'auto'` (or another value of its type) | | Key position. Multiple series get a key by default unless visible direct labels name them. 'none' hides the key; unnamed series warn. |
|
|
63
|
+
| 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. 'none' hides the key; unnamed series warn. |
|
|
64
|
+
| topN | object \| integer | | | Keep the n largest categories by absolute first-series value, or absolute gap for dumbbell, before sorting. Kept categories retain authored order unless sort.categories reorders them. No Others row is drawn; omitted category names are disclosed. Authored rest: true, restLabel, showRestCount or threshold warns that it is ignored when categories are omitted. |
|
|
64
65
|
| axisTitles | object | | | Title of the value axis when it is drawn: under the value-axis tick row, ending at the right edge of the plot. Drawn only when authored. |
|
|
65
66
|
| axisTitles.primary | string | | | 'Measure, unit' title of the value axis, e.g. 'Margin, %'. |
|
|
66
67
|
| variant | string | `'dot'`, `'dumbbell'`, `'lollipop'` | `'dot'` | Dot by default; dumbbell joins paired values and lollipop joins values to the baseline. |
|
|
67
68
|
| averageMarker | boolean \| object | | | Computed dashed average rule with a solver-placed Ø label, as on bar and column: the mean of every dot of the series in scope ('all' by default, or the listed series). |
|
|
68
69
|
| averageMarker.scope | string \| array | `'all'` (or another value of its type) | | Series included in the computed average; defaults to 'all'. |
|
|
70
|
+
| averageMarker.includePartial | boolean | | | true averages the categories marked partial too. By default they are left out, and the label names the periods the average covers. Column, bar and combo. |
|
|
69
71
|
| arrow | boolean | | | Dumbbell only (warning arrow-dumbbell-only otherwise): an arrowhead at the second series' dot shows the direction of change. The connector is painted good or bad by the sign of the change when the second series declares direction, neutral otherwise; a pair whose dots nearly touch keeps a plain connector. |
|
|
72
|
+
| gapColumn | boolean | | | Dumbbell only: prints the gap, second series minus first, signed in a column right of the plot under a head such as 'Gap, pp' (pp for percent values). A highlighted row prints bold. Default false. The column stays off below 576 px canvas width. |
|
|
70
73
|
| methodNote | boolean | | | Default false. true adds the method footnote that names the marker inside a range as its supplied mid-point. A supplied range.mid is drawn and keyed either way. |
|
|
71
74
|
| range | object | | | What the drawn ranges are: their key entry and, on request, their bounds as numbers. |
|
|
72
75
|
| range.label | string | | | The key entry for the drawn ranges, naming the interval, for example 'Peer range, min to max' or 'Interquartile range'. Default 'Range'. |
|
|
73
76
|
| range.values | boolean | | | Default false. true prints each range's low and high value beside its caps. |
|
|
74
77
|
| range.midLabel | string | | | The key entry for the open marker that draws each supplied range.mid, for example 'Peer midpoint'. Default 'Midpoint'. When only some rows carry a mid, a note names the others. |
|
|
75
78
|
|
|
76
|
-
Plus the [shared options](options.md). This type does not accept `
|
|
79
|
+
Plus the [shared options](options.md). This type does not accept `valueAxis.log`, `valueAxis.reverse`, `valueAxis.break`, `hatchStrength`, `rounding`. This type ignores `animate`, `debug`, `categoryAxis`, `categoryLabels`, `secondaryAxis` with an `option-ignored` warning.
|
|
77
80
|
|
|
78
81
|
## Annotations
|
|
79
82
|
|
|
@@ -87,7 +90,7 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
87
90
|
| 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
91
|
| abs | Reads the anchored data value and places its formatted absolute value in a collision-managed label. | at | at: AnchorRef | | |
|
|
89
92
|
| 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. The arm follows the horizontal value axis and clears the connector. |
|
|
90
|
-
| 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. | 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 category, which reads the first drawn series) 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. |
|
|
93
|
+
| 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 category, which reads the first drawn series) 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. |
|
|
91
94
|
|
|
92
95
|
## Sizing
|
|
93
96
|
|