boardplot 0.57.0 → 0.58.1
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 +311 -0
- package/README.md +48 -14
- package/dist/{DiagnosticDetails-JFBBXOT2.js → DiagnosticDetails-FXNTFSA4.js} +2 -2
- package/dist/{ReaderBox-GCIITQCX.js → ReaderBox-WVOT7VVJ.js} +8 -7
- package/dist/{annotateEngine-JMZI6QEG.js → annotateEngine-57L26X77.js} +2 -1
- package/dist/build-identity.json +3 -3
- package/dist/{chunk-6LQKU6YN.js → chunk-23FT7RLN.js} +11 -10
- package/dist/{chunk-5WSIH4SR.js → chunk-2CQBBN7M.js} +4 -4
- package/dist/chunk-2DS4MT7T.js +25 -0
- package/dist/{chunk-QFIRPOXR.js → chunk-2HII2B6S.js} +3 -3
- package/dist/{chunk-JMOBA5ES.js → chunk-2IRMGCYE.js} +2 -2
- package/dist/{chunk-JKXJWCJ5.js → chunk-2SWSUNA4.js} +116 -54
- package/dist/{chunk-O7Y6RJ4D.js → chunk-33EBLJVZ.js} +11 -11
- package/dist/{chunk-EHQLLZCQ.js → chunk-34PKJZRY.js} +59 -34
- package/dist/{chunk-SHAAMKN7.js → chunk-35ZJUZUO.js} +18 -18
- package/dist/{chunk-TGR6PRKG.js → chunk-3BMPYY26.js} +6 -3
- package/dist/{chunk-XJUZC53Y.js → chunk-3E6NLODZ.js} +1 -1
- package/dist/{chunk-H3EWFSWI.js → chunk-3ESWPMDW.js} +43 -29
- package/dist/{chunk-6KHRMK3I.js → chunk-3M2F7KSS.js} +158 -75
- package/dist/{chunk-UBXIGE2P.js → chunk-3MFVJMP6.js} +2 -2
- package/dist/{chunk-MOQFYJ3F.js → chunk-3OSQ32GN.js} +5 -5
- package/dist/{chunk-HGPFEG2L.js → chunk-3RXUA6VY.js} +5 -5
- package/dist/{chunk-I65OLJ2X.js → chunk-42QKUSHJ.js} +13 -3
- package/dist/{chunk-FAFUMSPR.js → chunk-4DK67I3B.js} +83 -51
- package/dist/{chunk-EEBMK6T6.js → chunk-4DMRIL5K.js} +8 -8
- package/dist/chunk-4M3UADCM.js +602 -0
- package/dist/{chunk-WSKZZ2ZB.js → chunk-4OJF6DXL.js} +538 -503
- package/dist/{chunk-UD6U4EF5.js → chunk-4ROZ4TFL.js} +1 -1
- package/dist/{chunk-I7KDPCC7.js → chunk-4TUU3UGY.js} +18 -10
- package/dist/{chunk-6ZN2XJFI.js → chunk-54YO56IK.js} +1 -1
- package/dist/{chunk-JMGB444D.js → chunk-5ACFYNA4.js} +8 -4
- package/dist/{chunk-BQIADGJB.js → chunk-5CYLT6FJ.js} +5 -5
- package/dist/{chunk-IVQT2E3Y.js → chunk-5I4RPBNE.js} +13 -13
- package/dist/{chunk-LW4ZQGVL.js → chunk-5KAYLRRP.js} +7 -8
- package/dist/{chunk-2BHLRHF2.js → chunk-5SVGTQTW.js} +4 -4
- package/dist/{chunk-5JTRCSBN.js → chunk-62BDQTO6.js} +2 -2
- package/dist/{chunk-4RN4OM6I.js → chunk-63JUV7NR.js} +3 -3
- package/dist/chunk-645BGVPP.js +26 -0
- package/dist/{chunk-JIH52I36.js → chunk-65U6ZBZZ.js} +119 -85
- package/dist/{chunk-3DUGZ7ML.js → chunk-6ALORYH7.js} +46 -31
- package/dist/{chunk-HB3TH7GY.js → chunk-6AVUTZ6W.js} +10 -6
- package/dist/{chunk-JYAZPMSA.js → chunk-6IUK6PAH.js} +7 -6
- package/dist/{chunk-W5SVS4B6.js → chunk-6JFQCVNN.js} +4 -4
- package/dist/{chunk-IZRTNCJQ.js → chunk-6JTCFPAD.js} +5 -5
- package/dist/{chunk-5TUDYKNL.js → chunk-6NGKQNTB.js} +42 -29
- package/dist/{chunk-IUVJVMKS.js → chunk-6V3A3MTG.js} +55 -32
- package/dist/{chunk-FJKFYQ5I.js → chunk-6YBNVI5I.js} +36 -28
- package/dist/chunk-76GPN6AT.js +72 -0
- package/dist/{chunk-SHCW2TCA.js → chunk-7GRR72MY.js} +25 -23
- package/dist/{chunk-D2B3KP35.js → chunk-7VWXXBTC.js} +4 -0
- package/dist/{chunk-Y5IKCXQR.js → chunk-7YZZCQT3.js} +5 -5
- package/dist/chunk-A65B23JK.js +113 -0
- package/dist/{chunk-2WTD3GCR.js → chunk-A6N24NGW.js} +3 -3
- package/dist/{chunk-72OJBDRB.js → chunk-AAQWFTDM.js} +52 -41
- package/dist/{chunk-4JNHF6JW.js → chunk-AGJ2QL4A.js} +84 -40
- package/dist/{chunk-I3DLERI7.js → chunk-AICO24HJ.js} +5 -2
- package/dist/{chunk-LSKCKGCF.js → chunk-AJGSCVVW.js} +2 -2
- package/dist/{chunk-7P7D6WXR.js → chunk-AKZOQGF3.js} +3 -3
- package/dist/{chunk-RSCRIWAH.js → chunk-AL62JJTB.js} +10 -3
- package/dist/{chunk-VY67Q6CJ.js → chunk-AMBQ6SWU.js} +36 -33
- package/dist/{chunk-73O6AOAA.js → chunk-AQ2PQ7FK.js} +241 -140
- package/dist/{chunk-XFCBH3TI.js → chunk-BHLNSJG7.js} +3 -3
- package/dist/{chunk-6XU5XGYV.js → chunk-BQ7SN7AW.js} +5 -5
- package/dist/{chunk-DRHQG44U.js → chunk-BQBD6Q5J.js} +6 -2
- package/dist/{chunk-LSR3SBJ4.js → chunk-BSZOQJXB.js} +234 -136
- package/dist/{chunk-KJLH5EHD.js → chunk-BVIJCUWW.js} +175 -110
- package/dist/{chunk-2AJWRVZ2.js → chunk-C47POAC5.js} +1 -1
- package/dist/{chunk-AOIZJ7GR.js → chunk-C4SQU2PB.js} +6 -6
- package/dist/{chunk-Y7Q3VEYC.js → chunk-CCAAI56H.js} +30 -10
- package/dist/{chunk-T3WCDDIL.js → chunk-CDUR3KWV.js} +2 -2
- package/dist/{chunk-T5MBORBK.js → chunk-CFESVCZR.js} +1 -1
- package/dist/{chunk-EEL2N4Y6.js → chunk-CKEFAD4R.js} +5 -5
- package/dist/{chunk-WE5WVQE4.js → chunk-CMPHT2LS.js} +3 -3
- package/dist/{chunk-FHA3KMFC.js → chunk-CQBPNE7Z.js} +5 -1
- package/dist/{chunk-JSA3ESEJ.js → chunk-CR5FP5SF.js} +1 -1
- package/dist/{chunk-NCCDEUHD.js → chunk-CSMVKG2C.js} +1 -1
- package/dist/{chunk-JHWDTV4K.js → chunk-D2TQX7UJ.js} +2 -2
- package/dist/{chunk-GHFTKVJN.js → chunk-DHGE46UK.js} +1 -1
- package/dist/{chunk-26WNBTWB.js → chunk-DORE2RHL.js} +5 -5
- package/dist/{chunk-AFA32LHN.js → chunk-DUOGEFLG.js} +62 -36
- package/dist/{chunk-WZB6R2ZX.js → chunk-DZYTXZNS.js} +11 -3
- package/dist/{chunk-O4D27FKH.js → chunk-E5YF236N.js} +4 -1
- package/dist/{chunk-6EE6XEMA.js → chunk-EB4PQEI3.js} +26 -17
- package/dist/{chunk-ANNQJWDX.js → chunk-EBWMTQ4U.js} +285 -34
- package/dist/{chunk-EHNGPUTO.js → chunk-EDW5HQND.js} +5 -5
- package/dist/{chunk-VM5CQ7CG.js → chunk-EHRRHSPV.js} +2 -2
- package/dist/{chunk-PYGEIPPH.js → chunk-EILNJQMN.js} +32 -12
- package/dist/{chunk-KGS5Z7SL.js → chunk-ERDKMZ7O.js} +2 -2
- package/dist/{chunk-USFIDSTO.js → chunk-ETUKDEGL.js} +18 -11
- package/dist/chunk-F2ET5ZTT.js +49 -0
- package/dist/{chunk-HVX2E26J.js → chunk-F3XOBFS4.js} +9 -8
- package/dist/{chunk-I4NUYVP5.js → chunk-FB6X7QHA.js} +1 -1
- package/dist/{chunk-LO3AGGE3.js → chunk-FJNZ7NWD.js} +5 -5
- package/dist/{chunk-IRXTNSZL.js → chunk-FPFRLRQO.js} +40 -22
- package/dist/{chunk-YTEJYLU7.js → chunk-FRR7BJ3B.js} +2 -2
- package/dist/{chunk-DPUCT567.js → chunk-FVWHEM2N.js} +7 -5
- package/dist/{chunk-A33MFWHW.js → chunk-G7BCLYL4.js} +2 -2
- package/dist/{chunk-2KCK63DD.js → chunk-G7CXJPEN.js} +2 -2
- package/dist/{chunk-2X6XY4K4.js → chunk-GB3RZYTK.js} +39 -19
- package/dist/{chunk-MTCDGSYW.js → chunk-GHCU6OSE.js} +2 -2
- package/dist/{chunk-AFGQXMKT.js → chunk-GNMB72V7.js} +161 -67
- package/dist/chunk-GOFS336W.js +24 -0
- package/dist/{chunk-JMXNXLAC.js → chunk-GQYT7G4F.js} +2 -2
- package/dist/{chunk-RRPTQGRU.js → chunk-H3VICNTN.js} +1 -1
- package/dist/{chunk-JRRSKCGG.js → chunk-H4EDDGGX.js} +3 -3
- package/dist/{chunk-5H4HFRDO.js → chunk-H7BCNS5J.js} +5 -5
- package/dist/{chunk-GC4WOLV3.js → chunk-HAG3K6PQ.js} +14 -2
- package/dist/chunk-HF4BCPIV.js +26 -0
- package/dist/{chunk-YCUNFAEE.js → chunk-HM4AJ5U4.js} +238 -127
- package/dist/{chunk-7FAO4ICF.js → chunk-HO4ILCW7.js} +2 -2
- package/dist/{chunk-ZV3SNRJI.js → chunk-HTQGJQZN.js} +4 -2
- package/dist/{chunk-G5BUGYIL.js → chunk-I52OMC5B.js} +192 -113
- package/dist/{chunk-TMXRTYGT.js → chunk-I5VNHDPR.js} +3 -2
- package/dist/{chunk-M74H7QYD.js → chunk-IDXYHDQY.js} +1 -1
- package/dist/{chunk-SSZB3VXG.js → chunk-IFUAPFL5.js} +102 -47
- package/dist/{chunk-IPWUBZ4P.js → chunk-IIWZJ5ZM.js} +1 -1
- package/dist/{chunk-KF3ZHLHQ.js → chunk-IMUMPKXF.js} +5 -5
- package/dist/{chunk-HC6WHTBX.js → chunk-IPBOREIY.js} +1 -1
- package/dist/{chunk-76UL4CT4.js → chunk-IPZJCBWD.js} +27 -22
- package/dist/{chunk-5P4MXWKP.js → chunk-ITEJQHXE.js} +4 -4
- package/dist/{chunk-WDAZ2MT4.js → chunk-IVDTP6SV.js} +4 -4
- package/dist/{chunk-BDGLMWPO.js → chunk-IXOBDDMW.js} +11 -2
- package/dist/{chunk-K6Y4HBK7.js → chunk-IXU5C3YY.js} +1000 -904
- package/dist/{chunk-EDBUVDRI.js → chunk-JBAVMO56.js} +372 -93
- package/dist/{chunk-VY2NPB2Q.js → chunk-JNDWRV34.js} +4 -4
- package/dist/{chunk-XYUXB5VK.js → chunk-JT3UTEWZ.js} +3 -3
- package/dist/{chunk-A6XCVOC5.js → chunk-JY4LTPOV.js} +1 -1
- package/dist/{chunk-VT7PBGL2.js → chunk-JYSFAH7C.js} +23 -36
- package/dist/chunk-K7XPTQBJ.js +267 -0
- package/dist/{chunk-2I76VFMZ.js → chunk-KI7VCHNZ.js} +49 -37
- package/dist/{chunk-YB6QGOCO.js → chunk-KUWIRCYJ.js} +2 -2
- package/dist/{chunk-MQ5EKWIG.js → chunk-KVBLTAO7.js} +5 -5
- package/dist/{chunk-XCROSJ2Z.js → chunk-KW4JXWHO.js} +1 -1
- package/dist/{chunk-BY5JGQFZ.js → chunk-KWIP5YRA.js} +4 -4
- package/dist/{chunk-KAAB2DIV.js → chunk-LJDATBPB.js} +6 -6
- package/dist/{chunk-TDDSWNGD.js → chunk-LOXZSTIM.js} +30 -28
- package/dist/{chunk-ZTSJ7NY6.js → chunk-LPMSGO7L.js} +3 -3
- package/dist/{chunk-IXM6BAM4.js → chunk-LXH4RPY4.js} +1 -1
- package/dist/{chunk-D5G67OER.js → chunk-LYAT62UT.js} +1 -1
- package/dist/{chunk-EFKFZNQC.js → chunk-M5LPP2GQ.js} +34 -20
- package/dist/{chunk-QZMLSK43.js → chunk-MALSSEXO.js} +294 -145
- package/dist/{chunk-XN7JDII2.js → chunk-MB5EX2YG.js} +230 -107
- package/dist/{chunk-PSYPB22T.js → chunk-MGXHFRQK.js} +5 -5
- package/dist/{chunk-GADI2DU7.js → chunk-MVR7YKBF.js} +152 -27
- package/dist/{chunk-IFURKTOL.js → chunk-MXUPMGRY.js} +2 -2
- package/dist/{chunk-C5SQEYTQ.js → chunk-NFGV5OAR.js} +153 -65
- package/dist/{chunk-RZNYW7UP.js → chunk-NNIZG3TH.js} +8 -0
- package/dist/{chunk-AKJO6N4K.js → chunk-NQPJWQTW.js} +11 -4
- package/dist/{chunk-YFI5PN5O.js → chunk-NSMYIUBZ.js} +34 -11
- package/dist/{chunk-H6EJ63QN.js → chunk-NT3HCXQC.js} +144 -83
- package/dist/chunk-NZ7FX3AE.js +65 -0
- package/dist/chunk-O3LT4TAI.js +34 -0
- package/dist/{chunk-L2XRUG4P.js → chunk-OELB7MTE.js} +5 -5
- package/dist/{chunk-7MYJUJZV.js → chunk-OMNB27GM.js} +4 -4
- package/dist/{chunk-GS5UG6QD.js → chunk-OO63YP35.js} +1 -1
- package/dist/{chunk-CEMXGMQN.js → chunk-OQUH7I5T.js} +3 -3
- package/dist/{chunk-Q7VPTN5X.js → chunk-OS7C2KMQ.js} +4 -4
- package/dist/{chunk-NRYERHEI.js → chunk-OTWIW2L3.js} +5 -5
- package/dist/chunk-OUNYHYJL.js +27 -0
- package/dist/{chunk-54HEIM2A.js → chunk-OUR5ZHCB.js} +2 -2
- package/dist/{chunk-Z257SH5U.js → chunk-OZA7HA6L.js} +1 -1
- package/dist/{chunk-WJQX7HBH.js → chunk-OZLKEBCD.js} +2 -2
- package/dist/{chunk-YGPLUENN.js → chunk-P3NMDPDP.js} +132 -83
- package/dist/{chunk-NINK4G7U.js → chunk-P5RCP4NK.js} +2 -2
- package/dist/{chunk-DYSEZVIJ.js → chunk-P6DEFCMQ.js} +2 -2
- package/dist/{chunk-J22ETKDJ.js → chunk-P7UOOMXE.js} +2 -2
- package/dist/chunk-PMT75APP.js +94 -0
- package/dist/{chunk-KLQKHA3T.js → chunk-PNYWBY4K.js} +5 -5
- package/dist/{chunk-XNV7VOIT.js → chunk-PVGJM2HP.js} +4 -4
- package/dist/{chunk-4U2WSW6F.js → chunk-Q2I3QLE3.js} +65 -36
- package/dist/{chunk-LGMV7ZV4.js → chunk-QATOOZMH.js} +5 -5
- package/dist/{chunk-H2POQ4LB.js → chunk-QFNWGSCT.js} +4 -4
- package/dist/{chunk-CIDOL4FO.js → chunk-QQMESIDA.js} +5 -5
- package/dist/{chunk-OTGNVAI4.js → chunk-R3VSWOTI.js} +4 -4
- package/dist/{chunk-UCIAHSJK.js → chunk-R5SGE2NS.js} +7 -3
- package/dist/{chunk-FX5VZK5F.js → chunk-RJICOOB3.js} +14 -8
- package/dist/{chunk-RMVCKO6N.js → chunk-RLH2CQCD.js} +458 -136
- package/dist/{chunk-VFLMBA2M.js → chunk-RPGEB3Z5.js} +19 -18
- package/dist/{chunk-KIXNHDXS.js → chunk-RQKDEJFQ.js} +5 -5
- package/dist/chunk-SBKM6XFS.js +211 -0
- package/dist/{chunk-TQ5HHNM3.js → chunk-SCAYWQZK.js} +2 -2
- package/dist/{chunk-Y5WHM2Q5.js → chunk-SH4FLUAD.js} +1 -1
- package/dist/{chunk-7EQU2TUN.js → chunk-SH4UGK5U.js} +84 -53
- package/dist/{chunk-EY4OA4OF.js → chunk-SHYS52VO.js} +370 -785
- package/dist/{chunk-ZSYU6LIH.js → chunk-SKPOXLG5.js} +5 -5
- package/dist/{chunk-OAT6FWKL.js → chunk-T7PRG6AO.js} +5 -5
- package/dist/chunk-TBZT5WUT.js +39 -0
- package/dist/{chunk-5HTGSB6Y.js → chunk-TKH655ON.js} +3 -3
- package/dist/{chunk-YO5UKKCQ.js → chunk-TMEUK2WS.js} +6 -2
- package/dist/{chunk-X5OVVMZX.js → chunk-TVOMGNFQ.js} +1 -1
- package/dist/{chunk-JARJP576.js → chunk-TX5FSNAU.js} +435 -29
- package/dist/{chunk-LUZ7HXBT.js → chunk-U52PNFPX.js} +1 -1
- package/dist/{chunk-OKM5LYYP.js → chunk-U6QZOMYC.js} +5 -5
- package/dist/{chunk-F4JAGDPD.js → chunk-UBYDY4B7.js} +8 -8
- package/dist/{chunk-V3UE3TB7.js → chunk-UCKUAKYQ.js} +2 -2
- package/dist/{chunk-NO7GRVUU.js → chunk-UOOXWGBU.js} +8 -8
- package/dist/{chunk-LFX5BERN.js → chunk-USMKNNOU.js} +47 -33
- package/dist/chunk-USSG6TJV.js +23 -0
- package/dist/{chunk-HFFKN7PA.js → chunk-UY34DDUM.js} +3 -3
- package/dist/{chunk-3LNVEE5Z.js → chunk-V7FV66KL.js} +1 -1
- package/dist/{chunk-62JZL6FW.js → chunk-V7JFT7NQ.js} +56 -42
- package/dist/{chunk-UP4JSNDR.js → chunk-V7NUJEJE.js} +1 -1
- package/dist/{chunk-FERP4WS3.js → chunk-VACZGW5R.js} +16 -18
- package/dist/{chunk-BO5EJBLH.js → chunk-VC62V7CX.js} +82 -47
- package/dist/{chunk-53OEKS4L.js → chunk-VESSIKBG.js} +6 -3
- package/dist/chunk-VJULLJLN.js +70 -0
- package/dist/{chunk-QLWUFEKR.js → chunk-VKNQOSGW.js} +8 -8
- package/dist/{chunk-BFDPY7JM.js → chunk-VTY6YHQZ.js} +11 -6
- package/dist/{chunk-UFZXZJJG.js → chunk-W2QILXAL.js} +5 -5
- package/dist/{chunk-QHPJ5ZKS.js → chunk-W6XSIBLR.js} +5 -5
- package/dist/{chunk-DJBMA4FW.js → chunk-WDJSDJLV.js} +4 -6
- package/dist/{chunk-JKOEHRGV.js → chunk-WDLWWEHZ.js} +1 -1
- package/dist/{chunk-IW3YUMPI.js → chunk-WFBN2HXR.js} +2 -2
- package/dist/chunk-WGJIYFVQ.js +24 -0
- package/dist/{chunk-43PCSBVQ.js → chunk-WKXLJNHW.js} +634 -8
- package/dist/{chunk-EWR6WVOV.js → chunk-WLH5IBFY.js} +6 -6
- package/dist/{chunk-RHVP62HI.js → chunk-WMQ57FOP.js} +5 -5
- package/dist/{chunk-GKQLKUMF.js → chunk-WNTUBGBB.js} +41 -32
- package/dist/{chunk-RHBQ2Q5H.js → chunk-WOICFLOJ.js} +60 -43
- package/dist/{chunk-QNLESRH6.js → chunk-WUP6C4ZD.js} +2 -2
- package/dist/chunk-WVCDISZP.js +89 -0
- package/dist/{chunk-CT4RFZO4.js → chunk-WW4KLAVO.js} +38 -23
- package/dist/{chunk-I5ZADE2U.js → chunk-X3QUASBR.js} +1 -1
- package/dist/{chunk-TXMS7QUJ.js → chunk-X46PSAJ7.js} +6 -6
- package/dist/{chunk-Z2BDTZDT.js → chunk-XC32OSCD.js} +97 -39
- package/dist/{chunk-M2OQK2FO.js → chunk-XD5XB22R.js} +2 -2
- package/dist/chunk-XLLWIHN2.js +24 -0
- package/dist/{chunk-SD6ENKTO.js → chunk-XMX4PCFL.js} +3 -3
- package/dist/{chunk-BM2A3IGQ.js → chunk-XO44IJGZ.js} +1 -1
- package/dist/{chunk-2HD5RY2U.js → chunk-XRRG4MBM.js} +3 -3
- package/dist/chunk-XSC4IXXC.js +24 -0
- package/dist/{chunk-D5RAVZ5C.js → chunk-XSEETONJ.js} +10 -9
- package/dist/{chunk-YBYV56FS.js → chunk-XZOFKLTD.js} +3 -3
- package/dist/{chunk-YNHPPZ7S.js → chunk-XZXZNI7A.js} +1 -1
- package/dist/{chunk-W7Q6PLT4.js → chunk-Y6E4JU3U.js} +37 -37
- package/dist/{chunk-XR7VOF2V.js → chunk-YGWPOYDE.js} +25 -13
- package/dist/{chunk-HDSHS2QZ.js → chunk-YJUBX3QF.js} +70 -47
- package/dist/{chunk-BDCKHLUB.js → chunk-YLRAAJYV.js} +72 -304
- package/dist/{chunk-I6QGYRY4.js → chunk-YW35KSXR.js} +2 -2
- package/dist/{chunk-GAFEN3H7.js → chunk-Z3WQXVFV.js} +2 -2
- package/dist/{chunk-WKWCNS6K.js → chunk-Z62TJQO5.js} +5 -5
- package/dist/{chunk-D3PQAVFW.js → chunk-Z6DUNKFU.js} +152 -29
- package/dist/{chunk-FF7MV4D4.js → chunk-Z6H5ED2I.js} +1 -1
- package/dist/{chunk-TWRFVW3J.js → chunk-ZB3JIL3L.js} +138 -89
- package/dist/{chunk-KUMJI5B6.js → chunk-ZBCCJPGW.js} +17 -14
- package/dist/{chunk-CV3NC75L.js → chunk-ZBOOMLHD.js} +1 -1
- package/dist/{chunk-QRZESG66.js → chunk-ZCHKIR7C.js} +64 -239
- package/dist/{chunk-ZDD3MJ2H.js → chunk-ZDJ7C64T.js} +1 -1
- package/dist/{chunk-KQ2WZ6BY.js → chunk-ZG4BMJRL.js} +1 -1
- package/dist/{chunk-QYOZ46ZQ.js → chunk-ZIVCPXXL.js} +467 -650
- package/dist/{chunk-V62B23VC.js → chunk-ZNRSYS76.js} +8 -2
- package/dist/{chunk-NIDH22DI.js → chunk-ZSYFQSPF.js} +12 -2
- package/dist/cli/index.js +8 -3
- package/dist/{core-5S5CJHBG.js → core-2GWH3ED7.js} +2 -1
- package/dist/{core-ZSERZGK6.js → core-3LCSHMKN.js} +3 -1
- package/dist/{core-FTQBESDS.js → core-3NQ5TXOJ.js} +3 -1
- package/dist/{core-D2OIGYC7.js → core-3XGQBHJI.js} +4 -1
- package/dist/{core-T3OSZOVV.js → core-4N6WH3IF.js} +3 -1
- package/dist/{core-VRVL6LIM.js → core-5CRTPVYA.js} +3 -1
- package/dist/{core-7XKNJM7Y.js → core-5K4HRIHX.js} +5 -1
- package/dist/{core-CCB3IXGD.js → core-743ZXTWK.js} +3 -1
- package/dist/{core-4M4RY7MX.js → core-7OAGK7ZJ.js} +3 -1
- package/dist/{core-VT35VDVS.js → core-7YDNMUU3.js} +6 -1
- package/dist/{core-4PW4MXWR.js → core-AAPPZSSZ.js} +4 -1
- package/dist/{core-OBPTBKX6.js → core-AC5AKSCM.js} +2 -1
- package/dist/{core-QFAVWFI3.js → core-AEALAFRA.js} +2 -1
- package/dist/{core-WXZJ7V7S.js → core-BEK6EPVF.js} +4 -1
- package/dist/{core-WP73P4CW.js → core-BRBJ3LPF.js} +5 -1
- package/dist/{core-AVA4XLQ2.js → core-EGTJOQK7.js} +2 -1
- package/dist/{core-XKXDXALI.js → core-FE4THVV3.js} +6 -1
- package/dist/{core-MAW4S3KA.js → core-FEBNVNVE.js} +5 -1
- package/dist/{core-L3UR75IJ.js → core-HIONDJGC.js} +4 -1
- package/dist/{core-GS4DXDDG.js → core-HMBMMF5Z.js} +4 -1
- package/dist/{core-QM34237W.js → core-LSYX4UQQ.js} +2 -1
- package/dist/{core-N2JEWJ7D.js → core-MIERUUUT.js} +2 -1
- package/dist/{core-A7HXVSKB.js → core-NTOOJZRA.js} +2 -1
- package/dist/{core-JDZDBTID.js → core-O5S2NETE.js} +2 -1
- package/dist/{core-OFPPRHYY.js → core-Q2Y3JEWL.js} +3 -1
- package/dist/{core-BJZEJ63L.js → core-RTBPKALG.js} +3 -1
- package/dist/{core-WNT6ZMRO.js → core-T7CKLMT2.js} +2 -1
- package/dist/{core-VWYXK2R3.js → core-TIIPSEK3.js} +4 -1
- package/dist/{core-EMSJRGSE.js → core-VBMWBPKM.js} +2 -1
- package/dist/{core-WPEYRK6Y.js → core-VLXOQ5CK.js} +4 -1
- package/dist/{core-7TTM4KRP.js → core-VYHQ5JY6.js} +3 -1
- package/dist/{core-DMDAXVMY.js → core-XJZWD43V.js} +2 -1
- package/dist/{core-AMWCZTOT.js → core-XUNZB6BM.js} +5 -1
- package/dist/{core-UNX4ZV4M.js → core-YKDDPMWW.js} +5 -1
- package/dist/{core-SKMHEA4Y.js → core-YN2VVGUL.js} +3 -1
- package/dist/{core-ZACFV6XR.js → core-YP4MNIMV.js} +5 -1
- package/dist/{core-FCSA74RT.js → core-ZETBHLSV.js} +3 -1
- package/dist/{dataTable-7IO546LM.js → dataTable-FEQZSDUZ.js} +7 -2
- package/dist/{engine-US3N6UCH.js → engine-SCQVNSAM.js} +23 -18
- package/dist/fixtures.js +2 -1
- package/dist/flags-BVLSAXT3.js +10 -0
- package/dist/{fontTables-ZPZQ6IR3.js → fontTables-JUW7ZTQY.js} +3 -1
- package/dist/geo/dach.js +1 -1
- package/dist/geo/de-states.js +1 -1
- package/dist/geo/eu27.js +1 -1
- package/dist/geo/europe.js +1 -1
- package/dist/geo/index.js +2 -2
- package/dist/geo/us-states.js +1 -1
- package/dist/geo/world.js +1 -1
- package/dist/index.js +27 -20
- package/dist/{main-2UWKGUHR.js → main-7UKLXCIL.js} +50 -119
- package/dist/mcp/server.js +121 -118
- package/dist/react/bar.js +5 -1
- package/dist/react/bartable.js +3 -1
- package/dist/react/box.js +3 -1
- package/dist/react/bullet.js +4 -1
- package/dist/react/butterfly.js +5 -1
- package/dist/react/choropleth.js +3 -1
- package/dist/react/cohort.js +3 -1
- package/dist/react/column.js +5 -1
- package/dist/react/combo.js +5 -1
- package/dist/react/creative.js +4 -1
- package/dist/react/diagram.js +3 -1
- package/dist/react/dimswitch.js +6 -1
- package/dist/react/dot.js +4 -1
- package/dist/react/export.js +29 -18
- package/dist/react/funnel.js +4 -1
- package/dist/react/gantt.js +3 -1
- package/dist/react/grid.js +6 -1
- package/dist/react/heatmap.js +3 -1
- package/dist/react/histogram.js +6 -1
- package/dist/react/index.js +92 -85
- package/dist/react/kpi.js +4 -1
- package/dist/react/likert.js +6 -1
- package/dist/react/line.js +4 -1
- package/dist/react/mekko.js +5 -1
- package/dist/react/pareto.js +6 -1
- package/dist/react/pie.js +4 -1
- package/dist/react/prepare.js +35 -22
- package/dist/react/pvm.js +6 -1
- package/dist/react/pyramid.js +5 -1
- package/dist/react/sankey.js +3 -1
- package/dist/react/scatter.js +3 -1
- package/dist/react/slope.js +4 -1
- package/dist/react/sparkline.js +4 -1
- package/dist/react/spec.js +17 -13
- package/dist/react/status.js +3 -1
- package/dist/react/story.js +3 -2
- package/dist/react/table.js +4 -1
- package/dist/react/theme.js +5 -3
- package/dist/react/tilemap.js +3 -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 +5 -1
- package/dist/{resvg-VB7S5HRF.js → resvg-ZYEZTSUO.js} +3 -1
- package/dist/rows.js +2 -2
- package/dist/{rowsModule-DYDVHBAX.js → rowsModule-WJH4QNXZ.js} +1 -1
- package/dist/{schema-YDZCGL56.js → schema-2R32F6AW.js} +1 -3
- package/dist/{schema-A2XUZUCV.js → schema-2TPGJGVR.js} +1 -3
- package/dist/{schema-MD22QYZU.js → schema-47BG2TZA.js} +1 -3
- package/dist/{schema-HEB6ZDI5.js → schema-56MOEOVR.js} +1 -3
- package/dist/{schema-K4V4PYBO.js → schema-5MSR4LNN.js} +1 -3
- package/dist/{schema-NOBNFD2F.js → schema-5RIYEWE6.js} +1 -3
- package/dist/{schema-OXO2XY4Y.js → schema-ALBF6V7Y.js} +1 -3
- package/dist/{schema-F2Q6MH7W.js → schema-BA6WP5YZ.js} +1 -3
- package/dist/{schema-G5KSSI5W.js → schema-CBL2SMVR.js} +1 -3
- package/dist/{schema-WFGDVBJK.js → schema-CWKGLDSR.js} +1 -3
- package/dist/{schema-DHMMGDTI.js → schema-DBIQFL56.js} +1 -3
- package/dist/{schema-626QXX4G.js → schema-DL7V6NN2.js} +1 -3
- package/dist/{schema-FC6J6KZC.js → schema-DUVJMFKQ.js} +1 -3
- package/dist/{schema-LGLQBRC4.js → schema-ECJERHKF.js} +1 -2
- package/dist/{schema-4JRNXEZF.js → schema-EDSEKZDJ.js} +1 -3
- package/dist/{schema-I44IDRGD.js → schema-ESR6ZIK4.js} +1 -3
- package/dist/{schema-FSYDLMGD.js → schema-F7TWGLRZ.js} +1 -3
- package/dist/{schema-JCU6LTYD.js → schema-FGB6IGZM.js} +1 -3
- package/dist/{schema-MGETMQYC.js → schema-FKGGTM4Z.js} +1 -2
- package/dist/{schema-XIHAKX3B.js → schema-JIAQE7WO.js} +1 -1
- package/dist/{schema-6V5K3J2V.js → schema-JYZ4RF6S.js} +1 -3
- package/dist/{schema-GXOG4MXL.js → schema-K7F6TEDK.js} +1 -2
- package/dist/{schema-NMIYKGHE.js → schema-KAK6DZX4.js} +1 -3
- package/dist/{schema-PHIHMDVB.js → schema-KCJ6WTGV.js} +1 -3
- package/dist/{schema-XRSORYBI.js → schema-MOKWIGF7.js} +1 -3
- package/dist/{schema-3KMU5737.js → schema-MQT6BMNK.js} +1 -3
- package/dist/{schema-JJWORI7D.js → schema-MR3BPPQR.js} +1 -3
- package/dist/{schema-IFTIMTS3.js → schema-OPXZYIW7.js} +1 -3
- package/dist/{schema-UXWKA3PI.js → schema-PV7JGX5H.js} +1 -3
- package/dist/{schema-CNJ4Y6CT.js → schema-PWPQF5RC.js} +1 -3
- package/dist/{schema-WBOPCTPC.js → schema-PYQEUC5P.js} +1 -3
- package/dist/{schema-J4HCSD5C.js → schema-Q5DACE4I.js} +6 -2
- package/dist/{schema-IUY7VYHJ.js → schema-R42VXFIS.js} +1 -3
- package/dist/{schema-WX2RS4OU.js → schema-TVUJNEX7.js} +1 -3
- package/dist/{schema-6PL46VXZ.js → schema-WZOSDDDJ.js} +1 -3
- package/dist/{schema-FGE5YK3S.js → schema-Y4TI2T3T.js} +1 -3
- package/dist/{schema-MQB6CE5V.js → schema-ZU2EU2VP.js} +1 -3
- package/dist/{specValidation-XGELWQUU.js → specValidation-DC4TVHWD.js} +3 -1
- package/dist/theme.js +4 -3
- package/dist/{themeShapeRules-PW4BQHKL.js → themeShapeRules-G7UZX6GJ.js} +1 -1
- package/dist/types/core/annotate.d.ts +27 -2
- package/dist/types/core/annotateArms.d.ts +3 -1
- package/dist/types/core/annotateTargets.d.ts +4 -0
- package/dist/types/core/annotationOrigin.d.ts +13 -0
- package/dist/types/core/axis.d.ts +2 -2
- package/dist/types/core/charts/band/stacks.d.ts +7 -1
- package/dist/types/core/charts/column/model.d.ts +13 -0
- package/dist/types/core/charts/combo/layout.d.ts +7 -0
- package/dist/types/core/charts/gantt/calendar.d.ts +4 -0
- package/dist/types/core/charts/grid/normalize.d.ts +5 -0
- package/dist/types/core/charts/grid/schema.d.ts +2 -2
- package/dist/types/core/charts/pareto/layout.d.ts +2 -0
- package/dist/types/core/charts/pvm/types.d.ts +1 -0
- package/dist/types/core/charts/scatter/clamp.d.ts +2 -1
- package/dist/types/core/charts/scatter/model.d.ts +5 -0
- package/dist/types/core/charts/scatter/valueLines.d.ts +3 -1
- package/dist/types/core/charts/table/resolve.d.ts +8 -3
- package/dist/types/core/charts/table/view.d.ts +24 -1
- package/dist/types/core/claims/browser.d.ts +2 -0
- package/dist/types/core/claims/ids.d.ts +38 -0
- package/dist/types/core/deferred.d.ts +1 -0
- package/dist/types/core/diagnostics/describe.d.ts +6 -1
- package/dist/types/core/doc/diagnostics.d.ts +3 -2
- package/dist/types/core/formatSpec.d.ts +33 -14
- package/dist/types/core/frame.d.ts +25 -58
- package/dist/types/core/frameText.d.ts +203 -0
- package/dist/types/core/geometry.d.ts +2 -0
- package/dist/types/core/label/categoryRow.d.ts +19 -2
- package/dist/types/core/label/solver.d.ts +23 -2
- package/dist/types/core/normalize/shared.d.ts +12 -2
- package/dist/types/core/notes.d.ts +15 -2
- package/dist/types/core/reading.d.ts +12 -1
- package/dist/types/core/request.d.ts +1 -1
- package/dist/types/core/schema/capability.d.ts +12 -0
- package/dist/types/core/seriesIdentity.d.ts +4 -1
- package/dist/types/core/sizing.d.ts +37 -1
- package/dist/types/core/structureCounts.d.ts +3 -1
- package/dist/types/core/theme.d.ts +33 -4
- package/dist/types/core/themeRules.d.ts +2 -0
- package/dist/types/core/types/annotations.d.ts +74 -4
- package/dist/types/core/types/options.d.ts +35 -3
- package/dist/types/core/types/scene.d.ts +30 -2
- package/dist/types/core/types/table.d.ts +6 -0
- package/dist/types/core/types/theme.d.ts +23 -0
- package/dist/types/react/TableChart.d.ts +5 -0
- package/dist/validate.js +13 -6
- package/docs/TELEMETRY.md +2 -2
- package/docs/manual.md +252 -62
- package/docs/reference/bar.md +12 -4
- package/docs/reference/bartable.md +2 -2
- package/docs/reference/box.md +8 -4
- package/docs/reference/bullet.md +9 -5
- package/docs/reference/butterfly.md +10 -5
- package/docs/reference/choropleth.md +3 -5
- package/docs/reference/cohort.md +1 -1
- package/docs/reference/column.md +18 -4
- package/docs/reference/combo.md +10 -5
- package/docs/reference/creative.md +3 -7
- package/docs/reference/diagram.md +1 -1
- package/docs/reference/dimswitch.md +23 -88
- package/docs/reference/dot.md +9 -5
- package/docs/reference/fixtures.md +37 -1
- package/docs/reference/funnel.md +9 -5
- package/docs/reference/gantt.md +8 -15
- package/docs/reference/grid.md +5 -2
- package/docs/reference/heatmap.md +10 -6
- package/docs/reference/kpi.md +1 -1
- package/docs/reference/likert.md +9 -4
- package/docs/reference/line.md +18 -5
- package/docs/reference/mekko.md +10 -5
- package/docs/reference/options.md +17 -13
- package/docs/reference/pareto.md +8 -4
- package/docs/reference/pie.md +9 -5
- package/docs/reference/pvm.md +9 -5
- package/docs/reference/pyramid.md +8 -4
- package/docs/reference/react.md +5 -5
- package/docs/reference/sankey.md +2 -2
- package/docs/reference/scatter.md +8 -4
- package/docs/reference/slope.md +9 -5
- package/docs/reference/sparkline.md +1 -1
- package/docs/reference/status.md +1 -1
- package/docs/reference/table.md +33 -114
- package/docs/reference/theme.md +12 -4
- package/docs/reference/tilemap.md +2 -4
- package/docs/reference/treemap.md +1 -1
- package/docs/reference/variance.md +12 -6
- package/docs/reference/waffle.md +1 -1
- package/docs/reference/warnings.md +1077 -0
- package/docs/reference/waterfall.md +16 -4
- package/docs/use-cases.md +25 -13
- package/llms.txt +19 -6
- package/package.json +18 -3
- package/dist/chunk-5RHP7YTL.js +0 -24
- package/dist/chunk-6VU2XI3W.js +0 -89
- package/dist/chunk-6WJOHZPW.js +0 -26
- package/dist/chunk-FL3FQ2YA.js +0 -27
- package/dist/chunk-G5CELEUR.js +0 -26
- package/dist/chunk-M4SPKUZE.js +0 -7
- package/dist/chunk-OF7FMGH5.js +0 -24
- package/dist/chunk-S2TSXUYP.js +0 -24
- package/dist/chunk-TKERVBJ3.js +0 -23
- package/dist/chunk-VMGTNB6H.js +0 -25
- package/dist/chunk-WZL4EEBS.js +0 -11
- package/dist/chunk-YJGFT63R.js +0 -27
- package/dist/chunk-ZNX5J7D7.js +0 -47
package/docs/reference/likert.md
CHANGED
|
@@ -88,11 +88,15 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
88
88
|
|
|
89
89
|
| Kind | Purpose | Required | Anchors | Optional fields | Notes |
|
|
90
90
|
|---|---|---|---|---|---|
|
|
91
|
-
| 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
|
|
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. |
|
|
93
|
-
| 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 |
|
|
91
|
+
| cagr | Draws a growth arrow between two anchored points and computes the compound annual growth rate from their values and ISO-date span. | | from: AnchorRef (optional); to: AnchorRef (optional) | suffix: string, default 'p.a.'. Text after the rate. period: boolean. Print the period before the rate from the anchors' category labels, '2014–2019: +5.8% p.a.'. Default true when the chart carries two or more CAGRs, so nested brackets are told apart by their text, false otherwise. An arrow's ends show its span, so an arrow prints the rate alone unless period is true. shape: bracket \| arrow, default bracket. arrow draws one straight arrow over the marks with the rate in an oval on it, lifted until it clears them. Where no straight line clears the chart, the span is too short for the oval, a stack's inner layer is the anchor or the chart lays comparisons out itself, it draws the bracket and warns cagr-arrow-no-room. | Omitted endpoints span the first to the last category, or the first to the last total on a waterfall. Resolved endpoints need a positive date interval from ISO dates or year-bearing labels and a positive start value; an end of zero reads -100%, and a start at or below zero or a negative end omits the rate and warns cagr-undefined. On a continuous time axis the years are the exact span between the two readings. An anchor on one series of several (seriesId, or a category of an unstacked line, which reads the first drawn series; on a stack a category reads the stack total) names that series in the label, "Product B +10.1% p.a.", and the arm runs from that series' segment or point. In text, ${value} prints the rate with its suffix, so "CAGR 2014–2019: ${value}" keeps the computed number. |
|
|
92
|
+
| diff | Draws a level-difference arrow between two anchors and computes either percent change or their signed value difference. | from, to | from: AnchorRef; to: AnchorRef | mode: relative \| absolute \| reversed \| both, default relative. relative prints the percent change from 'from' to 'to', reversed the change from 'to' to 'from', absolute the value difference, both the value difference with the percent change beside it. | Mode defaults to relative. Relative and reversed changes need a nonzero base; negative bases use its absolute magnitude and emit a warning. Absolute mode reports the raw value difference. A hidden label removes its arm. |
|
|
93
|
+
| delta | Computes the signed difference between an anchored value and another anchor or literal, then places a collision-managed label at the first anchor. | at, vs | at: AnchorRef; vs: AnchorRef \| number | mode: absolute \| relative \| both, default absolute. absolute prints at minus vs, relative the percent change from vs to at, both the two as '+149 (+36%)'. relative and both need a nonzero vs. | |
|
|
94
94
|
| note | Places authored text at an anchored data element through collision avoidance, with an optional icon or status chip. | at, text | at: AnchorRef | | |
|
|
95
|
-
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false.
|
|
95
|
+
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false. An arrow from the text to the anchored point, in the arrow standard of theme marks.arrow: the text stands far enough out for a 24 px shaft, level with the point right or left of it, or over or under it, where there is room. With no such seat it draws without the arrow and warns callout-arrow-no-room. Not with icon or status. Example: "arrow": true. | |
|
|
96
|
+
| text | Places authored text at a point through the label solver: on the point, or above, below, right or left of it. The text prints as written. | at, text | at: AnchorRef \| { categoryId, value } | | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. The text prints as written, ${value} included. It takes id and priority, and no other field. |
|
|
97
|
+
| line | Draws a straight line between two points or from a text annotation, in the ink and rule width of a bracket; a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the line in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the line starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
98
|
+
| arrow | Draws a straight arrow between two points or from a text annotation to a point, in the theme arrow look (`marks.arrow`); a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the shaft in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the arrow starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
99
|
+
| box | Draws an unfilled box with two points as opposite corners, wrapping whole category bands, in the ink and rule width of a bracket; text inside the box stays free. | from, to | from: AnchorRef \| { categoryId, value }; to: AnchorRef \| { categoryId, value } | dashed: boolean, default false. Draws the edges in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. from and to are opposite corners, the box has no fill, and text inside it stays free. A { categoryId, value } corner spans that category's whole band, so the box wraps whole bars, values and markers; from and to on one category wrap that category. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
96
100
|
|
|
97
101
|
## Sizing
|
|
98
102
|
|
|
@@ -119,6 +123,7 @@ Below the floor a render is refused with `size-below-floor` and the pixels it ne
|
|
|
119
123
|
| twelve-statements-slide | torture | Twelve statements on a full slide print their shares inside the bars |
|
|
120
124
|
| column-overrides | example | columnOverrides sets the widths, alignment and head words of the name, net and base columns |
|
|
121
125
|
| columns-after-plot | example | columnOrder moves the net and base columns to the other side of the marks |
|
|
126
|
+
| inside-base-values | example | Response shares inside each segment base |
|
|
122
127
|
|
|
123
128
|
## Not for
|
|
124
129
|
|
package/docs/reference/line.md
CHANGED
|
@@ -118,6 +118,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
118
118
|
|
|
119
119
|
| Path | Type | Values | Default | Meaning |
|
|
120
120
|
|---|---|---|---|---|
|
|
121
|
+
| highlight | string \| array | | | Select drawn data series by ID. On one plain data line without a fan, category IDs instead emphasize those points: larger markers and values in focus ink while the line keeps its paint. Series IDs take precedence. References do not count as data series. Several data series, area, stacked and bump forms keep series-only highlighting. Unsupported IDs warn highlight-unknown-id and leave the chart unchanged. Explicit value-label suppression and authored marker shapes remain effective. |
|
|
121
122
|
| rounding | string | `'nearest'`, `'sum-consistent'` | | stacked100-area defaults to sum-consistent rounding of complete computed wholes. Authored percentages and incomplete total100 bases keep their values. nearest rounds each computed share separately. Other line variants do not use this setting. |
|
|
122
123
|
| trend | boolean \| object | | | One least-squares line per shown data series, using the shared scatter fit. Fits every non-null source value in the shown range, with at least 3 points; min-max sampling changes the drawn points, not the fit. Regular month, quarter and year dates fit on the calendar period index and keep their spacing; exact 7-day steps fit per week; other dates use elapsed UTC days and exact date spacing; other categories use their original positions. The dashed series-colour line covers only its fitted range and is clipped to the value axis. The legend prints the series name, signed slope per month, quarter, year, week, day or period, and r². The layout derived.trends receipt carries slope, intercept, r² and the fit moments. Plain line and area only; stacks and bump refuse trend-unsupported. Too few points warn trend-undefined. A window or zoom changes the fitted range. Default false. |
|
|
123
124
|
| trend.label | string | | | Name of the fitted lines in the legend; default Linear trend. |
|
|
@@ -169,6 +170,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
169
170
|
| bump.focus | array | | | The entities to draw, at most 12. Every series is still ranked; the others are named in a note with their last rank and keep their values in the data table. A bump of more than 12 entities without focus is refused (bump-series-limit). |
|
|
170
171
|
| seriesLabels | string \| object | `'end'`, `'inline'`, `'key'`, `'none'` (or another value of its type) | | Where series names print; a name carries no value, except where two or more lines end within a line of each other at the last category: there each name takes its last value. On report, dashboard, slide and print, plain-line names use medium weight at the label role size, in a contrast-safe series colour. Values use regular weight. Crowded blocks use one line if two lines would move more than three label line heights from the endpoint. If one line cannot fit within that bound, a right-hand key lists names and end values from highest to lowest, with a reading disclosure. 'end' (default): a column just past the line ends, names only, short leaders; too wide for 18% of the width, shortLabel, then the key row. 'inline': on a clear stretch of each line; the last values still print. An authored 'end' or 'inline' that ends in the key row warns line-end-label-key. 'key': a key row above the plot. 'none': no names; two or more drawn series still get the key row (info series-labels-key) unless legend is set. A lone 'line' defaults to 'none'. { only } names the listed series and gives the rest no name and no value. |
|
|
171
172
|
| seriesLabels.only | array | | | The series named at their line ends; the others get neither a name nor a value, so twelve cohort curves read under four names. |
|
|
173
|
+
| pointLabelSide | string | `'shape'`, `'auto'` | | Preferred side for point values. 'shape' prefers left of the first finite point, above a strict local peak, below a strict local trough and right of the last finite point. Flat plateaus keep the existing preference. Default shape on one plain data line without a fan; reference series do not count. Other variants and several data series keep auto. The label solver can use a fallback to avoid collisions, and labelPlacements pins take precedence. 'auto' restores the previous candidate order and endpoint reserves. |
|
|
172
174
|
| valueLabels | string | `'none'`, `'last'`, `'ends'`, `'extremes'`, `'all'` | | Point values: default last, inline and bump none, stacked100-area ends. Distinct end values that round to the same text gain up to two decimals as one label set; the reading uses that precision. Bump keeps the precision used to rank its values. Choices: 'none' (default under seriesLabels 'inline'), 'last' (default), 'ends' (first and last; stacked100-area default), 'extremes' (ends plus each series' low and high) or 'all'. A value sits on the side of its point away from other lines and never nearer another line than its own; one with no free seat goes to the note line, and missing labels warn label-hidden once per chart; reading.omissions names each label and its destination. Stacked values sit in their band. labels.point sets the content. When the author sets valueLabels and every non-null value in a series has a string label (ignoring label:false cells), valueLabels selects the values and each selected value uses its cell text. Otherwise a string cell label also selects its point, outside the valueLabels selection, even when labels.point is false. label:false removes a value label. bump defaults to 'none'; its values are the measure behind the ranks, so each carries the unit, and without a unit or format it warns bump-values-unnamed. A plain line on a linear scale that does not start at zero draws a break glyph at its lowest value, so the cut baseline stays visible. A tick prints there under 'all' and valueAxis.show false, and on a shown value axis only where that value falls on the tick grid or valueAxis.min sets it. valueAxis.includeZero true or valueAxis.min 0 starts at zero and removes the break glyph and its tick. Where the last value carries options.unit because no subtitle prints it, a shown value axis prints a sign or magnitude unit ($, k, m) on its ticks too; a word unit stays on the value. |
|
|
173
175
|
| latestPoint | string \| object | `'ring'`, `'none'` (or another value of its type) | `'none'` | Ring the last observed point in the highlight colour, r 4.5 with a dot inside it: the newest cohort of a curves chart, the current period of a trend. 'ring' picks the primary series, the hero where emphasis names one and otherwise the first data series that is not a prior year, plan or forecast; { series } names one outright. Default 'none'. Line and area variants only: a stacked band's last point is the top of the stack, so stacked-area and stacked100-area refuse it. |
|
|
174
176
|
| latestPoint.series | string | | | The series whose last observed point is ringed. |
|
|
@@ -222,7 +224,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
222
224
|
| referenceBands[].label | string | | | REQUIRED. The band's name, printed bold at the start of its entry in the column right of the plot: the level or range as the reader should say it. Example: '60+'. |
|
|
223
225
|
| referenceBands[].description | string | | | What the level means, in plain type after the name; it wraps under it when the column is narrow. Example: 'very strong cycle'. |
|
|
224
226
|
|
|
225
|
-
Plus the [shared options](options.md). This type does not accept `valueAxis.break`. This type ignores `animate`, `debug`, `rowLabels`, `categoryLabels`, `secondaryAxis`, `sort`, `topN`, `bandFraction` with an `option-ignored` warning.
|
|
227
|
+
Plus the [shared options](options.md). This type does not accept `labelPosition`, `valueAxis.break`. This type ignores `animate`, `debug`, `rowLabels`, `categoryLabels`, `secondaryAxis`, `sort`, `topN`, `bandFraction` with an `option-ignored` warning.
|
|
226
228
|
|
|
227
229
|
## Annotations
|
|
228
230
|
|
|
@@ -230,16 +232,20 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
230
232
|
|
|
231
233
|
| Kind | Purpose | Required | Anchors | Optional fields | Notes |
|
|
232
234
|
|---|---|---|---|---|---|
|
|
233
|
-
| 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
|
|
234
|
-
| 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. placement: auto \| label \| bracket, default auto. With both ends on two different series at the last category, bracket draws the gap bracket in the right margin: an open ring on each end point, a dashed guide from each ring to the margin, a bracket with an arrowhead toward the measured end, and the gap as a large number beside it; the end values sit just over and under their guides. auto draws the bracket where gapFill washes the same two series and the label elsewhere. label keeps the label at the anchor. bracket on other anchors, or on stacked variants (stacked-area, stacked100-area), warns gap-bracket-unavailable and keeps the label. caption: string. A short line under the bracket number that says what it measures, right-aligned in muted ink. Only a gap bracket prints it; elsewhere it warns gap-caption-ignored. | 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. Diff labels precede point and end labels. Same-category arms attach there; anchored strokes do not displace them. Drawn reference series accept anchors. Bad anchors report the cause and valid ids. |
|
|
235
|
-
| 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 | placement: auto \| label \| bracket, default auto. With both ends on two different series at the last category, bracket draws the gap bracket in the right margin: an open ring on each end point, a dashed guide from each ring to the margin, a bracket with an arrowhead toward the measured end, and the gap as a large number beside it; the end values sit just over and under their guides. auto draws the bracket where gapFill washes the same two series and the label elsewhere. label keeps the label at the anchor. bracket on other anchors, or on stacked variants (stacked-area, stacked100-area), warns gap-bracket-unavailable and keeps the label. caption: string. A short line under the bracket number that says what it measures, right-aligned in muted ink. Only a gap bracket prints it; elsewhere it warns gap-caption-ignored. | Drawn reference series accept anchors. Bad anchors report the cause and valid ids. |
|
|
235
|
+
| cagr | Draws a growth arrow between two anchored points and computes the compound annual growth rate from their values and ISO-date span. | | from: AnchorRef (optional); to: AnchorRef (optional) | suffix: string, default 'p.a.'. Text after the rate. period: boolean. Print the period before the rate from the anchors' category labels, '2014–2019: +5.8% p.a.'. Default true when the chart carries two or more CAGRs, so nested brackets are told apart by their text, false otherwise. An arrow's ends show its span, so an arrow prints the rate alone unless period is true. shape: bracket \| arrow, default bracket. arrow draws one straight arrow over the marks with the rate in an oval on it, lifted until it clears them. Where no straight line clears the chart, the span is too short for the oval, a stack's inner layer is the anchor or the chart lays comparisons out itself, it draws the bracket and warns cagr-arrow-no-room. | Omitted endpoints span the first to the last category, or the first to the last total on a waterfall. Resolved endpoints need a positive date interval from ISO dates or year-bearing labels and a positive start value; an end of zero reads -100%, and a start at or below zero or a negative end omits the rate and warns cagr-undefined. On a continuous time axis the years are the exact span between the two readings. An anchor on one series of several (seriesId, or a category of an unstacked line, which reads the first drawn series; on a stack a category reads the stack total) names that series in the label, "Product B +10.1% p.a.", and the arm runs from that series' segment or point. In text, ${value} prints the rate with its suffix, so "CAGR 2014–2019: ${value}" keeps the computed number. Drawn reference series accept anchors. Bad anchors report the cause and valid ids. |
|
|
236
|
+
| diff | Draws a level-difference arrow between two anchors and computes either percent change or their signed value difference. | from, to | from: AnchorRef; to: AnchorRef | mode: relative \| absolute \| reversed \| both, default relative. relative prints the percent change from 'from' to 'to', reversed the change from 'to' to 'from', absolute the value difference, both the value difference with the percent change beside it. placement: auto \| label \| bracket, default auto. With both ends on two different series at the last category, bracket draws the gap bracket in the right margin: an open ring on each end point, a dashed guide from each ring to the margin, a bracket with an arrowhead toward the measured end, and the gap as a large number beside it; the end values sit just over and under their guides. auto draws the bracket where gapFill washes the same two series and the label elsewhere. label keeps the label at the anchor. On a bar chart a diff between two categories of one series rides in the shorter bar's row under auto: an arrow from the longer bar's end to the to end, with the number in a break of the shaft; label keeps the arrow off the rows with the number beside it. bracket on other anchors, or on stacked variants (stacked-area, stacked100-area), warns gap-bracket-unavailable and keeps the label. caption: string. A short line under the bracket number that says what it measures, right-aligned in muted ink. Only a gap bracket prints it; elsewhere it warns gap-caption-ignored. | 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. Diff labels precede point and end labels. Same-category arms attach there; anchored strokes do not displace them. Drawn reference series accept anchors. Bad anchors report the cause and valid ids. |
|
|
237
|
+
| delta | Computes the signed difference between an anchored value and another anchor or literal, then places a collision-managed label at the first anchor. | at, vs | at: AnchorRef; vs: AnchorRef \| number | mode: absolute \| relative \| both, default absolute. absolute prints at minus vs, relative the percent change from vs to at, both the two as '+149 (+36%)'. relative and both need a nonzero vs. placement: auto \| label \| bracket, default auto. With both ends on two different series at the last category, bracket draws the gap bracket in the right margin: an open ring on each end point, a dashed guide from each ring to the margin, a bracket with an arrowhead toward the measured end, and the gap as a large number beside it; the end values sit just over and under their guides. auto draws the bracket where gapFill washes the same two series and the label elsewhere. label keeps the label at the anchor. On a bar chart a diff between two categories of one series rides in the shorter bar's row under auto: an arrow from the longer bar's end to the to end, with the number in a break of the shaft; label keeps the arrow off the rows with the number beside it. bracket on other anchors, or on stacked variants (stacked-area, stacked100-area), warns gap-bracket-unavailable and keeps the label. caption: string. A short line under the bracket number that says what it measures, right-aligned in muted ink. Only a gap bracket prints it; elsewhere it warns gap-caption-ignored. | Drawn reference series accept anchors. Bad anchors report the cause and valid ids. |
|
|
236
238
|
| note | Places authored text at an anchored data element through collision avoidance, with an optional icon or status chip. | at, text | at: AnchorRef | | Drawn reference series accept anchors. Bad anchors report the cause and valid ids. |
|
|
237
|
-
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false.
|
|
239
|
+
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false. An arrow from the text to the anchored point, in the arrow standard of theme marks.arrow: the text stands far enough out for a 24 px shaft, level with the point right or left of it, or over or under it, where there is room. With no such seat it draws without the arrow and warns callout-arrow-no-room. Not with icon or status. Example: "arrow": true. | Drawn reference series accept anchors. Bad anchors report the cause and valid ids. |
|
|
238
240
|
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. seriesId: string. Series whose mean is measured. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. side: left \| right, default right. Side of the plot the label sits on. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. attainment: boolean \| { seriesId, direction }. Shades each category between its actual and the line. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
239
241
|
| indicator100 | Maps 100 through the chart's value scale and draws a side tick with a 100% label. | | | side: left \| right, default left. Side of the plot the 100% mark sits on. | No anchor is required. The chart needs a value scale that can represent 100. |
|
|
240
242
|
| abs | Reads the anchored data value and places its formatted absolute value in a collision-managed label. | at | at: AnchorRef | | Drawn reference series accept anchors. Bad anchors report the cause and valid ids. |
|
|
241
243
|
| event | Places a dated event in the lane above the plot as a block with a pole to the data, or, when it does not fit, as a numbered marker with an entry in the event key below the plot; periods draw a thin bar. | label | at: categoryId (optional) | date: ISO date yyyy-mm-dd, in place of at: the event sits at the last category whose date is on or before it, and the block header and the key print it as d MMM. Every category needs an ISO date; a date outside the categories warns event-out-of-range. end: ISO date, with date: the event is a period, drawn as a thin bar to the end of that day. to: Category id, with at: the event is a period to the end of that category. group: Id of a group in options.events.groups, which gives the kind label, tone and glyph. detail: string \| string[]. Authored lines under the title, at most three in the lane; nothing is cut, a longer block moves to the key. items: { label, detail? }[]. More changes on the same date, after this event's own label and detail. The lane and the key draw a compact +N after the title; the hover card, the SVG title and description, and the interaction records list every item in full. placement: auto \| key, default options.events.placement. key numbers this event into the key below the plot. tone: neutral \| bad \| good, default the group tone, else neutral. Column, combo and line paint the glyph, the marker ring and the period bar in it; gantt paints a bad rule. labelPlacement: top \| inline \| badge, default top. inline (line) sets the block beside its rule inside the plot. badge (gantt) draws the label, at most 3 characters, in a filled circle at the top of its rule; badge events never go to the numbered key. | Exactly one of at (a category id) and date (an ISO date) places the event; end or to makes it a period. The event lane above the plot sets a block of group and date, title and detail with a thin pole to the data; an event that does not fit, a second event on one category and every event under options.events.placement 'key' get a numbered marker and an entry in the key below the plot, numbered in time order; under footnotes: false they are left off and listed in the footnotes-off lint. The full date, title and detail of every event stay in the SVG title and description, the interaction records and the hover card, whether or not the lane or the key prints the detail. In compact mode the lane is one row of numbered markers and the key packs "n date title" into as few lines as the width allows; where the plot would still fall under 80px the key keeps "n title" and the info lint event-lane-compact says so. options.events.rows sets the lane rows (default by canvas width: 1 under 1080px, 2 from 1080px); a row gives way while the plot band left under the lane would keep less than 40% of the canvas height. |
|
|
242
244
|
| band | Draws an inclusive category span as a shaded band or bracket, or a value-axis plan corridor, tolerance band or attainment fill, with a collision-managed label. | | from: categoryId (optional); to: categoryId (optional) | | Era shade/bracket needs inclusive category IDs. Corridor and tolerance use finite low/high on the value scale, with optional from/to as a category clip. Attainment needs a plan value and shades each resolved actual; missing cells are skipped. Divider applies only to bracket bands. Scenario AC/PY/PL/FC paints a plan corridor (default PL). |
|
|
245
|
+
| text | Places authored text at a point through the label solver: on the point, or above, below, right or left of it. The text prints as written. | at, text | at: AnchorRef \| { categoryId, value } | | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. The text prints as written, ${value} included. It takes id and priority, and no other field. |
|
|
246
|
+
| line | Draws a straight line between two points or from a text annotation, in the ink and rule width of a bracket; a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the line in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the line starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
247
|
+
| arrow | Draws a straight arrow between two points or from a text annotation to a point, in the theme arrow look (`marks.arrow`); a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the shaft in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the arrow starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
248
|
+
| box | Draws an unfilled box with two points as opposite corners, wrapping whole category bands, in the ink and rule width of a bracket; text inside the box stays free. | from, to | from: AnchorRef \| { categoryId, value }; to: AnchorRef \| { categoryId, value } | dashed: boolean, default false. Draws the edges in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. from and to are opposite corners, the box has no fill, and text inside it stays free. A { categoryId, value } corner spans that category's whole band, so the box wraps whole bars, values and markers; from and to on one category wrap that category. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
243
249
|
|
|
244
250
|
## Trend lines
|
|
245
251
|
|
|
@@ -386,6 +392,9 @@ Below the floor a render is refused with `size-below-floor` and the pixels it ne
|
|
|
386
392
|
| shared-recession-period-bands | example | Period annotations separate the starting quarter, recession and recovery |
|
|
387
393
|
| tolerance-band | example | Tolerance band around a 90 indexed target |
|
|
388
394
|
| two-series-level-diff | example | Multi-series line with last-period difference and series CAGR |
|
|
395
|
+
| callout-arrow | example | Callout arrow from a note to the point it names |
|
|
396
|
+
| callout-arrow-compact | example | Callout arrow in the compact arrow look |
|
|
397
|
+
| callout-arrow-heavy | example | Callout arrow with a heavy shaft |
|
|
389
398
|
| line-compact-380 | example | Line in a 380px dashboard column |
|
|
390
399
|
| torture-long-labels | torture | Torture: long names at a generous size read whole, never cut |
|
|
391
400
|
| highlight-overlap | torture | Actual remains visible when plan overlaps |
|
|
@@ -396,6 +405,10 @@ Below the floor a render is refused with `size-below-floor` and the pixels it ne
|
|
|
396
405
|
| iso-months-year-row | example | ISO month ids across two years print months and a year row |
|
|
397
406
|
| rates-as-fractions | torture | SQL fractions use percentage cells at input |
|
|
398
407
|
| ordered-ramp-rest-apart | example | Rest only has to differ from the ordered ramp (othersShade 'apart') |
|
|
408
|
+
| drawing-kinds | example | A box over the maintenance weeks, the normal load and an arrow from a note |
|
|
409
|
+
| value-line-end-value | example | A named value line at the series end value prints its name beside that value |
|
|
410
|
+
| shade-band-inside-wrap | example | A narrow shaded band wraps its name inside |
|
|
411
|
+
| point-emphasis | example | A selected trough emphasizes its marker and value while the line keeps its ink |
|
|
399
412
|
| small-drawer | example | A plain line chart in a 480 by 200 drawer |
|
|
400
413
|
| weekly-orders-anomalies | example | Two weeks break out of the normal order range (anomaly on a line) |
|
|
401
414
|
| weekly-events-lane | example | Event lane over a weekly line: dotted rules behind the data, the rest numbered in the key |
|
package/docs/reference/mekko.md
CHANGED
|
@@ -74,7 +74,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
74
74
|
| widthSeriesId | string | | | Series supplying category widths; omitted uses category totals, or equal widths in bar mode. |
|
|
75
75
|
| ridge | string | | | Data-series id whose top boundary is emphasized across the variable-width columns. |
|
|
76
76
|
|
|
77
|
-
Plus the [shared options](options.md). This type does not accept `mode`, `valueAxis.log`, `valueAxis.reverse`, `valueAxis.break`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `bandFraction` with an `option-ignored` warning.
|
|
77
|
+
Plus the [shared options](options.md). This type does not accept `mode`, `valueAxis.log`, `valueAxis.reverse`, `valueAxis.break`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `bandFraction`, `topN.threshold` with an `option-ignored` warning.
|
|
78
78
|
|
|
79
79
|
## Annotations
|
|
80
80
|
|
|
@@ -82,14 +82,18 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
82
82
|
|
|
83
83
|
| Kind | Purpose | Required | Anchors | Optional fields | Notes |
|
|
84
84
|
|---|---|---|---|---|---|
|
|
85
|
-
| 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
|
|
86
|
-
| 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. |
|
|
87
|
-
| delta | Computes the signed difference between an anchored value and another anchor or literal, then places a collision-managed label at the first anchor. | at, vs | at: AnchorRef; vs: AnchorRef \| number |
|
|
85
|
+
| cagr | Draws a growth arrow between two anchored points and computes the compound annual growth rate from their values and ISO-date span. | | from: AnchorRef (optional); to: AnchorRef (optional) | suffix: string, default 'p.a.'. Text after the rate. period: boolean. Print the period before the rate from the anchors' category labels, '2014–2019: +5.8% p.a.'. Default true when the chart carries two or more CAGRs, so nested brackets are told apart by their text, false otherwise. An arrow's ends show its span, so an arrow prints the rate alone unless period is true. shape: bracket \| arrow, default bracket. arrow draws one straight arrow over the marks with the rate in an oval on it, lifted until it clears them. Where no straight line clears the chart, the span is too short for the oval, a stack's inner layer is the anchor or the chart lays comparisons out itself, it draws the bracket and warns cagr-arrow-no-room. | Omitted endpoints span the first to the last category, or the first to the last total on a waterfall. Resolved endpoints need a positive date interval from ISO dates or year-bearing labels and a positive start value; an end of zero reads -100%, and a start at or below zero or a negative end omits the rate and warns cagr-undefined. On a continuous time axis the years are the exact span between the two readings. An anchor on one series of several (seriesId, or a category of an unstacked line, which reads the first drawn series; on a stack a category reads the stack total) names that series in the label, "Product B +10.1% p.a.", and the arm runs from that series' segment or point. In text, ${value} prints the rate with its suffix, so "CAGR 2014–2019: ${value}" keeps the computed number. |
|
|
86
|
+
| diff | Draws a level-difference arrow between two anchors and computes either percent change or their signed value difference. | from, to | from: AnchorRef; to: AnchorRef | mode: relative \| absolute \| reversed \| both, default relative. relative prints the percent change from 'from' to 'to', reversed the change from 'to' to 'from', absolute the value difference, both the value difference with the percent change beside it. | Mode defaults to relative. Relative and reversed changes need a nonzero base; negative bases use its absolute magnitude and emit a warning. Absolute mode reports the raw value difference. A hidden label removes its arm. |
|
|
87
|
+
| delta | Computes the signed difference between an anchored value and another anchor or literal, then places a collision-managed label at the first anchor. | at, vs | at: AnchorRef; vs: AnchorRef \| number | mode: absolute \| relative \| both, default absolute. absolute prints at minus vs, relative the percent change from vs to at, both the two as '+149 (+36%)'. relative and both need a nonzero vs. | |
|
|
88
88
|
| note | Places authored text at an anchored data element through collision avoidance, with an optional icon or status chip. | at, text | at: AnchorRef | | |
|
|
89
|
-
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false.
|
|
89
|
+
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false. An arrow from the text to the anchored point, in the arrow standard of theme marks.arrow: the text stands far enough out for a 24 px shaft, level with the point right or left of it, or over or under it, where there is room. With no such seat it draws without the arrow and warns callout-arrow-no-room. Not with icon or status. Example: "arrow": true. | |
|
|
90
90
|
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. side: left \| right, default right. Side of the plot the label sits on. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
91
91
|
| indicator100 | Maps 100 through the chart's value scale and draws a side tick with a 100% label. | | | side: left \| right, default left. Side of the plot the 100% mark sits on. | No anchor is required. The chart needs a value scale that can represent 100. |
|
|
92
92
|
| abs | Reads the anchored data value and places its formatted absolute value in a collision-managed label. | at | at: AnchorRef | | |
|
|
93
|
+
| text | Places authored text at a point through the label solver: on the point, or above, below, right or left of it. The text prints as written. | at, text | at: AnchorRef \| { categoryId, value } | | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. The text prints as written, ${value} included. It takes id and priority, and no other field. |
|
|
94
|
+
| line | Draws a straight line between two points or from a text annotation, in the ink and rule width of a bracket; a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the line in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the line starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
95
|
+
| arrow | Draws a straight arrow between two points or from a text annotation to a point, in the theme arrow look (`marks.arrow`); a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the shaft in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the arrow starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
96
|
+
| box | Draws an unfilled box with two points as opposite corners, wrapping whole category bands, in the ink and rule width of a bracket; text inside the box stays free. | from, to | from: AnchorRef \| { categoryId, value }; to: AnchorRef \| { categoryId, value } | dashed: boolean, default false. Draws the edges in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. from and to are opposite corners, the box has no fill, and text inside it stays free. A { categoryId, value } corner spans that category's whole band, so the box wraps whole bars, values and markers; from and to on one category wrap that category. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
93
97
|
|
|
94
98
|
## Sizing
|
|
95
99
|
|
|
@@ -112,3 +116,4 @@ Below the floor a render is refused with `size-below-floor` and the pixels it ne
|
|
|
112
116
|
| torture-long-labels | torture | Torture: long names at a generous size read whole, never cut |
|
|
113
117
|
| percent-format-on-shares | torture | Shares use the percent format and totals stay absolute |
|
|
114
118
|
| rounding-smallest-tie | torture | Equal-remainder ties favor the smaller share |
|
|
119
|
+
| bar-inside-base-values | example | Mekko bar values inside the base |
|
|
@@ -4,7 +4,7 @@ Contents: [Options](#options), [Target and size](#target-and-size), [Label kinds
|
|
|
4
4
|
|
|
5
5
|
<!-- Generated by scripts/generate-reference.mjs from the boardplot describe, list and fixtures payloads. -->
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
These options are shared across chart types. Each type page names its exceptions, ignored settings and overrides. To author a spec, start with compact `boardplot_describe` and request any needed field by path, for example `{ "type": "bar", "path": "options.title" }`. `detail: "full"` adds complete descriptions of the own fields of the type.
|
|
8
8
|
|
|
9
9
|
## Options
|
|
10
10
|
|
|
@@ -48,10 +48,10 @@ Every chart type accepts these options unless its own page names them as not acc
|
|
|
48
48
|
| footnotes | array \| false \| string | `false` (or another value of its type) | | A string is one footnote. Footnotes in authored order. `**text**` draws bold and a single `*` stays literal. The frame prints them within notes.maxLines and the rest go to the notes list. false leaves notes and the pointer off the frame; disclosures that notes.show prints, the source line and a required map credit stay. |
|
|
49
49
|
| notes | object | | | Notes; the footer rule: where the notes under the chart go, how many lines they take, and the note lines for what the drawing leaves out. |
|
|
50
50
|
| notes.maxListed | integer \| string | `'all'` (or another value of its type) | `8` | Items a note line names before it counts the rest, such as "Not labelled on the chart: ... and 236 more". Default: every note line names as many items as fit two footer lines, at most 8, reference lines and line end values first, then the rest in data order, and ends with "and N more"; when no name fits, it counts. 'all' names every item. 0 names none and only counts them, "18 of 36 values". All items stay in the reading and the hover records. |
|
|
51
|
-
| notes.placement | string | `'frame'`, `'info'`, `'list'` | | Where the notes go. 'frame' prints notes in the frame within maxLines and the rest in the notes list; 'list' prints only the source line, a required map credit and the pointer; 'info' is the React "Notes and sources" button with one visible line of source and required credit (an SVG or PNG draws it as 'frame'). Default by target: dashboard 'info', slide 'list', report and print 'frame'. |
|
|
52
|
-
| notes.maxLines | integer | | | Visible lines of notes and source line in the frame; a required map credit and a disclosure do not count. Notes that do not fit go to the notes list and the pointer counts them. Default report and dashboard 3 (2 under 720 px wide), slide 2, print 3. |
|
|
53
|
-
| notes.show | string[] | `'note'`, `'method'`, `'disclosure'`, `'ranks'` | | The kinds of note the frame prints. Default ['note'], the authored footnotes, within maxLines; an authored note a mark points at always prints. 'method' adds the one-line short form of the method notes the engine writes (likert net, pvm split). 'disclosure' adds the engine's notes on how to read the chart (a key, a data change, 'Not labelled on the chart: ...'), outside maxLines; then a chart may also key its marks to them, such as rank numbers under the columns. 'ranks' prints only the rank key: rank numbers under the columns where the names fit neither upright nor rotated, with the note that names them, and no other disclosure. Engine notes print nowhere under the chart by default; every note stays in the notes list of the render result and in its warnings. |
|
|
54
|
-
| notes.pointer | boolean | | `true` | Default true: when the notes list holds notes of the kinds notes.show prints that the frame does not print, the source line ends with "+N notes". |
|
|
51
|
+
| notes.placement | string | `'frame'`, `'info'`, `'list'` | | Where the notes go. 'frame' prints notes in the frame within maxLines and the rest in the notes list; 'list' prints only the source line, a required map credit and the pointer; 'info' is the React "Notes and sources" button with one visible line of source and required credit (an SVG or PNG draws it as 'frame'). Default by target: dashboard 'info', slide 'list', report and print 'frame'. An authored placement without notes.show also prints the engine's method notes and disclosures, within maxLines after the author notes. |
|
|
52
|
+
| notes.maxLines | integer | | | Visible lines of notes and source line in the frame; a required map credit, an author note or a disclosure a drawn mark points at, and a disclosure that an authored notes.show lists do not count. Notes that do not fit go to the notes list and the pointer counts them. Default report and dashboard 3 (2 under 720 px wide), slide 2, print 3. |
|
|
53
|
+
| notes.show | string[] | `'note'`, `'method'`, `'disclosure'`, `'ranks'` | | The kinds of note the frame prints. Default ['note'], the authored footnotes, within maxLines; an authored note a mark points at always prints. 'method' adds the one-line short form of the method notes the engine writes (likert net, pvm split). 'disclosure' adds the engine's notes on how to read the chart (a key, a data change, 'Not labelled on the chart: ...'), outside maxLines; then a chart may also key its marks to them, such as rank numbers under the columns. 'ranks' prints only the rank key: rank numbers under the columns where the names fit neither upright nor rotated, with the note that names them, and no other disclosure. Without notes.show, methodNote: true or an authored placement prints the method notes and disclosures within maxLines. Engine notes print nowhere under the chart by default; every note stays in the notes list of the render result and in its warnings. |
|
|
54
|
+
| notes.pointer | boolean | | `true` | Default true: when the notes list holds notes of the kinds notes.show prints that the frame does not print, the source line ends with "+N notes". false drops it; a live chart that then leaves author notes out warns notes-left-out. |
|
|
55
55
|
| theme | string \| object \| object | | | Theme preset or preset with overrides. An object with only overrides uses the default preset. Request context may supply a theme, otherwise resolution uses bridge. |
|
|
56
56
|
| theme.preset | string | | | Registered base theme whose tokens are overridden. |
|
|
57
57
|
| theme.overrides | object | | | Partial theme token tree merged with the named preset. Partial token tree applied to the default preset. |
|
|
@@ -59,8 +59,8 @@ Every chart type accepts these options unless its own page names them as not acc
|
|
|
59
59
|
| locale.language | string | | | BCP 47 language tag. Changes words only, such as notes and month names. It never changes the decimal or grouping marks; they come only from locale.decimal and locale.thousands. E.g. "de"; "de_DE" is read as "de-DE"; "en-US" puts the month first (Sep 4). |
|
|
60
60
|
| locale.decimal | string | `'.'`, `','` | | Decimal mark of every number the chart prints. Default '.'. The language does not change it. |
|
|
61
61
|
| locale.thousands | string | `','`, `'.'`, `'’'`, `'\\''`, `' '`, `' '` | | Grouping mark of every number the chart prints. The apostrophe ' is the same as ’, and the narrow no-break space is the same as the space. Default ',', or '.' with decimal ','. The language does not change it. A value equal to the decimal mark uses that fallback. |
|
|
62
|
-
| locale.minusGlyph | string | `'−'`, `'-'` | | Minus glyph
|
|
63
|
-
| locale.weekStartsOn | number | `0`, `1` | | First weekday for week
|
|
62
|
+
| locale.minusGlyph | string | `'−'`, `'-'` | | Minus glyph of the numbers a table or dimswitch formats from the locale; default Unicode minus. Other types print the Unicode minus and ignore it without a warning. |
|
|
63
|
+
| locale.weekStartsOn | number | `0`, `1` | | First weekday for week ticks; default Monday. Read by categoryAxis.dateTicks 'weeks' on column, combo and line, and by the week ticks of a line time axis. Those three report it (week-start-ignored) when dateTicks asks for another interval. Other types ignore it without a warning. |
|
|
64
64
|
| strings | object | | | Wording of built-in labels. These are the labels the renderer composes itself: author chart text stays unchanged and an explicit option still wins per label; host-level wording comes from the theme provider. |
|
|
65
65
|
| strings.newItems | string | | | PVM entry-bar name; default New items. |
|
|
66
66
|
| strings.lostItems | string | | | PVM exit-bar name; default Lost items. |
|
|
@@ -185,7 +185,11 @@ Every chart type accepts these options unless its own page names them as not acc
|
|
|
185
185
|
| labelDensity | string | `'full'`, `'smart'`, `'minimal'` | | Label selection policy, default smart. full: every value label competes for a slot, and a segment value that does not fit its segment moves outside on a leader. smart: as full, but a stacked column or combo segment value prints inside its segment or not at all (where one is wider than its column, the stacked column values step down a size, to the floor; still too wide, none prints), and a segment value drops when the segment is shorter than the label height plus 4 px padding (the label width on a horizontal bar); mekko also drops segment values in columns narrower than 24 px. A labelPlacements pin keeps its label. minimal: keeps only the chart's essential labels (totals, endpoints, highlights). Collision suppression applies at every level. |
|
|
186
186
|
| labels | false \| object | `false` (or another value of its type) | | Label visibility and content overrides; omission uses the selected chart policy. Unsupported chart types refuse this shared option. false turns optional labels off. An object maps a label kind (category, series, segment, point, total, grandTotal, insidePie, outsidePie, percentIndicator, restSeries, tick, axisTitle, valueLine, annotation, growth, activity, item; each chart reads its own, and a kind it does not read is refused) to true, false or content parts from absolute, percent, category and series. Another part is dropped with a warning; value draws as absolute. On a stacked column with one PY reference series, { growth: false } drops the growth arrows over the totals (↑ 6.1%) and keeps the PY ticks and their labels; { percentIndicator: false } drops the 100% marker of a 100% chart. On bar, box, column, combo, dot, line, Mekko, slope and variance, false keeps category names; { category: false } hides them. On bullet, butterfly, funnel, heatmap, pyramid and status, false keeps the row, column and stage names; on kpi it keeps the main number and the card name. Grid panels can leave category names to the grid. On a line, series false turns the series names off and point sets what each printed value shows, so { point: ['category', 'absolute'] } prints 08-16 44.7 at the point. On a stacked column or combo, { segment: ['absolute', 'percent'] } prints each segment value over its share of the stack; a stack with a negative or missing part prints the value alone and warns. restSeries sets the values of a stacked column, bar or area series whose colorRole is others: absent, they print everywhere except the dashboard target, where the hover card and the note line carry them; true prints them, false hides and notes them on every target. |
|
|
187
187
|
| categoryLabels | string | `'axis'`, `'staircase'` | | Where category names go: 'axis' (default), the row under the axis; 'staircase', each name over the lower columns beside its own, one step lower than the last, with a vertical leader to its column (column, combo, pareto). Without a seat for every name the row returns and staircase-labels-fallback warns. |
|
|
188
|
+
| labelPosition | string | `'auto'`, `'center'`, `'insideEnd'`, `'insideBase'`, `'outsideEnd'` | | Position of bar values. Default 'auto' keeps normal placement. 'center' uses the middle; 'insideEnd' and 'insideBase' use the edges farther from and nearer zero; 'outsideEnd' sits past the farther edge. Pins win. A blocked or too-small seat takes its safe fallback. Floating steps try above then below, or right then left horizontally. Axis bars try outside the end. Stacked segments keep their existing fallback; integrated variance totals stay inside. Stacked variants and integrated variance refuse outsideEnd. |
|
|
188
189
|
| labelPlacements | object | | | Authored placement pins keyed by label id; the solver checks each requested slot. On a line, a pinned end label removes the legend step of the end-label ladder. The slots a label can take depend on the chart and its data; a wrong slot warns unknown-slot and lists the valid and free slots of that render. |
|
|
190
|
+
| labelOffsets | object | | | Moves labels by a set distance, keyed by label id, such as { 'annotation:callout-2': { y: 40 } }. A label's id is in the labels of a render and in the warnings that name it. The move starts from the seat the solver or a pin chose. A seat that is blocked keeps the label where it stands and warns label-offset-blocked; an id this chart does not draw warns label-offset-unknown. A moved label gets a leader back to its seat, unless it is a value that takes none. A value moved off its own bar prints in page ink with a halo. A bracket's offset moves its label only, not its run. |
|
|
191
|
+
| labelOffsets.*.x | number | | | Pixels to the right; negative moves left. |
|
|
192
|
+
| labelOffsets.*.y | number | | | Pixels down; negative moves up. |
|
|
189
193
|
| legend | string \| object | `'top'`, `'bottom'`, `'right'`, `'left'`, `'none'`, `'auto'` (or another value of its type) | | A key without a named position sits in one row above the plot, flush with it, under the subtitle; more items wrap to further rows and move the plot down. 'bottom' puts the row under the plot. 'right' and 'left' put the key in a column beside the plot where the plot block keeps at least 68% of the chart width and the column fits the height; otherwise the key stays in the row above the plot and a legend-side-fallback warning says so. 'auto' adds keys when visible labels do not name every drawn series. A displayed subtitle measure or unit can name one primary series, matching the complete phrase without case sensitivity. Required explanatory keys remain, except the keys of a table, heatmap, cohort and variance, which 'none' drops for a host that draws its own. Automatic keys use footnote type in the top row. Explicit settings override theme.legend.auto, which defaults to false. Multi-series column, bar, combo, dot and scatter charts add a key when direct names are missing. A series key explains its scenario styling. Grids keep a required key under 'none' when direct names are incomplete. |
|
|
190
194
|
| legend.position | string | `'top'`, `'bottom'`, `'right'`, `'left'` | | Key position: 'top', one row above the plot, 'bottom', one row under it, or 'right' or 'left', a column beside the plot. A column beside the plot takes the plot's width: where the plot block would keep under 68% of the chart width, or the column does not fit the height, the key goes to the row above the plot with a legend-side-fallback warning. |
|
|
191
195
|
| legend.order | array | | | Legend item ids in the requested order; unspecified items follow. |
|
|
@@ -221,7 +225,7 @@ Every chart type accepts these options unless its own page names them as not acc
|
|
|
221
225
|
| topN.rest | boolean | | | Aggregate remaining categories into a rest bucket by default; false omits them where supported. On a bar mekko the rest bucket is the width-weighted mean of its rates. Pareto retains the bucket to preserve its population. |
|
|
222
226
|
| topN.restLabel | string | | | Authored rest-bucket name; ordinary charts default to Others and Pareto to Rest. |
|
|
223
227
|
| topN.showRestCount | boolean | | | Append the number of aggregated categories; ordinary charts default to false, while Pareto always discloses the count. |
|
|
224
|
-
| topN.threshold | number | | | Bar
|
|
228
|
+
| topN.threshold | number | | | Bar, column and table: minimum absolute category total after the rank cut, also when n keeps every category. The largest category always stays. Other types ignore it with an option-ignored warning. |
|
|
225
229
|
| bandFraction | number | | | Fraction of a category band occupied by its mark, greater than zero and at most one; default is chart-specific, commonly 0.7. |
|
|
226
230
|
| highlight | string \| array | | | One or more data ids selected for chart-specific visual emphasis. Selected marks take color.focus, and color.highlight on a theme that sets no focus. On a single-series bar, column or dot chart the named categories take it and every other mark steps back to color.neutralLight, the rest role. A series fill or colorRole outranks both colours; scenario marks keep their pattern and signColor its good/bad colours, and unhighlighted scenario marks keep their scenario colour. A highlight with no visible mark (null, or a zero bar or column) recedes nothing. On a line the named series take it at 2.6px and the others step through muted tints toward ink, with a swatch on each end label. On an unstacked area with several series the first named series is the one that is filled. |
|
|
227
231
|
| story | object | | | Guided steps over one chart. Each step fades the marks it does not name and shows a panel with its title and body. React needs withStory from boardplot/react/story. |
|
|
@@ -248,17 +252,17 @@ Every chart type accepts these options unless its own page names them as not acc
|
|
|
248
252
|
| interactive | boolean | | | Emit data-bp-* semantics for dependency-free web interactivity; static output is unchanged by default. |
|
|
249
253
|
| debug | boolean | | | Layout debug flag ignored with an option-ignored warning. |
|
|
250
254
|
| annotations | array | | | Data-bound annotations in authored order; explicit ids must be unique and each chart advertises its supported kinds. |
|
|
251
|
-
| annotations[].kind (annotations[] branch 1) | string | `'diff'`, `'cagr'`, `'delta'`, `'bracket'`, `'abs'`, `'note'`, `'callout'`, `'valueLine'`, `'indicator100'`, `'event'` | | Annotation operation; its anchors and additional fields are checked by the chart annotation pass. |
|
|
255
|
+
| annotations[].kind (annotations[] branch 1) | string | `'diff'`, `'cagr'`, `'delta'`, `'bracket'`, `'abs'`, `'note'`, `'callout'`, `'valueLine'`, `'indicator100'`, `'event'`, `'text'`, `'line'`, `'arrow'`, `'box'` | | Annotation operation; its anchors and additional fields are checked by the chart annotation pass. |
|
|
252
256
|
| annotations[].id (annotations[] branch 1) | string | | | Stable annotation identity; omission generates an id from kind and authored order. |
|
|
253
|
-
| annotations[].text (annotations[] branch 1) | string | | | Authored annotation text; on valueLine, text is read as label with an info warning when label is absent or equal. Refused on indicator100. ${value} prints the computed number in it: a cagr's rate with its suffix, a diff's change, a delta's difference, the anchored value of an abs, note or callout; a note or callout on a mark that prints the same number leaves it to the mark and reports annotation-value-on-mark. Without ${value}, text on a cagr, diff, delta or abs replaces the number, warns annotation-authored-override and the claim record marks the override. |
|
|
254
|
-
| annotations[].format (annotations[] branch 1) | string | | | Number format: annotation > anchored series > chart. Diff uses to, then from. CAGR
|
|
255
|
-
| annotations[].priority (annotations[] branch 1) | number | | | Annotation label priority during collision resolution. |
|
|
257
|
+
| annotations[].text (annotations[] branch 1) | string | | | Authored annotation text; on valueLine and event, text is read as label with an info warning when label is absent or equal, and refused beside a different label. Refused on indicator100, line, arrow and box. On a text annotation it is the text itself, and ${value} prints as written. Elsewhere ${value} prints the computed number in it: a cagr's rate with its suffix, a diff's change, a delta's difference, the anchored value of an abs, note or callout; a note or callout on a mark that prints the same number leaves it to the mark and reports annotation-value-on-mark. Without ${value}, text on a cagr, diff, delta or abs replaces the number, warns annotation-authored-override and the claim record marks the override. |
|
|
258
|
+
| annotations[].format (annotations[] branch 1) | string | | | Number format: annotation > anchored series > chart. Diff uses to, then from. CAGR, a relative or reversed diff and a relative delta need a percent example; value differences, also under mode both, use pp for percent levels. Refused on event, indicator100, text, line, arrow and box. |
|
|
259
|
+
| annotations[].priority (annotations[] branch 1) | number | | | Annotation label priority during collision resolution. Refused on line, arrow and box. |
|
|
256
260
|
| annotations[].icon (annotations[] branch 1) | string | `'alert'`, `'calendar'`, `'check'`, `'conversation'`, `'document'`, `'flag'`, `'gear'`, `'lightbulb'`, `'lock'`, `'people'`, `'star'`, `'target'`, `'workflow'` | | Registered icon for note or callout annotations; cannot be combined with status. |
|
|
257
261
|
| annotations[].status (annotations[] branch 1) | string | `'good'`, `'bad'`, `'warn'`, `'info'` | | Semantic status glyph for a note or callout; cannot be combined with icon. |
|
|
258
262
|
| annotations[].shape (annotations[] branch 1) | string | `'bracket'`, `'arrow'` | | A cagr's form: 'bracket', the default, runs over the marks, and 'arrow' is one straight arrow with the rate in an oval on it. |
|
|
259
263
|
| annotations[].kind (annotations[] branch 2) | string | `'band'` | | Era band spanning inclusive category ids, or a value-axis plan corridor, tolerance band or attainment fill. |
|
|
260
264
|
| annotations[].id (annotations[] branch 2) | string | | | Stable band annotation identity; omission generates an id from kind and authored order. |
|
|
261
|
-
| annotations[].text (annotations[] branch 2) | string | | |
|
|
265
|
+
| annotations[].text (annotations[] branch 2) | string | | | Read as label with an info warning when label is absent or equal; refused beside a different label. |
|
|
262
266
|
| annotations[].format (annotations[] branch 2) | string | | | Shared annotation value format; the band caption itself is authored text. |
|
|
263
267
|
| annotations[].priority (annotations[] branch 2) | number | | | Band label priority during collision resolution. |
|
|
264
268
|
| annotations[].from (annotations[] branch 2) | string | | | First category included in the band; required for era shade/bracket, optional clip for value-axis bands. |
|
package/docs/reference/pareto.md
CHANGED
|
@@ -66,10 +66,14 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
66
66
|
| Kind | Purpose | Required | Anchors | Optional fields | Notes |
|
|
67
67
|
|---|---|---|---|---|---|
|
|
68
68
|
| note | Places authored text at an anchored data element through collision avoidance, with an optional icon or status chip. | at, text | at: AnchorRef | | |
|
|
69
|
-
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false.
|
|
70
|
-
| 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
|
|
71
|
-
| 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. |
|
|
72
|
-
| 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 |
|
|
69
|
+
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false. An arrow from the text to the anchored point, in the arrow standard of theme marks.arrow: the text stands far enough out for a 24 px shaft, level with the point right or left of it, or over or under it, where there is room. With no such seat it draws without the arrow and warns callout-arrow-no-room. Not with icon or status. Example: "arrow": true. | |
|
|
70
|
+
| cagr | Draws a growth arrow between two anchored points and computes the compound annual growth rate from their values and ISO-date span. | | from: AnchorRef (optional); to: AnchorRef (optional) | suffix: string, default 'p.a.'. Text after the rate. period: boolean. Print the period before the rate from the anchors' category labels, '2014–2019: +5.8% p.a.'. Default true when the chart carries two or more CAGRs, so nested brackets are told apart by their text, false otherwise. An arrow's ends show its span, so an arrow prints the rate alone unless period is true. shape: bracket \| arrow, default bracket. arrow draws one straight arrow over the marks with the rate in an oval on it, lifted until it clears them. Where no straight line clears the chart, the span is too short for the oval, a stack's inner layer is the anchor or the chart lays comparisons out itself, it draws the bracket and warns cagr-arrow-no-room. | Omitted endpoints span the first to the last category, or the first to the last total on a waterfall. Resolved endpoints need a positive date interval from ISO dates or year-bearing labels and a positive start value; an end of zero reads -100%, and a start at or below zero or a negative end omits the rate and warns cagr-undefined. On a continuous time axis the years are the exact span between the two readings. An anchor on one series of several (seriesId, or a category of an unstacked line, which reads the first drawn series; on a stack a category reads the stack total) names that series in the label, "Product B +10.1% p.a.", and the arm runs from that series' segment or point. In text, ${value} prints the rate with its suffix, so "CAGR 2014–2019: ${value}" keeps the computed number. |
|
|
71
|
+
| diff | Draws a level-difference arrow between two anchors and computes either percent change or their signed value difference. | from, to | from: AnchorRef; to: AnchorRef | mode: relative \| absolute \| reversed \| both, default relative. relative prints the percent change from 'from' to 'to', reversed the change from 'to' to 'from', absolute the value difference, both the value difference with the percent change beside it. | Mode defaults to relative. Relative and reversed changes need a nonzero base; negative bases use its absolute magnitude and emit a warning. Absolute mode reports the raw value difference. A hidden label removes its arm. |
|
|
72
|
+
| delta | Computes the signed difference between an anchored value and another anchor or literal, then places a collision-managed label at the first anchor. | at, vs | at: AnchorRef; vs: AnchorRef \| number | mode: absolute \| relative \| both, default absolute. absolute prints at minus vs, relative the percent change from vs to at, both the two as '+149 (+36%)'. relative and both need a nonzero vs. | |
|
|
73
|
+
| text | Places authored text at a point through the label solver: on the point, or above, below, right or left of it. The text prints as written. | at, text | at: AnchorRef \| { categoryId, value } | | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. The text prints as written, ${value} included. It takes id and priority, and no other field. |
|
|
74
|
+
| line | Draws a straight line between two points or from a text annotation, in the ink and rule width of a bracket; a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the line in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the line starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
75
|
+
| arrow | Draws a straight arrow between two points or from a text annotation to a point, in the theme arrow look (`marks.arrow`); a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the shaft in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the arrow starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
76
|
+
| box | Draws an unfilled box with two points as opposite corners, wrapping whole category bands, in the ink and rule width of a bracket; text inside the box stays free. | from, to | from: AnchorRef \| { categoryId, value }; to: AnchorRef \| { categoryId, value } | dashed: boolean, default false. Draws the edges in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. from and to are opposite corners, the box has no fill, and text inside it stays free. A { categoryId, value } corner spans that category's whole band, so the box wraps whole bars, values and markers; from and to on one category wrap that category. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
73
77
|
|
|
74
78
|
## Sizing
|
|
75
79
|
|
package/docs/reference/pie.md
CHANGED
|
@@ -65,7 +65,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
65
65
|
| colors | string | `'categorical'`, `'sequential'` | | Slice colour strategy. Default 'sequential': one ramp of the first series colour in slice order, the first slice strongest, at every slice count. 'categorical' gives each slice its own theme hue. A highlight keeps its accent and steps the other slices into grey. |
|
|
66
66
|
| othersShade | string | `'quietest'`, `'apart'` | | Sequential ramp beside an Others slice. Without an Others slice the ramp does not change. Default 'quietest'. 'quietest': Others is the quietest part, so every named step has more contrast against the background than Others and none matches it. 'apart': named steps only differ from Others, and some may be quieter. If Others is stronger than the first named step, the ramp falls back to 'apart' and the chart warns others-shade-unavailable. |
|
|
67
67
|
|
|
68
|
-
Plus the [shared options](options.md). This type does not accept `valueAxis`, `hatchStrength`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `bandFraction`, `valueAxis.show`, `valueAxis.gridlines` with an `option-ignored` warning.
|
|
68
|
+
Plus the [shared options](options.md). This type does not accept `labelPosition`, `valueAxis`, `hatchStrength`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `bandFraction`, `valueAxis.show`, `valueAxis.gridlines`, `topN.threshold` with an `option-ignored` warning.
|
|
69
69
|
|
|
70
70
|
## Annotations
|
|
71
71
|
|
|
@@ -73,12 +73,16 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
73
73
|
|
|
74
74
|
| Kind | Purpose | Required | Anchors | Optional fields | Notes |
|
|
75
75
|
|---|---|---|---|---|---|
|
|
76
|
-
| 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
|
|
77
|
-
| 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. |
|
|
76
|
+
| cagr | Draws a growth arrow between two anchored points and computes the compound annual growth rate from their values and ISO-date span. | | from: AnchorRef (optional); to: AnchorRef (optional) | suffix: string, default 'p.a.'. Text after the rate. period: boolean. Print the period before the rate from the anchors' category labels, '2014–2019: +5.8% p.a.'. Default true when the chart carries two or more CAGRs, so nested brackets are told apart by their text, false otherwise. An arrow's ends show its span, so an arrow prints the rate alone unless period is true. shape: bracket \| arrow, default bracket. arrow draws one straight arrow over the marks with the rate in an oval on it, lifted until it clears them. Where no straight line clears the chart, the span is too short for the oval, a stack's inner layer is the anchor or the chart lays comparisons out itself, it draws the bracket and warns cagr-arrow-no-room. | Omitted endpoints span the first to the last category, or the first to the last total on a waterfall. Resolved endpoints need a positive date interval from ISO dates or year-bearing labels and a positive start value; an end of zero reads -100%, and a start at or below zero or a negative end omits the rate and warns cagr-undefined. On a continuous time axis the years are the exact span between the two readings. An anchor on one series of several (seriesId, or a category of an unstacked line, which reads the first drawn series; on a stack a category reads the stack total) names that series in the label, "Product B +10.1% p.a.", and the arm runs from that series' segment or point. In text, ${value} prints the rate with its suffix, so "CAGR 2014–2019: ${value}" keeps the computed number. |
|
|
77
|
+
| diff | Draws a level-difference arrow between two anchors and computes either percent change or their signed value difference. | from, to | from: AnchorRef; to: AnchorRef | mode: relative \| absolute \| reversed \| both, default relative. relative prints the percent change from 'from' to 'to', reversed the change from 'to' to 'from', absolute the value difference, both the value difference with the percent change beside it. | Mode defaults to relative. Relative and reversed changes need a nonzero base; negative bases use its absolute magnitude and emit a warning. Absolute mode reports the raw value difference. A hidden label removes its arm. |
|
|
78
78
|
| note | Places authored text at an anchored data element through collision avoidance, with an optional icon or status chip. | at, text | at: AnchorRef | | |
|
|
79
|
-
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false.
|
|
80
|
-
| 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 |
|
|
79
|
+
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false. An arrow from the text to the anchored point, in the arrow standard of theme marks.arrow: the text stands far enough out for a 24 px shaft, level with the point right or left of it, or over or under it, where there is room. With no such seat it draws without the arrow and warns callout-arrow-no-room. Not with icon or status. Example: "arrow": true. | |
|
|
80
|
+
| delta | Computes the signed difference between an anchored value and another anchor or literal, then places a collision-managed label at the first anchor. | at, vs | at: AnchorRef; vs: AnchorRef \| number | mode: absolute \| relative \| both, default absolute. absolute prints at minus vs, relative the percent change from vs to at, both the two as '+149 (+36%)'. relative and both need a nonzero vs. | |
|
|
81
81
|
| abs | Reads the anchored data value and places its formatted absolute value in a collision-managed label. | at | at: AnchorRef | | |
|
|
82
|
+
| text | Places authored text at a point through the label solver: on the point, or above, below, right or left of it. The text prints as written. | at, text | at: AnchorRef \| { categoryId, value } | | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. The text prints as written, ${value} included. It takes id and priority, and no other field. |
|
|
83
|
+
| line | Draws a straight line between two points or from a text annotation, in the ink and rule width of a bracket; a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the line in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the line starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
84
|
+
| arrow | Draws a straight arrow between two points or from a text annotation to a point, in the theme arrow look (`marks.arrow`); a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the shaft in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the arrow starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
85
|
+
| box | Draws an unfilled box with two points as opposite corners, wrapping whole category bands, in the ink and rule width of a bracket; text inside the box stays free. | from, to | from: AnchorRef \| { categoryId, value }; to: AnchorRef \| { categoryId, value } | dashed: boolean, default false. Draws the edges in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. from and to are opposite corners, the box has no fill, and text inside it stays free. A { categoryId, value } corner spans that category's whole band, so the box wraps whole bars, values and markers; from and to on one category wrap that category. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
82
86
|
|
|
83
87
|
## Sizing
|
|
84
88
|
|
package/docs/reference/pvm.md
CHANGED
|
@@ -54,7 +54,7 @@ One form; its chart ID is `pvm`.
|
|
|
54
54
|
| currentLabel | string | | Closing total-bar name; default Current. |
|
|
55
55
|
| items | array | yes | Comparable items with prior and current quantities and revenues for the price/volume/mix decomposition. |
|
|
56
56
|
| items[].id | string | yes | Unique item identity binding prior and current decomposition inputs. |
|
|
57
|
-
| items[].label | string | |
|
|
57
|
+
| items[].label | string | | Item name for the author. The bridge draws effect bars, not items, so no item name prints. |
|
|
58
58
|
| items[].prior | object | yes | Base period. |
|
|
59
59
|
| items[].prior.qty | number | yes | Units sold in the period. Never negative; 0 only with revenue 0. |
|
|
60
60
|
| items[].prior.revenue | number | yes | Revenue for those units. Price is derived as revenue / qty. |
|
|
@@ -86,13 +86,17 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
86
86
|
|
|
87
87
|
| Kind | Purpose | Required | Anchors | Optional fields | Notes |
|
|
88
88
|
|---|---|---|---|---|---|
|
|
89
|
-
| 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
|
|
90
|
-
| diff | Draws a level-difference arrow between two anchors and computes either percent change or their signed value difference. | from, to | from: AnchorRef; to: AnchorRef | mode: relative \| absolute \| reversed, default relative. relative prints the percent change from 'from' to 'to', reversed the change from 'to' to 'from', absolute the value difference. | Mode defaults to relative. Relative and reversed changes need a nonzero base; negative bases use its absolute magnitude and emit a warning. Absolute mode reports the raw value difference. A hidden label removes its arm. |
|
|
91
|
-
| 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 |
|
|
89
|
+
| cagr | Draws a growth arrow between two anchored points and computes the compound annual growth rate from their values and ISO-date span. | | from: AnchorRef (optional); to: AnchorRef (optional) | suffix: string, default 'p.a.'. Text after the rate. period: boolean. Print the period before the rate from the anchors' category labels, '2014–2019: +5.8% p.a.'. Default true when the chart carries two or more CAGRs, so nested brackets are told apart by their text, false otherwise. An arrow's ends show its span, so an arrow prints the rate alone unless period is true. shape: bracket \| arrow, default bracket. arrow draws one straight arrow over the marks with the rate in an oval on it, lifted until it clears them. Where no straight line clears the chart, the span is too short for the oval, a stack's inner layer is the anchor or the chart lays comparisons out itself, it draws the bracket and warns cagr-arrow-no-room. | Omitted endpoints span the first to the last category, or the first to the last total on a waterfall. Resolved endpoints need a positive date interval from ISO dates or year-bearing labels and a positive start value; an end of zero reads -100%, and a start at or below zero or a negative end omits the rate and warns cagr-undefined. On a continuous time axis the years are the exact span between the two readings. An anchor on one series of several (seriesId, or a category of an unstacked line, which reads the first drawn series; on a stack a category reads the stack total) names that series in the label, "Product B +10.1% p.a.", and the arm runs from that series' segment or point. In text, ${value} prints the rate with its suffix, so "CAGR 2014–2019: ${value}" keeps the computed number. |
|
|
90
|
+
| diff | Draws a level-difference arrow between two anchors and computes either percent change or their signed value difference. | from, to | from: AnchorRef; to: AnchorRef | mode: relative \| absolute \| reversed \| both, default relative. relative prints the percent change from 'from' to 'to', reversed the change from 'to' to 'from', absolute the value difference, both the value difference with the percent change beside it. | Mode defaults to relative. Relative and reversed changes need a nonzero base; negative bases use its absolute magnitude and emit a warning. Absolute mode reports the raw value difference. A hidden label removes its arm. |
|
|
91
|
+
| delta | Computes the signed difference between an anchored value and another anchor or literal, then places a collision-managed label at the first anchor. | at, vs | at: AnchorRef; vs: AnchorRef \| number | mode: absolute \| relative \| both, default absolute. absolute prints at minus vs, relative the percent change from vs to at, both the two as '+149 (+36%)'. relative and both need a nonzero vs. | |
|
|
92
92
|
| note | Places authored text at an anchored data element through collision avoidance, with an optional icon or status chip. | at, text | at: AnchorRef | | |
|
|
93
|
-
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false.
|
|
93
|
+
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false. An arrow from the text to the anchored point, in the arrow standard of theme marks.arrow: the text stands far enough out for a 24 px shaft, level with the point right or left of it, or over or under it, where there is room. With no such seat it draws without the arrow and warns callout-arrow-no-room. Not with icon or status. Example: "arrow": true. | |
|
|
94
94
|
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. side: left \| right, default right. Side of the plot the label sits on. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
95
95
|
| abs | Reads the anchored data value and places its formatted absolute value in a collision-managed label. | at | at: AnchorRef | | |
|
|
96
|
+
| text | Places authored text at a point through the label solver: on the point, or above, below, right or left of it. The text prints as written. | at, text | at: AnchorRef \| { categoryId, value } | | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. The text prints as written, ${value} included. It takes id and priority, and no other field. |
|
|
97
|
+
| line | Draws a straight line between two points or from a text annotation, in the ink and rule width of a bracket; a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the line in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the line starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
98
|
+
| arrow | Draws a straight arrow between two points or from a text annotation to a point, in the theme arrow look (`marks.arrow`); a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the shaft in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the arrow starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
99
|
+
| box | Draws an unfilled box with two points as opposite corners, wrapping whole category bands, in the ink and rule width of a bracket; text inside the box stays free. | from, to | from: AnchorRef \| { categoryId, value }; to: AnchorRef \| { categoryId, value } | dashed: boolean, default false. Draws the edges in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. from and to are opposite corners, the box has no fill, and text inside it stays free. A { categoryId, value } corner spans that category's whole band, so the box wraps whole bars, values and markers; from and to on one category wrap that category. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
96
100
|
|
|
97
101
|
## Sizing
|
|
98
102
|
|
|
@@ -76,11 +76,15 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
76
76
|
|
|
77
77
|
| Kind | Purpose | Required | Anchors | Optional fields | Notes |
|
|
78
78
|
|---|---|---|---|---|---|
|
|
79
|
-
| 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
|
|
80
|
-
| 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. |
|
|
81
|
-
| delta | Computes the signed difference between an anchored value and another anchor or literal, then places a collision-managed label at the first anchor. | at, vs | at: AnchorRef; vs: AnchorRef \| number |
|
|
79
|
+
| cagr | Draws a growth arrow between two anchored points and computes the compound annual growth rate from their values and ISO-date span. | | from: AnchorRef (optional); to: AnchorRef (optional) | suffix: string, default 'p.a.'. Text after the rate. period: boolean. Print the period before the rate from the anchors' category labels, '2014–2019: +5.8% p.a.'. Default true when the chart carries two or more CAGRs, so nested brackets are told apart by their text, false otherwise. An arrow's ends show its span, so an arrow prints the rate alone unless period is true. shape: bracket \| arrow, default bracket. arrow draws one straight arrow over the marks with the rate in an oval on it, lifted until it clears them. Where no straight line clears the chart, the span is too short for the oval, a stack's inner layer is the anchor or the chart lays comparisons out itself, it draws the bracket and warns cagr-arrow-no-room. | Omitted endpoints span the first to the last category, or the first to the last total on a waterfall. Resolved endpoints need a positive date interval from ISO dates or year-bearing labels and a positive start value; an end of zero reads -100%, and a start at or below zero or a negative end omits the rate and warns cagr-undefined. On a continuous time axis the years are the exact span between the two readings. An anchor on one series of several (seriesId, or a category of an unstacked line, which reads the first drawn series; on a stack a category reads the stack total) names that series in the label, "Product B +10.1% p.a.", and the arm runs from that series' segment or point. In text, ${value} prints the rate with its suffix, so "CAGR 2014–2019: ${value}" keeps the computed number. |
|
|
80
|
+
| diff | Draws a level-difference arrow between two anchors and computes either percent change or their signed value difference. | from, to | from: AnchorRef; to: AnchorRef | mode: relative \| absolute \| reversed \| both, default relative. relative prints the percent change from 'from' to 'to', reversed the change from 'to' to 'from', absolute the value difference, both the value difference with the percent change beside it. | Mode defaults to relative. Relative and reversed changes need a nonzero base; negative bases use its absolute magnitude and emit a warning. Absolute mode reports the raw value difference. A hidden label removes its arm. |
|
|
81
|
+
| delta | Computes the signed difference between an anchored value and another anchor or literal, then places a collision-managed label at the first anchor. | at, vs | at: AnchorRef; vs: AnchorRef \| number | mode: absolute \| relative \| both, default absolute. absolute prints at minus vs, relative the percent change from vs to at, both the two as '+149 (+36%)'. relative and both need a nonzero vs. | |
|
|
82
82
|
| note | Places authored text at an anchored data element through collision avoidance, with an optional icon or status chip. | at, text | at: AnchorRef | | |
|
|
83
|
-
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false.
|
|
83
|
+
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false. An arrow from the text to the anchored point, in the arrow standard of theme marks.arrow: the text stands far enough out for a 24 px shaft, level with the point right or left of it, or over or under it, where there is room. With no such seat it draws without the arrow and warns callout-arrow-no-room. Not with icon or status. Example: "arrow": true. | |
|
|
84
|
+
| text | Places authored text at a point through the label solver: on the point, or above, below, right or left of it. The text prints as written. | at, text | at: AnchorRef \| { categoryId, value } | | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. The text prints as written, ${value} included. It takes id and priority, and no other field. |
|
|
85
|
+
| line | Draws a straight line between two points or from a text annotation, in the ink and rule width of a bracket; a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the line in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the line starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
86
|
+
| arrow | Draws a straight arrow between two points or from a text annotation to a point, in the theme arrow look (`marks.arrow`); a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the shaft in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the arrow starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
87
|
+
| box | Draws an unfilled box with two points as opposite corners, wrapping whole category bands, in the ink and rule width of a bracket; text inside the box stays free. | from, to | from: AnchorRef \| { categoryId, value }; to: AnchorRef \| { categoryId, value } | dashed: boolean, default false. Draws the edges in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. from and to are opposite corners, the box has no fill, and text inside it stays free. A { categoryId, value } corner spans that category's whole band, so the box wraps whole bars, values and markers; from and to on one category wrap that category. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
84
88
|
|
|
85
89
|
## Sizing
|
|
86
90
|
|