boardplot 0.0.0-stage → 0.52.5
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 +18 -0
- package/LICENSE +201 -0
- package/NOTICE.md +180 -0
- package/README.md +208 -2
- package/THIRD_PARTY_NOTICES.md +1110 -0
- package/dist/DiagnosticDetails-UNYNYCAH.js +69 -0
- package/dist/ReaderBox-VUNSFKZY.js +137 -0
- package/dist/annotateEngine-H7OW4H3W.js +30 -0
- package/dist/build-identity.json +6 -0
- package/dist/chunk-24WB3HMB.js +621 -0
- package/dist/chunk-263SZKIL.js +8 -0
- package/dist/chunk-27QQEWNV.js +18 -0
- package/dist/chunk-2AKWCMS4.js +24 -0
- package/dist/chunk-2DHJJ2EN.js +24 -0
- package/dist/chunk-2EQE4E3I.js +22 -0
- package/dist/chunk-2GELJH37.js +88 -0
- package/dist/chunk-2JAWQ7VV.js +3874 -0
- package/dist/chunk-2LMCD3ZR.js +6 -0
- package/dist/chunk-2MTWKMEG.js +841 -0
- package/dist/chunk-2SGIHKKU.js +33 -0
- package/dist/chunk-2UVTHU7A.js +1146 -0
- package/dist/chunk-33CBPK5Q.js +2800 -0
- package/dist/chunk-33PLBIMA.js +176 -0
- package/dist/chunk-35DZP2R2.js +22 -0
- package/dist/chunk-3D3D3D23.js +25 -0
- package/dist/chunk-3EZRM4YM.js +92 -0
- package/dist/chunk-3GZECHOK.js +802 -0
- package/dist/chunk-3HHNQPAH.js +68 -0
- package/dist/chunk-3I6RANBJ.js +1058 -0
- package/dist/chunk-3SIRPKMP.js +12 -0
- package/dist/chunk-3W23F7EY.js +185 -0
- package/dist/chunk-3XQ635KD.js +24 -0
- package/dist/chunk-3ZCKEANJ.js +24 -0
- package/dist/chunk-4DNOEV3Q.js +25857 -0
- package/dist/chunk-4GB7TBY7.js +373 -0
- package/dist/chunk-4SM2ONUC.js +18 -0
- package/dist/chunk-5C7TWNYZ.js +79 -0
- package/dist/chunk-5DJXJXDE.js +58 -0
- package/dist/chunk-5ENRZX6I.js +687 -0
- package/dist/chunk-5KWXRYAT.js +294 -0
- package/dist/chunk-5T5YW52S.js +47 -0
- package/dist/chunk-627P6T25.js +936 -0
- package/dist/chunk-62FR4FYJ.js +23 -0
- package/dist/chunk-6JUJ2DU3.js +67 -0
- package/dist/chunk-6KWIQ5KF.js +18 -0
- package/dist/chunk-6UBEGKIQ.js +25 -0
- package/dist/chunk-6XE3GVGU.js +116 -0
- package/dist/chunk-76ANFJOI.js +227 -0
- package/dist/chunk-7IFLQMJL.js +160 -0
- package/dist/chunk-7JVAQX6C.js +28 -0
- package/dist/chunk-7QDAHY5M.js +63 -0
- package/dist/chunk-7VXZDB45.js +149 -0
- package/dist/chunk-7X65ZQN4.js +38 -0
- package/dist/chunk-A2FHZH7E.js +1410 -0
- package/dist/chunk-A372DLQX.js +54 -0
- package/dist/chunk-A3ULWR5N.js +76 -0
- package/dist/chunk-A4QZXLXF.js +7 -0
- package/dist/chunk-A5JWFZVU.js +1467 -0
- package/dist/chunk-A5LZUYK4.js +59 -0
- package/dist/chunk-A6XCAQ52.js +89 -0
- package/dist/chunk-A7A4PDG5.js +24 -0
- package/dist/chunk-A7IEVBYI.js +35 -0
- package/dist/chunk-ACXX2JNL.js +6 -0
- package/dist/chunk-AFK47A6O.js +25 -0
- package/dist/chunk-ALKTNXMR.js +3650 -0
- package/dist/chunk-AOQ6VF5H.js +6 -0
- package/dist/chunk-ASAON7G4.js +648 -0
- package/dist/chunk-ATTE3FYC.js +24 -0
- package/dist/chunk-AZOUSKZD.js +728 -0
- package/dist/chunk-B2EBEXIS.js +113 -0
- package/dist/chunk-B67K5X4M.js +58 -0
- package/dist/chunk-BBL3R5YZ.js +186 -0
- package/dist/chunk-BIDIGDGH.js +6 -0
- package/dist/chunk-BKYMLFUG.js +69 -0
- package/dist/chunk-BLFWUMTD.js +12 -0
- package/dist/chunk-BM6SFFWF.js +6 -0
- package/dist/chunk-BUPLB3EX.js +129 -0
- package/dist/chunk-BVWU6GOB.js +47 -0
- package/dist/chunk-BW5VLBSZ.js +15 -0
- package/dist/chunk-C64FBRJO.js +290 -0
- package/dist/chunk-CAE2HK2G.js +295 -0
- package/dist/chunk-CCQNL33L.js +446 -0
- package/dist/chunk-CDZHNLO6.js +42 -0
- package/dist/chunk-COKHNEJP.js +24 -0
- package/dist/chunk-COYPDRJK.js +21 -0
- package/dist/chunk-CRZKGHZ6.js +1810 -0
- package/dist/chunk-CS4DHFNG.js +128 -0
- package/dist/chunk-CYDZP5W6.js +1589 -0
- package/dist/chunk-D4BIV6WG.js +1072 -0
- package/dist/chunk-D4SOADBD.js +19 -0
- package/dist/chunk-DCCJRLAJ.js +422 -0
- package/dist/chunk-DFKTS6XJ.js +75 -0
- package/dist/chunk-DGDOGOTQ.js +25 -0
- package/dist/chunk-DLC23CKC.js +53 -0
- package/dist/chunk-DRTA6JG5.js +160 -0
- package/dist/chunk-DVKBU23L.js +97 -0
- package/dist/chunk-E2HEVF23.js +692 -0
- package/dist/chunk-EC2NAYPQ.js +24 -0
- package/dist/chunk-EKQK5D6G.js +14 -0
- package/dist/chunk-EKQMYG2B.js +2353 -0
- package/dist/chunk-ELYU6TRQ.js +98 -0
- package/dist/chunk-EQT3EPTB.js +203 -0
- package/dist/chunk-ERAIVAK5.js +1359 -0
- package/dist/chunk-ETHWK2RZ.js +16 -0
- package/dist/chunk-EWVKBRLV.js +72 -0
- package/dist/chunk-F77BNDAT.js +43 -0
- package/dist/chunk-FGAGGPFF.js +566 -0
- package/dist/chunk-FIANWJXX.js +19 -0
- package/dist/chunk-FIWNDOMO.js +6 -0
- package/dist/chunk-FOKEGVPB.js +24 -0
- package/dist/chunk-FT3F72C3.js +30 -0
- package/dist/chunk-FT47HQ5U.js +47 -0
- package/dist/chunk-GDOW2KNP.js +19 -0
- package/dist/chunk-GDQ3NGDZ.js +17 -0
- package/dist/chunk-GH3ZMBFX.js +563 -0
- package/dist/chunk-GQPESFAF.js +3378 -0
- package/dist/chunk-GQS46LC3.js +50 -0
- package/dist/chunk-GULJ6KVT.js +587 -0
- package/dist/chunk-GWQIXU37.js +2774 -0
- package/dist/chunk-GZ2VNM4L.js +24 -0
- package/dist/chunk-GZ4RHGIW.js +836 -0
- package/dist/chunk-H4H4O62O.js +46 -0
- package/dist/chunk-H57TJD3B.js +72 -0
- package/dist/chunk-H7UZZ7KP.js +24 -0
- package/dist/chunk-HAAUJDGB.js +83 -0
- package/dist/chunk-HFG76JTS.js +296 -0
- package/dist/chunk-HJXXFPOL.js +211 -0
- package/dist/chunk-HTYFQHRC.js +24 -0
- package/dist/chunk-HUF6TQ2J.js +24 -0
- package/dist/chunk-HUFCSX2Y.js +89 -0
- package/dist/chunk-HX3MQ3H4.js +26 -0
- package/dist/chunk-HZQEQ34U.js +296 -0
- package/dist/chunk-I322G5UG.js +888 -0
- package/dist/chunk-IDDA5INB.js +60 -0
- package/dist/chunk-IDTLHPTK.js +60 -0
- package/dist/chunk-II7652VA.js +2918 -0
- package/dist/chunk-IN4QT33I.js +38 -0
- package/dist/chunk-IV2UXZXX.js +16 -0
- package/dist/chunk-IXSZ7OKR.js +133 -0
- package/dist/chunk-IYEFEBRN.js +41 -0
- package/dist/chunk-IZ35GMGB.js +2543 -0
- package/dist/chunk-IZCOG3FS.js +28 -0
- package/dist/chunk-JA755JHN.js +379 -0
- package/dist/chunk-JETXFF3M.js +33 -0
- package/dist/chunk-JFBEAUJ6.js +24 -0
- package/dist/chunk-JFG4DHKQ.js +48 -0
- package/dist/chunk-JL5BRMDT.js +179 -0
- package/dist/chunk-JLCAWQ3H.js +195 -0
- package/dist/chunk-JLZM7XMZ.js +525 -0
- package/dist/chunk-JMH5MD5A.js +19 -0
- package/dist/chunk-JRPI64AQ.js +3066 -0
- package/dist/chunk-JSX3C6LL.js +344 -0
- package/dist/chunk-JY4R3GML.js +83 -0
- package/dist/chunk-JYBT2JNY.js +61 -0
- package/dist/chunk-K2HNV4LE.js +2008 -0
- package/dist/chunk-KAXJFL7N.js +43 -0
- package/dist/chunk-KDMKHR5A.js +32 -0
- package/dist/chunk-KFFNCDX6.js +19 -0
- package/dist/chunk-KKWZWP67.js +24 -0
- package/dist/chunk-KOJ5QETJ.js +8 -0
- package/dist/chunk-KPMGGE4W.js +51 -0
- package/dist/chunk-KS7DXCXH.js +27 -0
- package/dist/chunk-KSYVTEKR.js +24 -0
- package/dist/chunk-KU4YS6HN.js +61 -0
- package/dist/chunk-KYELSLDJ.js +40 -0
- package/dist/chunk-LC3PSQJJ.js +383 -0
- package/dist/chunk-LC6DYCTG.js +85 -0
- package/dist/chunk-LNKY5Z2X.js +23 -0
- package/dist/chunk-LO2DANS6.js +302 -0
- package/dist/chunk-M4SPKUZE.js +7 -0
- package/dist/chunk-M4YLED7M.js +17 -0
- package/dist/chunk-M6KTNAND.js +746 -0
- package/dist/chunk-MCOIEWW6.js +54 -0
- package/dist/chunk-MDYLOIS2.js +48 -0
- package/dist/chunk-MEISCROL.js +24 -0
- package/dist/chunk-MFLH5ZDQ.js +69 -0
- package/dist/chunk-MIXKQJ64.js +935 -0
- package/dist/chunk-MJMJEURO.js +359 -0
- package/dist/chunk-MNJ2DHU6.js +526 -0
- package/dist/chunk-NEVSQGOI.js +63 -0
- package/dist/chunk-NG5IGZXC.js +1179 -0
- package/dist/chunk-NLOMCLKI.js +3303 -0
- package/dist/chunk-NMCOUVN5.js +24 -0
- package/dist/chunk-NT3HAZYT.js +51 -0
- package/dist/chunk-NXNQQ3DS.js +382 -0
- package/dist/chunk-NYEY6W5R.js +569 -0
- package/dist/chunk-OAPCJO6W.js +23 -0
- package/dist/chunk-OH7FA4TF.js +251 -0
- package/dist/chunk-OLNORNCT.js +331 -0
- package/dist/chunk-OQEBOVUO.js +30 -0
- package/dist/chunk-ORUJI3VB.js +83 -0
- package/dist/chunk-PEN2DK7T.js +49 -0
- package/dist/chunk-PGIQMQRU.js +1650 -0
- package/dist/chunk-PTVOXB5T.js +39 -0
- package/dist/chunk-PUVGWJQ5.js +24 -0
- package/dist/chunk-PWROWDZS.js +137 -0
- package/dist/chunk-Q6XJOJTY.js +29 -0
- package/dist/chunk-QBR6IKIX.js +50 -0
- package/dist/chunk-QETGGFH2.js +30 -0
- package/dist/chunk-QG6MOQLI.js +2934 -0
- package/dist/chunk-QGCEHR6S.js +13 -0
- package/dist/chunk-QHFQHQDC.js +43 -0
- package/dist/chunk-QHRE2M6V.js +26 -0
- package/dist/chunk-QKL7IY42.js +38 -0
- package/dist/chunk-QN6JHMGU.js +44 -0
- package/dist/chunk-QNHZXFRA.js +347 -0
- package/dist/chunk-QPWRHDLZ.js +17 -0
- package/dist/chunk-QVABTUDS.js +80 -0
- package/dist/chunk-QXILAMAU.js +28 -0
- package/dist/chunk-QZAT46PP.js +95 -0
- package/dist/chunk-R3WI7ZLE.js +545 -0
- package/dist/chunk-R5SWC3EW.js +30 -0
- package/dist/chunk-RJQ5YS3Q.js +40 -0
- package/dist/chunk-RNOD2UWF.js +613 -0
- package/dist/chunk-RNXITK5M.js +24 -0
- package/dist/chunk-ROXO4R3J.js +16 -0
- package/dist/chunk-RQ5DNYLG.js +10 -0
- package/dist/chunk-RSWVH7DB.js +24 -0
- package/dist/chunk-RTJXOIIQ.js +12 -0
- package/dist/chunk-RZNYW7UP.js +133 -0
- package/dist/chunk-S4F27M7N.js +37 -0
- package/dist/chunk-S4ONWRJE.js +28 -0
- package/dist/chunk-S53OGZL6.js +168 -0
- package/dist/chunk-S5ADHIZK.js +2508 -0
- package/dist/chunk-S62M63LU.js +19 -0
- package/dist/chunk-S7VDRUED.js +62 -0
- package/dist/chunk-SGD3ZHID.js +250 -0
- package/dist/chunk-SGSPYHFE.js +40 -0
- package/dist/chunk-SLTMRTXV.js +597 -0
- package/dist/chunk-SXGTRZFN.js +26 -0
- package/dist/chunk-SZPTTNW7.js +16 -0
- package/dist/chunk-T3IGJARD.js +22 -0
- package/dist/chunk-TA3TFKYZ.js +86 -0
- package/dist/chunk-TNEHPP3H.js +18 -0
- package/dist/chunk-TPYV2FTV.js +25 -0
- package/dist/chunk-TPZB2YWR.js +25 -0
- package/dist/chunk-TSR5YDPS.js +1266 -0
- package/dist/chunk-TTR7EWNH.js +170 -0
- package/dist/chunk-TVHLKVUO.js +24 -0
- package/dist/chunk-TXINIAFL.js +198 -0
- package/dist/chunk-TXZBBZOG.js +58 -0
- package/dist/chunk-UEU46Q3D.js +300 -0
- package/dist/chunk-UMDEWWXT.js +33 -0
- package/dist/chunk-UQSVWO7Z.js +334 -0
- package/dist/chunk-UZF3G2FN.js +942 -0
- package/dist/chunk-V422EKLW.js +24 -0
- package/dist/chunk-V4DYVLOO.js +433 -0
- package/dist/chunk-V4VC25UL.js +128 -0
- package/dist/chunk-V667FCIJ.js +12 -0
- package/dist/chunk-VABRPZVC.js +43 -0
- package/dist/chunk-VB2MJLET.js +19 -0
- package/dist/chunk-VDAKTZQP.js +18 -0
- package/dist/chunk-VDAZPGR2.js +79 -0
- package/dist/chunk-VXZFQKBJ.js +21 -0
- package/dist/chunk-VYMGZ27S.js +133 -0
- package/dist/chunk-W2RGSGRR.js +131 -0
- package/dist/chunk-W7UZXD5D.js +1109 -0
- package/dist/chunk-WDUNR2VI.js +2718 -0
- package/dist/chunk-WHSTEAVP.js +229 -0
- package/dist/chunk-WJMUMN3I.js +127 -0
- package/dist/chunk-WLZ54FWG.js +120 -0
- package/dist/chunk-WMJPFLF3.js +2980 -0
- package/dist/chunk-WRHFBCVY.js +24 -0
- package/dist/chunk-WVSNSWBJ.js +47 -0
- package/dist/chunk-WYJEOMNY.js +31 -0
- package/dist/chunk-WYJMV62X.js +24 -0
- package/dist/chunk-WZGJSQKN.js +29 -0
- package/dist/chunk-WZL4EEBS.js +11 -0
- package/dist/chunk-X7TXGKRX.js +272 -0
- package/dist/chunk-XB4KZ6WO.js +81 -0
- package/dist/chunk-XDLQRSSH.js +266 -0
- package/dist/chunk-XDS4UZGR.js +113 -0
- package/dist/chunk-XEGRWWNO.js +30 -0
- package/dist/chunk-XO5ONLVM.js +420 -0
- package/dist/chunk-XPWRD424.js +24 -0
- package/dist/chunk-XTNV2YMB.js +50 -0
- package/dist/chunk-XW5J5JAX.js +42 -0
- package/dist/chunk-XY5O74BH.js +33 -0
- package/dist/chunk-XYONCO5Q.js +984 -0
- package/dist/chunk-Y4PXIJMD.js +829 -0
- package/dist/chunk-YAYRRKC7.js +24 -0
- package/dist/chunk-YEDYBMCW.js +210 -0
- package/dist/chunk-YFG4E3N2.js +1161 -0
- package/dist/chunk-YHTO46W2.js +2670 -0
- package/dist/chunk-YI2ZVTCB.js +38 -0
- package/dist/chunk-YKO3VCTF.js +24 -0
- package/dist/chunk-YP3I6W7T.js +24 -0
- package/dist/chunk-YQ2B3YVF.js +687 -0
- package/dist/chunk-YS6KMYM4.js +91 -0
- package/dist/chunk-YTSSXSZR.js +197 -0
- package/dist/chunk-Z256ACGC.js +27 -0
- package/dist/chunk-Z2MGTKDR.js +20 -0
- package/dist/chunk-Z5VSLLNY.js +23 -0
- package/dist/chunk-Z7X3RGGA.js +22 -0
- package/dist/chunk-ZF43WRG3.js +29 -0
- package/dist/chunk-ZJKOLOVF.js +1754 -0
- package/dist/chunk-ZQ4VFQID.js +76 -0
- package/dist/chunk-ZSLGN6CO.js +89 -0
- package/dist/chunk-ZVTFZF4V.js +542 -0
- package/dist/cli/index.js +9 -0
- package/dist/core-5Z6UW5DS.js +31 -0
- package/dist/core-6ANZ2OWO.js +40 -0
- package/dist/core-6LLJNZ4O.js +37 -0
- package/dist/core-CPN2HF75.js +33 -0
- package/dist/core-CS7AKNME.js +37 -0
- package/dist/core-DBRILYNB.js +38 -0
- package/dist/core-DU77ZYPR.js +34 -0
- package/dist/core-E6YD7VU4.js +32 -0
- package/dist/core-EE55P6XK.js +56 -0
- package/dist/core-FFLPH5XK.js +41 -0
- package/dist/core-IV26EL5C.js +32 -0
- package/dist/core-IZVZ2B7Y.js +34 -0
- package/dist/core-JQV7STNF.js +34 -0
- package/dist/core-KBH3EJZV.js +32 -0
- package/dist/core-KFBW5PRT.js +36 -0
- package/dist/core-KWGXHBJE.js +37 -0
- package/dist/core-MZMR2DF4.js +32 -0
- package/dist/core-OK2ZY5OJ.js +29 -0
- package/dist/core-OV5MPTZP.js +43 -0
- package/dist/core-OW5V74Q4.js +40 -0
- package/dist/core-PL64QPOH.js +57 -0
- package/dist/core-PVINU5JJ.js +33 -0
- package/dist/core-QUYSNTC7.js +34 -0
- package/dist/core-RE3L6YCM.js +29 -0
- package/dist/core-RUA3EWW3.js +39 -0
- package/dist/core-RY6IFRKM.js +35 -0
- package/dist/core-SCWEVNUY.js +34 -0
- package/dist/core-SE67HHFG.js +55 -0
- package/dist/core-T5Q4DSH2.js +32 -0
- package/dist/core-TJX3I7KH.js +37 -0
- package/dist/core-ULUA5ZB2.js +55 -0
- package/dist/core-WLVU2HWX.js +46 -0
- package/dist/core-WQPHNVNY.js +51 -0
- package/dist/core-XXIOJY2X.js +52 -0
- package/dist/core-ZH7XTJTD.js +39 -0
- package/dist/core-ZHE7N4NS.js +50 -0
- package/dist/core-ZJYLJWZQ.js +38 -0
- package/dist/dataTable-IL7HVDHL.js +58 -0
- package/dist/engine-MYLZI5VH.js +961 -0
- package/dist/fixtures.d.ts +1 -0
- package/dist/fixtures.js +40 -0
- package/dist/fontTables-ZYBUCJ5N.js +18 -0
- package/dist/fonts.d.ts +1 -0
- package/dist/fonts.js +19 -0
- package/dist/geo/dach.d.ts +1 -0
- package/dist/geo/dach.js +14 -0
- package/dist/geo/de-states.d.ts +1 -0
- package/dist/geo/de-states.js +14 -0
- package/dist/geo/eu27.d.ts +1 -0
- package/dist/geo/eu27.js +14 -0
- package/dist/geo/europe.d.ts +1 -0
- package/dist/geo/europe.js +14 -0
- package/dist/geo/index.d.ts +1 -0
- package/dist/geo/index.js +41 -0
- package/dist/geo/us-states.d.ts +1 -0
- package/dist/geo/us-states.js +14 -0
- package/dist/geo/world.d.ts +1 -0
- package/dist/geo/world.js +14 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +363 -0
- package/dist/main-ISJ53IS5.js +568 -0
- package/dist/mcp/server.js +1023 -0
- package/dist/module-SVEW5ZUE.js +137233 -0
- package/dist/react/bar.d.ts +1 -0
- package/dist/react/bar.js +80 -0
- package/dist/react/bartable.d.ts +1 -0
- package/dist/react/bartable.js +70 -0
- package/dist/react/box.d.ts +1 -0
- package/dist/react/box.js +64 -0
- package/dist/react/bullet.d.ts +1 -0
- package/dist/react/bullet.js +71 -0
- package/dist/react/butterfly.d.ts +1 -0
- package/dist/react/butterfly.js +65 -0
- package/dist/react/choropleth.d.ts +1 -0
- package/dist/react/choropleth.js +67 -0
- package/dist/react/cohort.d.ts +1 -0
- package/dist/react/cohort.js +69 -0
- package/dist/react/column.d.ts +1 -0
- package/dist/react/column.js +85 -0
- package/dist/react/combo.d.ts +1 -0
- package/dist/react/combo.js +85 -0
- package/dist/react/creative.d.ts +1 -0
- package/dist/react/creative.js +61 -0
- package/dist/react/diagram.d.ts +1 -0
- package/dist/react/diagram.js +60 -0
- package/dist/react/dimswitch.d.ts +1 -0
- package/dist/react/dimswitch.js +71 -0
- package/dist/react/dot.d.ts +1 -0
- package/dist/react/dot.js +69 -0
- package/dist/react/export.d.ts +1 -0
- package/dist/react/export.js +657 -0
- package/dist/react/funnel.d.ts +1 -0
- package/dist/react/funnel.js +62 -0
- package/dist/react/gantt.d.ts +1 -0
- package/dist/react/gantt.js +62 -0
- package/dist/react/grid.d.ts +1 -0
- package/dist/react/grid.js +66 -0
- package/dist/react/heatmap.d.ts +1 -0
- package/dist/react/heatmap.js +67 -0
- package/dist/react/histogram.d.ts +1 -0
- package/dist/react/histogram.js +85 -0
- package/dist/react/index.d.ts +1 -0
- package/dist/react/index.js +503 -0
- package/dist/react/kpi.d.ts +1 -0
- package/dist/react/kpi.js +67 -0
- package/dist/react/likert.d.ts +1 -0
- package/dist/react/likert.js +82 -0
- package/dist/react/line.d.ts +1 -0
- package/dist/react/line.js +80 -0
- package/dist/react/mekko.d.ts +1 -0
- package/dist/react/mekko.js +70 -0
- package/dist/react/pareto.d.ts +1 -0
- package/dist/react/pareto.js +89 -0
- package/dist/react/pie.d.ts +1 -0
- package/dist/react/pie.js +63 -0
- package/dist/react/prepare.d.ts +1 -0
- package/dist/react/prepare.js +277 -0
- package/dist/react/pvm.d.ts +1 -0
- package/dist/react/pvm.js +67 -0
- package/dist/react/pyramid.d.ts +1 -0
- package/dist/react/pyramid.js +66 -0
- package/dist/react/sankey.d.ts +1 -0
- package/dist/react/sankey.js +59 -0
- package/dist/react/scatter.d.ts +1 -0
- package/dist/react/scatter.js +62 -0
- package/dist/react/slope.d.ts +1 -0
- package/dist/react/slope.js +63 -0
- package/dist/react/sparkline.d.ts +1 -0
- package/dist/react/sparkline.js +59 -0
- package/dist/react/spec.d.ts +1 -0
- package/dist/react/spec.js +370 -0
- package/dist/react/status.d.ts +1 -0
- package/dist/react/status.js +64 -0
- package/dist/react/story.d.ts +1 -0
- package/dist/react/story.js +140 -0
- package/dist/react/table.d.ts +1 -0
- package/dist/react/table.js +68 -0
- package/dist/react/theme.d.ts +1 -0
- package/dist/react/theme.js +53 -0
- package/dist/react/tilemap.d.ts +1 -0
- package/dist/react/tilemap.js +66 -0
- package/dist/react/treemap.d.ts +1 -0
- package/dist/react/treemap.js +61 -0
- package/dist/react/variance.d.ts +1 -0
- package/dist/react/variance.js +64 -0
- package/dist/react/waffle.d.ts +1 -0
- package/dist/react/waffle.js +62 -0
- package/dist/react/waterfall.d.ts +1 -0
- package/dist/react/waterfall.js +67 -0
- package/dist/resvg-ZOVDIZTV.js +23 -0
- package/dist/rows.d.ts +1 -0
- package/dist/rows.js +23 -0
- package/dist/rowsModule-3Y4I3M3E.js +27 -0
- package/dist/schema-2BMZOHXI.js +22 -0
- package/dist/schema-2GUBWOBC.js +26 -0
- package/dist/schema-34ZELWRQ.js +25 -0
- package/dist/schema-3BHL2B76.js +22 -0
- package/dist/schema-4735XAZX.js +29 -0
- package/dist/schema-5YTNQ6JY.js +22 -0
- package/dist/schema-7J3NAIN2.js +27 -0
- package/dist/schema-AOJJ7JZB.js +22 -0
- package/dist/schema-CVMV4LRA.js +22 -0
- package/dist/schema-D3RCMN3T.js +22 -0
- package/dist/schema-E2ISJ65D.js +23 -0
- package/dist/schema-E6YOSOWB.js +28 -0
- package/dist/schema-EQQB43AY.js +22 -0
- package/dist/schema-EVLLL5UF.js +22 -0
- package/dist/schema-EYQ5IBLF.js +23 -0
- package/dist/schema-EYZVD73N.js +22 -0
- package/dist/schema-G4KFMQBL.js +22 -0
- package/dist/schema-GH7IKSOU.js +23 -0
- package/dist/schema-IF5N3J56.js +42 -0
- package/dist/schema-IG7JIR4H.js +23 -0
- package/dist/schema-JJYJOQTT.js +23 -0
- package/dist/schema-KFC4WYH4.js +32 -0
- package/dist/schema-L7263JMT.js +25 -0
- package/dist/schema-MEAFRXVH.js +53 -0
- package/dist/schema-P63S63GE.js +23 -0
- package/dist/schema-P7LJFJAJ.js +22 -0
- package/dist/schema-PA2MXYY4.js +23 -0
- package/dist/schema-PDZ6256H.js +23 -0
- package/dist/schema-PNC3Z7AH.js +25 -0
- package/dist/schema-QEVSIMGO.js +22 -0
- package/dist/schema-QJJPRRE7.js +22 -0
- package/dist/schema-S3EQKVOT.js +23 -0
- package/dist/schema-STGL44TL.js +22 -0
- package/dist/schema-T4NE2EAO.js +22 -0
- package/dist/schema-TQYTESG3.js +22 -0
- package/dist/schema-W376PAJG.js +22 -0
- package/dist/schema-XYYDUUHS.js +26 -0
- package/dist/specValidation-NVBIZMEE.js +48 -0
- package/dist/theme.d.ts +1 -0
- package/dist/theme.js +24 -0
- package/dist/themeShapeRules-5C2463YH.js +11 -0
- package/dist/types/core/a11y/accessibility.d.ts +43 -0
- package/dist/types/core/a11y/recordsShared.d.ts +44 -0
- package/dist/types/core/a11y/structuralRecords.d.ts +6 -0
- package/dist/types/core/a11y/types.d.ts +116 -0
- package/dist/types/core/annotate.d.ts +300 -0
- package/dist/types/core/annotateArms.d.ts +37 -0
- package/dist/types/core/annotateFields.d.ts +30 -0
- package/dist/types/core/annotateGapBracket.d.ts +66 -0
- package/dist/types/core/annotateLinks.d.ts +47 -0
- package/dist/types/core/annotateTargets.d.ts +90 -0
- package/dist/types/core/axis.d.ts +179 -0
- package/dist/types/core/bandSelect.d.ts +10 -0
- package/dist/types/core/bands.d.ts +14 -0
- package/dist/types/core/calendarLabels.d.ts +101 -0
- package/dist/types/core/charts/band/stacks.d.ts +155 -0
- package/dist/types/core/charts/bar/fixtures.d.ts +9 -0
- package/dist/types/core/charts/bar/layout.d.ts +95 -0
- package/dist/types/core/charts/bartable/fixtures.d.ts +4 -0
- package/dist/types/core/charts/bartable/types.d.ts +192 -0
- package/dist/types/core/charts/box/fixtures.d.ts +12 -0
- package/dist/types/core/charts/box/types.d.ts +110 -0
- package/dist/types/core/charts/bullet/fixtures.d.ts +11 -0
- package/dist/types/core/charts/butterfly/fixtures.d.ts +9 -0
- package/dist/types/core/charts/choropleth/fixtures.d.ts +3 -0
- package/dist/types/core/charts/choropleth/overlayTypes.d.ts +68 -0
- package/dist/types/core/charts/choropleth/types.d.ts +117 -0
- package/dist/types/core/charts/cohort/fixtures.d.ts +12 -0
- package/dist/types/core/charts/cohort/types.d.ts +165 -0
- package/dist/types/core/charts/column/anomaly.d.ts +204 -0
- package/dist/types/core/charts/column/fixtures.d.ts +12 -0
- package/dist/types/core/charts/column/layout.d.ts +116 -0
- package/dist/types/core/charts/column/model.d.ts +295 -0
- package/dist/types/core/charts/column/types.d.ts +56 -0
- package/dist/types/core/charts/combo/endpoints.d.ts +165 -0
- package/dist/types/core/charts/combo/fixtures.d.ts +12 -0
- package/dist/types/core/charts/combo/layout.d.ts +48 -0
- package/dist/types/core/charts/creative/fixtures.d.ts +4 -0
- package/dist/types/core/charts/creative/types.d.ts +73 -0
- package/dist/types/core/charts/diagram/fixtures.d.ts +3 -0
- package/dist/types/core/charts/dimswitch/compile.d.ts +20 -0
- package/dist/types/core/charts/dimswitch/fixtures.d.ts +3 -0
- package/dist/types/core/charts/dimswitch/types.d.ts +152 -0
- package/dist/types/core/charts/dot/fixtures.d.ts +11 -0
- package/dist/types/core/charts/funnel/fixtures.d.ts +11 -0
- package/dist/types/core/charts/gantt/fixtures.d.ts +9 -0
- package/dist/types/core/charts/gantt/layout.d.ts +56 -0
- package/dist/types/core/charts/grid/fixtures.d.ts +3 -0
- package/dist/types/core/charts/grid/metricStack.d.ts +108 -0
- package/dist/types/core/charts/grid/metricStackSchema.d.ts +74 -0
- package/dist/types/core/charts/grid/normalize.d.ts +99 -0
- package/dist/types/core/charts/grid/schema.d.ts +168 -0
- package/dist/types/core/charts/heatmap/fixtures.d.ts +11 -0
- package/dist/types/core/charts/histogram/fixtures.d.ts +15 -0
- package/dist/types/core/charts/histogram/types.d.ts +98 -0
- package/dist/types/core/charts/kpi/fixtures.d.ts +9 -0
- package/dist/types/core/charts/likert/fixtures.d.ts +11 -0
- package/dist/types/core/charts/likert/layout.d.ts +111 -0
- package/dist/types/core/charts/line/fixtures.d.ts +16 -0
- package/dist/types/core/charts/line/types.d.ts +6 -0
- package/dist/types/core/charts/mekko/fixtures.d.ts +13 -0
- package/dist/types/core/charts/pareto/fixtures.d.ts +5 -0
- package/dist/types/core/charts/pareto/layout.d.ts +68 -0
- package/dist/types/core/charts/pie/fixtures.d.ts +14 -0
- package/dist/types/core/charts/pvm/fixtures.d.ts +13 -0
- package/dist/types/core/charts/pvm/types.d.ts +118 -0
- package/dist/types/core/charts/pyramid/fixtures.d.ts +4 -0
- package/dist/types/core/charts/pyramid/types.d.ts +92 -0
- package/dist/types/core/charts/sankey/fixtures.d.ts +4 -0
- package/dist/types/core/charts/sankey/types.d.ts +116 -0
- package/dist/types/core/charts/scatter/fixtures.d.ts +12 -0
- package/dist/types/core/charts/scatter/types.d.ts +58 -0
- package/dist/types/core/charts/slope/fixtures.d.ts +13 -0
- package/dist/types/core/charts/sparkline/fixtures.d.ts +9 -0
- package/dist/types/core/charts/status/fixtures.d.ts +8 -0
- package/dist/types/core/charts/status/layout.d.ts +71 -0
- package/dist/types/core/charts/table/fitFormats.d.ts +67 -0
- package/dist/types/core/charts/table/fixtures.d.ts +7 -0
- package/dist/types/core/charts/table/resolve.d.ts +72 -0
- package/dist/types/core/charts/table/view.d.ts +156 -0
- package/dist/types/core/charts/tilemap/fixtures.d.ts +3 -0
- package/dist/types/core/charts/tilemap/types.d.ts +94 -0
- package/dist/types/core/charts/treemap/fixtures.d.ts +4 -0
- package/dist/types/core/charts/treemap/types.d.ts +78 -0
- package/dist/types/core/charts/variance/fixtures.d.ts +12 -0
- package/dist/types/core/charts/waffle/fixtures.d.ts +5 -0
- package/dist/types/core/charts/waffle/types.d.ts +117 -0
- package/dist/types/core/charts/waterfall/fixtures.d.ts +9 -0
- package/dist/types/core/claims/browser.d.ts +49 -0
- package/dist/types/core/claims/manifest.d.ts +22 -0
- package/dist/types/core/dateFormat.d.ts +39 -0
- package/dist/types/core/deferred.d.ts +121 -0
- package/dist/types/core/diagnostics/describe.d.ts +149 -0
- package/dist/types/core/diagnostics/jsonPatch.d.ts +36 -0
- package/dist/types/core/doc/bareChart.d.ts +2 -0
- package/dist/types/core/doc/diagnostics.d.ts +124 -0
- package/dist/types/core/doc/docExpand.d.ts +39 -0
- package/dist/types/core/doc/document.d.ts +43 -0
- package/dist/types/core/doc/ownedDocumentCopy.d.ts +5 -0
- package/dist/types/core/doc/specError.d.ts +6 -0
- package/dist/types/core/emptyData.d.ts +27 -0
- package/dist/types/core/eventLane.d.ts +208 -0
- package/dist/types/core/fontMetrics/index.d.ts +47 -0
- package/dist/types/core/fontMetrics/injected.d.ts +40 -0
- package/dist/types/core/fontMetrics/tableDocument.d.ts +73 -0
- package/dist/types/core/fontMetrics/tables.generated.d.ts +17 -0
- package/dist/types/core/footer.d.ts +59 -0
- package/dist/types/core/format.d.ts +149 -0
- package/dist/types/core/formatPrecision.d.ts +136 -0
- package/dist/types/core/formatSpec.d.ts +302 -0
- package/dist/types/core/frame.d.ts +583 -0
- package/dist/types/core/geo/packs/all.d.ts +7 -0
- package/dist/types/core/geo/packs/dach.d.ts +16 -0
- package/dist/types/core/geo/packs/de-states.d.ts +16 -0
- package/dist/types/core/geo/packs/eu27.d.ts +16 -0
- package/dist/types/core/geo/packs/europe.d.ts +16 -0
- package/dist/types/core/geo/packs/index.d.ts +22 -0
- package/dist/types/core/geo/packs/registry.d.ts +37 -0
- package/dist/types/core/geo/packs/us-states.d.ts +16 -0
- package/dist/types/core/geo/packs/world.d.ts +16 -0
- package/dist/types/core/geo/tiles/eu27.generated.d.ts +412 -0
- package/dist/types/core/geo/tiles/europe.generated.d.ts +842 -0
- package/dist/types/core/geo/tiles/index.d.ts +8 -0
- package/dist/types/core/geo/tiles/types.d.ts +36 -0
- package/dist/types/core/geo/tiles/us-states.generated.d.ts +952 -0
- package/dist/types/core/geo/tiles/world.generated.d.ts +968 -0
- package/dist/types/core/geo/types.d.ts +146 -0
- package/dist/types/core/geometry.d.ts +102 -0
- package/dist/types/core/grid/sharedScale.d.ts +82 -0
- package/dist/types/core/icons.d.ts +227 -0
- package/dist/types/core/inputError.d.ts +14 -0
- package/dist/types/core/isoDate.d.ts +2 -0
- package/dist/types/core/isoTime.d.ts +7 -0
- package/dist/types/core/label/categoryRow.d.ts +332 -0
- package/dist/types/core/label/occupied.d.ts +41 -0
- package/dist/types/core/label/ownership.d.ts +83 -0
- package/dist/types/core/label/solver.d.ts +380 -0
- package/dist/types/core/label/tickRow.d.ts +78 -0
- package/dist/types/core/live/types.d.ts +50 -0
- package/dist/types/core/normalize/shared.d.ts +56 -0
- package/dist/types/core/notes.d.ts +174 -0
- package/dist/types/core/othersShade.d.ts +9 -0
- package/dist/types/core/periodYears.d.ts +9 -0
- package/dist/types/core/polyline.d.ts +11 -0
- package/dist/types/core/rangeRules.d.ts +19 -0
- package/dist/types/core/ratioTier.d.ts +120 -0
- package/dist/types/core/readerStrings.d.ts +13 -0
- package/dist/types/core/reading.d.ts +120 -0
- package/dist/types/core/registry.d.ts +178 -0
- package/dist/types/core/repaintGeometry.d.ts +19 -0
- package/dist/types/core/request.d.ts +124 -0
- package/dist/types/core/rows.d.ts +45 -0
- package/dist/types/core/scale.d.ts +106 -0
- package/dist/types/core/schema/capability.d.ts +229 -0
- package/dist/types/core/schema/namedColumns.d.ts +45 -0
- package/dist/types/core/schema/reference.d.ts +31 -0
- package/dist/types/core/schema/refusals.d.ts +45 -0
- package/dist/types/core/schema/unknownKeys.d.ts +45 -0
- package/dist/types/core/seriesIdentity.d.ts +120 -0
- package/dist/types/core/shareRounding.d.ts +49 -0
- package/dist/types/core/sizing.d.ts +330 -0
- package/dist/types/core/staticFooter.d.ts +6 -0
- package/dist/types/core/story.d.ts +41 -0
- package/dist/types/core/structureCounts.d.ts +10 -0
- package/dist/types/core/svg/renderSvg.d.ts +51 -0
- package/dist/types/core/target.d.ts +89 -0
- package/dist/types/core/text.d.ts +113 -0
- package/dist/types/core/theme.d.ts +478 -0
- package/dist/types/core/themeFields.d.ts +11 -0
- package/dist/types/core/themeRules.d.ts +111 -0
- package/dist/types/core/themeShape.d.ts +87 -0
- package/dist/types/core/themeValidate.d.ts +15 -0
- package/dist/types/core/timeAxis.d.ts +106 -0
- package/dist/types/core/types/annotations.d.ts +223 -0
- package/dist/types/core/types/cell.d.ts +82 -0
- package/dist/types/core/types/data.d.ts +309 -0
- package/dist/types/core/types/diagram.d.ts +234 -0
- package/dist/types/core/types/index.d.ts +8 -0
- package/dist/types/core/types/options.d.ts +1583 -0
- package/dist/types/core/types/scene.d.ts +990 -0
- package/dist/types/core/types/sizing.d.ts +51 -0
- package/dist/types/core/types/table.d.ts +873 -0
- package/dist/types/core/types/theme.d.ts +806 -0
- package/dist/types/core/zoom.d.ts +106 -0
- package/dist/types/fixtures/index.d.ts +40 -0
- package/dist/types/fixtures/registry.d.ts +15 -0
- package/dist/types/fonts.d.ts +10 -0
- package/dist/types/index.d.ts +70 -0
- package/dist/types/react/BoardplotTheme.d.ts +9 -0
- package/dist/types/react/DimSwitchChart.d.ts +36 -0
- package/dist/types/react/ScaleGroup.d.ts +31 -0
- package/dist/types/react/SceneRenderer.d.ts +23 -0
- package/dist/types/react/SizePlaceholder.d.ts +51 -0
- package/dist/types/react/StoryFrame.d.ts +42 -0
- package/dist/types/react/TableChart.d.ts +220 -0
- package/dist/types/react/a11ySurface.d.ts +20 -0
- package/dist/types/react/barrelCharts.d.ts +1023 -0
- package/dist/types/react/charts/bar.d.ts +28 -0
- package/dist/types/react/charts/bartable.d.ts +27 -0
- package/dist/types/react/charts/box.d.ts +27 -0
- package/dist/types/react/charts/bullet.d.ts +28 -0
- package/dist/types/react/charts/butterfly.d.ts +28 -0
- package/dist/types/react/charts/choropleth.d.ts +27 -0
- package/dist/types/react/charts/cohort.d.ts +52 -0
- package/dist/types/react/charts/column.d.ts +27 -0
- package/dist/types/react/charts/combo.d.ts +7 -0
- package/dist/types/react/charts/creative.d.ts +27 -0
- package/dist/types/react/charts/diagram.d.ts +162 -0
- package/dist/types/react/charts/dimswitch.d.ts +6 -0
- package/dist/types/react/charts/dot.d.ts +28 -0
- package/dist/types/react/charts/funnel.d.ts +28 -0
- package/dist/types/react/charts/gantt.d.ts +28 -0
- package/dist/types/react/charts/grid.d.ts +29 -0
- package/dist/types/react/charts/heatmap.d.ts +28 -0
- package/dist/types/react/charts/histogram.d.ts +27 -0
- package/dist/types/react/charts/kpi.d.ts +28 -0
- package/dist/types/react/charts/likert.d.ts +27 -0
- package/dist/types/react/charts/line.d.ts +28 -0
- package/dist/types/react/charts/mekko.d.ts +28 -0
- package/dist/types/react/charts/pareto.d.ts +28 -0
- package/dist/types/react/charts/pie.d.ts +28 -0
- package/dist/types/react/charts/pvm.d.ts +27 -0
- package/dist/types/react/charts/pyramid.d.ts +27 -0
- package/dist/types/react/charts/sankey.d.ts +27 -0
- package/dist/types/react/charts/scatter.d.ts +28 -0
- package/dist/types/react/charts/slope.d.ts +28 -0
- package/dist/types/react/charts/sparkline.d.ts +28 -0
- package/dist/types/react/charts/status.d.ts +27 -0
- package/dist/types/react/charts/table.d.ts +6 -0
- package/dist/types/react/charts/tilemap.d.ts +27 -0
- package/dist/types/react/charts/treemap.d.ts +27 -0
- package/dist/types/react/charts/variance.d.ts +28 -0
- package/dist/types/react/charts/waffle.d.ts +28 -0
- package/dist/types/react/charts/waterfall.d.ts +28 -0
- package/dist/types/react/createChartComponent.d.ts +135 -0
- package/dist/types/react/export/clipboard.d.ts +8 -0
- package/dist/types/react/export/csv.d.ts +2 -0
- package/dist/types/react/export/frame.d.ts +35 -0
- package/dist/types/react/export/index.d.ts +7 -0
- package/dist/types/react/export/png.d.ts +14 -0
- package/dist/types/react/export/svg.d.ts +5 -0
- package/dist/types/react/export/types.d.ts +69 -0
- package/dist/types/react/export/useExport.d.ts +17 -0
- package/dist/types/react/exportLink.d.ts +49 -0
- package/dist/types/react/footerFrame.d.ts +25 -0
- package/dist/types/react/hover/dataTable.d.ts +13 -0
- package/dist/types/react/hover/engine.d.ts +210 -0
- package/dist/types/react/hover/keyboard.d.ts +44 -0
- package/dist/types/react/hover/labelCard.d.ts +170 -0
- package/dist/types/react/hover/placement.d.ts +49 -0
- package/dist/types/react/index.d.ts +16 -0
- package/dist/types/react/parseChartSpec.d.ts +16 -0
- package/dist/types/react/prepare.d.ts +32 -0
- package/dist/types/react/prepared.d.ts +53 -0
- package/dist/types/react/preparedTable.d.ts +15 -0
- package/dist/types/react/rowsInput.d.ts +55 -0
- package/dist/types/react/rowsModule.d.ts +18 -0
- package/dist/types/react/rowsStore.d.ts +50 -0
- package/dist/types/react/scale-group.d.ts +2 -0
- package/dist/types/react/scaleGroupContext.d.ts +22 -0
- package/dist/types/react/scenePaint.d.ts +10 -0
- package/dist/types/react/scrollState.d.ts +26 -0
- package/dist/types/react/spec.d.ts +65 -0
- package/dist/types/react/specValidation.d.ts +45 -0
- package/dist/types/react/story.d.ts +15 -0
- package/dist/types/react/theme.d.ts +9 -0
- package/dist/types/react/themeContext.d.ts +44 -0
- package/dist/types/react/useChartLayout.d.ts +22 -0
- package/dist/types/react/useContainerSize.d.ts +57 -0
- package/dist/types/react/useHover.d.ts +100 -0
- package/dist/types/react/useZoom.d.ts +50 -0
- package/dist/types/rows.d.ts +58 -0
- package/dist/types/tableLooks.d.ts +6 -0
- package/dist/types/theme.d.ts +3 -0
- package/dist/types/validate.d.ts +3 -0
- package/dist/validate.d.ts +1 -0
- package/dist/validate.js +222 -0
- package/docs/FONTS.md +68 -0
- package/docs/TELEMETRY.md +94 -0
- package/docs/manual.md +838 -0
- package/docs/reference/bar.md +222 -0
- package/docs/reference/bartable.md +143 -0
- package/docs/reference/box.md +93 -0
- package/docs/reference/bullet.md +118 -0
- package/docs/reference/butterfly.md +117 -0
- package/docs/reference/choropleth.md +148 -0
- package/docs/reference/cohort.md +149 -0
- package/docs/reference/column.md +275 -0
- package/docs/reference/combo.md +219 -0
- package/docs/reference/creative.md +147 -0
- package/docs/reference/diagram.md +191 -0
- package/docs/reference/dimswitch.md +1395 -0
- package/docs/reference/dot.md +117 -0
- package/docs/reference/fixtures.md +1088 -0
- package/docs/reference/funnel.md +121 -0
- package/docs/reference/gantt.md +132 -0
- package/docs/reference/grid.md +302 -0
- package/docs/reference/heatmap.md +127 -0
- package/docs/reference/histogram.md +77 -0
- package/docs/reference/kpi.md +115 -0
- package/docs/reference/likert.md +113 -0
- package/docs/reference/line.md +436 -0
- package/docs/reference/mekko.md +114 -0
- package/docs/reference/options.md +313 -0
- package/docs/reference/pareto.md +102 -0
- package/docs/reference/pie.md +114 -0
- package/docs/reference/pvm.md +114 -0
- package/docs/reference/pyramid.md +99 -0
- package/docs/reference/react.md +703 -0
- package/docs/reference/reading.md +28 -0
- package/docs/reference/sankey.md +110 -0
- package/docs/reference/scatter.md +211 -0
- package/docs/reference/slope.md +126 -0
- package/docs/reference/sparkline.md +74 -0
- package/docs/reference/status.md +107 -0
- package/docs/reference/table.md +673 -0
- package/docs/reference/theme.md +361 -0
- package/docs/reference/tilemap.md +121 -0
- package/docs/reference/treemap.md +86 -0
- package/docs/reference/variance.md +126 -0
- package/docs/reference/waffle.md +106 -0
- package/docs/reference/waterfall.md +164 -0
- package/llms.txt +57 -0
- package/package.json +437 -4
|
@@ -0,0 +1,1583 @@
|
|
|
1
|
+
/** Options. */
|
|
2
|
+
import type { LiveWindowOptions } from '../live/types.js';
|
|
3
|
+
import type { Margin } from '../geometry.js';
|
|
4
|
+
import type { TextMeasurer } from '../text.js';
|
|
5
|
+
import type { Direction, Id, OwnerRef, Scenario } from './cell.js';
|
|
6
|
+
import type { SlotId } from './cell.js';
|
|
7
|
+
import type { LineSeriesTarget, VarianceSpec } from './data.js';
|
|
8
|
+
import type { Annotation, EventOptions } from './annotations.js';
|
|
9
|
+
import type { OthersShade } from '../othersShade.js';
|
|
10
|
+
import type { ThemeRef } from './theme.js';
|
|
11
|
+
import type { OPTION_CAPABILITY, VALUE_AXIS_CAPABILITY, VALUE_AXIS_ONLY } from '../schema/capability.js';
|
|
12
|
+
export type RenderTarget = 'report' | 'dashboard' | 'slide' | 'print';
|
|
13
|
+
export type LengthUnit = 'px' | 'pt' | 'mm';
|
|
14
|
+
export type SizePreset = 'slide-16x9' | 'slide-4x3' | 'a4' | 'dashboard' | 'a4-landscape-content' | 'a4-portrait-content';
|
|
15
|
+
export type CanvasSizeInput = SizePreset | {
|
|
16
|
+
width: number;
|
|
17
|
+
height?: number;
|
|
18
|
+
unit?: LengthUnit;
|
|
19
|
+
};
|
|
20
|
+
export { SIZE_PRESETS } from '../target.js';
|
|
21
|
+
export type LabelDensity = 'full' | 'smart' | 'minimal';
|
|
22
|
+
export type SortOrder = 'sheet' | 'asc' | 'desc' | 'reverse';
|
|
23
|
+
export type LabelKind = 'category' | 'series' | 'segment' | 'point' | 'total' | 'grandTotal' | 'insidePie' | 'outsidePie' | 'percentIndicator' | 'restSeries' | 'tick' | 'axisTitle' | 'valueLine' | 'annotation' | 'growth' | 'activity' | 'item' | 'scale';
|
|
24
|
+
export type LabelContent = ('absolute' | 'percent' | 'category' | 'series')[];
|
|
25
|
+
export interface Subtitle {
|
|
26
|
+
company?: string;
|
|
27
|
+
measure: string;
|
|
28
|
+
period?: string;
|
|
29
|
+
/**
|
|
30
|
+
* Scenario codes appended to the subtitle as their own segment, joined
|
|
31
|
+
* with " vs " ("AC vs PL"). `subtitleSchema` accepts
|
|
32
|
+
* `z.array(z.string())` and `formatScenarios` joins whatever it is given, so the
|
|
33
|
+
* runtime renders any string here; `Scenario[]` alone rejected documents the
|
|
34
|
+
* renderer draws (`scenarios: ['Q1']`). The `string & {}` member keeps the
|
|
35
|
+
* four scenario codes in autocomplete without narrowing the accepted domain.
|
|
36
|
+
*/
|
|
37
|
+
scenarios?: (Scenario | (string & {}))[];
|
|
38
|
+
}
|
|
39
|
+
export interface LocaleSpec {
|
|
40
|
+
/** BCP 47 tag ('de', 'fr-FR'). Changes words only, such as notes and month names; English when absent. It never changes the decimal or grouping marks. */
|
|
41
|
+
language?: string;
|
|
42
|
+
/** Decimal mark of every number the chart prints. Default '.'. The language does not change it. */
|
|
43
|
+
decimal?: '.' | ',';
|
|
44
|
+
/** Grouping mark of every number the chart prints. Default ',', or '.' with decimal ','. A value equal to the decimal mark uses that fallback. */
|
|
45
|
+
thousands?: ',' | '.' | '’' | ' ';
|
|
46
|
+
minusGlyph?: '−' | '-';
|
|
47
|
+
weekStartsOn?: 0 | 1;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Wording for labels the renderer composes itself. Every key is optional and
|
|
51
|
+
* the locale default stands in when the key is absent. Unsupported languages use English. Authored chart text is
|
|
52
|
+
* never rewritten, and an explicit caller option (topN.restLabel, options.source,
|
|
53
|
+
* a host legend-disclosure template) keeps precedence over this block.
|
|
54
|
+
*/
|
|
55
|
+
export interface StringsSpec {
|
|
56
|
+
/** PVM bridge entry and exit bar names. Defaults New items and Lost items. */
|
|
57
|
+
newItems?: string;
|
|
58
|
+
lostItems?: string;
|
|
59
|
+
/** Cohort measure name and its count-based formula. Defaults describe retention. */
|
|
60
|
+
cohortMeasure?: string;
|
|
61
|
+
cohortFormula?: string;
|
|
62
|
+
/** Name of the aggregated rest bucket on pie, column, bar, mekko and butterfly. Default 'Others'. */
|
|
63
|
+
others?: string;
|
|
64
|
+
/** Label of a computed total row, such as the cohort exhibit total. Default 'Total'. */
|
|
65
|
+
total?: string;
|
|
66
|
+
/** Word introducing the authored source credit in the frame. Default 'Source'. */
|
|
67
|
+
source?: string;
|
|
68
|
+
/** Not applicable value; default 'n/a' (German 'k. A.'). */
|
|
69
|
+
notApplicable?: string;
|
|
70
|
+
/** Series or category legend disclosure; '{count}' becomes '2 of 4'. Default '<count> series shown'. */
|
|
71
|
+
legendCount?: string;
|
|
72
|
+
/** Partial hatch key label without a category name; default 'Partial'. A category-naming key uses toDate. */
|
|
73
|
+
partial?: string;
|
|
74
|
+
/** Meaning of a better sign-coloured value. */
|
|
75
|
+
better?: string;
|
|
76
|
+
/** Meaning of a worse sign-coloured value. */
|
|
77
|
+
worse?: string;
|
|
78
|
+
/** Name of a mixed-sign stack positive boundary. */
|
|
79
|
+
positiveTotal?: string;
|
|
80
|
+
/** Range method note. */
|
|
81
|
+
rangeMidNote?: string;
|
|
82
|
+
/** Tornado method note. */
|
|
83
|
+
sensitivityNote?: string;
|
|
84
|
+
/** Tornado base mismatch note. */
|
|
85
|
+
hatchedBaseNote?: string;
|
|
86
|
+
/** Tornado missing output note; {drivers} is replaced. */
|
|
87
|
+
missingSwingNote?: string;
|
|
88
|
+
/** Focused bump note. */
|
|
89
|
+
rankOmitted?: string;
|
|
90
|
+
/** A missing bump rank. */
|
|
91
|
+
noRank?: string;
|
|
92
|
+
/** Bump method note; {direction}, {format}, and {ring} are replaced. */
|
|
93
|
+
rankMethod?: string;
|
|
94
|
+
/** Direction of a bump rank. */
|
|
95
|
+
higherBetter?: string;
|
|
96
|
+
/** Direction of a bump rank. */
|
|
97
|
+
lowerBetter?: string;
|
|
98
|
+
/** Format clause in the bump method note. */
|
|
99
|
+
rankFormat?: string;
|
|
100
|
+
/** Tie clause in the bump method note. */
|
|
101
|
+
rankRing?: string;
|
|
102
|
+
/** Note for folded zero line ends. */
|
|
103
|
+
nearZeroNote?: string;
|
|
104
|
+
/** Anomaly marker key. */
|
|
105
|
+
flagged?: string;
|
|
106
|
+
/** Anomaly rule key. */
|
|
107
|
+
corridor?: string;
|
|
108
|
+
/** Authored anomaly bounds key. */
|
|
109
|
+
corridorBounds?: string;
|
|
110
|
+
/** Anomaly median rule label and key. */
|
|
111
|
+
median?: string;
|
|
112
|
+
/** Small-sample anomaly sentence. */
|
|
113
|
+
anomalySmallSample?: string;
|
|
114
|
+
/** Zero-MAD anomaly sentence. */
|
|
115
|
+
anomalyZeroMad?: string;
|
|
116
|
+
/** MAD anomaly sentence; preserves the full calculation. */
|
|
117
|
+
anomalyMadRule?: string;
|
|
118
|
+
/** Zero-centred anomaly rule clause. */
|
|
119
|
+
anomalyCentreZero?: string;
|
|
120
|
+
/** Median-centred anomaly rule clause. */
|
|
121
|
+
anomalyCentreMedian?: string;
|
|
122
|
+
/** Threshold anomaly sentence. */
|
|
123
|
+
anomalyThresholdRule?: string;
|
|
124
|
+
/** Two-sided threshold clause. */
|
|
125
|
+
outsideBounds?: string;
|
|
126
|
+
/** Lower threshold clause. */
|
|
127
|
+
belowBound?: string;
|
|
128
|
+
/** Upper threshold clause. */
|
|
129
|
+
aboveBound?: string;
|
|
130
|
+
/** Off-scale lower corridor bound. */
|
|
131
|
+
lowerBound?: string;
|
|
132
|
+
/** Off-scale upper corridor bound. */
|
|
133
|
+
upperBound?: string;
|
|
134
|
+
/** Off-scale corridor note. */
|
|
135
|
+
undrawnBounds?: string;
|
|
136
|
+
/** Heading of the note for hidden chart labels. */
|
|
137
|
+
hiddenLabels?: string;
|
|
138
|
+
/** Pointer to one hidden note. */
|
|
139
|
+
noteOne?: string;
|
|
140
|
+
/** Pointer to hidden notes. */
|
|
141
|
+
noteMany?: string;
|
|
142
|
+
/** React notes panel label. */
|
|
143
|
+
notesAndSources?: string;
|
|
144
|
+
/** Label of the Close control in the React notes panel. */
|
|
145
|
+
close?: string;
|
|
146
|
+
/** Word before a map credit in the React notes panel. */
|
|
147
|
+
mapCredit?: string;
|
|
148
|
+
/** Key for a gap between two lines. */
|
|
149
|
+
gapBetween?: string;
|
|
150
|
+
/** Positive line gap key. */
|
|
151
|
+
aboveSeries?: string;
|
|
152
|
+
/** Negative line gap key. */
|
|
153
|
+
belowSeries?: string;
|
|
154
|
+
/** Name before a computed mean; English Average, German Ø. */
|
|
155
|
+
average?: string;
|
|
156
|
+
/** Tolerance-band bounds. Fields: {v1}, {v2}. */
|
|
157
|
+
valueLineRange?: string;
|
|
158
|
+
/** Text after a running category name in its key or note. */
|
|
159
|
+
toDate?: string;
|
|
160
|
+
/** Key for the forecast pattern. */
|
|
161
|
+
forecast?: string;
|
|
162
|
+
/** Key for the plan outline. */
|
|
163
|
+
plan?: string;
|
|
164
|
+
/** Header at the actual-to-forecast boundary. Keeps the scenario code by default. */
|
|
165
|
+
forecastHeader?: string;
|
|
166
|
+
/** Name before a net total. */
|
|
167
|
+
net?: string;
|
|
168
|
+
/** Marker on an incomplete stack total; prints under notes.show 'disclosure'. */
|
|
169
|
+
incomplete?: string;
|
|
170
|
+
/** Key for a range whisker. */
|
|
171
|
+
range?: string;
|
|
172
|
+
/** Note heading for omitted column values. */
|
|
173
|
+
valuesNotOnColumns?: string;
|
|
174
|
+
/** Note heading for omitted combo values. */
|
|
175
|
+
valuesNotBesideMarks?: string;
|
|
176
|
+
/** Incomplete total note; {partial} is the marker. */
|
|
177
|
+
partialTotals?: string;
|
|
178
|
+
/** Incomplete total note where no marker prints (notes.show without 'disclosure'). */
|
|
179
|
+
knownPartsTotals?: string;
|
|
180
|
+
/** Word before missing stack parts. */
|
|
181
|
+
without?: string;
|
|
182
|
+
/** Word joining missing stack parts. */
|
|
183
|
+
and?: string;
|
|
184
|
+
/** Positive sign key; {series} and {meaning} are replaced. */
|
|
185
|
+
aboveZero?: string;
|
|
186
|
+
/** Negative sign key; {series} and {meaning} are replaced. */
|
|
187
|
+
belowZero?: string;
|
|
188
|
+
/** Key for an authored uncertainty bound. */
|
|
189
|
+
declaredBounds?: string;
|
|
190
|
+
/** Label of a shared rank. */
|
|
191
|
+
tied?: string;
|
|
192
|
+
/** Symbol before a displaced shared-rank label. */
|
|
193
|
+
tiedSymbol?: string;
|
|
194
|
+
/** Football-field spine; {value} is replaced. */
|
|
195
|
+
currentValue?: string;
|
|
196
|
+
/** Tornado spine; {value} is replaced. */
|
|
197
|
+
baseCase?: string;
|
|
198
|
+
/** Tornado hatch key. */
|
|
199
|
+
swingOutsideBase?: string;
|
|
200
|
+
/** Missing uncertainty note; {categories} is replaced. */
|
|
201
|
+
fanGap?: string;
|
|
202
|
+
/** Mixed-sign share note; {categories} is replaced. */
|
|
203
|
+
mixedShares?: string;
|
|
204
|
+
/**
|
|
205
|
+
* Key labels of a table's traffic-light heat lane (`scale: 'status'`):
|
|
206
|
+
* the side below the centre, the warn band around it and the side above
|
|
207
|
+
* it. Defaults 'Below average', 'Around average' and 'Above average', or
|
|
208
|
+
* '... total' under `center: 'total'`.
|
|
209
|
+
*/
|
|
210
|
+
heatBelow?: string;
|
|
211
|
+
heatAround?: string;
|
|
212
|
+
heatAbove?: string;
|
|
213
|
+
/**
|
|
214
|
+
* Bullet band key words, worst to best, for the one worse-to-better key (`bandKey`).
|
|
215
|
+
* The list needs one word per band; any other length keeps the built-in words.
|
|
216
|
+
*/
|
|
217
|
+
bandKey?: string[];
|
|
218
|
+
/** The word for a bullet row's comparison value in every phrase the bullet composes ("vs target", "of target", the keys, the hover card). Default 'target'. */
|
|
219
|
+
target?: string;
|
|
220
|
+
/** Bullet column heads. Defaults 'Actual', '% of {v1}', 'vs {v1}' (percent-of-target rows), 'Target' and 'Gap to {v1}'; {v1} is the comparison word. */
|
|
221
|
+
actualColumn?: string;
|
|
222
|
+
shareColumn?: string;
|
|
223
|
+
deltaColumn?: string;
|
|
224
|
+
targetColumn?: string;
|
|
225
|
+
gapColumn?: string;
|
|
226
|
+
/** Line under a bullet gap: below, above or on the comparison value. Defaults 'below {v1}', 'above {v1}', 'on {v1}'. */
|
|
227
|
+
gapBelow?: string;
|
|
228
|
+
gapAbove?: string;
|
|
229
|
+
gapOn?: string;
|
|
230
|
+
/** Waffle note naming the share of one cell; '{value}' becomes the percent, such as 5%. Default 'One cell = {value}'. */
|
|
231
|
+
cellNote?: string;
|
|
232
|
+
/**
|
|
233
|
+
* Last item of a note line that lists only its first items (`notes.maxListed`); '{count}' becomes the
|
|
234
|
+
* number left out. Default 'and {count} more'. A React chart with hover on adds ' (hover shows each value)' when this is not set.
|
|
235
|
+
*/
|
|
236
|
+
moreListed?: string;
|
|
237
|
+
/** Story panel buttons and counter ('{step}' and '{count}', two digits). Defaults '‹ Back', 'Next ›', '{step} – {count}'. */
|
|
238
|
+
storyBack?: string;
|
|
239
|
+
storyNext?: string;
|
|
240
|
+
storyCounter?: string;
|
|
241
|
+
/** Live region position; '{step}' and '{count}' are unpadded. Defaults 'Step {step} of {count}' (EN), 'Schritt {step} von {count}' (DE). */
|
|
242
|
+
storyStep?: string;
|
|
243
|
+
/** Ends of a scatter qualitative axis. Defaults 'Lower' and 'Higher'. */
|
|
244
|
+
axisLow?: string;
|
|
245
|
+
axisHigh?: string;
|
|
246
|
+
/** Table and dimswitch note for a change printed n.m.: past ±999 % or off a base that rounds to 0. */
|
|
247
|
+
nearZeroChange?: string;
|
|
248
|
+
/** Table note for a change printed n.m. because one operand is a partial total over fewer rows. */
|
|
249
|
+
mixedCoverage?: string;
|
|
250
|
+
/** Dimswitch card note naming the periods it leaves out at a narrow width; {periods} is replaced. */
|
|
251
|
+
hiddenPeriods?: string;
|
|
252
|
+
/** Cascade share-column heading. */
|
|
253
|
+
share?: string;
|
|
254
|
+
/** Histogram binning disclosure; {count}, {about}, {width}, {from}, {to}. */
|
|
255
|
+
histogramBins?: string;
|
|
256
|
+
/** Histogram approximation word, including its trailing space. */
|
|
257
|
+
histogramAbout?: string;
|
|
258
|
+
/** Histogram method note; {count}, {width}, {from}, {rule}, {rounding}, {smallSample}. */
|
|
259
|
+
histogramMethod?: string;
|
|
260
|
+
histogramRuleCount?: string;
|
|
261
|
+
histogramRuleWidth?: string;
|
|
262
|
+
/** Rounded bin width description; {rule} is replaced. */
|
|
263
|
+
histogramSnapped?: string;
|
|
264
|
+
histogramRounded?: string;
|
|
265
|
+
histogramSmallSample?: string;
|
|
266
|
+
/** Required source-null stack notes; {categories} is replaced. */
|
|
267
|
+
missingStack?: string;
|
|
268
|
+
incompleteStacks?: string;
|
|
269
|
+
/** Required stacked-area note for a suppressed series; {series} and {period} are replaced. */
|
|
270
|
+
rebaseZero?: string;
|
|
271
|
+
rebaseMissing?: string;
|
|
272
|
+
/** Required note for incomplete 100% stacks without total100; {categories} is replaced. */
|
|
273
|
+
knownPartsShares?: string;
|
|
274
|
+
}
|
|
275
|
+
/** One step of a story: its panel text and the data ids it brings forward. No highlight is an intro step. */
|
|
276
|
+
export interface StoryStepSpec {
|
|
277
|
+
id: string;
|
|
278
|
+
title: string;
|
|
279
|
+
body?: string;
|
|
280
|
+
highlight?: Id | Id[];
|
|
281
|
+
}
|
|
282
|
+
export interface StorySpec {
|
|
283
|
+
steps: StoryStepSpec[];
|
|
284
|
+
/** The step static output (SVG, PNG, server render) draws; default the first. */
|
|
285
|
+
step?: string;
|
|
286
|
+
}
|
|
287
|
+
export interface LegendOptions {
|
|
288
|
+
position: 'right' | 'bottom' | 'top';
|
|
289
|
+
order?: Id[];
|
|
290
|
+
}
|
|
291
|
+
export interface ValueAxisOptions {
|
|
292
|
+
show?: boolean;
|
|
293
|
+
min?: number;
|
|
294
|
+
max?: number;
|
|
295
|
+
tickStep?: number;
|
|
296
|
+
includeZero?: boolean;
|
|
297
|
+
percent?: boolean;
|
|
298
|
+
/** Scatter only: log10 scale on 'x', 'y' (also `true`) or 'both'; every value on it must be above zero. */
|
|
299
|
+
log?: boolean | 'x' | 'y' | 'both';
|
|
300
|
+
reverse?: boolean;
|
|
301
|
+
gridlines?: boolean;
|
|
302
|
+
/**
|
|
303
|
+
* Valid straight breaks collapse the omitted domain span to a fixed 12px gap.
|
|
304
|
+
*
|
|
305
|
+
* `style` names only what v1.0 accepts. `'wiggle'` (line/area/
|
|
306
|
+
* mekko) is staged for v1.5 and is rejected by the schema today, so declaring
|
|
307
|
+
* it here would let a consumer compile a document the runtime always refuses —
|
|
308
|
+
* the exact divergence this package exists to remove. Widening the literal when
|
|
309
|
+
* wiggle ships is not a breaking change. Absent or `false` keeps the axis whole.
|
|
310
|
+
* Waterfall and pvm alone accept `'auto'`: choose a safe break when the smallest
|
|
311
|
+
* total is at least twice the running span and the steps would be small.
|
|
312
|
+
* Totals stay visibly taller than smaller steps and no shorter than equal steps.
|
|
313
|
+
* Unsafe automatic breaks move down when valid; unsafe authored breaks are ignored with a warning.
|
|
314
|
+
*/
|
|
315
|
+
break?: {
|
|
316
|
+
from: number;
|
|
317
|
+
to: number;
|
|
318
|
+
style?: 'straight';
|
|
319
|
+
} | 'auto' | false;
|
|
320
|
+
}
|
|
321
|
+
export interface CategoryAxisOptions {
|
|
322
|
+
crossesBetween?: boolean;
|
|
323
|
+
dateTicks?: 'years' | 'quarters' | 'months' | 'weeks' | 'days';
|
|
324
|
+
}
|
|
325
|
+
/**
|
|
326
|
+
* Right-hand axis that RELABELS the primary domain as a share of `total` —
|
|
327
|
+
* not a second scale. No `y2` is created, every series keeps the primary
|
|
328
|
+
* scale, and the primary domain is pinned so the top tick row is exactly
|
|
329
|
+
* 100%. Because there is only one scale, a ruler is not a dual axis and does
|
|
330
|
+
* not carry the `dual-axis` warning.
|
|
331
|
+
*/
|
|
332
|
+
export interface AxisRuler {
|
|
333
|
+
of: 'primary';
|
|
334
|
+
/** The quantity 100% refers to; must be positive and finite. */
|
|
335
|
+
total: number;
|
|
336
|
+
/** Number of tick INTERVALS on the percent ladder; default 5 ⇒ 0…100 by 20. */
|
|
337
|
+
ticks?: number;
|
|
338
|
+
}
|
|
339
|
+
/**
|
|
340
|
+
* Mutually exclusive by construction: `acknowledge` opts in to a genuinely
|
|
341
|
+
* independent second scale, `ruler` declares there is no second scale at all.
|
|
342
|
+
* Supplying both is a contradiction about what the right-hand axis MEANS, so
|
|
343
|
+
* the union makes it a type error (and combo refuses both at runtime).
|
|
344
|
+
*/
|
|
345
|
+
export type AcknowledgedSecondaryAxis = {
|
|
346
|
+
acknowledge: true;
|
|
347
|
+
};
|
|
348
|
+
export type SecondaryAxisOptions = (AcknowledgedSecondaryAxis & {
|
|
349
|
+
ruler?: never;
|
|
350
|
+
/**
|
|
351
|
+
* Pin the acknowledged secondary domain (data may only WIDEN it, never
|
|
352
|
+
* be clipped). Used by the pareto chart: the cumulative
|
|
353
|
+
* share axis is pinned to [0, 100] so the percent ladder reads exact
|
|
354
|
+
* shares while the bar axis stays independently economy-capped.
|
|
355
|
+
*/
|
|
356
|
+
domain?: [number, number];
|
|
357
|
+
/**
|
|
358
|
+
* Format-by-example for the right-axis TICKS only (e.g. '1.2%'); wins
|
|
359
|
+
* over series formats. Data labels keep their series/scale formats.
|
|
360
|
+
*/
|
|
361
|
+
format?: string;
|
|
362
|
+
/**
|
|
363
|
+
* false draws no right tick column: the secondary series is read
|
|
364
|
+
* from its labelled values and the secondary axis title. Default true.
|
|
365
|
+
*/
|
|
366
|
+
show?: boolean;
|
|
367
|
+
}) | {
|
|
368
|
+
acknowledge?: never;
|
|
369
|
+
ruler: AxisRuler;
|
|
370
|
+
};
|
|
371
|
+
export interface TopNOptions {
|
|
372
|
+
n: number;
|
|
373
|
+
/** Show the rest bucket. On Pareto, false hides its column but keeps it in the cumulative curve. */
|
|
374
|
+
rest?: boolean;
|
|
375
|
+
restLabel?: string;
|
|
376
|
+
showRestCount?: boolean;
|
|
377
|
+
threshold?: number;
|
|
378
|
+
}
|
|
379
|
+
/**
|
|
380
|
+
* Focus input: the ONE active source owner whose labels gain solver
|
|
381
|
+
* priority. This is the pure, serializable half of `InteractionTarget`:
|
|
382
|
+
* the host keeps the interaction state (`activeId`) and takes the target's
|
|
383
|
+
* `owner`. The `chart`/`panel` scope is expressed by WHICH resolved request
|
|
384
|
+
* carries the focus — for a grid, the panel's own options — so a focus in one
|
|
385
|
+
* panel never reaches a sibling, which is a separate layout run.
|
|
386
|
+
*/
|
|
387
|
+
export interface FocusInput {
|
|
388
|
+
/** Source owner to emphasise. An owner with no defined key never matches. */
|
|
389
|
+
owner: OwnerRef;
|
|
390
|
+
}
|
|
391
|
+
/** One cell `details` key: its label on the hover card, its number format and unit. */
|
|
392
|
+
export interface DetailField {
|
|
393
|
+
key: string;
|
|
394
|
+
label?: string;
|
|
395
|
+
format?: string;
|
|
396
|
+
unit?: string;
|
|
397
|
+
}
|
|
398
|
+
export interface BaseOptions {
|
|
399
|
+
/**
|
|
400
|
+
* Accessible presentation. `title` emits the SVG hover title (default false);
|
|
401
|
+
* accessible naming is always retained. `table` asks the React chart
|
|
402
|
+
* components for the record-derived accessible data table: 'hidden' keeps it
|
|
403
|
+
* available to assistive technology only, 'toggle' adds a disclosure control,
|
|
404
|
+
* and 'below' renders it visibly under the chart. BoardplotChart includes it in
|
|
405
|
+
* the server output; a per-type component adds it after mount. Omitted, no
|
|
406
|
+
* table is drawn.
|
|
407
|
+
* The SVG is unchanged by either key.
|
|
408
|
+
*/
|
|
409
|
+
a11y?: {
|
|
410
|
+
title?: boolean;
|
|
411
|
+
table?: 'hidden' | 'toggle' | 'below';
|
|
412
|
+
};
|
|
413
|
+
/** Explicit presentation mode; otherwise full at or above the chart's minimum width, compact below it. */
|
|
414
|
+
mode?: 'full' | 'compact';
|
|
415
|
+
/**
|
|
416
|
+
* What a canvas below the chart's minimum (on either axis) gets, for the types with a
|
|
417
|
+
* compact floor: column, line, scatter, dot and bar. 'compact' (default) draws the tight
|
|
418
|
+
* chart down to the floor, and on a pinned canvas a full-mode refusal for lack of room falls
|
|
419
|
+
* back to compact; 'refuse' refuses below the minimum. Types without a floor
|
|
420
|
+
* always refuse below their minimum.
|
|
421
|
+
*/
|
|
422
|
+
belowMinimum?: 'compact' | 'refuse';
|
|
423
|
+
/** Reading context. Default report. */
|
|
424
|
+
target?: RenderTarget;
|
|
425
|
+
/**
|
|
426
|
+
* One factor on every text the chart draws, 0.5 to 2.5. 1, like absent,
|
|
427
|
+
* keeps the target's sizes; 1.25 sets every text 25 % larger. The layout
|
|
428
|
+
* re-flows at the new sizes; the canvas keeps its size. A factor under 1
|
|
429
|
+
* stops each text at the target's readability floor; a factor above 1
|
|
430
|
+
* raises the floors with the text. The factor scales the size of the chart's width
|
|
431
|
+
* class, so charts of different widths draw different sizes at the same
|
|
432
|
+
* factor; `textSize` gives equal text across charts.
|
|
433
|
+
*/
|
|
434
|
+
textScale?: number;
|
|
435
|
+
/**
|
|
436
|
+
* The primary label size in layout px, the same at every width, 6 to 32.
|
|
437
|
+
* Every other text role keeps its ratio to the primary label in the middle
|
|
438
|
+
* width class (720 to 1079 px): `textSize: 13` on the report target draws a
|
|
439
|
+
* 560 px chart with the sizes a 1010 px chart has. Use it for equal text
|
|
440
|
+
* across charts on one page or slide. A chart of 1080 px or more draws smaller than its default under textSize 13. On slide and print, textSize is in layout px. Not allowed with `textScale`. In a
|
|
441
|
+
* grid it applies to every panel, and a panel may not set a different value.
|
|
442
|
+
* A size under the target's floor stops each text at that floor.
|
|
443
|
+
*/
|
|
444
|
+
textSize?: number;
|
|
445
|
+
/** Target default or explicit frame. A width alone leaves height automatic. */
|
|
446
|
+
size?: CanvasSizeInput;
|
|
447
|
+
margin?: Partial<Margin>;
|
|
448
|
+
/** Outer frame margin; each supplied side overrides margin and theme defaults. */
|
|
449
|
+
canvas?: {
|
|
450
|
+
margin?: Partial<Margin>;
|
|
451
|
+
};
|
|
452
|
+
/** False omits the visible chart title while retaining an accessible name. */
|
|
453
|
+
title?: string | false;
|
|
454
|
+
subtitle?: string | Subtitle;
|
|
455
|
+
unit?: string;
|
|
456
|
+
/**
|
|
457
|
+
* The host prints the unit beside the chart. True, no end label, table
|
|
458
|
+
* head or legend check repeats it; number formatting does not change.
|
|
459
|
+
* Default false.
|
|
460
|
+
*/
|
|
461
|
+
unitShown?: boolean;
|
|
462
|
+
source?: string;
|
|
463
|
+
/**
|
|
464
|
+
* The notes under the chart, in authored order. False leaves the notes off
|
|
465
|
+
* the canvas: these notes, the method notes the engine derives, the key to
|
|
466
|
+
* an event badge and the "+N notes" pointer. A disclosure that `notes.show`
|
|
467
|
+
* prints (a rounding note, a partial period, values not printed), the
|
|
468
|
+
* source line and a required map credit stay. For a
|
|
469
|
+
* host that draws its own frame around the chart and carries the notes
|
|
470
|
+
* there; `title: false` is the same switch for the title.
|
|
471
|
+
*/
|
|
472
|
+
footnotes?: string[] | false;
|
|
473
|
+
/**
|
|
474
|
+
* The footer rule. `maxListed`: the items a note line
|
|
475
|
+
* the engine writes for what the drawing leaves out ("Not labelled on the
|
|
476
|
+
* chart:...") names before it counts the rest ("and 3 more"); default 8,
|
|
477
|
+
* 'all' names every item, 0 names none and only counts them ("18 of 36
|
|
478
|
+
* values"). Every item stays in the reading's omissions and the hover records. `placement`: 'frame' prints notes in the frame within
|
|
479
|
+
* `maxLines`, 'list' prints only the source, a required credit and the
|
|
480
|
+
* pointer, 'info' is a React "Notes and sources" button (the SVG draws it as
|
|
481
|
+
* 'frame'); default dashboard 'info', slide 'list', else 'frame'.
|
|
482
|
+
* `maxLines`: visible lines of notes and source, a required credit not
|
|
483
|
+
* counted; default report and dashboard 3 (2 under 720 px), slide 2,
|
|
484
|
+
* print 3. `show`: the kinds the frame prints, default ['note'], the
|
|
485
|
+
* author's notes; 'method' adds the engine's short method lines, and
|
|
486
|
+
* 'disclosure' the engine's notes on how to read the chart (keys, data
|
|
487
|
+
* changes, "Not labelled on the chart:..."), outside the budget; 'ranks'
|
|
488
|
+
* only the rank key, the disclosure that names the rank numbers a column
|
|
489
|
+
* row draws when its names do not fit (also printed by 'disclosure'). Engine
|
|
490
|
+
* notes not shown stay in the notes list. `pointer`: default true, prints
|
|
491
|
+
* "+N notes" when the notes list holds more of the kinds `show` prints.
|
|
492
|
+
*/
|
|
493
|
+
notes?: {
|
|
494
|
+
maxListed?: number | 'all';
|
|
495
|
+
placement?: 'frame' | 'info' | 'list';
|
|
496
|
+
maxLines?: number;
|
|
497
|
+
show?: ('note' | 'method' | 'disclosure' | 'ranks')[];
|
|
498
|
+
pointer?: boolean;
|
|
499
|
+
};
|
|
500
|
+
theme?: ThemeRef;
|
|
501
|
+
locale?: LocaleSpec;
|
|
502
|
+
/** Built-in wording for renderer-composed labels; explicit options still win per label. */
|
|
503
|
+
strings?: StringsSpec;
|
|
504
|
+
format?: string;
|
|
505
|
+
/**
|
|
506
|
+
* Label, format, unit and order of the cell `details` keys, the extra facts
|
|
507
|
+
* a value's hover card lists after it. Declared keys print first, in this
|
|
508
|
+
* order; an undeclared key prints after them, labelled with its key.
|
|
509
|
+
*/
|
|
510
|
+
detailFields?: DetailField[];
|
|
511
|
+
/**
|
|
512
|
+
* How an automatic number format prints a nonzero value below its last
|
|
513
|
+
* shown digit. 'bound' (default): "<0.01" at two decimals, ">−0.01" below
|
|
514
|
+
* zero, "<1" for whole numbers, "<+0.01" on a signed change label; below 0.0001, scientific form. 'zero': spreadsheet style, the format's
|
|
515
|
+
* own "0.00". 'scientific': two significant digits and a power of ten,
|
|
516
|
+
* "1.2 × 10⁻⁹". 'p-value': every value from 0 to 1 prints as APA 7
|
|
517
|
+
* writes a p-value, ".042", and "<.001" below. An authored format prints
|
|
518
|
+
* as authored.
|
|
519
|
+
*/
|
|
520
|
+
smallValues?: 'bound' | 'zero' | 'scientific' | 'p-value';
|
|
521
|
+
/** Named theme palette (theme.color.palettes key) for the series ramp. */
|
|
522
|
+
palette?: string;
|
|
523
|
+
labelDensity?: LabelDensity;
|
|
524
|
+
labels?: false | Partial<Record<LabelKind, boolean | LabelContent>>;
|
|
525
|
+
labelPlacements?: Record<Id, SlotId>;
|
|
526
|
+
/**
|
|
527
|
+
* Where the category names go (column, combo, pareto). 'axis' (default): the
|
|
528
|
+
* row under the axis. 'staircase': each name in the free space over the
|
|
529
|
+
* lower columns, one step lower than the one before, with a vertical leader
|
|
530
|
+
* down to its column; falls back to the row, with a warning, when a name has
|
|
531
|
+
* no seat.
|
|
532
|
+
*/
|
|
533
|
+
categoryLabels?: 'axis' | 'staircase';
|
|
534
|
+
legend?: 'none' | 'right' | 'bottom' | 'top' | 'auto' | LegendOptions;
|
|
535
|
+
valueAxis?: ValueAxisOptions;
|
|
536
|
+
categoryAxis?: CategoryAxisOptions;
|
|
537
|
+
/**
|
|
538
|
+
* The SHARED surface is acknowledge-only, because that is what
|
|
539
|
+
* `schema/shared.ts` accepts. The `ruler` variant lives on ComboOptions,
|
|
540
|
+
* whose own schema widens it (`combo/index.ts` secondaryAxisSchema) — and
|
|
541
|
+
* it has to, because the react-surface check enumerates every declared
|
|
542
|
+
* option against the runtime and catches `secondaryAxis.ruler` declared on
|
|
543
|
+
* all 27 charts while 26 of them reject it. Declarations follow the
|
|
544
|
+
* runtime; the runtime is never widened to match a declaration.
|
|
545
|
+
*/
|
|
546
|
+
secondaryAxis?: AcknowledgedSecondaryAxis;
|
|
547
|
+
/** `x` is refused: no chart type shares an x scale. */
|
|
548
|
+
scaleGroup?: {
|
|
549
|
+
x?: never;
|
|
550
|
+
y?: string;
|
|
551
|
+
id?: string;
|
|
552
|
+
};
|
|
553
|
+
/**
|
|
554
|
+
* Alignment of the row labels on a horizontal category axis. Default 'left':
|
|
555
|
+
* one shared left edge. 'right' pushes each label block against the plot —
|
|
556
|
+
* note a MULTI-LINE label is still positioned by its longest line, so its short lines stay ragged on the right.
|
|
557
|
+
*/
|
|
558
|
+
rowLabels?: {
|
|
559
|
+
align?: 'left' | 'right';
|
|
560
|
+
};
|
|
561
|
+
sort?: {
|
|
562
|
+
categories?: SortOrder;
|
|
563
|
+
segments?: SortOrder;
|
|
564
|
+
};
|
|
565
|
+
topN?: TopNOptions;
|
|
566
|
+
/**
|
|
567
|
+
* REFUSED on every registered type, and typed so the compiler says so.
|
|
568
|
+
* Measured: `transpose: true` moved the geometry of 0 of 240 fixtures
|
|
569
|
+
* across all 29 types — the schema said yes and nothing happened, which is
|
|
570
|
+
* the worst failure mode, because the only
|
|
571
|
+
* caller of this surface is an agent reading `ok: true`. Orientation in this
|
|
572
|
+
* library is a TYPE, not a flag: 'bar' is the horizontal twin of 'column',
|
|
573
|
+
* 'butterfly' the mirrored one, and waterfall carries its own `variant`.
|
|
574
|
+
* Declarations follow the runtime (see secondaryAxis above), so this is
|
|
575
|
+
* `never` on both sides rather than dropped on one.
|
|
576
|
+
*/
|
|
577
|
+
transpose?: never;
|
|
578
|
+
bandFraction?: number;
|
|
579
|
+
highlight?: Id | Id[];
|
|
580
|
+
/** Guided story: steps that fade every mark but the ones a step names, with a text panel. */
|
|
581
|
+
story?: StorySpec;
|
|
582
|
+
colorblindSafe?: boolean;
|
|
583
|
+
/**
|
|
584
|
+
* How strongly forecast, partial-period and no-data hatches draw, 0 to 100;
|
|
585
|
+
* 100 is the theme's recipe. Default 60 on a line or area forecast, 100
|
|
586
|
+
* where the hatch is the only cue (theme.ts, HATCH_STRENGTH_DEFAULT).
|
|
587
|
+
*/
|
|
588
|
+
hatchStrength?: number;
|
|
589
|
+
/** `sum-consistent` makes computed shares total 100%. Incompatible precisions or more than 13 decimals warn and keep the requested formats without adjustment. */
|
|
590
|
+
rounding?: 'nearest' | 'sum-consistent';
|
|
591
|
+
animate?: boolean;
|
|
592
|
+
/** Emit progressive-enhancement metadata; layout geometry is unchanged. */
|
|
593
|
+
interactive?: boolean;
|
|
594
|
+
debug?: boolean;
|
|
595
|
+
/**
|
|
596
|
+
* Embed claim: the width (CSS px) at which this chart's SVG will be
|
|
597
|
+
* placed in a host document. Fonts are absolute SVG px, so the host scales
|
|
598
|
+
* type by s = embed.width / canvas width; declaring the width arms the
|
|
599
|
+
* `type-below-effective-min` lint (a warning).
|
|
600
|
+
* Geometry never changes.
|
|
601
|
+
*/
|
|
602
|
+
embed?: {
|
|
603
|
+
width: number;
|
|
604
|
+
};
|
|
605
|
+
/**
|
|
606
|
+
* Active-source focus. The ONE source owner whose labels gain solver
|
|
607
|
+
* priority while it is set; every other label keeps its authored order.
|
|
608
|
+
* Public and serializable (matching `schema/shared.ts`'s nullable `focus`),
|
|
609
|
+
* so it travels on the resolved layout request and is retained by the
|
|
610
|
+
* prepared request fingerprint; `null` clears an inherited focus. The focus
|
|
611
|
+
* adds `focusBonus` to a selected label's sort key, which may carry it past a
|
|
612
|
+
* higher authored band — that is the intended promotion. Layout only: totals,
|
|
613
|
+
* shares, scales and claims are unchanged, and with the key omitted the
|
|
614
|
+
* layout is byte-identical to a build without the feature. A grid panel scopes
|
|
615
|
+
* its own focus by carrying it on that panel's options; siblings never see it.
|
|
616
|
+
*/
|
|
617
|
+
focus?: FocusInput | null;
|
|
618
|
+
annotations?: Annotation[];
|
|
619
|
+
measure?: TextMeasurer;
|
|
620
|
+
}
|
|
621
|
+
/** A shared-base key whose admission `src/core/schema/shared.ts` decides per type. */
|
|
622
|
+
type GatedOptionKey = keyof typeof OPTION_CAPABILITY & keyof BaseOptions;
|
|
623
|
+
/** The gated keys chart type `T` does NOT implement. */
|
|
624
|
+
export type RefusedOptionKeys<T extends string> = {
|
|
625
|
+
[K in GatedOptionKey]: (typeof OPTION_CAPABILITY)[K] extends {
|
|
626
|
+
unsupportedSeverity: 'warn';
|
|
627
|
+
} ? never : T extends (typeof OPTION_CAPABILITY)[K]['implementedBy'][number] ? never : K;
|
|
628
|
+
}[GatedOptionKey];
|
|
629
|
+
/**
|
|
630
|
+
* `BaseOptions` as chart type `T` really accepts it.
|
|
631
|
+
*
|
|
632
|
+
* Every gated key `T` does not implement becomes `never` rather than being
|
|
633
|
+
* dropped, for the reason `transpose` is `never` above and `secondaryAxis.ruler`
|
|
634
|
+
* is absent from charts that do not implement it: declarations FOLLOW the runtime, and the pack
|
|
635
|
+
* contract's option enumeration compares them in BOTH directions — a key the
|
|
636
|
+
* declaration offers and the schema refuses fails `react-surface` exactly as
|
|
637
|
+
* loudly as the reverse. Dropping the key instead would also make
|
|
638
|
+
* `options.locale` on a column chart a plain "property does not exist", where
|
|
639
|
+
* `never` lets the compiler point at the same sentence the runtime prints.
|
|
640
|
+
*/
|
|
641
|
+
export type BaseOptionsFor<T extends string> = Omit<BaseOptions, RefusedOptionKeys<T> | 'valueAxis' | (T extends 'mekko' ? 'mode' : never)> & {
|
|
642
|
+
[K in RefusedOptionKeys<T>]?: Refused<BaseOptions[K]>;
|
|
643
|
+
} & {
|
|
644
|
+
valueAxis?: ValueAxisFor<T>;
|
|
645
|
+
};
|
|
646
|
+
/**
|
|
647
|
+
* A refused key as a layout sees it: absent. An object option whose fields
|
|
648
|
+
* are all optional keeps their names with every value `never`, so no value
|
|
649
|
+
* typechecks and a leftover `options.sort?.categories` read compiles to
|
|
650
|
+
* undefined; any other refused key is `never`.
|
|
651
|
+
*/
|
|
652
|
+
type Refused<V> = NonNullable<V> extends object ? {} extends NonNullable<V> ? {
|
|
653
|
+
[P in keyof NonNullable<V>]?: never;
|
|
654
|
+
} : never : never;
|
|
655
|
+
/** The valueAxis sub-keys type `T` does not read, from VALUE_AXIS_CAPABILITY and VALUE_AXIS_ONLY. */
|
|
656
|
+
type RefusedValueAxisKeys<T extends string> = {
|
|
657
|
+
[K in keyof typeof VALUE_AXIS_CAPABILITY]: T extends (typeof VALUE_AXIS_CAPABILITY)[K]['implementedBy'][number] ? never : K;
|
|
658
|
+
}[keyof typeof VALUE_AXIS_CAPABILITY] | (T extends keyof typeof VALUE_AXIS_ONLY ? Exclude<keyof ValueAxisOptions, (typeof VALUE_AXIS_ONLY)[T]['keys'][number]> : never);
|
|
659
|
+
/**
|
|
660
|
+
* `ValueAxisOptions` as chart type `T` accepts it: the refused sub-keys are
|
|
661
|
+
* `never`, the way BaseOptionsFor refuses top-level keys, and a type that
|
|
662
|
+
* reads no sub-key at all (pvm, sparkline, table) gets `never` for the
|
|
663
|
+
* object, so even `valueAxis: {}` fails to compile as the schema refuses it.
|
|
664
|
+
*/
|
|
665
|
+
type ValueAxisFor<T extends string> = T extends keyof typeof VALUE_AXIS_ONLY ? (typeof VALUE_AXIS_ONLY)[T]['keys'] extends readonly [] ? never : ValueAxisOptionsFor<T> : ValueAxisOptionsFor<T>;
|
|
666
|
+
type ValueAxisOptionsFor<T extends string> = {
|
|
667
|
+
[K in keyof ValueAxisOptions]: K extends RefusedValueAxisKeys<T> ? never : K extends 'break' ? T extends 'waterfall' | 'pvm' ? ValueAxisOptions[K] : Exclude<ValueAxisOptions[K], 'auto'> : ValueAxisOptions[K];
|
|
668
|
+
};
|
|
669
|
+
export interface DerivedRatioTier {
|
|
670
|
+
id: Id;
|
|
671
|
+
label: string;
|
|
672
|
+
numeratorSeriesId: Id;
|
|
673
|
+
denominatorSeriesId: Id;
|
|
674
|
+
at: Id[];
|
|
675
|
+
format?: string;
|
|
676
|
+
direction?: Direction;
|
|
677
|
+
}
|
|
678
|
+
/** Modified z-score rule, computed from the data. */
|
|
679
|
+
export interface AnomalyMadSpec {
|
|
680
|
+
method: 'mad';
|
|
681
|
+
/** Flag threshold on |modified z|; default 3.5, the authors' pairing with 1.4826. */
|
|
682
|
+
k?: number;
|
|
683
|
+
/** Centre of the rule. 'zero' (default) reads the input as a deviation. */
|
|
684
|
+
baseline?: 'zero' | 'median';
|
|
685
|
+
/** Names the rule on the exhibit; it is prefixed to the derived sentence, never a replacement. */
|
|
686
|
+
label?: string;
|
|
687
|
+
}
|
|
688
|
+
/** Fully authored bounds — no statistics at all. */
|
|
689
|
+
export interface AnomalyThresholdSpec {
|
|
690
|
+
method: 'threshold';
|
|
691
|
+
low?: number;
|
|
692
|
+
high?: number;
|
|
693
|
+
label?: string;
|
|
694
|
+
}
|
|
695
|
+
export type AnomalySpec = AnomalyMadSpec | AnomalyThresholdSpec;
|
|
696
|
+
export interface ColumnOptions extends BaseOptionsFor<'column'> {
|
|
697
|
+
/** Title of the drawn value axis. */
|
|
698
|
+
axisTitles?: {
|
|
699
|
+
primary?: string;
|
|
700
|
+
};
|
|
701
|
+
variant?: 'grouped' | 'stacked' | 'stacked100';
|
|
702
|
+
/**
|
|
703
|
+
* Which values print, as on line: 'none', 'last', 'ends' (first and last),
|
|
704
|
+
* 'extremes' (first, last, highest and lowest; a tie takes the first) or
|
|
705
|
+
* 'all', per series. Wins over labelDensity. The value axis is drawn
|
|
706
|
+
* unless valueAxis.show says otherwise or the mode is 'all'. Grouped only.
|
|
707
|
+
*/
|
|
708
|
+
valueLabels?: ValueLabelMode;
|
|
709
|
+
grandTotalLabels?: boolean;
|
|
710
|
+
/** Every stacked series is a share of the same whole; the stack then has a total. Stacked variants only. */
|
|
711
|
+
sharesOfOneWhole?: boolean;
|
|
712
|
+
referenceStyle?: 'tick' | 'line' | 'marker';
|
|
713
|
+
/** Per-category cumulative-boundary ticks; ordered column axes connect them by default. */
|
|
714
|
+
netLine?: boolean | {
|
|
715
|
+
seriesId?: Id;
|
|
716
|
+
connectors?: boolean;
|
|
717
|
+
};
|
|
718
|
+
/** Computed arithmetic-average rule; Id[] limits the contributing series. */
|
|
719
|
+
averageMarker?: boolean | {
|
|
720
|
+
scope: 'all' | Id[];
|
|
721
|
+
};
|
|
722
|
+
/**
|
|
723
|
+
* `style` is 'line' (default) or 'dashed'; dashed matches the waterfall
|
|
724
|
+
* bridge's dash.reference token. There is no 'dot' or 'line-dot' variant:
|
|
725
|
+
* 'dot' would draw boundary markers and NO connecting line, so it would
|
|
726
|
+
* show two corners the rects already show and drop the relationship the
|
|
727
|
+
* connector exists to state; 'line-dot' would add glyphs carrying no extra fact.
|
|
728
|
+
*/
|
|
729
|
+
connectors?: boolean | {
|
|
730
|
+
style?: 'line' | 'dashed';
|
|
731
|
+
scope?: 'all' | Id[];
|
|
732
|
+
};
|
|
733
|
+
/**
|
|
734
|
+
* Ribbon chart (rank-flow stacked columns): a translucent band joins each
|
|
735
|
+
* series' segments in adjacent columns. `order` 'rank' (default on stacked)
|
|
736
|
+
* stacks each column by its own values, largest on top, so a crossing
|
|
737
|
+
* ribbon is a rank swap; 'sheet' (default on stacked100) keeps the series
|
|
738
|
+
* order. Stacked variants only; for ordered columns only.
|
|
739
|
+
*/
|
|
740
|
+
ribbons?: boolean | {
|
|
741
|
+
order?: 'rank' | 'sheet';
|
|
742
|
+
};
|
|
743
|
+
ratioTier?: DerivedRatioTier;
|
|
744
|
+
/**
|
|
745
|
+
* Paint each column good/bad/neutral by sign(value) × series.direction.
|
|
746
|
+
* Declared HERE, not in a chart-local type: the column zod schema accepts
|
|
747
|
+
* it at runtime, so a consumer type that omits it is exactly the
|
|
748
|
+
* type-runtime drift the public-API lock exists to catch.
|
|
749
|
+
*/
|
|
750
|
+
signColor?: boolean;
|
|
751
|
+
/** Paint the data series on the theme's ordered ramp, the first strongest, for series whose order is the encoding. */
|
|
752
|
+
seriesRamp?: boolean;
|
|
753
|
+
/** With `seriesRamp` and a Rest series (colorRole 'others'): 'quietest' keeps every named step further from the background than Rest. 'apart': they only differ from it. Unset takes the chart default (DEFAULT_OTHERS_SHADE). */
|
|
754
|
+
othersShade?: OthersShade;
|
|
755
|
+
/** Flag exceptional periods against a visible, named threshold corridor. */
|
|
756
|
+
anomaly?: AnomalySpec;
|
|
757
|
+
/**
|
|
758
|
+
* Name the stacked series once, at the right edge of the LAST column
|
|
759
|
+
* or the left edge of the FIRST, instead of in a legend: the
|
|
760
|
+
* layers of a cohort chart are read off their own bars. `{ only }` names
|
|
761
|
+
* the ones that get a label, which is how twelve layers carry five names.
|
|
762
|
+
*/
|
|
763
|
+
seriesLabels?: {
|
|
764
|
+
at: 'right-edge' | 'left-edge';
|
|
765
|
+
only?: Id[];
|
|
766
|
+
/** Each name carries its series' CAGR ("Product B +10.1% p.a."), first to last category or over from/to. */
|
|
767
|
+
cagr?: true | {
|
|
768
|
+
from?: Id;
|
|
769
|
+
to?: Id;
|
|
770
|
+
format?: string;
|
|
771
|
+
};
|
|
772
|
+
};
|
|
773
|
+
/** Segment shares on chosen columns only (`only`), in a format by example ("26.3%"). Stacked variants. */
|
|
774
|
+
shareLabels?: {
|
|
775
|
+
only?: Id[];
|
|
776
|
+
format?: string;
|
|
777
|
+
};
|
|
778
|
+
/** Display the last n periods; source means and anomaly rules keep every period. */
|
|
779
|
+
window?: Pick<LiveWindowOptions, 'last'>;
|
|
780
|
+
/** Visible category endpoints; source means and anomaly rules keep every period. */
|
|
781
|
+
viewDomain?: {
|
|
782
|
+
x: [string, string];
|
|
783
|
+
};
|
|
784
|
+
/** The event lane and key: placement, lane rows, event groups (column, combo, line). */
|
|
785
|
+
events?: EventOptions;
|
|
786
|
+
}
|
|
787
|
+
/** Football-field "current value" pin: bare number or number plus its label. */
|
|
788
|
+
export interface CurrentValueSpec {
|
|
789
|
+
value: number;
|
|
790
|
+
label?: string;
|
|
791
|
+
}
|
|
792
|
+
/** Tornado base case: the output metric with every driver at its base input. */
|
|
793
|
+
export interface BaseValueSpec {
|
|
794
|
+
value: number;
|
|
795
|
+
label?: string;
|
|
796
|
+
}
|
|
797
|
+
/**
|
|
798
|
+
* Tornado case identity. Two NAMED series rather than one range cell, because a
|
|
799
|
+
* range normalizes low>high away and would destroy the fact that an inverse
|
|
800
|
+
* driver's LOW input produces the HIGH output.
|
|
801
|
+
*/
|
|
802
|
+
export interface TornadoCases {
|
|
803
|
+
low: Id;
|
|
804
|
+
high: Id;
|
|
805
|
+
}
|
|
806
|
+
export interface BarOptions extends Omit<ColumnOptions, 'ratioTier' | 'variant' | 'anomaly' | 'rowLabels' | 'events' | 'seriesRamp' | 'othersShade' | 'seriesLabels' | 'shareLabels' | 'window' | 'viewDomain' | 'categoryLabels' | 'ribbons'> {
|
|
807
|
+
/** Refused: a horizontal bar prints each name beside its row already (staircase names are column, combo and pareto). */
|
|
808
|
+
categoryLabels?: never;
|
|
809
|
+
/**
|
|
810
|
+
* Re-declared, not inherited: bar's type is derived from COLUMN's, and column
|
|
811
|
+
* has no row labels, so the shared gate types `rowLabels` as never there and
|
|
812
|
+
* bar would inherit the refusal for an option it implements. Any shared option
|
|
813
|
+
* bar implements and column does not has to be omitted and restated here.
|
|
814
|
+
*/
|
|
815
|
+
rowLabels?: {
|
|
816
|
+
align?: 'left' | 'right';
|
|
817
|
+
};
|
|
818
|
+
/**
|
|
819
|
+
* The weight and the ink of the reference tick. It is read only
|
|
820
|
+
* under `referenceStyle: 'tick'`: the dashed 'line' keeps its 1.25 px and
|
|
821
|
+
* the 'marker' its neutral dot. A board that wants a strong prior-year
|
|
822
|
+
* mark authors `{ width: 2, color: 'highlight' }`.
|
|
823
|
+
*/
|
|
824
|
+
referenceTick?: {
|
|
825
|
+
width?: number;
|
|
826
|
+
color?: 'ink' | 'highlight';
|
|
827
|
+
};
|
|
828
|
+
variant?: ColumnOptions['variant'] | 'football-field' | 'tornado';
|
|
829
|
+
currentValue?: number | CurrentValueSpec;
|
|
830
|
+
baseValue?: number | BaseValueSpec;
|
|
831
|
+
tornado?: TornadoCases;
|
|
832
|
+
/**
|
|
833
|
+
* Default false. true adds the method notes of the football-field and tornado
|
|
834
|
+
* variants; a football-field range draws its mid-point tick only with its
|
|
835
|
+
* note. Hatched tornado bars and drivers not shown print regardless.
|
|
836
|
+
*/
|
|
837
|
+
methodNote?: boolean;
|
|
838
|
+
}
|
|
839
|
+
export interface ButterflyOptions extends BaseOptionsFor<'butterfly'> {
|
|
840
|
+
a: Id;
|
|
841
|
+
b: Id;
|
|
842
|
+
centerColumnWidth?: number;
|
|
843
|
+
sortBy?: 'sheet' | 'a' | 'b' | 'sum' | 'diff';
|
|
844
|
+
sharedScale?: boolean;
|
|
845
|
+
}
|
|
846
|
+
export interface WaterfallOptions extends BaseOptionsFor<'waterfall'> {
|
|
847
|
+
/** Authored value-axis title above a vertical bridge; horizontal bridges do not print it. */
|
|
848
|
+
axisTitles?: {
|
|
849
|
+
primary?: string;
|
|
850
|
+
};
|
|
851
|
+
variant?: 'vertical' | 'horizontal';
|
|
852
|
+
build?: 'up' | 'down';
|
|
853
|
+
/** Paint each plain step good or bad by its sign times the item's direction; false paints the neutral. */
|
|
854
|
+
signColor?: boolean;
|
|
855
|
+
}
|
|
856
|
+
export type LineInterpolation = 'linear' | 'step-after' | 'step-before' | 'monotone';
|
|
857
|
+
export type GapFillTone = 'good' | 'bad' | 'neutral';
|
|
858
|
+
/** A target pin addressed from options, which must name its series. */
|
|
859
|
+
export interface LineOptionTarget extends LineSeriesTarget {
|
|
860
|
+
seriesId: Id;
|
|
861
|
+
}
|
|
862
|
+
export interface LineGapFill {
|
|
863
|
+
between: [Id, Id];
|
|
864
|
+
positiveTone?: GapFillTone;
|
|
865
|
+
negativeTone?: GapFillTone;
|
|
866
|
+
}
|
|
867
|
+
/**
|
|
868
|
+
* One nested uncertainty band of a fan, declared as a pair of ordinary series.
|
|
869
|
+
*
|
|
870
|
+
* `label` is REQUIRED and carries no default. "80% predictive interval",
|
|
871
|
+
* "P10-P90 of 500 simulations" and "min/max of three planning scenarios" are
|
|
872
|
+
* drawn identically and mean entirely different things; a reader cannot
|
|
873
|
+
* recover which one they are looking at from the picture, so the author has to
|
|
874
|
+
* say. There is no honest fallback string the engine could invent here.
|
|
875
|
+
*/
|
|
876
|
+
export interface LineFanBand {
|
|
877
|
+
/** Series id carrying the lower bound. */
|
|
878
|
+
low: Id;
|
|
879
|
+
/** Series id carrying the upper bound. */
|
|
880
|
+
high: Id;
|
|
881
|
+
/** What the interval MEANS. Required, min length 1. */
|
|
882
|
+
label: string;
|
|
883
|
+
}
|
|
884
|
+
/**
|
|
885
|
+
* Uncertainty fan preset. Bands are ORDINARY SERIES painted as nested washes;
|
|
886
|
+
* the engine derives no quantile, sigma or interval of its own — see
|
|
887
|
+
* `FanDerived.method` in the line layout for why.
|
|
888
|
+
*
|
|
889
|
+
* Bands are authored OUTERMOST FIRST, and the engine verifies that nesting
|
|
890
|
+
* rather than sorting it: reordering a crossed pair would hide an authoring
|
|
891
|
+
* error the reader could never see.
|
|
892
|
+
*/
|
|
893
|
+
export interface LineFan {
|
|
894
|
+
/** The central trajectory series id. */
|
|
895
|
+
of: Id;
|
|
896
|
+
/** 1..4 bands, outermost first. Four is the legibility cap, not a whim. */
|
|
897
|
+
bands: LineFanBand[];
|
|
898
|
+
/** Draw the bound series as dotted hairlines as well; default false. */
|
|
899
|
+
showBounds?: boolean;
|
|
900
|
+
}
|
|
901
|
+
/**
|
|
902
|
+
* Bump preset. Direction is CHART-LEVEL and cannot be per series: ranking puts
|
|
903
|
+
* every entity on one ladder, so "this series is lowerIsBetter and that one is
|
|
904
|
+
* higherIsBetter" names no ordering at all. A per-series `direction` on the
|
|
905
|
+
* data is therefore ignored with a warning rather than honoured.
|
|
906
|
+
*/
|
|
907
|
+
export interface LineBumpOptions {
|
|
908
|
+
direction?: 'higherIsBetter' | 'lowerIsBetter';
|
|
909
|
+
/**
|
|
910
|
+
* The entities to draw, at most BUMP_SERIES_LIMIT (12). Every entity is
|
|
911
|
+
* still ranked; the others are named in a note with their last rank and
|
|
912
|
+
* keep their values in the data table. Above the limit a bump without it is
|
|
913
|
+
* refused (bump-series-limit).
|
|
914
|
+
*/
|
|
915
|
+
focus?: Id[];
|
|
916
|
+
}
|
|
917
|
+
/**
|
|
918
|
+
* A named reference band on a line chart: one level (`value`) or a range
|
|
919
|
+
* (`low` and `high`) in the value axis' units, drawn as a thin neutral band
|
|
920
|
+
* across the plot and named in a column right of it.
|
|
921
|
+
*/
|
|
922
|
+
export interface LineReferenceBand {
|
|
923
|
+
id?: Id;
|
|
924
|
+
value?: number;
|
|
925
|
+
low?: number;
|
|
926
|
+
high?: number;
|
|
927
|
+
/** Bold short name, such as "60+". */
|
|
928
|
+
label: string;
|
|
929
|
+
/** Plain words after the name, such as "very strong cycle". */
|
|
930
|
+
description?: string;
|
|
931
|
+
}
|
|
932
|
+
/** Where a line chart names its series: at the line ends, on the lines, in a key row above the plot, or nowhere. */
|
|
933
|
+
export type SeriesLabelMode = 'end' | 'inline' | 'key' | 'none';
|
|
934
|
+
/** Which point values a line prints: none, the last, the first and last, those plus each series' low and high, or every point. */
|
|
935
|
+
export type ValueLabelMode = 'none' | 'last' | 'ends' | 'extremes' | 'all';
|
|
936
|
+
/** A unit of a time-axis tick step. */
|
|
937
|
+
export type LineXTimeUnit = 'millisecond' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year';
|
|
938
|
+
/** The continuous x axis of a line or area chart (data.x). */
|
|
939
|
+
export interface LineXAxis {
|
|
940
|
+
/** 'time' reads data.x as instants in `zone`; 'number' as plain numbers. */
|
|
941
|
+
type: 'time' | 'number';
|
|
942
|
+
/** IANA zone of ticks, labels and offset-free times; default 'UTC'. */
|
|
943
|
+
zone?: string;
|
|
944
|
+
/** Axis start, an x value; default the first reading. */
|
|
945
|
+
min?: string | number;
|
|
946
|
+
/** Axis end, an x value; default the last reading. */
|
|
947
|
+
max?: string | number;
|
|
948
|
+
/** Authored tick step: a number on number axes, { unit, step } on time axes. */
|
|
949
|
+
tickStep?: number | {
|
|
950
|
+
unit: LineXTimeUnit;
|
|
951
|
+
step?: number;
|
|
952
|
+
};
|
|
953
|
+
/** Explicit ticks: x values or { value, label } pairs. */
|
|
954
|
+
ticks?: (string | number | {
|
|
955
|
+
value: string | number;
|
|
956
|
+
label?: string;
|
|
957
|
+
})[];
|
|
958
|
+
/** Tick label format: a time pattern such as 'HH:mm', or a number format-by-example. */
|
|
959
|
+
format?: string;
|
|
960
|
+
/** Axis title under the tick row, at the right end. */
|
|
961
|
+
title?: string;
|
|
962
|
+
/** Number axes: the unit of x, which names the trend slope. */
|
|
963
|
+
unit?: string;
|
|
964
|
+
/** Most ticks the automatic ladder draws; default 10. */
|
|
965
|
+
maxTicks?: number;
|
|
966
|
+
}
|
|
967
|
+
export interface LineOptions extends Omit<BaseOptionsFor<'line'>, 'annotations'> {
|
|
968
|
+
/** On a time x axis, x anchors also accept epoch milliseconds, including categoryId, date and end. */
|
|
969
|
+
annotations?: Annotation<string | number>[];
|
|
970
|
+
/** Least-squares fit per shown series (line/area) over every source value in the shown range. Regular months, quarters and years fit on the period index; other dates use weeks or elapsed UTC days; otherwise category positions. The key prints slope per period unit and r². At least 3 non-null points; window/zoom sets the fitted range. */
|
|
971
|
+
trend?: boolean | {
|
|
972
|
+
label?: string;
|
|
973
|
+
};
|
|
974
|
+
/** stacked100-area defaults to sum-consistent rounding of complete computed wholes; nearest preserves separate rounding. */
|
|
975
|
+
rounding?: 'nearest' | 'sum-consistent';
|
|
976
|
+
/** The event lane and key: placement, lane rows, event groups. */
|
|
977
|
+
events?: EventOptions;
|
|
978
|
+
/** Title over the drawn value axis. */
|
|
979
|
+
axisTitles?: {
|
|
980
|
+
primary?: string;
|
|
981
|
+
};
|
|
982
|
+
/** Where an end label of a series that ends early goes: beside its last point, 'lineEnd' (default), or in the gutter right of the plot, 'gutter'. The theme's labels.endLabelPlacement sets the default. */
|
|
983
|
+
endLabelPlacement?: 'gutter' | 'lineEnd';
|
|
984
|
+
/** Display-only live window; source statistics and index baselines stay complete. */
|
|
985
|
+
window?: LiveWindowOptions;
|
|
986
|
+
/** Flag exceptional periods of the one drawn line against a named corridor, with column's rule. */
|
|
987
|
+
anomaly?: AnomalySpec;
|
|
988
|
+
/** Visible category endpoints, or two x values on a continuous axis. Calculations keep the complete source series. */
|
|
989
|
+
viewDomain?: {
|
|
990
|
+
x: [string | number, string | number];
|
|
991
|
+
};
|
|
992
|
+
/** Continuous x axis: readings from data.x placed by value, as times in a zone or plain numbers. */
|
|
993
|
+
xAxis?: LineXAxis;
|
|
994
|
+
/**
|
|
995
|
+
* FC areas use hatched fills; FC lines use a contrast-safe tint. An actual-to-forecast
|
|
996
|
+
* transition adds a divider at the last actual point and an FC header, reusing authored period furniture.
|
|
997
|
+
* Area endpoints use leaders. Stacked and 100% area values sit wholly on their band,
|
|
998
|
+
* the first and last moved inward along it; stacked100-area values need twice the measured
|
|
999
|
+
* label height. Shared band edges have 1px separators.
|
|
1000
|
+
* `'bump'` is a rank preset on the line engine, not a fifth geometry: the
|
|
1001
|
+
* engine derives standard-competition ranks from the values and plots those.
|
|
1002
|
+
* It is mutually exclusive with the area variants by construction — the
|
|
1003
|
+
* field holds one value — and refuses `valueAxis.percent` promotion.
|
|
1004
|
+
*/
|
|
1005
|
+
variant?: 'line' | 'area' | 'stacked-area' | 'stacked100-area' | 'bump';
|
|
1006
|
+
bump?: LineBumpOptions;
|
|
1007
|
+
/**
|
|
1008
|
+
* Where the series names print. 'end' (default): a column right of the line
|
|
1009
|
+
* ends with short leaders, names only. 'inline': on each line's clear
|
|
1010
|
+
* stretch. 'key': a key row above the plot. 'none': nowhere; two or more
|
|
1011
|
+
* drawn series then fall back to the key row. `{ only }` names the listed
|
|
1012
|
+
* series at their ends and leaves the rest without name or value. A lone
|
|
1013
|
+
* plain line defaults to 'none', the title names it.
|
|
1014
|
+
*/
|
|
1015
|
+
seriesLabels?: SeriesLabelMode | {
|
|
1016
|
+
only: Id[];
|
|
1017
|
+
};
|
|
1018
|
+
/** Which point values print, each at its own point. Default 'last'; 'ends' on stacked100-area, 'none' on bump. */
|
|
1019
|
+
valueLabels?: ValueLabelMode;
|
|
1020
|
+
/**
|
|
1021
|
+
* A ring on the last observed point: the newest cohort of a curves chart,
|
|
1022
|
+
* the current period of a trend. `'ring'` picks the primary series (the
|
|
1023
|
+
* hero where `emphasis` named one, else the first data series that is not
|
|
1024
|
+
* a prior year, a plan or a forecast); the object form names the series
|
|
1025
|
+
* outright. `'none'` and omission draw nothing.
|
|
1026
|
+
*/
|
|
1027
|
+
latestPoint?: 'ring' | 'none' | {
|
|
1028
|
+
series: Id;
|
|
1029
|
+
marker?: 'ring';
|
|
1030
|
+
};
|
|
1031
|
+
/**
|
|
1032
|
+
* Multi-series line colouring. `'none'`: every series takes its theme
|
|
1033
|
+
* ramp colour, `color.series[i]`. `'first'`: the first series takes ink and
|
|
1034
|
+
* the others step back to muted context tints. `'ordered'`: the series take
|
|
1035
|
+
* the theme's ordered ramp in data order, the first the lightest (still 3:1
|
|
1036
|
+
* on the page) and the last the full ink, for series whose order is the
|
|
1037
|
+
* encoding, such as cohorts. Unset means `'none'`, except on a drawn fan,
|
|
1038
|
+
* whose centre is the subject and takes the ink. `'first'` is for the plain
|
|
1039
|
+
* `line` variant only; highlight, palette, series fill, colorRole and
|
|
1040
|
+
* series-level scenario keep their own colours; cell-level FC and PL keep
|
|
1041
|
+
* their dashes.
|
|
1042
|
+
*/
|
|
1043
|
+
emphasis?: 'first' | 'ordered' | 'none';
|
|
1044
|
+
/** With `emphasis: 'ordered'` and a Rest series (colorRole 'others'): 'quietest' keeps every named step further from the background than Rest. 'apart': they only differ from it. Unset takes the chart default (DEFAULT_OTHERS_SHADE). */
|
|
1045
|
+
othersShade?: OthersShade;
|
|
1046
|
+
/** With `highlight`: 'grey' (default) greys the other series; 'fade' keeps their own colour, washed toward the page. */
|
|
1047
|
+
highlightMode?: 'grey' | 'fade';
|
|
1048
|
+
rebase100?: boolean | {
|
|
1049
|
+
at: Id;
|
|
1050
|
+
};
|
|
1051
|
+
ratioTier?: DerivedRatioTier;
|
|
1052
|
+
interpolate?: LineInterpolation;
|
|
1053
|
+
gapFill?: LineGapFill;
|
|
1054
|
+
fan?: LineFan;
|
|
1055
|
+
targets?: LineOptionTarget[];
|
|
1056
|
+
/** Contiguous phase partition filled under one continuous curve. */
|
|
1057
|
+
phases?: LinePhase[];
|
|
1058
|
+
/**
|
|
1059
|
+
* Weight and ink per scenario, opt-in and absent by default. A chart
|
|
1060
|
+
* that draws an actual against its prior year reads best with one
|
|
1061
|
+
* ladder: the current series at 1.5 px in the ink, the prior year at 1 px
|
|
1062
|
+
* in the muted ink. Nothing else in the engine reads a scenario for
|
|
1063
|
+
* weight, and the default widths (2, and the hero ladder's 2.4 and 1.4)
|
|
1064
|
+
* stand where this is absent. An authored `fill` or `colorRole`, a
|
|
1065
|
+
* `highlight` and `emphasis: 'first'` all still win.
|
|
1066
|
+
*/
|
|
1067
|
+
scenarioStyle?: Partial<Record<Scenario, LineScenarioStyle>>;
|
|
1068
|
+
/** Default false. true adds the bump chart's ranking note; fan gaps and folded tails print regardless. */
|
|
1069
|
+
methodNote?: boolean;
|
|
1070
|
+
/** Named reference bands, each named in a column right of the plot and tied to its band by a leader. */
|
|
1071
|
+
referenceBands?: LineReferenceBand[];
|
|
1072
|
+
}
|
|
1073
|
+
/** Weight and ink the lines of one scenario take. */
|
|
1074
|
+
export interface LineScenarioStyle {
|
|
1075
|
+
/** Stroke width in px. */
|
|
1076
|
+
width?: number;
|
|
1077
|
+
/** Which neutral ink the line takes. */
|
|
1078
|
+
ink?: 'ink' | 'inkMuted';
|
|
1079
|
+
}
|
|
1080
|
+
/** One lifecycle/era phase: an inclusive category span with its own fill. */
|
|
1081
|
+
export interface LinePhase {
|
|
1082
|
+
id: Id;
|
|
1083
|
+
label: string;
|
|
1084
|
+
from: Id;
|
|
1085
|
+
to: Id;
|
|
1086
|
+
tone?: 'neutral' | 'muted' | 'highlight' | 'good' | 'bad' | 'warn';
|
|
1087
|
+
rank?: number;
|
|
1088
|
+
}
|
|
1089
|
+
/** First line point defaults to its value; last defaults to series name and value. */
|
|
1090
|
+
export interface ComboOptions extends Omit<BaseOptionsFor<'combo'>, 'secondaryAxis'> {
|
|
1091
|
+
/** The event lane and key: placement, lane rows, event groups. */
|
|
1092
|
+
events?: EventOptions;
|
|
1093
|
+
/** Visible category endpoints; source means retain all observations. */
|
|
1094
|
+
viewDomain?: {
|
|
1095
|
+
x: [string, string];
|
|
1096
|
+
};
|
|
1097
|
+
/** Display the last n periods; source means retain all observations. */
|
|
1098
|
+
window?: Pick<LiveWindowOptions, 'last'>;
|
|
1099
|
+
/** Flag exceptional periods of the one line series against a named corridor, with column's rule. */
|
|
1100
|
+
anomaly?: AnomalySpec;
|
|
1101
|
+
/** Combo is the one type whose schema accepts the percent `ruler` form. */
|
|
1102
|
+
secondaryAxis?: SecondaryAxisOptions;
|
|
1103
|
+
/** Titles above active axes; acknowledged secondary charts infer unique series names and units. */
|
|
1104
|
+
axisTitles?: {
|
|
1105
|
+
primary?: string;
|
|
1106
|
+
secondary?: string;
|
|
1107
|
+
};
|
|
1108
|
+
/** Combo's line/area series share the line family's interpolation contract. */
|
|
1109
|
+
interpolate?: LineInterpolation;
|
|
1110
|
+
/** The dual-axis anatomy on an acknowledged, unpinned secondary scale. */
|
|
1111
|
+
dualAxis?: {
|
|
1112
|
+
anatomy?: boolean;
|
|
1113
|
+
growth?: boolean;
|
|
1114
|
+
};
|
|
1115
|
+
/** Which line points print their value, as on the line chart; default 'last' ('ends' under the dual-axis anatomy). The key row names the series. */
|
|
1116
|
+
valueLabels?: ValueLabelMode;
|
|
1117
|
+
/**
|
|
1118
|
+
* A ring on the last observed point of the lead line series, as on the line
|
|
1119
|
+
* chart. `'ring'` picks the first line series that is not a prior year, a
|
|
1120
|
+
* plan or a forecast. `'none'` rings nothing, and also drops the ring a
|
|
1121
|
+
* theme's ink lead line draws; omission keeps the theme's choice.
|
|
1122
|
+
*/
|
|
1123
|
+
latestPoint?: 'ring' | 'none';
|
|
1124
|
+
/** The mean of the column stacks as a dashed Ø rule, as on column; lines are left out. */
|
|
1125
|
+
averageMarker?: ColumnOptions['averageMarker'];
|
|
1126
|
+
/** How reference series draw, as on bar and column; default 'tick'. */
|
|
1127
|
+
referenceStyle?: ColumnOptions['referenceStyle'];
|
|
1128
|
+
/** Weight and ink of the reference tick, as on bar; read under referenceStyle 'tick' only. */
|
|
1129
|
+
referenceTick?: BarOptions['referenceTick'];
|
|
1130
|
+
}
|
|
1131
|
+
/**
|
|
1132
|
+
* Pareto. `sort` is deliberately absent: descending IS the analysis, and an
|
|
1133
|
+
* option to un-sort it would be an option to stop being a Pareto.
|
|
1134
|
+
*/
|
|
1135
|
+
export interface ParetoOptions extends Omit<BaseOptionsFor<'pareto'>, 'sort'> {
|
|
1136
|
+
/**
|
|
1137
|
+
* `never`, not absent. Omitting the key makes `sort` a plain unknown property,
|
|
1138
|
+
* which a non-strict zod object STRIPS: the option would parse away silently, leave
|
|
1139
|
+
* the published JSON Schema, and escape the (type, key) census
|
|
1140
|
+
* at all. The schema refuses it out loud, so the declaration says so too.
|
|
1141
|
+
*/
|
|
1142
|
+
sort?: never;
|
|
1143
|
+
/**
|
|
1144
|
+
* Cumulative-share reference, 0 < t < 100; default 80. A convention to
|
|
1145
|
+
* choose, not a property of the data: the rule, the highlighted vital few
|
|
1146
|
+
* and their key follow it. `false` draws the curve without a reference and
|
|
1147
|
+
* without the vital-few split.
|
|
1148
|
+
*/
|
|
1149
|
+
threshold?: number | false;
|
|
1150
|
+
/** Draw the derived cumulative curve; default true. */
|
|
1151
|
+
cumulative?: boolean;
|
|
1152
|
+
/** Footnotes stating the derivation and the vital-few set; default false. */
|
|
1153
|
+
methodNote?: boolean;
|
|
1154
|
+
/** Title over the left value axis; drawn when authored, or derived where the theme sets valueAxis.titles. */
|
|
1155
|
+
axisTitles?: {
|
|
1156
|
+
primary?: string;
|
|
1157
|
+
};
|
|
1158
|
+
/**
|
|
1159
|
+
* Scale the left axis to the total, so 100 % on the right sits level with
|
|
1160
|
+
* the total on the left and the curve starts at the top of the first
|
|
1161
|
+
* column; default false keeps two independent scales.
|
|
1162
|
+
*/
|
|
1163
|
+
totalScale?: boolean;
|
|
1164
|
+
}
|
|
1165
|
+
export interface MekkoOptions extends BaseOptionsFor<'mekko'> {
|
|
1166
|
+
/** Title of the drawn value axis, drawn only when authored. */
|
|
1167
|
+
axisTitles?: {
|
|
1168
|
+
primary?: string;
|
|
1169
|
+
};
|
|
1170
|
+
variant?: 'stacked100' | 'stacked' | 'bar';
|
|
1171
|
+
widthSeriesId?: Id;
|
|
1172
|
+
ridge?: Id;
|
|
1173
|
+
}
|
|
1174
|
+
export interface PieOptions extends BaseOptionsFor<'pie'> {
|
|
1175
|
+
/** Hole radius fraction, capped at 0.72 when inside labels are enabled. Centre totals include unit. */
|
|
1176
|
+
doughnut?: number;
|
|
1177
|
+
/** Defaults to five largest slices plus Others. */
|
|
1178
|
+
topN?: TopNOptions;
|
|
1179
|
+
/** Up to four displayed slices default to named outside labels with leaders. */
|
|
1180
|
+
labels?: BaseOptions['labels'];
|
|
1181
|
+
rotate?: 0 | 90 | 180 | 270;
|
|
1182
|
+
explode?: Record<Id, number>;
|
|
1183
|
+
/** Nominal slices use series hues; ordered shares use a perceptual tint ladder. */
|
|
1184
|
+
colors?: 'categorical' | 'sequential';
|
|
1185
|
+
/** Sequential ramp beside an Others slice. 'quietest': named slices stay further from the background than Others. 'apart': they only differ from it. Unset takes the chart default (DEFAULT_OTHERS_SHADE). */
|
|
1186
|
+
othersShade?: OthersShade;
|
|
1187
|
+
}
|
|
1188
|
+
/**
|
|
1189
|
+
* A quadrant cut point: either the number the author declares, or a statistic
|
|
1190
|
+
* the engine computes over the PLOTTED points and names on the exhibit. There
|
|
1191
|
+
* is deliberately no size-weighted form — a weighted median needs declared
|
|
1192
|
+
* weight semantics and there is no honest default.
|
|
1193
|
+
*/
|
|
1194
|
+
export type QuadrantThreshold = number | {
|
|
1195
|
+
stat: 'median' | 'mean';
|
|
1196
|
+
};
|
|
1197
|
+
/**
|
|
1198
|
+
* Strategy-matrix (2x2 / growth-share) preset on the scatter engine.
|
|
1199
|
+
* `x` and `y` are MANDATORY: where the dividing lines go decides which unit is
|
|
1200
|
+
* a star and which is a dog, so a bare enable is refused rather than guessed.
|
|
1201
|
+
*/
|
|
1202
|
+
export interface QuadrantOptions {
|
|
1203
|
+
x: QuadrantThreshold;
|
|
1204
|
+
y: QuadrantThreshold;
|
|
1205
|
+
/** Box captions, all optional; each rendered one places inside its own box. */
|
|
1206
|
+
labels?: {
|
|
1207
|
+
tl?: string;
|
|
1208
|
+
tr?: string;
|
|
1209
|
+
bl?: string;
|
|
1210
|
+
br?: string;
|
|
1211
|
+
};
|
|
1212
|
+
/**
|
|
1213
|
+
* Neutral checkerboard wash only. Good/bad quadrant coloring is NOT offered:
|
|
1214
|
+
* the engine cannot know axis polarity, so a semantic quadrant color would be
|
|
1215
|
+
* an unfounded judgment. Emphasis belongs on `options.highlight`.
|
|
1216
|
+
*/
|
|
1217
|
+
tint?: 'none' | 'alternating';
|
|
1218
|
+
/** First caption candidate: the box's outer corner (default) or its centre. */
|
|
1219
|
+
captionPlacement?: 'corner' | 'centre';
|
|
1220
|
+
/**
|
|
1221
|
+
* Short names of the two axes for a one-line method note ("Cuts: share at 1
|
|
1222
|
+
* and growth at 8; …"). Used only with both names and two declared cut points.
|
|
1223
|
+
*/
|
|
1224
|
+
axisNames?: {
|
|
1225
|
+
x?: string;
|
|
1226
|
+
y?: string;
|
|
1227
|
+
};
|
|
1228
|
+
}
|
|
1229
|
+
/**
|
|
1230
|
+
* Per-axis outlier clamp. `min`/`max` are the vertical axis, the one
|
|
1231
|
+
* `valueAxis.min` and `valueAxis.max` address on this type; `x` and `y` name an
|
|
1232
|
+
* axis. Stating the vertical bound both ways is refused, not merged.
|
|
1233
|
+
*/
|
|
1234
|
+
export interface ScatterClampOptions {
|
|
1235
|
+
min?: number;
|
|
1236
|
+
max?: number;
|
|
1237
|
+
x?: {
|
|
1238
|
+
min?: number;
|
|
1239
|
+
max?: number;
|
|
1240
|
+
};
|
|
1241
|
+
y?: {
|
|
1242
|
+
min?: number;
|
|
1243
|
+
max?: number;
|
|
1244
|
+
};
|
|
1245
|
+
}
|
|
1246
|
+
/**
|
|
1247
|
+
* `valueAxis` as scatter widens it. The shared `min`/`max` widen the domain so
|
|
1248
|
+
* no value is cut off; `clamp` caps it on purpose and marks what it cut.
|
|
1249
|
+
*/
|
|
1250
|
+
export interface ScatterValueAxisOptions extends ValueAxisOptionsFor<'scatter'> {
|
|
1251
|
+
clamp?: ScatterClampOptions;
|
|
1252
|
+
}
|
|
1253
|
+
export interface ScatterOptions extends BaseOptionsFor<'scatter'> {
|
|
1254
|
+
/** Exact visible scale limits; means and bubble sizing retain all source points. */
|
|
1255
|
+
viewDomain?: {
|
|
1256
|
+
x?: [number, number];
|
|
1257
|
+
y?: [number, number];
|
|
1258
|
+
};
|
|
1259
|
+
valueAxis?: ScatterValueAxisOptions;
|
|
1260
|
+
/** Drop points whose `count` is below this; refused when no point carries one. */
|
|
1261
|
+
minCount?: number;
|
|
1262
|
+
/** Axis titles; a scatter without them leaves the reader guessing which axis is which. */
|
|
1263
|
+
axisTitles?: {
|
|
1264
|
+
x?: string;
|
|
1265
|
+
y?: string;
|
|
1266
|
+
};
|
|
1267
|
+
/**
|
|
1268
|
+
* Format-by-example per axis, such as { x: '$0', y: '0%' }. Each falls back
|
|
1269
|
+
* to `format`. Ticks, point values, hover values, zone and clamp text and
|
|
1270
|
+
* the accessible description print each coordinate in its own axis format.
|
|
1271
|
+
*/
|
|
1272
|
+
axisFormat?: {
|
|
1273
|
+
x?: string;
|
|
1274
|
+
y?: string;
|
|
1275
|
+
};
|
|
1276
|
+
/** `value: true` prints each point's value: the size on a bubble chart, y otherwise. */
|
|
1277
|
+
labels?: false | (Partial<Record<LabelKind, boolean | LabelContent>> & {
|
|
1278
|
+
value?: boolean;
|
|
1279
|
+
});
|
|
1280
|
+
sizeBy?: 'area' | 'diameter';
|
|
1281
|
+
maxPointLabels?: number;
|
|
1282
|
+
quadrants?: QuadrantOptions;
|
|
1283
|
+
/**
|
|
1284
|
+
* Linear trend: an ordinary least squares fit over the drawn points, drawn
|
|
1285
|
+
* dashed across the fitted x range under the points. `true` fits all points
|
|
1286
|
+
* as one; `groups: 'each'` fits every group, a list fits the named groups.
|
|
1287
|
+
* Slope, intercept and r² go into the claims. The key entry prints the
|
|
1288
|
+
* slope and r²; on the plot the only text is `label`, at an end of the line.
|
|
1289
|
+
*/
|
|
1290
|
+
trend?: boolean | {
|
|
1291
|
+
groups?: 'all' | 'each' | Id[];
|
|
1292
|
+
label?: string;
|
|
1293
|
+
};
|
|
1294
|
+
/**
|
|
1295
|
+
* Pareto line through the drawn points no other point beats on both axes.
|
|
1296
|
+
* `x` and `y` say which end is better, such as { x: 'min', y: 'max' } for
|
|
1297
|
+
* the lowest cost at the highest score. Dotted, under the points, in x
|
|
1298
|
+
* order; keyed as 'Pareto line' or `label`. `extend` runs it a short way
|
|
1299
|
+
* past its first and last point; `groups` limits it to those groups.
|
|
1300
|
+
*/
|
|
1301
|
+
frontier?: {
|
|
1302
|
+
x: 'min' | 'max';
|
|
1303
|
+
y: 'min' | 'max';
|
|
1304
|
+
label?: string;
|
|
1305
|
+
extend?: boolean;
|
|
1306
|
+
groups?: 'all' | Id[];
|
|
1307
|
+
};
|
|
1308
|
+
/**
|
|
1309
|
+
* Bubble size key: nested circles on one bottom tangent, each with its value,
|
|
1310
|
+
* inside the plot in the first corner no bubble touches. Bubble charts only;
|
|
1311
|
+
* drawn by default whenever a size is mapped, false turns it off.
|
|
1312
|
+
* Default values: a round number at most the largest size and one a quarter
|
|
1313
|
+
* of it or less; an authored value above the largest size is left out with a
|
|
1314
|
+
* warning. `label` names the size measure.
|
|
1315
|
+
*/
|
|
1316
|
+
sizeLegend?: boolean | {
|
|
1317
|
+
values?: number[];
|
|
1318
|
+
label?: string;
|
|
1319
|
+
};
|
|
1320
|
+
/** Axes that read as directions, not scales: no ticks, 'Lower' and 'Higher' at the ends, the bold title between arrows. */
|
|
1321
|
+
qualitativeAxes?: boolean;
|
|
1322
|
+
/**
|
|
1323
|
+
* Default false. true adds the method notes: axes that do not start at zero
|
|
1324
|
+
* and the quadrant cut points, tie rule, shading and box counts. Clipped and
|
|
1325
|
+
* dropped points print regardless.
|
|
1326
|
+
*/
|
|
1327
|
+
methodNote?: boolean;
|
|
1328
|
+
}
|
|
1329
|
+
export interface VarianceOptions extends BaseOptionsFor<'variance'> {
|
|
1330
|
+
/** Title of the value axis valueAxis.show draws, drawn only when authored. */
|
|
1331
|
+
axisTitles?: {
|
|
1332
|
+
primary?: string;
|
|
1333
|
+
};
|
|
1334
|
+
variant: 'absolute' | 'relative' | 'integrated';
|
|
1335
|
+
variance: VarianceSpec;
|
|
1336
|
+
/**
|
|
1337
|
+
* What a category with no prior value leaves behind. 'dash' prints an en
|
|
1338
|
+
* dash at the baseline in the muted ink, so a missing reference reads as
|
|
1339
|
+
* missing instead of as no difference. Default 'none'.
|
|
1340
|
+
*/
|
|
1341
|
+
missingMark?: 'dash' | 'none';
|
|
1342
|
+
}
|
|
1343
|
+
/** Rows stop at their measured natural pitch, normally 44px; deltas use the label token. */
|
|
1344
|
+
export interface BulletOptions extends BaseOptionsFor<'bullet'> {
|
|
1345
|
+
/** Title of the shared-scale value axis valueAxis.show draws, drawn only when authored. */
|
|
1346
|
+
axisTitles?: {
|
|
1347
|
+
primary?: string;
|
|
1348
|
+
};
|
|
1349
|
+
/**
|
|
1350
|
+
* true: one absolute value scale across all rows — for same-unit rows whose
|
|
1351
|
+
* magnitudes should compare (this was the only behaviour before ENGINE_REV
|
|
1352
|
+
* 15). false: each row is normalized to its own zero-based extent (band
|
|
1353
|
+
* maximum, extended by value/target overshoot) — the bullet-graph percent-of-scale
|
|
1354
|
+
* convention, which keeps mixed-unit KPI rows legible. Default: false
|
|
1355
|
+
* exactly when every row declares bands, true otherwise (a bandless row has
|
|
1356
|
+
* no band maximum to normalize to). Normalized rows ignore `valueAxis` with
|
|
1357
|
+
* a warning: one absolute axis cannot describe differently scaled rows.
|
|
1358
|
+
*
|
|
1359
|
+
* 'percentOfTarget': every row on one scale in percent of its own
|
|
1360
|
+
* target (actual ÷ target), 0 to 120 %; three shared bands (below 80 %,
|
|
1361
|
+
* 80–100 %, at or above target) named once in a key, mirrored at 100 % on a
|
|
1362
|
+
* lower-is-better row (the key then names them more than 20 % off, up to
|
|
1363
|
+
* 20 % off, on target or better), one target line at 100 %, the value, its share of target and the
|
|
1364
|
+
* delta beside each row. The rows' own bands, `valueAxis` and annotations
|
|
1365
|
+
* are not drawn.
|
|
1366
|
+
*/
|
|
1367
|
+
sharedScale?: boolean | 'percentOfTarget';
|
|
1368
|
+
/**
|
|
1369
|
+
* How the band key reads. 'labels': one entry for each band label and shade.
|
|
1370
|
+
* 'ramp': one worse-to-better key with N entries (Worse ... Better; the words
|
|
1371
|
+
* come from `strings.bandKey` or the locale). 'auto' (default): ramp only when
|
|
1372
|
+
* the rows run both directions, a label sits on more than one shade, every
|
|
1373
|
+
* banded row has the same 2 to 5 bands, no band has a tone and no row is
|
|
1374
|
+
* neutral; otherwise labels. A forced ramp that cannot apply keeps labels and warns.
|
|
1375
|
+
* 'row': each band's name prints above its band on every row, the band edges are
|
|
1376
|
+
* ticked under each row on per-row scales, the value sits just past the bar end and
|
|
1377
|
+
* a key at the bottom names the bar, the target tick and the ramp. It needs a name
|
|
1378
|
+
* on every band, rows side by side with the target column, and room for each name;
|
|
1379
|
+
* elsewhere the key names the bands and a warning says so. 'auto' picks 'row' for at
|
|
1380
|
+
* most 4 rows that name every band, wherever 'row' can show.
|
|
1381
|
+
*/
|
|
1382
|
+
bandKey?: 'auto' | 'labels' | 'ramp' | 'row';
|
|
1383
|
+
/**
|
|
1384
|
+
* true (default): where the rows sit side by side and the plot keeps 45 % of
|
|
1385
|
+
* the width, a Target column and a Gap-to-target column print beside the
|
|
1386
|
+
* rows under their heads; the gap carries its position (below, above or on
|
|
1387
|
+
* target) under it, and each row name its direction. Where they do not fit,
|
|
1388
|
+
* and with false, the target prints above its tick and the delta at the row end.
|
|
1389
|
+
*/
|
|
1390
|
+
targetColumns?: boolean;
|
|
1391
|
+
/**
|
|
1392
|
+
* 'compact': the 120 x 28 mark for a KPI column. Bar, bands and
|
|
1393
|
+
* target tick stay; row label, value, delta, axis and band key go, and the
|
|
1394
|
+
* value and target stay in the description and the hover. Default 'regular'.
|
|
1395
|
+
*/
|
|
1396
|
+
density?: 'compact' | 'regular';
|
|
1397
|
+
}
|
|
1398
|
+
export interface DotOptions extends BaseOptionsFor<'dot'> {
|
|
1399
|
+
/** Authored value-axis title, under the tick row when the axis is drawn. */
|
|
1400
|
+
axisTitles?: {
|
|
1401
|
+
primary?: string;
|
|
1402
|
+
};
|
|
1403
|
+
variant?: 'dot' | 'dumbbell' | 'lollipop';
|
|
1404
|
+
/** The mean of every dot of the series in scope as a dashed Ø rule, as on bar and column. */
|
|
1405
|
+
averageMarker?: ColumnOptions['averageMarker'];
|
|
1406
|
+
/**
|
|
1407
|
+
* Dumbbell only: the connector becomes an arrow into the second series' dot.
|
|
1408
|
+
* Painted good or bad by the sign of the change when the second series
|
|
1409
|
+
* declares `direction`, neutral otherwise.
|
|
1410
|
+
*/
|
|
1411
|
+
arrow?: boolean;
|
|
1412
|
+
/** Default false. true adds the method note naming the mid-point tick inside a range, and draws the tick. */
|
|
1413
|
+
methodNote?: boolean;
|
|
1414
|
+
/**
|
|
1415
|
+
* What the drawn ranges are. `label` names the interval in the key
|
|
1416
|
+
* ("Peer range, min to max"); default "Range". `values: true` prints each
|
|
1417
|
+
* range's low and high beside its caps.
|
|
1418
|
+
*/
|
|
1419
|
+
range?: {
|
|
1420
|
+
label?: string;
|
|
1421
|
+
values?: boolean;
|
|
1422
|
+
};
|
|
1423
|
+
}
|
|
1424
|
+
export interface SlopeOptions extends BaseOptionsFor<'slope'> {
|
|
1425
|
+
/**
|
|
1426
|
+
* Fold every series that stays under this share of the endpoint total at BOTH
|
|
1427
|
+
* ends into one 'Other' line whose values the engine sums. A SHARE, not a
|
|
1428
|
+
* percent: 0.05 is five percent, and 5 is refused with the patch that turns it
|
|
1429
|
+
* into 0.05. Highlighted series keep their own name whatever their share.
|
|
1430
|
+
*/
|
|
1431
|
+
foldBelowShare?: number;
|
|
1432
|
+
/**
|
|
1433
|
+
* 'diverging' draws one panel per series: its values as the positive share
|
|
1434
|
+
* up from zero and its `negative` as the negative share down from zero, at
|
|
1435
|
+
* two periods. Unset draws the plain slope lines.
|
|
1436
|
+
*/
|
|
1437
|
+
variant?: 'lines' | 'diverging';
|
|
1438
|
+
/** Variant 'diverging' only. */
|
|
1439
|
+
diverging?: {
|
|
1440
|
+
/** Area names in the first panel. Default 'Positive' and 'Negative'. */
|
|
1441
|
+
labels?: {
|
|
1442
|
+
positive?: string;
|
|
1443
|
+
negative?: string;
|
|
1444
|
+
};
|
|
1445
|
+
/** Panel order. Default 'positive': the positive share in period 2, descending. */
|
|
1446
|
+
sort?: 'positive' | 'net' | 'data';
|
|
1447
|
+
/** Net score (positive − negative) in period 2 and its change under each panel. Default true. */
|
|
1448
|
+
net?: boolean;
|
|
1449
|
+
/** A note naming the share that chose neither answer, when the two do not add to 100. Default true. */
|
|
1450
|
+
neutralNote?: boolean;
|
|
1451
|
+
/** A group with a base `n` under this in either period is hatched and named in a note. Default 30. */
|
|
1452
|
+
minBase?: number;
|
|
1453
|
+
};
|
|
1454
|
+
}
|
|
1455
|
+
export interface HeatmapOptions extends BaseOptionsFor<'heatmap'> {
|
|
1456
|
+
scale?: 'continuous' | 'discrete';
|
|
1457
|
+
/** Automatic values share one fit decision per row; authored labels and valid pins retain precedence. */
|
|
1458
|
+
variant?: 'value' | 'harvey' | 'bubble';
|
|
1459
|
+
/** Where the continuous scale saturates, as table heat's cap: `pct` on a matrix of percent cells, in points, `abs` otherwise. */
|
|
1460
|
+
cap?: {
|
|
1461
|
+
pct?: number;
|
|
1462
|
+
abs?: number;
|
|
1463
|
+
};
|
|
1464
|
+
/** Bin edges of the discrete scale, ascending: n edges paint n − 1 colour bins, such as [0, 30, 50, 100]. */
|
|
1465
|
+
breaks?: number[];
|
|
1466
|
+
/**
|
|
1467
|
+
* The bubble glyph: `levels` names ordinal sizes 1..n (series `sizes` hold
|
|
1468
|
+
* the level), else sizes are a continuous area scale. `sizeLabel` and
|
|
1469
|
+
* `colorLabel` title the two keys. `track` draws a line with an arrow through
|
|
1470
|
+
* each row (default false: it implies an order).
|
|
1471
|
+
*/
|
|
1472
|
+
bubble?: {
|
|
1473
|
+
levels?: string[];
|
|
1474
|
+
sizeLabel?: string;
|
|
1475
|
+
colorLabel?: string;
|
|
1476
|
+
track?: boolean;
|
|
1477
|
+
};
|
|
1478
|
+
/** Cells whose series `bases` entry is below this base draw hatched, and a note says why. */
|
|
1479
|
+
minBase?: number;
|
|
1480
|
+
/**
|
|
1481
|
+
* How a cell with no value is drawn. Default `'hatch'`: stripes and a key
|
|
1482
|
+
* entry. `'blank'` draws no fill and no stripe; the same key entry or note
|
|
1483
|
+
* still names the blank cell. A blank cell keeps its grid line and dash,
|
|
1484
|
+
* so it does not read as the palest value. A low base stays hatched.
|
|
1485
|
+
*/
|
|
1486
|
+
missing?: 'hatch' | 'blank';
|
|
1487
|
+
}
|
|
1488
|
+
/** Standalone width defaults to 360px and stops at 420px; comparison rows follow the value. */
|
|
1489
|
+
export interface KpiOptions extends BaseOptionsFor<'kpi'> {
|
|
1490
|
+
/**
|
|
1491
|
+
* 'compact' uses a 280 px default card width instead of 360, for a
|
|
1492
|
+
* dashboard that puts nine of them in a row. An
|
|
1493
|
+
* unsized card of either density takes the height of its content.
|
|
1494
|
+
* 'regular' is the default.
|
|
1495
|
+
*/
|
|
1496
|
+
density?: 'compact' | 'regular';
|
|
1497
|
+
/**
|
|
1498
|
+
* How `data.compare[]` and `data.attainment` are drawn. 'chip'
|
|
1499
|
+
* (the default) puts each in a tinted chip. 'text' draws each one the way
|
|
1500
|
+
* `data.delta` is drawn: text in its tone and no fill, the compare entries
|
|
1501
|
+
* signed with a caret, side by side on one row and one per row when they do
|
|
1502
|
+
* not fit, the attainment on the row under them.
|
|
1503
|
+
*/
|
|
1504
|
+
comparisons?: 'chip' | 'text';
|
|
1505
|
+
}
|
|
1506
|
+
/**
|
|
1507
|
+
* The standalone sparkline: 176 by 36 by default, no axes, no
|
|
1508
|
+
* smoothing, no fill. A bare one draws edge to edge, because it is a mark
|
|
1509
|
+
* inside someone else's card; one that carries a title takes the canvas
|
|
1510
|
+
* margin, and `canvas.margin` overrides either.
|
|
1511
|
+
*/
|
|
1512
|
+
export interface SparklineOptions extends BaseOptionsFor<'sparkline'> {
|
|
1513
|
+
/** A ring on the last observed point, in the highlight. Default 'last'. */
|
|
1514
|
+
ring?: 'last' | 'none';
|
|
1515
|
+
/**
|
|
1516
|
+
* The first and last authored label under the ends of the line. Default
|
|
1517
|
+
* 'none'. It is `endLabels` and not `labels`, because `labels` is the
|
|
1518
|
+
* shared per-label-kind switch every other type reads.
|
|
1519
|
+
*/
|
|
1520
|
+
endLabels?: 'ends' | 'none';
|
|
1521
|
+
/** 'last' prints the last observed value beside the end of the line. Default 'none'. */
|
|
1522
|
+
valueLabel?: 'last' | 'none';
|
|
1523
|
+
/** Stroke width of the line. Default 1.5. */
|
|
1524
|
+
stroke?: number;
|
|
1525
|
+
/** A 1 px dashed line at this value, unlabelled; the scale always includes it. */
|
|
1526
|
+
reference?: number;
|
|
1527
|
+
/** The end ring in this tone instead of the highlight. Refused with ring 'none'. */
|
|
1528
|
+
ringTone?: 'good' | 'warn' | 'bad';
|
|
1529
|
+
}
|
|
1530
|
+
export interface FunnelOptions extends BaseOptionsFor<'funnel'> {
|
|
1531
|
+
/** Rows bound automatic callout leaders to three text widths; centered stage text uses three centered lines. */
|
|
1532
|
+
variant?: 'rows' | 'centered';
|
|
1533
|
+
totalCvr?: 'none' | 'column';
|
|
1534
|
+
/** Centered single-series stages darken by default; authored paints and palettes take priority. */
|
|
1535
|
+
stageShade?: 'darken' | 'lighten';
|
|
1536
|
+
/**
|
|
1537
|
+
* Rows only: the automatic "Biggest drop" callout at the step with the
|
|
1538
|
+
* largest loss. Default false; the step captions already print every rate.
|
|
1539
|
+
*/
|
|
1540
|
+
worstDropCallout?: boolean;
|
|
1541
|
+
}
|
|
1542
|
+
export interface GridOptions extends BaseOptionsFor<'grid'> {
|
|
1543
|
+
/** Top-down metric stack with shared categories and computed readouts. */
|
|
1544
|
+
stack?: import('../charts/grid/metricStack.js').MetricStackOptions;
|
|
1545
|
+
columns?: number;
|
|
1546
|
+
/** Category-aligned column/variance tiers use 4:1 plot heights unless authored tracks or a shared y scale apply. */
|
|
1547
|
+
sharedAxis?: 'category' | 'none';
|
|
1548
|
+
/**
|
|
1549
|
+
* Numeric panels with matching unit and format read against one value scale,
|
|
1550
|
+
* so panel heights compare in facets and category-aligned tiers.
|
|
1551
|
+
*
|
|
1552
|
+
* Defaults to true in every sharedAxis mode only with evidence of one
|
|
1553
|
+
* measure: every numeric panel names the same non-empty unit and format,
|
|
1554
|
+
* the grid names a unit, or the panels come from repeat or a scaleGroup. A
|
|
1555
|
+
* shared chart type is no evidence. Set true to share panels without a
|
|
1556
|
+
* unit, false to keep independent domains. A grid with a nonnumeric panel or mismatched unit or
|
|
1557
|
+
* format stays independent unless an authored scale group says otherwise.
|
|
1558
|
+
*/
|
|
1559
|
+
sharedScale?: boolean;
|
|
1560
|
+
/**
|
|
1561
|
+
* Panel order. `sheet` keeps the authored array and is the default.
|
|
1562
|
+
*
|
|
1563
|
+
* Deliberately NOT spelled `sort: { panels }`. The inherited base `sort` is
|
|
1564
|
+
* category-shaped, and `ChartDefinition` constrains every options type to
|
|
1565
|
+
* extend `BaseOptions`, so narrowing that key on one chart does not type.
|
|
1566
|
+
* Widening it would leave `sort: { categories: 'asc' }` legal on a grid and
|
|
1567
|
+
* silently dropped, which is a defect, so the ordering gets a key
|
|
1568
|
+
* of its own instead of an overloaded one.
|
|
1569
|
+
*
|
|
1570
|
+
* Only meaningful for facet cells; an authored row/column grid places its
|
|
1571
|
+
* panels explicitly, and asking for an order there warns rather than silently
|
|
1572
|
+
* doing nothing.
|
|
1573
|
+
*/
|
|
1574
|
+
panelOrder?: 'sheet' | 'lastDesc' | 'lastAsc' | 'totalDesc' | 'totalAsc';
|
|
1575
|
+
/**
|
|
1576
|
+
* A facet grid of more panels than `columns` (a number) on a card under 480 px takes
|
|
1577
|
+
* `columns` as a maximum: where a panel drops category names for room, it draws with
|
|
1578
|
+
* fewer columns, down to two, at the largest count that prints every name and that an
|
|
1579
|
+
* authored height seats.
|
|
1580
|
+
* Default true. False keeps the authored count at every width.
|
|
1581
|
+
*/
|
|
1582
|
+
reflow?: boolean;
|
|
1583
|
+
}
|