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/react.md
CHANGED
|
@@ -243,7 +243,7 @@ Depth d shows the measures of the Total and of d − 1 member levels, in both va
|
|
|
243
243
|
| fallbackSize.height | number | | | Canvas height in the stated unit; at least 24 layout px after conversion. Omitted, height stays automatic. |
|
|
244
244
|
| fallbackSize.unit | string | `'px'`, `'pt'`, `'mm'` | | Dimension unit. Default px. One pt is 96/72 layout px; one mm is 96/25.4 layout px. |
|
|
245
245
|
|
|
246
|
-
`size="container"` measures the room the host gives after React attaches and lays the chart out in it. It never measures what it draws, so a heading or the data-table toggle beside the chart does not make it grow. `fallbackSize` is the frame of the server output, of hydration and of the first client render; without it the fallback is 720 × 405 px. A chart mounted on the client without `fallbackSize` draws the busy placeholder until its container reports a width, and is laid out once, at that width; a container that reports none within 100 ms gets the fallback. A zero-width parent keeps the last usable size, and a chart that was refused in a small parent draws again once the parent is wide enough. While the container is still changing size, a size refusal waits: the busy placeholder stands in, and no warning goes to `onWarnings` or `onRefused`, until the size holds still for 120 ms.
|
|
246
|
+
`size="container"` measures the room the host gives after React attaches and lays the chart out in it. It never measures what it draws, so a heading or the data-table toggle beside the chart does not make it grow. `fallbackSize` is the frame of the server output, of hydration and of the first client render; without it the fallback is 720 × 405 px. A chart mounted on the client without `fallbackSize` draws the busy placeholder until its container reports a width, and is laid out once, at that width; a container that reports none within 100 ms gets the fallback. A zero-width parent keeps the last usable size, and a chart that was refused in a small parent draws again once the parent is wide enough. While the container is still changing size, a size refusal waits: the busy placeholder stands in, and no warning goes to `onWarnings` or `onRefused`, until the size holds still for 120 ms and no newer size is still laying out.
|
|
247
247
|
|
|
248
248
|
A parent that takes its width from its content never grows the chart: it measures the chart's fallback width, and the chart lays out at the width the parent measured. This happens with a flex item that does not stretch: in a flex row without a width or `flex: 1`, in a flex column with `align-items: center` (a Next.js page that centres its content this way keeps the chart at its fallback width), with `margin: auto` and a `max-width` inside a flex parent, and with `display: inline-block` or `width: fit-content`. Give the parent its own width, for example `width: 100%` beside the `max-width`.
|
|
249
249
|
|
|
@@ -311,8 +311,8 @@ export function Dashboard() {
|
|
|
311
311
|
| 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). |
|
|
312
312
|
| locale.decimal | string | `'.'`, `','` | | Decimal mark of every number the chart prints. Default '.'. The language does not change it. |
|
|
313
313
|
| 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. |
|
|
314
|
-
| locale.minusGlyph | string | `'−'`, `'-'` | | Minus glyph
|
|
315
|
-
| locale.weekStartsOn | number | `0`, `1` | | First weekday for week
|
|
314
|
+
| 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. |
|
|
315
|
+
| 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. |
|
|
316
316
|
| motion | string | `'system'`, `'reduce'`, `'full'` | | Motion preference. Default system; charts remain static unless motion is enabled. |
|
|
317
317
|
| density | string | `'comfortable'`, `'compact'` | | Inherited density. Default comfortable preserves existing spacing. Compact scales pad and row-pitch tokens (labelPad, canvas margins, frame gaps, legendRowH) and maps to compact table density when the table has no explicit density. |
|
|
318
318
|
| strings | object | | | Inherited built-in wording. Authored labels remain unchanged. |
|
|
@@ -420,7 +420,7 @@ A dashboard selects `dashboard` once, at the provider, and keeps container sizin
|
|
|
420
420
|
|
|
421
421
|
A chart that does not use `size="container"` does not grow past its natural width. It can shrink with its parent, and `onWarnings` reports a shrink below its safe minimum.
|
|
422
422
|
|
|
423
|
-
`onWarnings(warnings)` receives the warnings of the layout. In the browser it also watches the width the chart shows at; more than half a CSS pixel below `geometry.presentation.minDisplayWidth` it adds one display finding, `observed-display-too-small`. It repeats only when the warning state changes. The observation does not change the geometry, the prepared result or the exported SVG.
|
|
423
|
+
`onWarnings(warnings)` receives the warnings of the layout. In the browser it also watches the width the chart shows at; more than half a CSS pixel below `geometry.presentation.minDisplayWidth` it adds one display finding, `observed-display-too-small`. A container chart is judged only at the width it was laid out for: shown at another width, its drawing stands in for the layout at that width. It repeats only when the warning state changes. The observation does not change the geometry, the prepared result or the exported SVG.
|
|
424
424
|
|
|
425
425
|
## Refusals
|
|
426
426
|
|
|
@@ -615,7 +615,7 @@ Without a chart that holds it, the handle exports the spec or request it gets, `
|
|
|
615
615
|
- SVG carries the page's web fonts that its text draws with, as `data:` font faces: only the families, weights, styles and `unicode-range` slices the text uses, so a file opened elsewhere keeps the face and its spacing. A loaded face whose file the page cannot read (a style sheet from another origin, a `FontFace` built in script) is named in a console warning and drawn in a fallback face. `embedFonts: false` writes the plain SVG. See [Export fonts](../manual.md#export-fonts).
|
|
616
616
|
- PNG rasterizes that SVG through the browser canvas, or through a `rasterizePng` function you pass, with the same font copies, since an SVG drawn as an image loads nothing from outside itself.
|
|
617
617
|
|
|
618
|
-
The nearest `BoardplotTheme` applies; `context` and `request` fields passed to the hook override it. The export keeps the resolved target and size; the file type does not select a target. To export at a size, set it in the spec: `options.size: { width }` lays the chart out at that width and its content height, `{ width, height }` at that frame. `request` takes a whole chart request, `type` and `data` included, such as a prepared chart's; the fields it names replace the spec's. A request or spec with `size: 'container'` and no chart that holds the handle exports at its `fallbackSize`, the frame the component draws before it measures, or 720 × 405 px without one. A chart whose notes print in the SVG needs more room than its notes button on screen: the export then grows taller at the same width, with the
|
|
618
|
+
The nearest `BoardplotTheme` applies; `context` and `request` fields passed to the hook override it. The export keeps the resolved target and size; the file type does not select a target. To export at a size, set it in the spec: `options.size: { width }` lays the chart out at that width and its content height, `{ width, height }` at that frame. `request` takes a whole chart request, `type` and `data` included, such as a prepared chart's; the fields it names replace the spec's. A request or spec with `size: 'container'` and no chart that holds the handle exports at its `fallbackSize`, the frame the component draws before it measures, or 720 × 405 px without one. A chart whose notes print in the SVG needs more room than its notes button on screen: the export then grows taller at the same width, with the warning `static-footer-grew`. An invalid request resolves to `code: 'invalid'` instead of rejecting. Clipboard permission is requested only by `copyImage` and `copyData`; `copyImage` starts the clipboard write before the PNG is painted, inside the click that called it, which Safari requires.
|
|
619
619
|
|
|
620
620
|
A complete download in TypeScript without the `exporter` link. The standalone exports take the provider settings from `useBoardplotTheme()`, and the card's width sets the file's width, so the file is laid out at the width the reader sees. `useExport({ spec })` does the same at the spec's own size, with the provider applied for you.
|
|
621
621
|
|
package/docs/reference/sankey.md
CHANGED
|
@@ -75,7 +75,7 @@ One form; its chart ID is `sankey`.
|
|
|
75
75
|
|
|
76
76
|
| Path | Type | Values | Default | Meaning |
|
|
77
77
|
|---|---|---|---|---|
|
|
78
|
-
| linkColor | string | `'source'`, `'target'` | | Which end's node colour a ribbon takes. Unset: every node and ribbon draws neutral, and a node with fill, colorRole or a highlight colours the ribbons it touches. 'source' shows where flows come from and 'target' where they go, each with one palette step per node; with a highlight, only the highlighted nodes keep a colour. Nodes that colour no link draw in the neutral mark colour. |
|
|
78
|
+
| linkColor | string | `'source'`, `'target'` | | Which end's node colour a ribbon takes. Unset: every node and ribbon draws neutral, and a node with fill, colorRole or a highlight colours the ribbons it touches. 'source' shows where flows come from and 'target' where they go, each with one palette step per node; with a highlight, only the highlighted nodes keep a colour. Nodes that colour no link draw in the neutral mark colour. Ribbons are translucent so crossings and node bars show through: on a light page the alpha rises from surface.ribbonAlpha (default 0.35) until a ribbon reaches the 1.4:1 mark floor; on a dark page it stays at surface.ribbonAlpha, under 3:1 against the page, and the node bars and values carry the flow. |
|
|
79
79
|
| order | string | `'flow'`, `'data'` | | 'flow' orders the nodes of each column for the fewest weighted ribbon crossings. 'data' keeps the order of data.nodes, then first seen in links. Default 'flow', and 'data' when stage-qualified ids repeat across stages, so segments keep one order every month. |
|
|
80
80
|
| other | false \| object | `false` (or another value of its type) | | Small nodes folded into one Other node per column, so a long tail stays readable; the note lists every folded node with its value. A column folds only when at least two nodes qualify. The Other node is as tall as its members together, so each column keeps its total. Default { share: 0.02 } without stages; off with stage-qualified links, where an object folds an id in every stage or in none. false keeps every node. |
|
|
81
81
|
| other.share | number | | | Fold nodes under this share of their column's total; default 0.02. |
|
|
@@ -85,7 +85,7 @@ One form; its chart ID is `sankey`.
|
|
|
85
85
|
| columnOverrides.*.width | number | | | Track width in px. It beats the width the type would pick. |
|
|
86
86
|
| linkValue | string | `'none'`, `'large'` | `'large'` | Flow values on the ribbons: 'large' (default) prints the value of every ribbon at least one line high at its arriving end, right aligned to the next bar; thinner ribbons print nothing, and a value that would cover a node label is left out. 'none' prints node values only. |
|
|
87
87
|
|
|
88
|
-
Plus the [shared options](options.md). This type does not accept `detailFields`, `labels`, `valueAxis`, `story`, `hatchStrength`, `rounding`, `annotations`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `sort`, `topN`, `bandFraction`, `legend`, `valueAxis.show`, `valueAxis.gridlines` with an `option-ignored` warning.
|
|
88
|
+
Plus the [shared options](options.md). This type does not accept `detailFields`, `labels`, `labelPosition`, `valueAxis`, `story`, `hatchStrength`, `rounding`, `annotations`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `sort`, `topN`, `bandFraction`, `legend`, `valueAxis.show`, `valueAxis.gridlines` with an `option-ignored` warning.
|
|
89
89
|
|
|
90
90
|
## Annotations
|
|
91
91
|
|
|
@@ -144,7 +144,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
144
144
|
| qualitativeAxes | boolean | | | Axes that read as directions, not scales: no tick numbers and no gridlines; each axis prints strings.axisLow ('Lower') and strings.axisHigh ('Higher') at its ends and its title in bold between two arrows, the y axis in a column left of the plot. Needs axisTitles. Positions keep their numeric scale. |
|
|
145
145
|
| methodNote | boolean | | | Default false. true adds the method footnotes: axes that do not start at zero, and for quadrants the cut points with their source, the tie rule, the shading, units on a cut point, empty boxes and a divider that falls outside the range. Clipped and dropped points are required for interpretation and print regardless. |
|
|
146
146
|
|
|
147
|
-
Plus the [shared options](options.md). This type does not accept `detailFields`, `valueAxis.break`, `hatchStrength`, `rounding`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `sort`, `topN`, `bandFraction` with an `option-ignored` warning.
|
|
147
|
+
Plus the [shared options](options.md). This type does not accept `detailFields`, `labelPosition`, `valueAxis.break`, `hatchStrength`, `rounding`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `sort`, `topN`, `bandFraction` with an `option-ignored` warning.
|
|
148
148
|
|
|
149
149
|
## Annotations
|
|
150
150
|
|
|
@@ -152,12 +152,16 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
152
152
|
|
|
153
153
|
| Kind | Purpose | Required | Anchors | Optional fields | Notes |
|
|
154
154
|
|---|---|---|---|---|---|
|
|
155
|
-
| 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. |
|
|
156
|
-
| 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 |
|
|
155
|
+
| 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. |
|
|
156
|
+
| 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. | |
|
|
157
157
|
| abs | Reads the anchored data value and places its formatted absolute value in a collision-managed label. | at | at: AnchorRef | | |
|
|
158
158
|
| note | Places authored text at an anchored data element through collision avoidance, with an optional icon or status chip. | at, text | at: AnchorRef | | |
|
|
159
|
-
| 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.
|
|
159
|
+
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false. An arrow from the text to the anchored point, in the arrow standard of theme marks.arrow: the text stands far enough out for a 24 px shaft, level with the point right or left of it, or over or under it, where there is room. With no such seat it draws without the arrow and warns callout-arrow-no-room. Not with icon or status. Example: "arrow": true. | |
|
|
160
160
|
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. side: left \| right, default right. Side of the plot the label sits on. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
161
|
+
| text | Places authored text at a point through the label solver: on the point, or above, below, right or left of it. The text prints as written. | at, text | at: AnchorRef \| { categoryId, value } | | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. The text prints as written, ${value} included. It takes id and priority, and no other field. |
|
|
162
|
+
| line | Draws a straight line between two points or from a text annotation, in the ink and rule width of a bracket; a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the line in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the line starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
163
|
+
| 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. |
|
|
164
|
+
| 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. |
|
|
161
165
|
|
|
162
166
|
## Sizing
|
|
163
167
|
|
package/docs/reference/slope.md
CHANGED
|
@@ -83,7 +83,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
83
83
|
| columnOverrides.*.headAlign | string | `'left'`, `'right'`, `'center'` | | Head alignment; defaults to align. |
|
|
84
84
|
| columnOverrides.*.label | string | | | Head text. |
|
|
85
85
|
|
|
86
|
-
Plus the [shared options](options.md). This type does not accept `valueAxis.tickStep`, `valueAxis.includeZero`, `valueAxis.percent`, `valueAxis.log`, `valueAxis.reverse`, `valueAxis.break`, `rounding`, `seriesLabels`, `valueLabels`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `sort`, `topN`, `bandFraction`, `valueAxis.show`, `valueAxis.gridlines`, `legend: 'none'`, `legend: 'auto'` with an `option-ignored` warning.
|
|
86
|
+
Plus the [shared options](options.md). This type does not accept `labelPosition`, `valueAxis.tickStep`, `valueAxis.includeZero`, `valueAxis.percent`, `valueAxis.log`, `valueAxis.reverse`, `valueAxis.break`, `rounding`, `seriesLabels`, `valueLabels`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `sort`, `topN`, `bandFraction`, `valueAxis.show`, `valueAxis.gridlines`, `legend: 'none'`, `legend: 'auto'` with an `option-ignored` warning.
|
|
87
87
|
|
|
88
88
|
## Annotations
|
|
89
89
|
|
|
@@ -91,13 +91,17 @@ An annotation anchor is a category or item id string, or an object with category
|
|
|
91
91
|
|
|
92
92
|
| Kind | Purpose | Required | Anchors | Optional fields | Notes |
|
|
93
93
|
|---|---|---|---|---|---|
|
|
94
|
-
| 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
|
|
95
|
-
| 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. |
|
|
96
|
-
| 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 |
|
|
94
|
+
| 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. |
|
|
95
|
+
| 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. |
|
|
96
|
+
| 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. | |
|
|
97
97
|
| abs | Reads the anchored data value and places its formatted absolute value in a collision-managed label. | at | at: AnchorRef | | |
|
|
98
98
|
| note | Places authored text at an anchored data element through collision avoidance, with an optional icon or status chip. | at, text | at: AnchorRef | | |
|
|
99
|
-
| 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.
|
|
99
|
+
| callout | Places authored free text at an anchored data element, routing a leader when displaced and honoring the preferred side. | at, text | at: AnchorRef | preferSide: left \| right \| above \| below. Side the solver tries first; the label keeps a leader when it moves. headline: string. A bold first line over the text, which then prints in plain type; ${value} in it prints the anchored value from the data. Example: "headline": "${value}", "text": "Peak in handheld-loom demand" prints 153 in bold over the words. arrow: boolean, default false. An arrow from the text to the anchored point, in the arrow standard of theme marks.arrow: the text stands far enough out for a 24 px shaft, level with the point right or left of it, or over or under it, where there is room. With no such seat it draws without the arrow and warns callout-arrow-no-room. Not with icon or status. Example: "arrow": true. | |
|
|
100
100
|
| valueLine | Draws a reference line at an authored value or an engine-computed mean, with optional tolerance shading and attainment fill between the line and resolved actuals. | | from: categoryId (optional); to: categoryId (optional) | value: number \| 'mean', default mean. A number draws the line there; mean has the engine compute it. valueKind: 'fraction'. Multiply a numeric value and its tolerance by 100 before layout: 0.35 draws at 35%. Independent of data.valueKind. Omit it for values already in percent points; not valid with mean. label: string \| false. Name plus value; ${value} sets its position. A number already in the name is kept once. false hides it. tolerance: number \| { low, high }. A number shades that distance on both sides of the line; low and high shade an authored corridor. | No anchor is required. Value defaults to mean. Scoped means are line-only: seriesId and paired from/to compute a primary-axis mean and limit its stroke to those bands; other types refuse scope fields for a mean. Numeric values cannot use scope fields except as a category clip with tolerance or attainment. A secondary-axis line needs an acknowledged secondary scale and an explicit numeric value. Optional tolerance shades a value-axis band; optional attainment fills between the line and resolved actuals. |
|
|
101
|
+
| text | Places authored text at a point through the label solver: on the point, or above, below, right or left of it. The text prints as written. | at, text | at: AnchorRef \| { categoryId, value } | | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. The text prints as written, ${value} included. It takes id and priority, and no other field. |
|
|
102
|
+
| line | Draws a straight line between two points or from a text annotation, in the ink and rule width of a bracket; a stretch that would cross text is cut. | from, to | from: AnchorRef \| { categoryId, value } \| { annotationId }; to: AnchorRef \| { categoryId, value } \| { annotationId } | dashed: boolean, default false. Draws the line in the dash of a reference line. | A point is an anchor or { categoryId, value } with value in axis units. A value outside the plot, a chart with no value scale or an anchor that does not resolve warns bad-anchor and draws nothing; the axis does not grow. An end { annotationId } names a text annotation: the line starts or ends at the nearest edge of that text, at every size, and is not drawn when the text is not. A { categoryId, value } end stands on the category's centre. A stretch that would cross text is cut and warns draw-crosses-text. It takes dashed and id, and no other field. |
|
|
103
|
+
| 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. |
|
|
104
|
+
| 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. |
|
|
101
105
|
|
|
102
106
|
## Sizing
|
|
103
107
|
|
|
@@ -45,7 +45,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
45
45
|
| reference | number | | | A 1 px dashed line at this value in the muted ink. The scale always includes it. On a framed sparkline with valueLabel 'last' its value prints in the column of the last value, muted. |
|
|
46
46
|
| ringTone | string | `'good'`, `'warn'`, `'bad'` | | Paints the end ring in this tone instead of the highlight. Refused with ring 'none'. |
|
|
47
47
|
|
|
48
|
-
Plus the [shared options](options.md). This type does not accept `detailFields`, `labels`, `valueAxis`, `story`, `hatchStrength`, `rounding`, `annotations`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `sort`, `topN`, `bandFraction`, `legend`, `valueAxis.show`, `valueAxis.gridlines` with an `option-ignored` warning.
|
|
48
|
+
Plus the [shared options](options.md). This type does not accept `detailFields`, `labels`, `labelPosition`, `valueAxis`, `story`, `hatchStrength`, `rounding`, `annotations`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `sort`, `topN`, `bandFraction`, `legend`, `valueAxis.show`, `valueAxis.gridlines` with an `option-ignored` warning.
|
|
49
49
|
|
|
50
50
|
## Annotations
|
|
51
51
|
|
package/docs/reference/status.md
CHANGED
|
@@ -79,7 +79,7 @@ A `cell` is a number, null or a value object; see [Value cell](options.md#value-
|
|
|
79
79
|
| columnOverrides.*.headAlign | string | `'left'`, `'right'`, `'center'` | | Head alignment; defaults to align. |
|
|
80
80
|
| columnOverrides.*.label | string | | | Head text. |
|
|
81
81
|
|
|
82
|
-
Plus the [shared options](options.md). This type does not accept `detailFields`, `valueAxis`, `rounding`, `annotations`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `sort`, `topN`, `bandFraction`, `valueAxis.show`, `valueAxis.gridlines` with an `option-ignored` warning.
|
|
82
|
+
Plus the [shared options](options.md). This type does not accept `detailFields`, `labelPosition`, `valueAxis`, `rounding`, `annotations`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `sort`, `topN`, `bandFraction`, `valueAxis.show`, `valueAxis.gridlines` with an `option-ignored` warning.
|
|
83
83
|
|
|
84
84
|
## Annotations
|
|
85
85
|
|
package/docs/reference/table.md
CHANGED
|
@@ -58,49 +58,29 @@ Consulting-grade table: hierarchy with honest totals (derive/validate/source), t
|
|
|
58
58
|
| columnToggles[].columns | array | yes | Columns toggled within one header group. |
|
|
59
59
|
| columnToggles[].defaultVisible | boolean | | Visible before options.columnVisibility; defaults false. |
|
|
60
60
|
| columns | array | yes | Display order; exactly one rowLabel column. Width, alignment, label and order of a column are authored here, so table takes no columnOverrides or columnOrder. |
|
|
61
|
-
| columns[].id (columns[] branch 1) | string | yes | Nonempty reference id. |
|
|
62
|
-
| columns[].label (columns[] branch 1) | string | | Visible name; defaults to id. |
|
|
63
|
-
| columns[].subLabel (columns[] branch 1) | string | | Second header line. At the micro step in muted ink: a weekday under a date, an ISO week under a week start. Primary labels keep one baseline. |
|
|
64
|
-
| columns[].width (columns[] branch 1) | number | | Width in px. React keeps it and scrolls. SVG narrows authored tracks only when the fixed frame needs it, with table-overflow and a wider-size fix. Value and computed tracks widen for figures, and a row-label track for its labels up to 180 px (table-column-widened). Other content may cut (table-column-clipped); remove width for automatic content sizing. |
|
|
65
|
-
| columns[].align (columns[] branch 1) | string | | Cell alignment. Numeric left alignment is accepted but linted. One of `'left'`, `'right'`, `'center'`. |
|
|
66
|
-
| columns[].headAlign (columns[] branch 1) | string | | Head alignment; defaults to align. One of `'left'`, `'right'`, `'center'`. |
|
|
67
|
-
| columns[].emphasis (columns[] branch 1) | string | | Header and cell emphasis. 'strong' sets the header and its cells to the emphasis weight (700 by default), 'muted' paints them in the muted ink. A strong column is measured in the bold weight; muted is paint only. One of `'strong'`, `'muted'`. |
|
|
68
|
-
| columns[].band (columns[] branch 1) | boolean | | Column band ground. Neighbouring banded columns read as one block and the first of the run takes the left hairline, so a block inside a column group needs no group of its own. Paint only. |
|
|
69
|
-
| columns[].fitFormat (columns[] branch 1) | false | | false: options.fitFormats leaves this column's format as authored. One of `false`. |
|
|
70
|
-
| columns[].noteLine (columns[] branch 1) | boolean | | Notes below figures. They use the inline step in muted ink. Default false keeps the note inline after the figure, where a 90 px block track cuts it off; a steering block column says sum under its year-to-date figure. The note takes the first line slot whose change line holds no value in that cell, and where every line holds one, or the row prints none, the row grows by one inline line. |
|
|
61
|
+
| columns[].id (columns[] branch 1 \| columns[] branch 2 \| columns[] branch 3 \| columns[] branch 4 \| columns[] branch 5 \| columns[] branch 6 \| columns[] branch 7) | string | yes | Nonempty reference id. |
|
|
62
|
+
| columns[].label (columns[] branch 1 \| columns[] branch 2 \| columns[] branch 3 \| columns[] branch 4 \| columns[] branch 5 \| columns[] branch 6 \| columns[] branch 7) | string | | Visible name; defaults to id. |
|
|
63
|
+
| columns[].subLabel (columns[] branch 1 \| columns[] branch 2 \| columns[] branch 3 \| columns[] branch 4 \| columns[] branch 5 \| columns[] branch 6 \| columns[] branch 7) | string | | Second header line. At the micro step in muted ink: a weekday under a date, an ISO week under a week start. Primary labels keep one baseline. |
|
|
64
|
+
| columns[].width (columns[] branch 1 \| columns[] branch 2 \| columns[] branch 3 \| columns[] branch 4 \| columns[] branch 5 \| columns[] branch 6 \| columns[] branch 7) | number | | Width in px. React keeps it and scrolls. SVG narrows authored tracks only when the fixed frame needs it, with table-overflow and a wider-size fix. Value and computed tracks widen for figures, and a row-label track for its labels up to 180 px (table-column-widened). Other content may cut (table-column-clipped); remove width for automatic content sizing. |
|
|
65
|
+
| columns[].align (columns[] branch 1 \| columns[] branch 2 \| columns[] branch 3 \| columns[] branch 4 \| columns[] branch 5 \| columns[] branch 6 \| columns[] branch 7) | string | | Cell alignment. Numeric left alignment is accepted but linted. One of `'left'`, `'right'`, `'center'`. |
|
|
66
|
+
| columns[].headAlign (columns[] branch 1 \| columns[] branch 2 \| columns[] branch 3 \| columns[] branch 4 \| columns[] branch 5 \| columns[] branch 6 \| columns[] branch 7) | string | | Head alignment; defaults to align. One of `'left'`, `'right'`, `'center'`. |
|
|
67
|
+
| columns[].emphasis (columns[] branch 1 \| columns[] branch 2 \| columns[] branch 3 \| columns[] branch 4 \| columns[] branch 5 \| columns[] branch 6 \| columns[] branch 7) | string | | Header and cell emphasis. 'strong' sets the header and its cells to the emphasis weight (700 by default), 'muted' paints them in the muted ink. A strong column is measured in the bold weight; muted is paint only. One of `'strong'`, `'muted'`. |
|
|
68
|
+
| columns[].band (columns[] branch 1 \| columns[] branch 2 \| columns[] branch 3 \| columns[] branch 4 \| columns[] branch 5 \| columns[] branch 6 \| columns[] branch 7) | boolean | | Column band ground. Neighbouring banded columns read as one block and the first of the run takes the left hairline, so a block inside a column group needs no group of its own. Paint only. |
|
|
69
|
+
| columns[].fitFormat (columns[] branch 1 \| columns[] branch 2 \| columns[] branch 3 \| columns[] branch 4 \| columns[] branch 5 \| columns[] branch 6 \| columns[] branch 7) | false | | false: options.fitFormats leaves this column's format as authored. One of `false`. |
|
|
70
|
+
| columns[].noteLine (columns[] branch 1 \| columns[] branch 2 \| columns[] branch 3 \| columns[] branch 4 \| columns[] branch 5 \| columns[] branch 6 \| columns[] branch 7) | boolean | | Notes below figures. They use the inline step in muted ink. Default false keeps the note inline after the figure, where a 90 px block track cuts it off; a steering block column says sum under its year-to-date figure. The note takes the first line slot whose change line holds no value in that cell, and where every line holds one, or the row prints none, the row grows by one inline line. |
|
|
71
71
|
| columns[].kind (columns[] branch 1) | string | yes | Kind. One of `'rowLabel'`. |
|
|
72
72
|
| columns[].maxWidth (columns[] branch 1) | number | | Label width cap in px. Includes indent and affix; explicit width wins. |
|
|
73
73
|
| columns[].maxTextWidth (columns[] branch 1) | number | | Caps how much the label text adds to the column width, in px. The indent, the unit affix and the collapsed hint come on top of it. It is not a hard cap: when the header or another row makes the column wider, labels use that room. Ignored when width is set; maxWidth still caps the whole track. |
|
|
74
|
-
| columns[].id (columns[] branch 2) | string | yes | Nonempty reference id. |
|
|
75
|
-
| columns[].label (columns[] branch 2) | string | | Visible name; defaults to id. |
|
|
76
|
-
| columns[].subLabel (columns[] branch 2) | string | | Second header line. At the micro step in muted ink: a weekday under a date, an ISO week under a week start. Primary labels keep one baseline. |
|
|
77
|
-
| columns[].width (columns[] branch 2) | number | | Width in px. React keeps it and scrolls. SVG narrows authored tracks only when the fixed frame needs it, with table-overflow and a wider-size fix. Value and computed tracks widen for figures, and a row-label track for its labels up to 180 px (table-column-widened). Other content may cut (table-column-clipped); remove width for automatic content sizing. |
|
|
78
|
-
| columns[].align (columns[] branch 2) | string | | Cell alignment. Numeric left alignment is accepted but linted. One of `'left'`, `'right'`, `'center'`. |
|
|
79
|
-
| columns[].headAlign (columns[] branch 2) | string | | Head alignment; defaults to align. One of `'left'`, `'right'`, `'center'`. |
|
|
80
|
-
| columns[].emphasis (columns[] branch 2) | string | | Header and cell emphasis. 'strong' sets the header and its cells to the emphasis weight (700 by default), 'muted' paints them in the muted ink. A strong column is measured in the bold weight; muted is paint only. One of `'strong'`, `'muted'`. |
|
|
81
|
-
| columns[].band (columns[] branch 2) | boolean | | Column band ground. Neighbouring banded columns read as one block and the first of the run takes the left hairline, so a block inside a column group needs no group of its own. Paint only. |
|
|
82
|
-
| columns[].fitFormat (columns[] branch 2) | false | | false: options.fitFormats leaves this column's format as authored. One of `false`. |
|
|
83
|
-
| columns[].noteLine (columns[] branch 2) | boolean | | Notes below figures. They use the inline step in muted ink. Default false keeps the note inline after the figure, where a 90 px block track cuts it off; a steering block column says sum under its year-to-date figure. The note takes the first line slot whose change line holds no value in that cell, and where every line holds one, or the row prints none, the row grows by one inline line. |
|
|
84
74
|
| columns[].kind (columns[] branch 2) | string | yes | Kind. One of `'value'`. |
|
|
85
|
-
| columns[].format (columns[] branch 2) | string | | Number format example. Examples: '€1.2m', '1,234', '+1.2%', '1.2pp', '$1.2bn', '(1.0)'. A magnitude after the number divides the raw value: k, thousand, Tsd., Tausend (10³); m, M, mn, mm, million(s), Mio., Million(en) (10⁶); b, B, bn, billion(s), Mrd., Milliarde(n), milliard(s) (10⁹); tn, trillion(s), Bio., Billionen (10¹²). The letters k, m, M, mm, b, B and T scale when glued to the number or spaced beside a currency ('$1.2 k'); '12 m/s' and '50 B' keep their unit. A scale inside a currency affix ('USDm 1.2', '1.2 €m') holds that divisor. A value of 1000 or more in a free scale rolls up and one that would print as 0 rolls down, in the example's spelling; a German or French chart prints its own words (Mrd., Bio.; Md, Bn). A unit alone ('$M', '€bn', '%', 'x') picks precision from the data. Spreadsheet number codes translate to examples with warning format-spreadsheet-code; percent values stay percent points. Direction glyphs (▲/▼, ↑/↓) at the start or end of the example carry a sign. A glyph inside the prefix or unit stays literal text. ± carries a sign. A trailing minus marks negatives, '1st' prints English ordinals, and '1.2E+06' prints scientific notation. With no digit, one run of 1–15 @ fixes significant figures: '$@@@M' prints 4,270,000 as $4.27M. A table holds an authored magnitude: under '$1.2k', 2,496,000 prints as 2,496.0 thousand, not as $2.5M. Percent values are authored in POINTS: 6.2 with format '1.2%' renders '6.2%'. A difference of two percent levels uses 'pp', not '%'. A separator followed by exactly three digits after a nonzero integer part is a thousands mark: '1.000' groups thousands with a dot and prints decimals with a comma; write '0.000' for three decimals. The format's unit, $M for '$1.2m', prints once beside subtitle.measure when every value column shares it; without a measure, or with mixed units, each value head carries it, as 'Q1 ($M)'. unitShown true drops it from the heads too. |
|
|
75
|
+
| columns[].format (columns[] branch 2 \| columns[] branch 3) | string | | Number format example. Examples: '€1.2m', '1,234', '+1.2%', '1.2pp', '$1.2bn', '(1.0)'. A magnitude after the number divides the raw value: k, thousand, Tsd., Tausend (10³); m, M, mn, mm, million(s), Mio., Million(en) (10⁶); b, B, bn, billion(s), Mrd., Milliarde(n), milliard(s) (10⁹); tn, trillion(s), Bio., Billionen (10¹²). The letters k, m, M, mm, b, B and T scale when glued to the number or spaced beside a currency ('$1.2 k'); '12 m/s' and '50 B' keep their unit. A scale inside a currency affix ('USDm 1.2', '1.2 €m') holds that divisor. A value of 1000 or more in a free scale rolls up and one that would print as 0 rolls down, in the example's spelling; a German or French chart prints its own words (Mrd., Bio.; Md, Bn). A unit alone ('$M', '€bn', '%', 'x') picks precision from the data. Spreadsheet number codes translate to examples with warning format-spreadsheet-code; percent values stay percent points. Direction glyphs (▲/▼, ↑/↓) at the start or end of the example carry a sign. A glyph inside the prefix or unit stays literal text. ± carries a sign. A trailing minus marks negatives, '1st' prints English ordinals, and '1.2E+06' prints scientific notation. With no digit, one run of 1–15 @ fixes significant figures: '$@@@M' prints 4,270,000 as $4.27M. A table holds an authored magnitude: under '$1.2k', 2,496,000 prints as 2,496.0 thousand, not as $2.5M. Percent values are authored in POINTS: 6.2 with format '1.2%' renders '6.2%'. A difference of two percent levels uses 'pp', not '%'. A separator followed by exactly three digits after a nonzero integer part is a thousands mark: '1.000' groups thousands with a dot and prints decimals with a comma; write '0.000' for three decimals. The format's unit, $M for '$1.2m', prints once beside subtitle.measure when every value column shares it; without a measure, or with mixed units, each value head carries it, as 'Q1 ($M)'. unitShown true drops it from the heads too. |
|
|
86
76
|
| columns[].scenario (columns[] branch 2) | string | | Header scenario: AC, PY, PL or FC. LY means PY (last year); codes accept any case. One of `'AC'`, `'PY'`, `'PL'`, `'FC'`. |
|
|
87
|
-
| columns[].polarity (columns[] branch 2) | string | | Which sign is favorable. Judgment tones and directional encodings read it. One of `'higherIsBetter'`, `'lowerIsBetter'`. |
|
|
88
|
-
| columns[].materiality (columns[] branch 2) | object | | Mute tones below this threshold; keep values visible. |
|
|
89
|
-
| columns[].materiality.pct (columns[] branch 2) | number | | Percent-column threshold in points. |
|
|
90
|
-
| columns[].materiality.abs (columns[] branch 2) | number | | Other numeric threshold in source units. |
|
|
77
|
+
| columns[].polarity (columns[] branch 2 \| columns[] branch 3) | string | | Which sign is favorable. Judgment tones and directional encodings read it. One of `'higherIsBetter'`, `'lowerIsBetter'`. |
|
|
78
|
+
| columns[].materiality (columns[] branch 2 \| columns[] branch 3) | object | | Mute tones where the printed figure is below this threshold; keep values visible. |
|
|
79
|
+
| columns[].materiality.pct (columns[] branch 2 \| columns[] branch 3) | number | | Percent-column threshold in points. |
|
|
80
|
+
| columns[].materiality.abs (columns[] branch 2 \| columns[] branch 3) | number | | Other numeric threshold in source units. |
|
|
91
81
|
| columns[].aggregate (columns[] branch 2) | string | | Parent-row aggregation. Default 'sum' over additive children; 'none' where the column format is a percentage, percentage points or a multiple, or the summand rows carry different units (decimals do not count), since those do not add. An explicit 'sum' there warns aggregate-non-additive. One of `'sum'`, `'none'`, `'source'`. |
|
|
92
82
|
| columns[].nulls (columns[] branch 2) | string | | Default 'propagate'. A missing child then makes the parent '—', with no silent partial sums; 'skip' sums the present values and auto-footnotes 'partial'. One of `'propagate'`, `'skip'`. |
|
|
93
83
|
| columns[].percentScale (columns[] branch 2) | string | | Values already in points; percent-scale-suspect stays quiet. One of `'points'`. |
|
|
94
|
-
| columns[].id (columns[] branch 3) | string | yes | Nonempty reference id. |
|
|
95
|
-
| columns[].label (columns[] branch 3) | string | | Visible name; defaults to id. |
|
|
96
|
-
| columns[].subLabel (columns[] branch 3) | string | | Second header line. At the micro step in muted ink: a weekday under a date, an ISO week under a week start. Primary labels keep one baseline. |
|
|
97
|
-
| columns[].width (columns[] branch 3) | number | | Width in px. React keeps it and scrolls. SVG narrows authored tracks only when the fixed frame needs it, with table-overflow and a wider-size fix. Value and computed tracks widen for figures, and a row-label track for its labels up to 180 px (table-column-widened). Other content may cut (table-column-clipped); remove width for automatic content sizing. |
|
|
98
|
-
| columns[].align (columns[] branch 3) | string | | Cell alignment. Numeric left alignment is accepted but linted. One of `'left'`, `'right'`, `'center'`. |
|
|
99
|
-
| columns[].headAlign (columns[] branch 3) | string | | Head alignment; defaults to align. One of `'left'`, `'right'`, `'center'`. |
|
|
100
|
-
| columns[].emphasis (columns[] branch 3) | string | | Header and cell emphasis. 'strong' sets the header and its cells to the emphasis weight (700 by default), 'muted' paints them in the muted ink. A strong column is measured in the bold weight; muted is paint only. One of `'strong'`, `'muted'`. |
|
|
101
|
-
| columns[].band (columns[] branch 3) | boolean | | Column band ground. Neighbouring banded columns read as one block and the first of the run takes the left hairline, so a block inside a column group needs no group of its own. Paint only. |
|
|
102
|
-
| columns[].fitFormat (columns[] branch 3) | false | | false: options.fitFormats leaves this column's format as authored. One of `false`. |
|
|
103
|
-
| columns[].noteLine (columns[] branch 3) | boolean | | Notes below figures. They use the inline step in muted ink. Default false keeps the note inline after the figure, where a 90 px block track cuts it off; a steering block column says sum under its year-to-date figure. The note takes the first line slot whose change line holds no value in that cell, and where every line holds one, or the row prints none, the row grows by one inline line. |
|
|
104
84
|
| columns[].kind (columns[] branch 3) | string | yes | Kind. One of `'computed'`. |
|
|
105
85
|
| columns[].calc (columns[] branch 3) | object | yes | Calculation over value-column ids. A { row } or { row, previous: true } ref is refused (row-ref-in-column-calc): put cross-row refs in rows[].calc. |
|
|
106
86
|
| columns[].calc.ref (columns[] branch 3; columns[].calc branch 1) | string \| object | yes | Cell ref: column id or { row, col?, previous? }. |
|
|
@@ -114,80 +94,27 @@ Consulting-grade table: hierarchy with honest totals (derive/validate/source), t
|
|
|
114
94
|
| columns[].calc.op (columns[] branch 3; columns[].calc branch 4) | string | yes | Absolute value. One of `'abs'`. |
|
|
115
95
|
| columns[].calc.of (columns[] branch 3; columns[].calc branch 4) | object | yes | Cell or expression. |
|
|
116
96
|
| columns[].calc.op (columns[] branch 3; columns[].calc branch 5) | string | yes | a minus b. One of `'delta'`. |
|
|
117
|
-
| columns[].calc.a (columns[] branch 3; columns[].calc branch 5) | string \| object | yes | Current cell. |
|
|
118
|
-
| columns[].calc.a.row (columns[] branch 3; columns[].calc branch 5) | string | yes | Row id. |
|
|
119
|
-
| columns[].calc.a.col (columns[] branch 3; columns[].calc branch 5) | string | | Column id. Omitted means the column being evaluated. |
|
|
120
|
-
| columns[].calc.a.previous (columns[] branch 3; columns[].calc branch 5) | true | | Prior member in this group. The first member is n/a. One of `true`. |
|
|
121
|
-
| columns[].calc.b (columns[] branch 3; columns[].calc branch 5) | string \| object | yes | Reference cell. |
|
|
122
|
-
| columns[].calc.b.row (columns[] branch 3; columns[].calc branch 5) | string | yes | Row id. |
|
|
123
|
-
| columns[].calc.b.col (columns[] branch 3; columns[].calc branch 5) | string | | Column id. Omitted means the column being evaluated. |
|
|
124
|
-
| columns[].calc.b.previous (columns[] branch 3; columns[].calc branch 5) | true | | Prior member in this group. The first member is n/a. One of `true`. |
|
|
97
|
+
| columns[].calc.a (columns[] branch 3; columns[].calc branch 5 \| columns[] branch 3; columns[].calc branch 6) | string \| object | yes | Current cell. |
|
|
98
|
+
| columns[].calc.a.row (columns[] branch 3; columns[].calc branch 5 \| columns[] branch 3; columns[].calc branch 6) | string | yes | Row id. |
|
|
99
|
+
| columns[].calc.a.col (columns[] branch 3; columns[].calc branch 5 \| columns[] branch 3; columns[].calc branch 6) | string | | Column id. Omitted means the column being evaluated. |
|
|
100
|
+
| columns[].calc.a.previous (columns[] branch 3; columns[].calc branch 5 \| columns[] branch 3; columns[].calc branch 6) | true | | Prior member in this group. The first member is n/a. One of `true`. |
|
|
101
|
+
| columns[].calc.b (columns[] branch 3; columns[].calc branch 5 \| columns[] branch 3; columns[].calc branch 6) | string \| object | yes | Reference cell. |
|
|
102
|
+
| columns[].calc.b.row (columns[] branch 3; columns[].calc branch 5 \| columns[] branch 3; columns[].calc branch 6) | string | yes | Row id. |
|
|
103
|
+
| columns[].calc.b.col (columns[] branch 3; columns[].calc branch 5 \| columns[] branch 3; columns[].calc branch 6) | string | | Column id. Omitted means the column being evaluated. |
|
|
104
|
+
| columns[].calc.b.previous (columns[] branch 3; columns[].calc branch 5 \| columns[] branch 3; columns[].calc branch 6) | true | | Prior member in this group. The first member is n/a. One of `true`. |
|
|
125
105
|
| columns[].calc.op (columns[] branch 3; columns[].calc branch 6) | string | yes | 100*(a-b)/b relative change; n.m. when b is zero or negative, n/a when a and b are both zero. One of `'percentDelta'`. |
|
|
126
|
-
| columns[].calc.a (columns[] branch 3; columns[].calc branch 6) | string \| object | yes | Current cell. |
|
|
127
|
-
| columns[].calc.a.row (columns[] branch 3; columns[].calc branch 6) | string | yes | Row id. |
|
|
128
|
-
| columns[].calc.a.col (columns[] branch 3; columns[].calc branch 6) | string | | Column id. Omitted means the column being evaluated. |
|
|
129
|
-
| columns[].calc.a.previous (columns[] branch 3; columns[].calc branch 6) | true | | Prior member in this group. The first member is n/a. One of `true`. |
|
|
130
|
-
| columns[].calc.b (columns[] branch 3; columns[].calc branch 6) | string \| object | yes | Reference cell. |
|
|
131
|
-
| columns[].calc.b.row (columns[] branch 3; columns[].calc branch 6) | string | yes | Row id. |
|
|
132
|
-
| columns[].calc.b.col (columns[] branch 3; columns[].calc branch 6) | string | | Column id. Omitted means the column being evaluated. |
|
|
133
|
-
| columns[].calc.b.previous (columns[] branch 3; columns[].calc branch 6) | true | | Prior member in this group. The first member is n/a. One of `true`. |
|
|
134
106
|
| columns[].calc.op (columns[] branch 3; columns[].calc branch 7) | string | yes | Share of column leaf total. One of `'share'`. |
|
|
135
107
|
| columns[].calc.of (columns[] branch 3; columns[].calc branch 7) | string \| object | yes | Share denominator cell. |
|
|
136
108
|
| columns[].calc.of.row (columns[] branch 3; columns[].calc branch 7) | string | yes | Row id. |
|
|
137
109
|
| columns[].calc.of.col (columns[] branch 3; columns[].calc branch 7) | string | | Column id. Omitted means the column being evaluated. |
|
|
138
110
|
| columns[].calc.of.previous (columns[] branch 3; columns[].calc branch 7) | true | | Prior member in this group. The first member is n/a. One of `true`. |
|
|
139
|
-
| columns[].format (columns[] branch 3) | string | | Number format example. Examples: '€1.2m', '1,234', '+1.2%', '1.2pp', '$1.2bn', '(1.0)'. A magnitude after the number divides the raw value: k, thousand, Tsd., Tausend (10³); m, M, mn, mm, million(s), Mio., Million(en) (10⁶); b, B, bn, billion(s), Mrd., Milliarde(n), milliard(s) (10⁹); tn, trillion(s), Bio., Billionen (10¹²). The letters k, m, M, mm, b, B and T scale when glued to the number or spaced beside a currency ('$1.2 k'); '12 m/s' and '50 B' keep their unit. A scale inside a currency affix ('USDm 1.2', '1.2 €m') holds that divisor. A value of 1000 or more in a free scale rolls up and one that would print as 0 rolls down, in the example's spelling; a German or French chart prints its own words (Mrd., Bio.; Md, Bn). A unit alone ('$M', '€bn', '%', 'x') picks precision from the data. Spreadsheet number codes translate to examples with warning format-spreadsheet-code; percent values stay percent points. Direction glyphs (▲/▼, ↑/↓) at the start or end of the example carry a sign. A glyph inside the prefix or unit stays literal text. ± carries a sign. A trailing minus marks negatives, '1st' prints English ordinals, and '1.2E+06' prints scientific notation. With no digit, one run of 1–15 @ fixes significant figures: '$@@@M' prints 4,270,000 as $4.27M. A table holds an authored magnitude: under '$1.2k', 2,496,000 prints as 2,496.0 thousand, not as $2.5M. Percent values are authored in POINTS: 6.2 with format '1.2%' renders '6.2%'. A difference of two percent levels uses 'pp', not '%'. A separator followed by exactly three digits after a nonzero integer part is a thousands mark: '1.000' groups thousands with a dot and prints decimals with a comma; write '0.000' for three decimals. The format's unit, $M for '$1.2m', prints once beside subtitle.measure when every value column shares it; without a measure, or with mixed units, each value head carries it, as 'Q1 ($M)'. unitShown true drops it from the heads too. |
|
|
140
|
-
| columns[].polarity (columns[] branch 3) | string | | Which sign is favorable. Judgment tones and directional encodings read it. One of `'higherIsBetter'`, `'lowerIsBetter'`. |
|
|
141
|
-
| columns[].materiality (columns[] branch 3) | object | | Mute tones below this threshold; keep values visible. |
|
|
142
|
-
| columns[].materiality.pct (columns[] branch 3) | number | | Percent-column threshold in points. |
|
|
143
|
-
| columns[].materiality.abs (columns[] branch 3) | number | | Other numeric threshold in source units. |
|
|
144
|
-
| columns[].id (columns[] branch 4) | string | yes | Nonempty reference id. |
|
|
145
|
-
| columns[].label (columns[] branch 4) | string | | Visible name; defaults to id. |
|
|
146
|
-
| columns[].subLabel (columns[] branch 4) | string | | Second header line. At the micro step in muted ink: a weekday under a date, an ISO week under a week start. Primary labels keep one baseline. |
|
|
147
|
-
| columns[].width (columns[] branch 4) | number | | Width in px. React keeps it and scrolls. SVG narrows authored tracks only when the fixed frame needs it, with table-overflow and a wider-size fix. Value and computed tracks widen for figures, and a row-label track for its labels up to 180 px (table-column-widened). Other content may cut (table-column-clipped); remove width for automatic content sizing. |
|
|
148
|
-
| columns[].align (columns[] branch 4) | string | | Cell alignment. Numeric left alignment is accepted but linted. One of `'left'`, `'right'`, `'center'`. |
|
|
149
|
-
| columns[].headAlign (columns[] branch 4) | string | | Head alignment; defaults to align. One of `'left'`, `'right'`, `'center'`. |
|
|
150
|
-
| columns[].emphasis (columns[] branch 4) | string | | Header and cell emphasis. 'strong' sets the header and its cells to the emphasis weight (700 by default), 'muted' paints them in the muted ink. A strong column is measured in the bold weight; muted is paint only. One of `'strong'`, `'muted'`. |
|
|
151
|
-
| columns[].band (columns[] branch 4) | boolean | | Column band ground. Neighbouring banded columns read as one block and the first of the run takes the left hairline, so a block inside a column group needs no group of its own. Paint only. |
|
|
152
|
-
| columns[].fitFormat (columns[] branch 4) | false | | false: options.fitFormats leaves this column's format as authored. One of `false`. |
|
|
153
|
-
| columns[].noteLine (columns[] branch 4) | boolean | | Notes below figures. They use the inline step in muted ink. Default false keeps the note inline after the figure, where a 90 px block track cuts it off; a steering block column says sum under its year-to-date figure. The note takes the first line slot whose change line holds no value in that cell, and where every line holds one, or the row prints none, the row grows by one inline line. |
|
|
154
111
|
| columns[].kind (columns[] branch 4) | string | yes | Kind. One of `'text'`. |
|
|
155
112
|
| columns[].wrap (columns[] branch 4) | boolean | | Wrap prose and grow its row; do not widen the table. A line break (\\n) in a cell starts a new line. Use it for the note column of a scorecard. |
|
|
156
|
-
| columns[].id (columns[] branch 5) | string | yes | Nonempty reference id. |
|
|
157
|
-
| columns[].label (columns[] branch 5) | string | | Visible name; defaults to id. |
|
|
158
|
-
| columns[].subLabel (columns[] branch 5) | string | | Second header line. At the micro step in muted ink: a weekday under a date, an ISO week under a week start. Primary labels keep one baseline. |
|
|
159
|
-
| columns[].width (columns[] branch 5) | number | | Width in px. React keeps it and scrolls. SVG narrows authored tracks only when the fixed frame needs it, with table-overflow and a wider-size fix. Value and computed tracks widen for figures, and a row-label track for its labels up to 180 px (table-column-widened). Other content may cut (table-column-clipped); remove width for automatic content sizing. |
|
|
160
|
-
| columns[].align (columns[] branch 5) | string | | Cell alignment. Numeric left alignment is accepted but linted. One of `'left'`, `'right'`, `'center'`. |
|
|
161
|
-
| columns[].headAlign (columns[] branch 5) | string | | Head alignment; defaults to align. One of `'left'`, `'right'`, `'center'`. |
|
|
162
|
-
| columns[].emphasis (columns[] branch 5) | string | | Header and cell emphasis. 'strong' sets the header and its cells to the emphasis weight (700 by default), 'muted' paints them in the muted ink. A strong column is measured in the bold weight; muted is paint only. One of `'strong'`, `'muted'`. |
|
|
163
|
-
| columns[].band (columns[] branch 5) | boolean | | Column band ground. Neighbouring banded columns read as one block and the first of the run takes the left hairline, so a block inside a column group needs no group of its own. Paint only. |
|
|
164
|
-
| columns[].fitFormat (columns[] branch 5) | false | | false: options.fitFormats leaves this column's format as authored. One of `false`. |
|
|
165
|
-
| columns[].noteLine (columns[] branch 5) | boolean | | Notes below figures. They use the inline step in muted ink. Default false keeps the note inline after the figure, where a 90 px block track cuts it off; a steering block column says sum under its year-to-date figure. The note takes the first line slot whose change line holds no value in that cell, and where every line holds one, or the row prints none, the row grows by one inline line. |
|
|
166
113
|
| columns[].kind (columns[] branch 5) | string | yes | Status cell: on-track \| at-risk \| off-track \| done \| pending or { v: key }. Green means on-track, amber or yellow means at-risk, and red means off-track; keys and traffic-light words accept any case and conversions warn input-converted. Other text refuses: status-value-invalid. Numbers draw the missing dash and warn: status-value-number; a later release refuses numbers. Each key has a fixed tone. For free status text, use a text column with a cell tone. One of `'status'`. |
|
|
167
114
|
| columns[].labels (columns[] branch 5) | object | | Display text per status key, e.g. { pending: 'Learning' }. The key keeps its tone; an unlisted key prints as itself. |
|
|
168
115
|
| columns[].mark (columns[] branch 5) | string | | How a status prints. 'chip' (default): a tone wash behind tone-mixed text. 'square': a small tone square before ink text, with no wash. One of `'chip'`, `'square'`. |
|
|
169
|
-
| columns[].id (columns[] branch 6) | string | yes | Nonempty reference id. |
|
|
170
|
-
| columns[].label (columns[] branch 6) | string | | Visible name; defaults to id. |
|
|
171
|
-
| columns[].subLabel (columns[] branch 6) | string | | Second header line. At the micro step in muted ink: a weekday under a date, an ISO week under a week start. Primary labels keep one baseline. |
|
|
172
|
-
| columns[].width (columns[] branch 6) | number | | Width in px. React keeps it and scrolls. SVG narrows authored tracks only when the fixed frame needs it, with table-overflow and a wider-size fix. Value and computed tracks widen for figures, and a row-label track for its labels up to 180 px (table-column-widened). Other content may cut (table-column-clipped); remove width for automatic content sizing. |
|
|
173
|
-
| columns[].align (columns[] branch 6) | string | | Cell alignment. Numeric left alignment is accepted but linted. One of `'left'`, `'right'`, `'center'`. |
|
|
174
|
-
| columns[].headAlign (columns[] branch 6) | string | | Head alignment; defaults to align. One of `'left'`, `'right'`, `'center'`. |
|
|
175
|
-
| columns[].emphasis (columns[] branch 6) | string | | Header and cell emphasis. 'strong' sets the header and its cells to the emphasis weight (700 by default), 'muted' paints them in the muted ink. A strong column is measured in the bold weight; muted is paint only. One of `'strong'`, `'muted'`. |
|
|
176
|
-
| columns[].band (columns[] branch 6) | boolean | | Column band ground. Neighbouring banded columns read as one block and the first of the run takes the left hairline, so a block inside a column group needs no group of its own. Paint only. |
|
|
177
|
-
| columns[].fitFormat (columns[] branch 6) | false | | false: options.fitFormats leaves this column's format as authored. One of `false`. |
|
|
178
|
-
| columns[].noteLine (columns[] branch 6) | boolean | | Notes below figures. They use the inline step in muted ink. Default false keeps the note inline after the figure, where a 90 px block track cuts it off; a steering block column says sum under its year-to-date figure. The note takes the first line slot whose change line holds no value in that cell, and where every line holds one, or the row prints none, the row grows by one inline line. |
|
|
179
116
|
| columns[].kind (columns[] branch 6) | string | yes | Date cell: an ISO date (YYYY-MM-DD) or { v: date } (other text refuses: date-invalid; numbers draw the missing dash and warn: date-value-number). One of `'date'`. |
|
|
180
117
|
| columns[].format (columns[] branch 6) | string | | Date pattern or example: '30 Sep 2026', 'Sep-26', '2026-09-30', '30.09.2026', '09/30/2026', 'September 2026' or '2026'. Tokens: d, dd, ddd, dddd, M, MM, MMM, MMMM, MMMMM, Q (1), QQ (Q1), QQQ (Quarter 1), w, ww, yy, yyyy and 'quoted literals'. Excel mmm/mmmm name months and 'dd/mm/yyyy' uses lowercase months. YYYY/YY mean year and D/DD mean day. Numeric dates use a day above 12 to choose the order. Otherwise they read day first and warn date-format-ambiguous. A year in front keeps year/month/day. A short year beside a month name with a space or comma also warns when it could be a day. 'FY26' reads the calendar year and gives date-format-fiscal-year (info). Unreadable text warns date-format-unknown and uses 'd MMM yyyy'. |
|
|
181
|
-
| columns[].id (columns[] branch 7) | string | yes | Nonempty reference id. |
|
|
182
|
-
| columns[].label (columns[] branch 7) | string | | Visible name; defaults to id. |
|
|
183
|
-
| columns[].subLabel (columns[] branch 7) | string | | Second header line. At the micro step in muted ink: a weekday under a date, an ISO week under a week start. Primary labels keep one baseline. |
|
|
184
|
-
| columns[].width (columns[] branch 7) | number | | Width in px. React keeps it and scrolls. SVG narrows authored tracks only when the fixed frame needs it, with table-overflow and a wider-size fix. Value and computed tracks widen for figures, and a row-label track for its labels up to 180 px (table-column-widened). Other content may cut (table-column-clipped); remove width for automatic content sizing. |
|
|
185
|
-
| columns[].align (columns[] branch 7) | string | | Cell alignment. Numeric left alignment is accepted but linted. One of `'left'`, `'right'`, `'center'`. |
|
|
186
|
-
| columns[].headAlign (columns[] branch 7) | string | | Head alignment; defaults to align. One of `'left'`, `'right'`, `'center'`. |
|
|
187
|
-
| columns[].emphasis (columns[] branch 7) | string | | Header and cell emphasis. 'strong' sets the header and its cells to the emphasis weight (700 by default), 'muted' paints them in the muted ink. A strong column is measured in the bold weight; muted is paint only. One of `'strong'`, `'muted'`. |
|
|
188
|
-
| columns[].band (columns[] branch 7) | boolean | | Column band ground. Neighbouring banded columns read as one block and the first of the run takes the left hairline, so a block inside a column group needs no group of its own. Paint only. |
|
|
189
|
-
| columns[].fitFormat (columns[] branch 7) | false | | false: options.fitFormats leaves this column's format as authored. One of `false`. |
|
|
190
|
-
| columns[].noteLine (columns[] branch 7) | boolean | | Notes below figures. They use the inline step in muted ink. Default false keeps the note inline after the figure, where a 90 px block track cuts it off; a steering block column says sum under its year-to-date figure. The note takes the first line slot whose change line holds no value in that cell, and where every line holds one, or the row prints none, the row grows by one inline line. |
|
|
191
118
|
| columns[].kind (columns[] branch 7) | string | yes | Kind. One of `'encoding'`. |
|
|
192
119
|
| columns[].encoding (columns[] branch 7) | object | yes | Sparkline over other columns; no own cell values. |
|
|
193
120
|
| columns[].encoding.type (columns[] branch 7) | string | yes | Per-row mini line or column over sourceColumns; null values leave gaps in source order. One of `'sparkline'`. |
|
|
@@ -217,23 +144,15 @@ Consulting-grade table: hierarchy with honest totals (derive/validate/source), t
|
|
|
217
144
|
| rows[].calc.op (rows[].calc branch 4) | string | yes | Absolute value. One of `'abs'`. |
|
|
218
145
|
| rows[].calc.of (rows[].calc branch 4) | object | yes | Cell or expression. |
|
|
219
146
|
| rows[].calc.op (rows[].calc branch 5) | string | yes | a minus b. One of `'delta'`. |
|
|
220
|
-
| rows[].calc.a (rows[].calc branch 5) | string \| object | yes | Current cell. |
|
|
221
|
-
| rows[].calc.a.row (rows[].calc branch 5) | string | yes | Row id. |
|
|
222
|
-
| rows[].calc.a.col (rows[].calc branch 5) | string | | Column id. Omitted means the column being evaluated. |
|
|
223
|
-
| rows[].calc.a.previous (rows[].calc branch 5) | true | | Prior member in this group. The first member is n/a. One of `true`. |
|
|
224
|
-
| rows[].calc.b (rows[].calc branch 5) | string \| object | yes | Reference cell. |
|
|
225
|
-
| rows[].calc.b.row (rows[].calc branch 5) | string | yes | Row id. |
|
|
226
|
-
| rows[].calc.b.col (rows[].calc branch 5) | string | | Column id. Omitted means the column being evaluated. |
|
|
227
|
-
| rows[].calc.b.previous (rows[].calc branch 5) | true | | Prior member in this group. The first member is n/a. One of `true`. |
|
|
147
|
+
| rows[].calc.a (rows[].calc branch 5 \| rows[].calc branch 6) | string \| object | yes | Current cell. |
|
|
148
|
+
| rows[].calc.a.row (rows[].calc branch 5 \| rows[].calc branch 6) | string | yes | Row id. |
|
|
149
|
+
| rows[].calc.a.col (rows[].calc branch 5 \| rows[].calc branch 6) | string | | Column id. Omitted means the column being evaluated. |
|
|
150
|
+
| rows[].calc.a.previous (rows[].calc branch 5 \| rows[].calc branch 6) | true | | Prior member in this group. The first member is n/a. One of `true`. |
|
|
151
|
+
| rows[].calc.b (rows[].calc branch 5 \| rows[].calc branch 6) | string \| object | yes | Reference cell. |
|
|
152
|
+
| rows[].calc.b.row (rows[].calc branch 5 \| rows[].calc branch 6) | string | yes | Row id. |
|
|
153
|
+
| rows[].calc.b.col (rows[].calc branch 5 \| rows[].calc branch 6) | string | | Column id. Omitted means the column being evaluated. |
|
|
154
|
+
| rows[].calc.b.previous (rows[].calc branch 5 \| rows[].calc branch 6) | true | | Prior member in this group. The first member is n/a. One of `true`. |
|
|
228
155
|
| rows[].calc.op (rows[].calc branch 6) | string | yes | 100*(a-b)/b relative change; n.m. when b is zero or negative, n/a when a and b are both zero. One of `'percentDelta'`. |
|
|
229
|
-
| rows[].calc.a (rows[].calc branch 6) | string \| object | yes | Current cell. |
|
|
230
|
-
| rows[].calc.a.row (rows[].calc branch 6) | string | yes | Row id. |
|
|
231
|
-
| rows[].calc.a.col (rows[].calc branch 6) | string | | Column id. Omitted means the column being evaluated. |
|
|
232
|
-
| rows[].calc.a.previous (rows[].calc branch 6) | true | | Prior member in this group. The first member is n/a. One of `true`. |
|
|
233
|
-
| rows[].calc.b (rows[].calc branch 6) | string \| object | yes | Reference cell. |
|
|
234
|
-
| rows[].calc.b.row (rows[].calc branch 6) | string | yes | Row id. |
|
|
235
|
-
| rows[].calc.b.col (rows[].calc branch 6) | string | | Column id. Omitted means the column being evaluated. |
|
|
236
|
-
| rows[].calc.b.previous (rows[].calc branch 6) | true | | Prior member in this group. The first member is n/a. One of `true`. |
|
|
237
156
|
| rows[].calc.op (rows[].calc branch 7) | string | yes | Share of column leaf total. One of `'share'`. |
|
|
238
157
|
| rows[].calc.of (rows[].calc branch 7) | string \| object | yes | Share denominator cell. |
|
|
239
158
|
| rows[].calc.of.row (rows[].calc branch 7) | string | yes | Row id. |
|
|
@@ -285,7 +204,7 @@ Consulting-grade table: hierarchy with honest totals (derive/validate/source), t
|
|
|
285
204
|
| encodings.*.type (encodings.* branch 5) | string | `'arrow'` | | Select the arrow lane. |
|
|
286
205
|
| encodings.*.scale (encodings.* branch 5) | string | `'absolute'`, `'relative'` | | 'absolute' cuts the change itself at 10 and 2 (points on a percent column); 'relative' cuts its share of the column's largest change at 10% and 2%. Default 'absolute' on a percent column, 'relative' elsewhere. |
|
|
287
206
|
| encodings.*.type (encodings.* branch 6) | string | `'heat'` | | Select the heat lane. |
|
|
288
|
-
| encodings.*.cap (encodings.* branch 6) | object | | | Where the lane saturates; without it the largest magnitude in the column does, on both sides of zero.
|
|
207
|
+
| encodings.*.cap (encodings.* branch 6) | object | | | Where the lane saturates; without it the largest magnitude in the column does, on both sides of zero. Lanes with different caps add the note that shading compares values within each column. |
|
|
289
208
|
| encodings.*.cap.pct (encodings.* branch 6) | number | | | Percent-column tint cap in points. Example: 20 for a ±20% YoY lane. |
|
|
290
209
|
| encodings.*.cap.abs (encodings.* branch 6) | number | | | Other numeric tint cap in source units. |
|
|
291
210
|
| encodings.*.alpha (encodings.* branch 6) | number | | | Tint weight at the cap; default 0.18, and 0.26 on scale 'status', where every painted cell takes it. Text stays readable up to 0.18 on every shipped theme and up to 0.35 on a status ground; above that the figures take the contrast ink. |
|
|
@@ -337,7 +256,7 @@ Consulting-grade table: hierarchy with honest totals (derive/validate/source), t
|
|
|
337
256
|
| labelIndent.step | number | | | px per rung; default 16. |
|
|
338
257
|
| outlineMarks | boolean | | `false` | Fold marks beside parent rows. Drawn in static SVG/PNG and read-only grids. Default false: no marks or gutter. true draws the marks and reserves their gutter. Interactive grids keep their fold buttons either way. |
|
|
339
258
|
|
|
340
|
-
Plus the [shared options](options.md). This type does not accept `detailFields`, `labels`, `valueAxis`, `story`, `hatchStrength`, `rounding`, `annotations`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `bandFraction`, `valueAxis.show`, `valueAxis.gridlines` with an `option-ignored` warning.
|
|
259
|
+
Plus the [shared options](options.md). This type does not accept `detailFields`, `labels`, `labelPosition`, `valueAxis`, `story`, `hatchStrength`, `rounding`, `annotations`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `bandFraction`, `valueAxis.show`, `valueAxis.gridlines`, `focus`, `labelDensity` with an `option-ignored` warning.
|
|
341
260
|
|
|
342
261
|
## Annotations
|
|
343
262
|
|
package/docs/reference/theme.md
CHANGED
|
@@ -192,7 +192,7 @@ Defaults are the `bridge` preset.
|
|
|
192
192
|
| marks.nodeStrokeWidth | number | | | | Width in px of a diagram node ring and a group frame (0 to 3). Absent uses stroke.hair. |
|
|
193
193
|
| marks.restOutline | boolean | | | | false draws the marks that recede under a highlight (color.rest) without the separation outline marks.contrastEdge: true adds to a fill too close to the background. Absent means true. |
|
|
194
194
|
| marks.areaFromOrigin | boolean | | | | true places the first and last category of an area chart (line variants area, stacked-area, stacked100-area) on the plot edges, so the bands start at the value axis; an authored categoryAxis.crossesBetween wins. Absent keeps the categories centred in their bands. |
|
|
195
|
-
| marks.barLabels | string | | `'auto'`, `'outside'` | | 'outside' places a bar chart's value label past the bar end, or drops it (a label-hidden lint) where no room is left there; never inside the bar or in a backed box. On grouped bars that cross zero, a negative value reads right of the zero line, where the positive values start, so the negative side holds only its bars; with no value axis drawn, the domain is the extent plus the label room rather than a rounded one. Absent keeps the cascade: inside the end where it fits, else outside, else inside on a backing. |
|
|
195
|
+
| marks.barLabels | string | | `'auto'`, `'outside'` | | 'outside' places a bar chart's value label past the bar end, or drops it (a label-hidden lint) where no room is left there; never inside the bar or in a backed box. On grouped bars that cross zero, a negative value reads right of the zero line, where the positive values start, so the negative side holds only its bars; with no value axis drawn, the domain is the extent plus the label room rather than a rounded one. Absent keeps the cascade: inside the end where it fits, else outside, else inside on a backing. Stacked and stacked100 bars keep each part inside its segment and warn option-ignored. |
|
|
196
196
|
| marks.comboColumnTint | number | | | | A combo's column series with no authored fill, colorRole or palette fill their actual columns in color.focus at this tint amount toward the background, 0 to 1 (0.74 = 26 % focus). Stacked series take a ramp of it: the top series the tint, the ones below stepping down the stacked-area ramp, capped at the full focus (26 / 45 / 70 / 100 % from the top at 0.74). The scenario look wins: a plan outline and a forecast hatch draw in the full focus, and a prior year keeps its scenario colour. A washed column takes no separation outline in any scheme: the tint is the theme's choice. Absent keeps the series colour. |
|
|
197
197
|
| marks.comboLine | string | | `'series'`, `'ink'` | | 'ink' draws a combo's lead line, when it has no authored fill, colorRole, highlight or palette, in color.ink at 1.5 px with the latest-point ring in color.highlight on its last observed point, never on a forecast one; its page-colour casing is a half-pixel hairline each side, not a second stroke. Absent keeps the focus at 2 px on a 1.5 px casing. |
|
|
198
198
|
| marks.sparkEnd | string | | `'dot'`, `'ring'` | | The last point of a kpi card's spark, a table spark and a creative trend: 'ring' draws the standalone sparkline's ring, the background with a 1.5 px ring in color.highlight at radius 3.2. Absent keeps 'dot', a filled point in the highlight. |
|
|
@@ -207,6 +207,14 @@ Defaults are the `bridge` preset.
|
|
|
207
207
|
| marks.funnelFill | string | | `'status'`, `'ramp'` | | How a funnel (rows or centered) fills its bars. 'ramp': a single series takes color.series by stage, stage 1 the first colour; an outcome split takes it by series; the lost share, a series whose colorRole is 'status-lost' or 'bad', is color.badFill at 45 % over the background. Status colours never reach the bars, so a status map that borrows a text colour cannot fill a stage. An authored series fill wins. Absent means 'status': a colorRole resolves through the theme and a single series takes color.focus. |
|
|
208
208
|
| marks.statusFill | string | | `'quiet'`, `'full'` | | How a status chart fills its good and neutral cells. Absent means 'quiet': a good cell draws color.goodFill washed toward the page (about 78 %) and a neutral cell color.neutralMark washed less (about 67 %), so off-track and at-risk cells carry the colour. Each wash steps back toward its full colour until the cell sits further from the page than a cell with no status and stays apart from it and from every other state colour, also for red-green colour vision. It is decided in the theme the chart is painted in; on a dark page the wash also steps back until the cell reads against the page as clearly as the light wash does on white. A hatched good or neutral state keeps its full colour under its hatch, and a plain state of the same tone stays a step stronger than that hatch ground. 'full' fills good and neutral cells with color.goodFill and color.neutralMark as they are. |
|
|
209
209
|
| marks.bulletBandFill | string | | `'light'`, `'full'` | | How a bullet paints its bands. Absent means 'light': the qualitative bands of every row take the light ladder, the good end 0.06 lightness from the page and each band 0.06 from the next, so the bar stays the darkest mark at any row count. A band with a tone (good, warn, bad, neutral) takes its tone's fill washed toward the page: good sits 0.13 lightness from the page, warn 0.11, bad 0.09 and neutral 0.15, so a wide off-plan zone stays pale and good and bad differ in lightness. An attainment band washes its good and bad fills the same way. It is decided in the theme the chart is painted in. 'full' paints toned bands and attainment bands in color.goodFill, color.warnFill, color.badFill and color.neutralMark as they are, and steps the ladder 0.12 apart on rows that do not print their band names. |
|
|
210
|
+
| marks.arrow | object | | | | The look of every annotation arrow: a drawn arrow, a callout arrow, a CAGR bracket or growth arrow, a difference, a link, a gap bracket and a band bracket. Absent keys keep the standard: a filled head 8 px long and 7 px wide in color.ink, a shaft in stroke.mark, the tip 6 px off the edge of the mark it points at, the tail 4 px off its text and a shaft of at least 24 px. A difference or bracket tip still touches its level guide. A callout with no seat that keeps the shaft draws no arrow and warns callout-arrow-no-room. |
|
|
211
|
+
| marks.arrow.style | string | | `'standard'`, `'compact'` | | 'compact' brings back the arrows before the standard: heads 4 to 10 px by kind, a stroke.rule shaft, the tip on the point and no shortest shaft; the other marks.arrow keys then do nothing. Absent means 'standard'. |
|
|
212
|
+
| marks.arrow.head | number | | | | Head length in px, tip to base (4 to 24). Absent means 8. |
|
|
213
|
+
| marks.arrow.headWidth | number | | | | Head width in px at its base (3 to 24). Absent means 7. |
|
|
214
|
+
| marks.arrow.tipGap | number | | | | Air in px between the tip and the edge of the mark it points at (0 to 24). Absent means 6. |
|
|
215
|
+
| marks.arrow.tailGap | number | | | | Air in px between the tail and its text (0 to 16). Absent means 4. |
|
|
216
|
+
| marks.arrow.minShaft | number | | | | The shortest shaft in px, tail to head base (0 to 96). A callout arrow seats its text this far out. Absent means 24. |
|
|
217
|
+
| marks.arrow.stroke | number | | | | Shaft width in px (0.5 to 4). Absent means the thin `stroke.rule` line; 1.5 matches `stroke.mark`. |
|
|
210
218
|
| labels | object | | | | Label conventions. Absent keeps the shipped placement. |
|
|
211
219
|
| labels.endLabelPlacement | string | | `'gutter'`, `'lineEnd'` | | Default for the line option endLabelPlacement: 'gutter' puts every end label right of the plot, 'lineEnd' puts the label of a series that ends early beside its last point. |
|
|
212
220
|
| labels.ink | string | | `'ink'`, `'muted'` | | Ink of the value and category labels on the page: 'ink' (default) or 'muted', the grey inkMuted. A highlighted mark's labels keep the full ink; labels inside a fill keep their contrast ink. |
|
|
@@ -352,8 +360,8 @@ Defaults are the `bridge` preset.
|
|
|
352
360
|
| invalid-theme-override | overrides produce a structurally invalid theme |
|
|
353
361
|
| theme-name-reserved | a full theme object uses a preset name |
|
|
354
362
|
| unparseable-color | a colour is unsupported; use hex, rgb(), hsl(), oklch() or var() with a literal fallback |
|
|
355
|
-
| contrast-ink | ink on background is below 4.5:1 |
|
|
356
|
-
| contrast-ink-muted | inkMuted on background is below 3:1 |
|
|
363
|
+
| contrast-ink | ink, or a table ink that stands for it, on background is below 4.5:1 |
|
|
364
|
+
| contrast-ink-muted | inkMuted, or a muted table ink, on background is below 3:1 |
|
|
357
365
|
| contrast-inside-label | a label inside a fill is below its contrast floor |
|
|
358
366
|
| semantic-equals-background | good, bad or highlight equals the background |
|
|
359
367
|
| good-bad-similar | good and bad are nearly identical |
|
|
@@ -361,7 +369,7 @@ Defaults are the `bridge` preset.
|
|
|
361
369
|
|
|
362
370
|
A retired key, such as `space.barGap`, is accepted for good: the theme draws without it and warns `option-deprecated` with a JSON Patch that removes it. A retired preset name, such as `ibcs`, draws as its successor and warns with a patch that rewrites it. An unknown key that never existed is refused with a suggest that names it and a JSON Patch that removes it. The CLI, the MCP tools, React and `parseThemeJson` from `boardplot/validate` give the same warnings, suggests and patches; `parseThemeJson` throws a refusal as an `invalid-theme` error whose patch paths start at the theme file.
|
|
363
371
|
|
|
364
|
-
A resolved theme is FROZEN, all the way down. `resolveTheme`, the `theme` on a resolved request and the one a React component reads are the same deeply frozen object, so a write to one throws where it is written instead of changing a theme the engine has already judged and cached. A variant is a new object: spread the resolved theme, or pass `overrides` and let the engine merge and check them.
|
|
372
|
+
A resolved theme is FROZEN, all the way down. `resolveTheme`, the `theme` on a resolved request and the one a React component reads are the same deeply frozen object, so a write to one throws where it is written instead of changing a theme the engine has already judged and cached. A variant is a new object: spread the resolved theme, or pass `overrides` and let the engine merge and check them. The engine keeps the merged theme for the `overrides` object it was given, so a change to that object after the call is not seen: pass a new object for a new theme.
|
|
365
373
|
|
|
366
374
|
## Fonts
|
|
367
375
|
|
|
@@ -57,15 +57,13 @@ One form; its chart ID is `tilemap`.
|
|
|
57
57
|
| overlays[].glyph.shares[].tone (overlays[].glyph branch 1) | string | | Semantic glyph tone resolved through the theme. One of `'good'`, `'bad'`, `'warn'`, `'neutral'`, `'info'`. |
|
|
58
58
|
| overlays[].glyph.kind (overlays[].glyph branch 2) | string | yes | Draw a fractionally filled Harvey ball. One of `'harvey'`. |
|
|
59
59
|
| overlays[].glyph.value (overlays[].glyph branch 2) | number | yes | Filled fraction from 0, empty, to 1, full. |
|
|
60
|
-
| overlays[].glyph.tone (overlays[].glyph branch 2) | string | | Semantic glyph tone resolved through the theme. One of `'good'`, `'bad'`, `'warn'`, `'neutral'`, `'info'`. |
|
|
60
|
+
| overlays[].glyph.tone (overlays[].glyph branch 2 \| overlays[].glyph branch 4 \| overlays[].glyph branch 5) | string | | Semantic glyph tone resolved through the theme. One of `'good'`, `'bad'`, `'warn'`, `'neutral'`, `'info'`. |
|
|
61
61
|
| overlays[].glyph.kind (overlays[].glyph branch 3) | string | yes | Draw a semantic status glyph. One of `'status'`. |
|
|
62
62
|
| overlays[].glyph.status (overlays[].glyph branch 3) | string | yes | Status judgment shown by the glyph. One of `'good'`, `'bad'`, `'warn'`, `'neutral'`. |
|
|
63
63
|
| overlays[].glyph.kind (overlays[].glyph branch 4) | string | yes | Draw a named built-in icon. One of `'icon'`. |
|
|
64
64
|
| overlays[].glyph.name (overlays[].glyph branch 4) | string | yes | Name from the built-in icon catalogue: alert calendar check conversation document flag gear lightbulb lock people star target workflow. |
|
|
65
|
-
| overlays[].glyph.tone (overlays[].glyph branch 4) | string | | Semantic glyph tone resolved through the theme. One of `'good'`, `'bad'`, `'warn'`, `'neutral'`, `'info'`. |
|
|
66
65
|
| overlays[].glyph.kind (overlays[].glyph branch 5) | string | yes | Draw a geometric location marker. One of `'marker'`. |
|
|
67
66
|
| overlays[].glyph.shape (overlays[].glyph branch 5) | string | | Marker outline; defaults to circle. One of `'circle'`, `'square'`, `'diamond'`. |
|
|
68
|
-
| overlays[].glyph.tone (overlays[].glyph branch 5) | string | | Semantic glyph tone resolved through the theme. One of `'good'`, `'bad'`, `'warn'`, `'neutral'`, `'info'`. |
|
|
69
67
|
| overlays[].label | string | yes | Readable name for this overlay or pie share. |
|
|
70
68
|
| overlays[].size | string | | Glyph size tier; defaults to md. One of `'sm'`, `'md'`, `'lg'`. |
|
|
71
69
|
| overlays[].a11y | string | | Authored accessible description for the overlay. |
|
|
@@ -90,7 +88,7 @@ One form; its chart ID is `tilemap`.
|
|
|
90
88
|
| overlayMeasure | string | | | The measure the overlay glyphs show, e.g. 'Activation progress, %'. The overlay key prints it as a heading without a category swatch, apart from the colour key; Harvey-ball overlays without it warn geo-overlay-measure-unnamed. |
|
|
91
89
|
| regionValues | boolean | | | Print each tile's value under its code, e.g. 'CA' over '52'. Unset prints the values when every value fits its tile and keeps the codes alone when one does not. true prints them where they fit: a tile too small for both keeps its code and the layout warns that its value shows on hover only. false prints codes only. |
|
|
92
90
|
|
|
93
|
-
Plus the [shared options](options.md). This type does not accept `detailFields`, `valueAxis`, `highlight`, `story`, `rounding`, `annotations`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `sort`, `topN`, `bandFraction`, `valueAxis.show`, `valueAxis.gridlines` with an `option-ignored` warning.
|
|
91
|
+
Plus the [shared options](options.md). This type does not accept `detailFields`, `labelPosition`, `valueAxis`, `highlight`, `story`, `rounding`, `annotations`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `sort`, `topN`, `bandFraction`, `valueAxis.show`, `valueAxis.gridlines` with an `option-ignored` warning.
|
|
94
92
|
|
|
95
93
|
## Annotations
|
|
96
94
|
|
|
@@ -60,7 +60,7 @@ Part of a whole in one or two levels (group, item): cell area is value. Squarifi
|
|
|
60
60
|
| cellValue | string | `'value'`, `'share'`, `'value-share'` | `'value'` | Name and bold value print together, inside the cell or on a circle leader. A pair that does not fit goes to the complete list. 'value' (default), 'share' of the grand total, or 'value-share' as "3,080 (17%)". A percent format applies to cell shares; group totals stay in value units. |
|
|
61
61
|
| total | boolean \| string | | | Total callout at the lower right, no larger than the title. true prints the formatted grand total with the unit; a string prints itself, with '{value}' replaced by the formatted total. Off by default: the title usually states the total. |
|
|
62
62
|
|
|
63
|
-
Plus the [shared options](options.md). This type does not accept `detailFields`, `labels`, `valueAxis.tickStep`, `valueAxis.log`, `valueAxis.reverse`, `valueAxis.break`, `highlight`, `story`, `hatchStrength`, `rounding`, `annotations`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `sort`, `topN`, `bandFraction` with an `option-ignored` warning.
|
|
63
|
+
Plus the [shared options](options.md). This type does not accept `detailFields`, `labels`, `labelPosition`, `valueAxis.tickStep`, `valueAxis.log`, `valueAxis.reverse`, `valueAxis.break`, `highlight`, `story`, `hatchStrength`, `rounding`, `annotations`. This type ignores `animate`, `debug`, `rowLabels`, `categoryAxis`, `categoryLabels`, `secondaryAxis`, `sort`, `topN`, `bandFraction`, `valueAxis` with an `option-ignored` warning.
|
|
64
64
|
|
|
65
65
|
## Annotations
|
|
66
66
|
|